Payout
- idType: stringrequired
Payout ID. Use this ID to retrieve the payout or generate a payout report.
- objectenumconst:payoutrequired
- accountType: stringrequired
Account that owns the payout. For a connected account, this matches the account selected by
Paypercut-Account. - createdType: stringFormat: date-timerequired
When the payout was created for business purposes.
- updatedType: stringFormat: date-timerequired
When the payout was last updated.
- statusType: stringenumrequired
Current payout status. Use payout events or retrieve the payout to track changes.
values- pending
The payout has been created and is awaiting processing.
- processing
The payout is being processed.
- paid
The payout has been marked paid. Use its ID to generate a payout report.
- failed
The payout failed. Check the destination before taking further action.
- canceled
The payout was canceled.
- pending
- amountType: integerFormat: int64required
Payout amount in the smallest currency unit, as indicated by
currency.scale. - currencyType:requiredProperties: 2
Currency of the amount, including its three-letter ISO code and number of decimal places.
- livemodeType: booleanrequired
Whether the payout belongs to live mode. Test mode payouts return
false. - methodType: stringenumrequired
Delivery method. Current payouts use
standard.values- standard
Standard payout delivery.
- instant
Reserved for instant delivery. Current payouts do not use it.
- standard
- typeenumconst:bank_accountrequired
Type of destination receiving the payout.
- reconciliationType: stringenum
_status requiredWhether the balance transactions associated with the payout have been linked. This is separate from the payout's delivery status.
values- unspecified
No reconciliation status is available.
- in
_progress The payout's balance transaction links are still being recorded.
- completed
The payout's balance transaction links are available.
- not
_applicable Balance transaction linking does not apply to this payout.
- unspecified
- balanceType: string | null
_transaction Related balance transaction ID. Omitted when unavailable.
- arrivalType: stringFormat: date
_date Calendar date the payout was expected to arrive, when known. This is an estimate, not confirmation of delivery.
- destination
Financial Destination ID or, with
expand[]=destination, the masked details recorded for this payout. Omitted when no destination ID is available.- Type: string
Financial Destination ID or, with
expand[]=destination, the masked details recorded for this payout. Omitted when no destination ID is available.

