Skip to main content
curl --request PUT \
  --url https://api.dots.dev/api/v2/users/{user_id}/payout-methods \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '{
  "platform": "ach",
  "routing_number": "123456789",
  "account_number": "123456789",
  "account_type": "checking"
}'
{
  "platform": "ach",
  "handle": "<string>",
  "email": "<string>",
  "phone_number": "<string>",
  "cash_tag": "<string>",
  "account_number": "<string>",
  "routing_number": "<string>",
  "account_type": "checking",
  "rtp_enabled": true,
  "meta": "<any>"
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
user_id
string<uuid>
required

Id of the user to fetch

Body

application/json
​
platform
enum<string>
required

Payout platform to add.

Available options:
paypal,
venmo,
cash_app,
ach
​
routing_number
string

Bank account or Cash App routing number. Required if platform = ach or cash_app.

​
account_number
string

Bank account or Cash App account number. Required if platform = ach or cash_app.

​
account_type
enum<string>

Bank account type. Required if platform = ach.

Available options:
checking,
savings
​
email
string

PayPal email address. Required if platform = paypal.

​
phone_number
string

Venmo phone number. One of phone_number or handle is required if platform = venmo.

​
handle
string

Venmo handle. One of phone_number or handle is required if platform = venmo.

​
cash_tag
string

Cash App Cash Tag. Required if platform = cash_app.

​
is_default
boolean | null

When true, the newly added payment method will be set as the user's default payout method.

​
auto_payout_enabled
boolean | null

When specified, enables or disables auto payout for this user.

​
metadata
any

Optional metadata to store with the payout method. Can be any valid JSON value (object, string, number, boolean, array, or null).

Response

200 - application/json

OK

​
platform
enum<string>
required

The type of account to add.

Available options:
ach,
paypal,
venmo,
cash_app,
airtm,
payoneer
​
handle
string

Handle for Venmo accounts.

​
email
string

Email for PayPal and Payoneer accounts.

​
phone_number
string

Phone number for Venmo accounts.

​
cash_tag
string

Cash tag for Cash App accounts.

​
account_number
string

ACH account number.

​
routing_number
string

ACH routing number.

​
account_type
enum<string>

ACH account type, either "checking" or "savings".

Available options:
checking,
savings
​
rtp_enabled
boolean

Indicates if RTP is enabled for the payment method (applies to ach only).

​
meta
any

Optional metadata stored with the payout method. Can be any valid JSON value (object, string, number, boolean, array, or null).