v5

OpenAPI 3.1.0Proprietary2026-08-011476181.4 MB

Cards

List cards

Retrieve a paginated list of cards. Cards can be filtered by cardholder, bound funding-source internal account, state, and platform-specific card identifier. If no filters are provided, returns all cards visible to the caller.

get/cards

Query parameters

cardholderIdstring

Filter by cardholder (customer) id.

accountIdstring

Filter by internal account id. Returns cards whose fundingSources array contains the given internal account id.

platformCardIdstring

Filter by platform-specific card identifier.

state'PENDING_KYC' | 'PROCESSING' | 'ACTIVE' | 'FROZEN' | 'CLOSED'

Lifecycle state of a card.

State	Description
PENDING_KYC	The cardholder has not yet completed KYC. Cards in this state cannot transact.
PROCESSING	The card has been requested and is being provisioned with the issuer.
ACTIVE	The card is live and can authorize transactions.
FROZEN	The card is temporarily disabled by the platform. New authorizations are declined with CARD_PAUSED. Existing settlements and refunds continue to reconcile.
CLOSED	The card is permanently closed. Terminal, irreversible state.

Filter by card state.

limitinteger

Maximum number of results to return (default 20, max 100)

cursorstring

Cursor for pagination (returned from previous request)

sortOrder'asc' | 'desc'

Order to sort results in

Response

Successful operation

hasMoreboolean required

Indicates if more results are available beyond this page

nextCursorstring

Cursor to retrieve the next page of results (only present if hasMore is true)

totalCountinteger

Total number of cards matching the criteria (excluding pagination)

Example response

{
  "data": [
    {
      "id": "Card:019542f5-b3e7-1d02-0000-000000000010",
      "cardholderId": "Customer:019542f5-b3e7-1d02-0000-000000000001",
      "platformCardId": "card-emp-aary-001",
      "last4": "4242",
      "expMonth": 12,
      "expYear": 2029,
      "fundingSources": [
        "InternalAccount:019542f5-b3e7-1d02-0000-000000000002",
        "InternalAccount:019542f5-b3e7-1d02-0000-000000000003"
      ],
      "currency": "USD",
      "processorRef": "card_b81c2a4f",
      "issuerRef": "lead_card_7a1b9c3d",
      "createdAt": "2026-05-08T14:10:00Z",
      "updatedAt": "2026-05-08T14:11:00Z"
    }
  ]
}