Search Payouts by Merchant Reference

Returns payouts whose merchantReference matches the supplied value, scoped to the listed merchants.

Authentication

AuthorizationBearer

OAuth 2.0 access token issued by the CrissCross authorisation server.

Query parameters

merchantIdslist of stringsRequired

Comma-separated list of merchant IDs to search within.

merchantReferencestringRequired

Merchant reference to search for.

Response

Matching payouts retrieved successfully.

transactionIdstring

Unique payout identifier.

currentStatestring

Current state name.

previousStateslist of strings

Ordered list of prior state names.

transactionStateslist of maps from strings to any

Detailed history of state transitions.

merchantReferencestringOptional

Your reference for the payout.

processorstringOptional

Payout processor used.

merchantNamestringOptional

Merchant display name.

amountdoubleOptional

Payout amount.

currencystringOptional

3-character ISO currency code.

paymentLocationstringOptional

3-letter ISO country code.

paymentMethodIdstringOptional

Payment method identifier (e.g. banktransfer).

transactionTypestringOptional

Transaction type (e.g. PAYOUT).

processorReferencestringOptional

Processor-side reference.

financialTransactionReferencestringOptional

Financial transaction reference returned by the processor.

currentAttemptIdstringOptional

Identifier of the current delivery attempt.

batchPayoutIdstringOptional

Batch identifier when part of a batch payout.

identifiersmap from strings to stringsOptional

paymentAttributesmap from strings to stringsOptional

Errors

401

Unauthorized Error

422

Unprocessable Entity Error

500

Internal Server Error