List Payment Methods

List all saved payment methods for given entity (scoped down in JWT).

Request

curl -X GET \
  https://api.basistheory.ai/tenants/your-tenant-id/payment-methods \
  -H 'Authorization: Bearer your-api-key'

URL Parameters

ParameterRequiredTypeDefaultDescription
tenantIdtruestringnullThe tenant ID.

Response

[
  {
    "id": "26859380-7829-4ee1-8a0a-38927881e7ef",
    "type": "card",
    "entityId": "94c94330-94fd-4832-a106-e8474a274fe4",
    "card": {
      "type": "credit",
      "brand": "mastercard",
      "details": {
        "bin": "512035",
        "last4": "4594",
        "expirationMonth": "12",
        "expirationYear": "2025"
      },
      "display": {
        "artUrl": "https://sbx.assets.mastercard.com/card-art/combined-image-asset/6713d73d-a701-4bd2-bc9b-2e98940de9c7.png",
        "backgroundColor": "1A1F71",
        "foregroundColor": "000000",
        "description": "MasterCard Test Bank",
        "issuerName": "Test Issuer"
      }
    },
    "credentialTypes": ["network-token", "virtual-card", "pan"],
    "createdAt": "2025-06-16T14:00:00Z"
  },
  {
    "id": "26859380-7829-4ee1-8a0a-38927881e7ef",
    "type": "card", 
    "entityId": "94c94330-94fd-4832-a106-e8474a274fe4",
    "card": {
      "type": "credit",
      "brand": "visa",
      "details": {
        "bin": "424242",
        "last4": "4242",
        "expirationMonth": "12",
        "expirationYear": "2025"
      },
      "display": {
        "artUrl": "https://sandbox.api.visa.com/image.png",
        "backgroundColor": "1A1F71",
        "foregroundColor": "000000",
        "description": "Visa Test Bank",
        "issuerName": "Test Issuer"
      }
    },
    "credentialTypes": ["network-token", "virtual-card", "pan"],
    "createdAt": "2025-06-16T14:00:00Z"
  }
]

Response Properties

Array of payment method objects:

PropertyTypeDescription
idstringThe payment method ID.
typestringThe payment method type.
entityIdstringThe ID for the entity that owns the payment method.
cardCard ObjectSpecific details for "card" payment method type.
credentialTypesstring[]Array of available credential types that can be created.
createdAtdatetimeThe payment method created date.

Card Object

PropertyTypeDescription
typestringThe card type: debit or credit.
brandstringThe card brand (i.e. visa, mastercard).
detailsCard Details ObjectDetails about the card.
displayCard Display ObjectUI details for displaying the card.

Card Details Object

PropertyTypeDescription
binstring6 digit card BIN number.
last4stringCard last 4 numbers.
expirationMonthstringCard expiration month in MM format.
expirationYearstringCard expiration year in YYYY format.

Card Display Object

PropertyTypeDescription
artUrlstringA URL for the card art (if available).
backgroundColorstringThe background color for rendering the card UI.
foregroundColorstringThe foreground color for rendering the card UI.
descriptionstringShort card description.
issuerNamestringThe card issuer’s name.

Filtering and Pagination

Query Parameters

ParameterRequiredTypeDefaultDescription
limitfalsenumber50Maximum number of payment methods to return.
offsetfalsenumber0Number of payment methods to skip.
typefalsestringnullFilter by payment method type (e.g., card).

Example with Pagination

curl -X GET \
  'https://api.basistheory.ai/tenants/your-tenant-id/payment-methods?limit=10&offset=20' \
  -H 'Authorization: Bearer your-api-key'

Error Handling

{
  "error": {
    "status": 401,
    "type": "unauthorized",
    "title": "Unauthorized",
    "message": "Missing or invalid API key was provided."
  }
}