Skip to main content
GET
List Payment Methods
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.

Headers

X-API-KEY
string
required

API key required for authentication

Query Parameters

cursor
string
limit
string
sort
enum<string>
Available options:
asc,
desc
type
enum<string>
Available options:
bank-account-br,
bank-account-co,
bank-account-mx-clabe,
bank-account-sepa-iban,
bank-account-us,
bre-b,
card,
pix
status
enum<string>

Set to 'deleted' to list the deleted bank accounts, which the unfiltered list omits. Cards carry no status and are never returned when this is set.

Available options:
deleted
hasPayout
enum<string>

Filter to payment methods that have (true) or have not (false) funded a settled offramp payout. When set to false, cards are included in results. Omit to return all payment methods regardless of payout history.

Available options:
false,
true

Response

Returns the list of payment methods