CollectPaymentsManage Transactions

Search Payments by Merchant Reference

Search for payments using a merchant reference. Returns matching transactions across the specified merchant IDs.

Query parameters

merchantIdsstringRequired

Comma-separated list of merchant IDs (UUIDs) to search within.

merchantReferencestringRequired
The merchant reference to search for.

Response

Matching transactions returned successfully.
currentStatestring
Current transaction state
previousStateslist of strings
Array of previous transaction states
processorstring
Payment processor used for the transaction
merchantNamestring
Merchant name
transactionIdstring
Unique transaction identifier
amountdouble
Transaction amount
transactionTypestring
Transaction type
paymentMethodIdstring
Payment method identifier
currencystring
Transaction currency
merchantReferencestring
Merchant reference
transactionStateslist of maps from strings to any
Detailed transaction state history
paymentAttributesmap from strings to stringsOptional

Payment-specific attributes and metadata

identifiersmap from strings to stringsOptional
Additional transaction identifiers
paymentInstrumentmap from strings to anyOptional
Payment instrument details when applicable.
processorReferencestringOptional
Payment processor reference
financialTransactionReferencestringOptional
Financial transaction reference from the processor
currentAttemptIdstringOptional
Current attempt identifier
batchPayoutIdstringOptional
Batch payout identifier, if the transaction is part of a batch payout
refundTransactionIdslist of stringsOptional

Transaction identifiers of all refunds processed against this transaction. Each entry can be passed to GET /payment/refunds/{transactionId} to retrieve full refund state. UUID v7.

Errors

401
Unauthorized Error
422
Unprocessable Entity Error