Payouts APIPayouts

Get Payout by ID

Retrieves detailed information about a specific payout using its unique ID.

Path parameters

payoutIdstringRequired
Identifier of the payout in PayOS.

Response

Successful response with payout details.
payoutIdstring or null
Unique identifier for the payout.
statusenum or null
Current status of the payout.
Allowed values:
createdAtdatetime or nullDefaults to 1970-01-01T00:00:00.000Z
Timestamp when the payout was created.
recipientobject or null
currencystring or null

The currency code (e.g., ‘USD’).

amountdouble or null
The payout amount.
referencestring or null

Merchant-provided reference for the payout.

metadatamap from strings to any or null
Optional metadata object for additional information.

Errors