Skip to main content
GET
List payment methods by user
Returns a paginated list of the bank account payout methods saved for a given user.

Returns

An object with a data array of PaymentMethod objects. Use the cursor parameter to paginate; when nextCursor is present, more pages are available.

Authorizations

X-API-KEY
string
header
required

Query Parameters

userLocator
string

Identifies the target user. Format: <type>:<value> (e.g., email:alice@example.com, userId:abc123). Required with server API key auth; ignored with JWT.

type
enum<string>

Filter by payment method type. Without this filter, all types are returned.

Available options:
bank-account-us,
bank-account-mx-clabe,
bank-account-co,
bank-account-sepa-iban
cursor
string

Opaque pagination cursor from a previous response. Pass to retrieve the next page.

limit
integer
default:30

Maximum number of results per page (1-100, default 30).

Required range: 1 <= x <= 100
sort
enum<string>

Sort by creation date: asc (oldest first) or desc (newest first, default).

Available options:
asc,
desc
hasPayout
enum<string>

Filter to payout methods that have (true) or have not (false) funded a settled offramp payout. Omit to return all payout methods regardless of payout history.

Available options:
true,
false

Response

Paginated list of PaymentMethod objects. nextCursor and previousCursor are included when additional pages exist in that direction.

Paginated list of payment methods.

data
Bank account · object[]
required

Array of payment method objects for the current page.

nextCursor
string | null

Cursor to fetch the next page. null when there are no more results.

previousCursor
string | null

Cursor to fetch the previous page. null on the first page.