Add 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.

PUT /v2/users/{user_id}/payout-methods

cURL

Bank Account

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"
}
'

200

{
  "platform": "ach",
  "id": "<string>",
  "description": "<string>",
  "mask": "<string>",
  "email": "<string>",
  "phone_number": "<string>",
  "cash_tag": "<string>",
  "country": "<string>",
  "currency": "<string>"
}

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.

Response

200 - application/json

OK

The payout method.

platform · enum<string> · required

Available options: ach, paypal, venmo, cash_app, intl_transfer

id · string

ID of the payment-method.

description · string

mask · string

email · string

phone_number · string

cash_tag · string

country · string<iso3166>

currency · string<iso4217>