Endpoints
Attributes
string
required
Payout ID.
number
required
The payout amount in whole currency units.
string
required
When the payout was created.
string
required
Payout currency.
string | null
required
Estimated time the funds become available in the destination account.
number
required
The fee charged for the payout, in the payout currency.
string
required
string | null
required
Name of the entity processing the payout.
object | null
required
The saved payout method used. Requires payout:destination:read; null without it.
string | null
required
The ID returned by POST /payouts when this payout was requested. Match it to
the settled payout in GET /payouts. Null for payouts not created by POST
/payouts.
string
required
Payout delivery speed.Available options:
standard, instantstring
required
Current payout status.Available options:
requested, awaiting_payment, in_transit, completed, failed, canceled, deniedPayout

