Get Payout by ID

Retrieve detailed information about a specific payout using its unique ID. This is an alternative endpoint to /payouts/history/{id} for retrieving payout details.

Authentication

AuthorizationBearer
OAuth 2.0 access token

Path parameters

payoutIdstringRequired
Identifier of the payout

Response

Successful response with payout details
idstring
Payout ID
currencystring
Currency code
amountdouble
Payout amount
statusenum
Payout status
Allowed values:
createdAtdatetime
Payout creation timestamp
recipientTypestring
Type of recipient
recipientobject

Recipient details (masked for security)

completedAtdatetime
Payout completion timestamp
referencestring
External reference
descriptionstring
Payout description
failureReasonstring

Reason for failure (if status is failed)

Errors

403
Forbidden Error
404
Not Found Error