Skip to main content
GET
Retrieve Card

Authorizations

Authorization
string
header
required

An Account API key, account-scoped JWT, App API key, or user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************.

Headers

Api-Version-Date
string

Pins the request to a dated API version.

Example:

"2026-08-13"

Path Parameters

id
string
required

Card ID to retrieve, prefixed icrd_.

Query Parameters

account_id
string

The owning account ID (a biz_ identifier). Provide this or user_id.

user_id
string

The owning user ID (a user_ identifier). Provide this or account_id.

Response

card retrieved with its PIN by the assigned cardholder

billing
object | null
required

The billing address.

canceled_at
string<date-time> | null
required

When the card was canceled.

Example:

"2026-01-01T12:00:00.000Z"

created_at
string<date-time> | null
required

When the card was created.

Example:

"2026-01-01T12:00:00.000Z"

expiration_month
string | null
required

Card expiration month.

Example:

"12"

expiration_year
string | null
required

Card expiration year.

Example:

"2027"

id
string
required

Card ID, prefixed icrd_.

Example:

"icrd_xxxxxxxxxxxxxx"

last4
string | null
required

Last four digits of the card number. null for pending invitation cards.

Example:

"4242"

limit
object | null
required

The spending limit configuration.

name
string | null
required

Card display name.

Example:

"Bay rent card"

object
enum<string>
required
Available options:
card
Example:

"card"

spent_last_month
integer | null
required

Total spend in the last 30 days, in cents.

Example:

1234

status
enum<string> | null
required

The card status. denied means the issuer declined the cardholder, so the card will never be issued.

Available options:
null,
active,
frozen,
canceled,
invited,
denied
Example:

"active"

type
enum<string> | null
required

The card type.

Available options:
null,
virtual,
physical
Example:

"virtual"

user_id
string | null
required

Cardholder user ID, prefixed user_, when assigned.

Example:

"user_xxxxxxxxxxxxxx"

secrets
object | null

Sensitive card details. Present only on GET /cards/:id for active cards; null when the card is inactive or details cannot be retrieved.