Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json
​
amount
integer
required

Amount in cents to payout the user.

Required range: x > 0
​
platform
enum<string>
required

Platform that you are paying out the user through,

Available options:
paypal,
venmo,
ach,
bank_transfer,
cash_app,
default
​
user_id
string
required

ID of the user who you are creating the payout for.

​
account_id
string

The bank account ID you are paying to. Required for ach and intl_bank.

​
fund
boolean

Creates a transfer for the amount to the user before creating the payout. The funds are returned to the App Wallet if the payout does not succeed. Please ensure that you are handling transfer failure webhooks when using this option.

​
idempotency_key
string

UUID that will be used to idempotently handle requests. Transfers with existing idempotency keys will be rejected.

​
metadata

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.

​
tax_exempt
boolean

Payouts marked as tax_exempt will not be counted towards the 1099 threshold. Can be true only if fund is true.

Response

201 - application/json

The transfer object.

​
amount
number
​
created
string
​
external_data
object
​
id
string
​
metadata

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.

​
payout_link_id
string

ID of the payout-link that the transfer belongs to.

​
status
enum<string>
Available options:
created,
pending,
failed,
completed,
reversed,
canceled,
flagged
​
transactions
object[]
​
type
enum<string>
Available options:
refill,
payout,
balance
​
user_id
string