Skip to main content
GET
Retrieve a customer’s enrolled cards. Only non-sensitive card metadata is returned — full PANs (the real card numbers) are never exposed. GET /v1/listCards · Authenticated with your secret key.
Cards are scoped by merchant_id (derived from your secret key) and the customer_id query parameter.

Query parameters

string
required
The customer to list cards for — the same value you passed as user_id when creating the session.
string
default:"active"
active (default) or all (include previously deleted cards for historical reference).
string
default:"false"
true to include card_art_url and display metadata; otherwise those fields are null.

Response

object[]
number
Number of cards returned.

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