Skip to navigation
PayoutsPayoutsPayouts

Retrieve Payout

Retrieves the current state of a payout transaction. The response is the same shape returned by Initiate Payout and emitted on payout webhooks, so the same parser can be reused.

Authentication

AuthorizationBearer
OAuth 2.0 access token issued by the CrissCross authorisation server.

Path parameters

transactionIdstringRequiredformat: "uuid"
UUID of the payout transaction.

Response

Payout details retrieved successfully.
statusstring
Current payout status.
transactionIdstring
Unique identifier for the payout transaction.
messagestring

Human-readable status message.

merchantReferencestringOptional
Merchant reference from the original payout initiation.
sessionIdstringOptionalformat: "uuid"
Session ID associated with the payout, if applicable.
paymentMethodIdstringOptional

Payment method identifier (e.g. banktransfer, mobilemoney).

identifiersmap from strings to stringsOptional
Additional identifiers related to the payout.
paymentAttributesmap from strings to stringsOptional

Payout-specific attributes and metadata.

processorNamestringOptional

Name of the payout processor (if assigned).

processorReferencestringOptional

Processor-side reference for the payout (if available).

financialTransactionReferencestringOptional

Financial transaction reference returned by the processor (if available).

currentAttemptIdstringOptional
Identifier of the current delivery attempt.
batchPayoutIdstringOptional
Batch identifier, present when the payout is part of a batch.
authStateobjectOptional

Latest auth/state transition on the payout. The shape varies by state and (when present) authMethodType — additional method-specific fields may be present.

Errors

401
Unauthorized Error
404
Not Found Error
422
Unprocessable Entity Error
500
Internal Server Error