Skip to main content
GET
TypeScript

Autorisaties

Authorization
string
header
vereist

An Account API key, an App API key, an account access token, or a user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************. See Auth & API keys for how to get each one.

Scopes

payout:account:read

Headers

Api-Version-Date
string

Pins the request to a dated API version.

Voorbeeld:

"2026-11-17"

Padparameters

id
string
vereist

Card ID to retrieve, prefixed icrd_.

Queryparameters

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.

Respons

card retrieved with its PIN by the assigned cardholder

billing
object | null
vereist

The billing address.

canceled_at
string<date-time> | null
vereist

When the card was canceled.

Voorbeeld:

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

created_at
string<date-time> | null
vereist

When the card was created.

Voorbeeld:

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

digital_wallets
enum<string>[] | null
vereist

The digital wallets the card has been added to. List Cards, Update Card, and webhook payloads return null, as does Retrieve Card when the wallets cannot be retrieved.

Beschikbare opties:
apple_pay,
google_pay
expiration_month
string | null
vereist

Card expiration month.

Voorbeeld:

"12"

expiration_year
string | null
vereist

Card expiration year.

Voorbeeld:

"2027"

id
string
vereist

Card ID, prefixed icrd_.

Voorbeeld:

"icrd_xxxxxxxxxxxxxx"

issued
boolean
vereist

true once the issuer has issued the card. false for an invited card still waiting on its cardholder's onboarding or review, or one the issuer declined; it has no card number until it is issued.

Voorbeeld:

true

last4
string | null
vereist

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

Voorbeeld:

"4242"

limit
object | null
vereist

The spending limit configuration.

name
string | null
vereist

Card display name.

Voorbeeld:

"Bay rent card"

object
enum<string>
vereist
Beschikbare opties:
card
Voorbeeld:

"card"

spent_last_month
integer | null
vereist

Total spend in the last 30 days, in cents.

Voorbeeld:

1234

status
enum<string> | null
vereist

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

Beschikbare opties:
null,
active,
frozen,
canceled,
invited,
denied
Voorbeeld:

"active"

type
enum<string> | null
vereist

The card type.

Beschikbare opties:
null,
virtual,
physical
Voorbeeld:

"virtual"

user_id
string | null
vereist

Cardholder user ID, prefixed user_, when assigned.

Voorbeeld:

"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.