API ReferencePayouts

Fetch Payout

Fetch a payout

Required OAuth 2.0 scope: business/payouts:read

Path parameters

payout_idstringRequired>=1 character<=100 characters
The unique identifier of the payout.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Response

Successful Response
capital_repayment_amountobject
The amount deducted and paid back towards a cash advance.
created_atstringformat: "date-time"
The payout creation date and time in ISO 8601 format.
fee_amountobject
The fee associated with this payout.
gross_amountobject
The gross amount of the payout.
idstring
The unique identifier of the payout.
net_amountobject

The net proceeds of this payout after any fees & deductions.

payout_feeslist of objects
A list of fees associated with the payout.
payout_typeenum
The type of payout.
Allowed values:
statusenum
The current state of the payout.
Allowed values:
updated_atstring or nullformat: "date-time"
The date and time the payout was last modified in ISO 8601 format.

Errors