Skip to main content
GET
/
v2
/
users
/
{user_id}
/
payout-methods
List Payout Methods
curl --request GET \
  --url https://api.dots.dev/api/v2/users/{user_id}/payout-methods \
  --header 'Authorization: Basic <encoded-value>'
[
  {
    "id": "<string>",
    "platform": "ach",
    "description": "<string>",
    "mask": "<string>",
    "email": "<string>",
    "phone_number": "<string>",
    "cash_tag": "<string>",
    "country": "<string>",
    "currency": "<string>",
    "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

Response

200 - application/json

OK

Array of payout methods registered to the user.

​
platform
enum<string>
required
Available options:
ach,
paypal,
venmo,
cash_app,
intl_transfer,
airtm,
payoneer
​
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>
​
rtp_enabled
boolean

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

​
meta
any

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