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.

payoutIdstringOptional

Unique identifier for the payout.

statusenumOptional

Current status of the payout.

Allowed values:
createdAtdatetimeOptionalDefaults to 1970-01-01T00:00:00.000Z

Timestamp when the payout was created.

recipientobjectOptional
currencystringOptional

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

amountdoubleOptional

The payout amount.

referencestringOptional

Merchant-provided reference for the payout.

metadatamap from strings to anyOptional

Optional metadata object for additional information.

Errors