Payouts
Create a payout
Authorizations
Authorization
string
headerrequiredBasic authentication header of the form Basic <encoded-value>
, where <encoded-value>
is the base64-encoded string username:password
.
Body
application/json
user_id
string
requiredamount
number
requiredpayout_method
enum<string>
requiredAvailable options:
paypal
, venmo
, ach
, cash_app
, intl_transfer
, default
ach_account_id
string
Account id from /users/get if payout_method is ach
intl_account_id
string
Account id from /users/get{user_id}/intl_bank_accounts if payout_method is intl_transfer
fund
boolean
Pays the payout amount to the user before creating the payout. The funds are returned if the payout does not succeed.
Response
200 - application/json
success
boolean
error_code
integer
Error code if success is false