Add a Payout Method
Add a payout method to the user. Payout method can be one of paypal
, venmo
, ach
, or cash_app
. Each method has different required parameters.
Authorizations
Basic authentication header of the form Basic <encoded-value>
, where <encoded-value>
is the base64-encoded string username:password
.
Path Parameters
Id of the user to fetch
Body
Payout platform to add.
paypal
, venmo
, cash_app
, ach
Bank account or Cash App routing number. Required if platform
= ach
or cash_app
.
Bank account or Cash App account number. Required if platform
= ach
or cash_app
.
Bank account type. Required if platform
= ach
.
checking
, savings
PayPal email address. Required if platform
= paypal
.
Venmo phone number. One of phone_number
or handle
is required if platform
= venmo
.
Venmo handle. One of phone_number
or handle
is required if platform
= venmo
.
Cash App Cash Tag. Required if platform
= cash_app
.
When true, the newly added payment method will be set as the user's default payout method.
When specified, enables or disables auto payout for this user.
Response
The type of account to add.
ach
, paypal
, venmo
, cash_app
, airtm
, payoneer
Handle for Venmo accounts.
Email for PayPal and Payoneer accounts.
Phone number for Venmo accounts.
Cash tag for Cash App accounts.
ACH account number.
ACH routing number.
ACH account type, either "checking" or "savings".
checking
, savings
Indicates if RTP is enabled for the payment method (applies to ach only).