Payouts APIPayout

Search payouts by merchant reference

Retrieves payout transactions matching a merchant reference

Query parameters

merchantIdslist of stringsRequired

Comma-separated list of merchant IDs to search within

merchantReferencestringRequired
Merchant reference to search for

Response

Payouts retrieved 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 objects
Detailed transaction state history
paymentAttributesmap from strings to strings or null

Payment-specific attributes and metadata

identifiersmap from strings to strings or null
Additional transaction identifiers
paymentInstrumentobject or null
Card payment instrument details
processorReferencestring or null
Payment processor reference
financialTransactionReferencestring or null
Financial transaction reference from the processor
currentAttemptIdstring or null
Current attempt identifier
batchPayoutIdstring or null
Batch payout identifier, if the transaction is part of a batch payout

Errors