Skip to main content
GET
List Cards
Cards are scoped by merchant_id (derived from your secret key) and the customer_id query parameter. Only non-sensitive card metadata is returned — full PANs (the real card numbers) are never exposed.

Notes

  • Use status=all to include previously deleted cards for historical reference.
  • The card_id returned here is the same as the enrollmentId from the SDK’s collectPAN().

Error responses

Authorizations

Authorization
string
header
required

Your secret key: sk_test_* (sandbox) or sk_live_* (production).

Query Parameters

customer_id
string
required

The customer ID to retrieve cards for (the user_id used when creating the session)

status
enum<string>
default:active

Filter by card status

Available options:
active,
all
include_card_art
enum<string>
default:false

Include card art URL in response

Available options:
true,
false

Response

Cards retrieved

cards
object[]
count
number

Total number of cards returned