Skip to main content
GET
Retrieve a card

Authorizations

Authorization
string
header
required

Secret API key, e.g. sk_live_... or sk_test_....

Path Parameters

card_id
string
required

Response

OK.

A virtual or physical payment card. Full card number and CVC are never returned by this API.

id
string
required
read-only

Unique identifier, prefixed with card_.

Example:

"card_01JZ8N2K4M"

object
enum<string>
required
read-only

Object type.

Available options:
card
customer_id
string
required
Example:

"cus_01JZ8M4X7K"

program_id
string
required
Example:

"prog_01JZ8A2K4M"

type
enum<string>
required
Available options:
virtual,
physical
status
enum<string>
required

pending until the card is ready for use. terminated is final.

Available options:
pending,
active,
frozen,
terminated
currency
string
required

Three-letter ISO 4217 currency code.

Pattern: ^[A-Z]{3}$
Example:

"EUR"

created_at
string<date-time>
required
read-only

Time the card was created.

cardholder
object
brand
enum<string>
read-only
Available options:
visa,
mastercard
last4
string
read-only
Pattern: ^[0-9]{4}$
Example:

"4821"

expiry
object
read-only
spending_controls
object

Card-level spending limits. Omitted or null limits are not enforced.

replaced_card_id
string | null
read-only

ID of the card this card replaced, if any.

metadata
object

Up to 50 key-value pairs for your own reference. Values are strings up to 500 characters.

Example:
updated_at
string<date-time>
read-only

Time the card was last updated.