POST
/
api
/
payouts
/
create
Authorization
Body
{
  "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
  "amount": 0,
  "payout_method": "paypal",
  "ach_account_id": "string",
  "intl_account_id": "string",
  "fund": true
}
{
  "success": true,
  "error_code": 0
}

Authorizations

Authorizationheaderrequired
string

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

Body

application/json
ach_account_id
string

Account id from /users/get if payout_method is ach

amountrequired
number
fund
boolean

Pays the payout amount to the user before creating the payout. The funds are returned if the payout does not succeed.

intl_account_id
string

Account id from /users/get{user_id}/intl_bank_accounts if payout_method is intl_transfer

payout_methodrequired
enum<string>
Available options:
paypal,
venmo,
ach,
cash_app,
intl_transfer,
default
user_idrequired
string

Response

200 - application/json
error_code
integer

Error code if success is false

success
boolean