Skip to main content
GET
List Payment Methods
This endpoint requires a JWT from an external auth provider (Auth0, Firebase, Stytch, etc.) or a custom JWT backed by a JWKS endpoint. Crossmint Auth is not supported.

Authorizations

X-API-KEY
string
header
required

API key required for authentication

Authorization
string
header
required

The end user's JWT, sent as Authorization: Bearer <JWT> together with a client-side API key. Validated against the project's external JWT configuration.

Query Parameters

cursor
string

Opaque cursor from a previous response (nextCursor or previousCursor). Omit it on the first request.

limit
string

Maximum number of results per page. Minimum 1, maximum 100. Default 30.

sort
enum<string>

Sort direction by creation date. desc returns the newest first (default). asc returns the oldest first.

Available options:
asc,
desc
type
enum<string>

Filter by payment method type. Omit to return all types.

Available options:
bank-account-br,
bank-account-co,
bank-account-mx-clabe,
bank-account-ph,
bank-account-sepa-iban,
bank-account-us,
bre-b,
card,
pix
status
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.

Allowed value: "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

Paginated list of payment methods. nextCursor and previousCursor are present when more pages exist in that direction.

data
(MX CLABE · object | US bank account · object | CO bank account · object | SEPA IBAN · object | PH bank account · object | CO Bre-B key · object | Card · object)[]
required

Array of payment method objects for the current page.

A saved payment method. Sensitive fields (full PAN, CVC, full account numbers, IBANs, Bre-B keys) are never included.

Example:
nextCursor
string | null

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

previousCursor
string | null

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