Skip to main content
GET
/
unstable
/
payment-methods
List Payment Methods
curl --request GET \
  --url https://staging.crossmint.com/api/unstable/payment-methods \
  --header 'X-API-KEY: <x-api-key>'
{
  "data": [
    {
      "type": "card",
      "paymentMethodId": "pm_8d6a4b1f-9c8a-4cba-b2c1-3a5b8c0d6f12",
      "default": true,
      "display": {
        "imageUrl": "https://example.com/card-art.png"
      },
      "card": {
        "source": {
          "type": "basis-theory-token",
          "id": "01GZ1S0F2K3M4N5P6Q7R8S9T0V"
        },
        "brand": "visa",
        "last4": "4242",
        "expiration": {
          "month": "12",
          "year": "2030"
        },
        "billing": {
          "name": "Jane Doe"
        },
        "fundingType": "credit",
        "bin": "424242"
      }
    }
  ],
  "nextCursor": "eyJkaXJlY3Rpb24iOiJmb3J3YXJkIiwic29ydE9yZGVyIjoiZGVzYyIsInZlcnNpb24iOjEsImRhdGEiOnsiaWQiOiJwbV84ZDZhNGIxZi05YzhhLTRjYmEtYjJjMS0zYTViOGMwZDZmMTIifX0"
}

Documentation Index

Fetch the complete documentation index at: https://docs.crossmint.com/llms.txt

Use this file to discover all available pages before exploring further.

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.

Headers

​
X-API-KEY
string
required

API key required for authentication

Query Parameters

​
userLocator
string

Identifies the target user when authenticating with a server API key. Format: <type>:<value> (e.g., email:alice@example.com, userId:abc123, phoneNumber:+12125551234, twitter:alice). Required for API-key authentication; ignored when authenticating with a JWT (the JWT subject is used).

​
type
enum<string>

Filter by payment method type.

Available options:
card,
bank-account-us,
bank-account-mx,
bank-account-ar,
bank-account-br,
pix
​
cursor
string

Opaque cursor from a previous response's nextCursor or previousCursor. Omit on the first request.

​
limit
integer
default:30

Maximum number of items to return per page. Must be between 1 and 100.

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

Sort order by creation date. Defaults to desc (newest first). Once a page has been requested with a given sort, follow-up requests using the returned cursor preserve that order.

Available options:
asc,
desc

Response

200 - application/json

Returns a paginated list of payment methods

​
data
object[]
required

Page of payment methods in the requested sort order.

​
nextCursor
string

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

​
previousCursor
string

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