v47

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-013871777.1 KB

Payout

Retrieve a payout

Retrieve a payout object by id.

post/api/service/payout/retrieve

Request body

idstring required

The payout ID

Response

Retrieve a payout

idstring required

The payout ID

type'beneficiary' | 'customer' required

The payout type

status'paid' | 'pending' | 'in_transit' | 'failed' | 'canceled' required

The payout status

amountnumber required

The payout amount

currency'EUR' | 'GBP' | 'USDC' | 'USD' required

The payout currency

metadataobject

The payout metadata

{"stackTrail":"components:schemas:RetrieveResponseDto:properties:createdAt","oasType":"schema","type":"unknown","description":"The payout created at"}

{"stackTrail":"components:schemas:RetrieveResponseDto:properties:updatedAt","oasType":"schema","type":"unknown","description":"The payout updated at"}

paymentReferencestring

The payout payment reference

transactionIdstring

The payout transaction ID