Skip to main content
GET
/
unstable
/
payment-methods
List payment methods by user
curl --request GET \
  --url https://www.crossmint.com/api/unstable/payment-methods \
  --header 'X-API-KEY: <api-key>'
{
  "data": [
    {
      "paymentMethodId": "d4e5f6a7-b8c9-0123-def4-567890abcdef",
      "default": true,
      "displayName": "Visa ••1111",
      "type": "card",
      "card": {
        "brand": "visa",
        "last4": "1111",
        "expiration": {
          "month": "12",
          "year": "2028"
        },
        "billing": {
          "name": "Alice Smith",
          "phone": "+12125551234",
          "address": {
            "line1": "123 Main St",
            "city": "Springfield",
            "stateOrRegion": "IL",
            "postalCode": "62701",
            "country": "US"
          }
        },
        "fundingType": "debit",
        "bin": "411111",
        "country": "US"
      }
    },
    {
      "paymentMethodId": "dd8a59c6-aac0-47c2-9c21-686caf7f0359",
      "default": false,
      "displayName": "Chime ••6259",
      "type": "bank-account-us",
      "bankAccount": {
        "billing": {
          "name": "Alice Smith",
          "phone": "+12125551234",
          "address": {
            "line1": "123 Main St",
            "city": "New York",
            "stateOrRegion": "NY",
            "postalCode": "10001",
            "country": "US"
          }
        },
        "bankName": "Chime",
        "accountSuffix": "6259",
        "currency": "usd",
        "country": "US",
        "entityType": "individual",
        "bankAddress": {
          "line1": "123 Main St",
          "city": "New York",
          "stateOrRegion": "NY",
          "postalCode": "10001",
          "country": "US"
        },
        "routingNumber": "091300010",
        "accountType": "checking"
      }
    },
    {
      "paymentMethodId": "3323460b-d9d2-4ec6-b380-8a3e01e3f226",
      "default": false,
      "displayName": "SEPA Account ••6789",
      "type": "bank-account-sepa-iban",
      "bankAccount": {
        "billing": {
          "name": "Hans Müller",
          "phone": "+4915112345678",
          "address": {
            "line1": "Unter den Linden 1",
            "city": "Berlin",
            "stateOrRegion": "BE",
            "postalCode": "10117",
            "country": "DE"
          }
        },
        "bankName": null,
        "accountSuffix": "6789",
        "currency": "eur",
        "country": "DE",
        "entityType": "individual",
        "bic": "COBADEFFXXX"
      }
    }
  ],
  "nextCursor": "eyJsYXN0SWQiOiI2NDUifQ==",
  "previousCursor": null
}
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

Server-side API key from the Crossmint dashboard.

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:
card,
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 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:
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
object[]
required

Array of payment method objects for the current page.

A saved payment method. Sensitive fields (full PAN, CVC, full account numbers) are never included in responses.

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