Create a Payout
Create a payout for an existing user that has a payout method saved to their account.
Authorizations
Basic authentication header of the form Basic <encoded-value>
, where <encoded-value>
is the base64-encoded string username:password
.
Body
ID of the user
who you are creating the payout for.
Amount in cents to payout the user.
Platform that you are paying out the user
through,
paypal
, venmo
, ach
, bank_transfer
, cash_app
, default
The bank account ID you are paying to. Required for ach
and intl_bank
.
Creates a transfer for the amount to the user before creating the payout. The funds are returned if the payout does not succeed.
Payouts marked as tax_exempt
will not be counted towards the 1099 threshold. Can be true
only if fund
is true
.
UUID that will be used to idempotently handle requests. Transfers with existing idempotency keys will be rejected.
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
Response
created
, pending
, failed
, completed
, reversed
, canceled
, flagged
refill
, payout
, balance
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.