Skip to main content
POST
TypeScript

Autorisaties

Authorization
string
header
vereist

An Account API key, an App API key, an account access token, an account-scoped user 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:update

Headers

Idempotency-Key
string

A unique key that makes this request safe to retry. See Idempotent requests.

Maximum string length: 255
Voorbeeld:

"d9105228-4a08-46b1-8b91-42fed586d383"

Api-Version-Date
string

Pins the request to a dated API version.

Voorbeeld:

"2026-11-17"

Body

application/json
account_id
string

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

Voorbeeld:

"biz_xxxxxxxxxxxxxx"

assigned_user_id
string

The account member (a user_ identifier) to assign the card to. Required for business card issuing accounts. When this call files the card application, the member applies with their identity. An account API key that sends neither this nor kind is refused.

Voorbeeld:

"user_xxxxxxxxxxxxxx"

billing
object

The card's initial billing address. On a business card it also registers the assigned member as a cardholder if they are not one yet. For an individual card, region is also required.

cardholder
object

Details for a business card's assigned member when they are not registered as a cardholder yet. Send with billing to register them and start provisioning in one call instead of sending them an onboarding invitation. The legal name comes from the member's approved identity verification when they have one, and from these fields when they do not.

kind
enum<string>

Who the card application verifies, set only on the call that files it; sending it while the account's application is in progress or approved is a 400. business applies as the account with its approved KYB. individual applies as a person: assigned_user_id when given, otherwise the account owner, using the identity verified on the account. Omit it to apply as the business when its KYB is approved, and as an individual otherwise.

Beschikbare opties:
individual,
business
Voorbeeld:

"individual"

name
string

A display name for the card.

Voorbeeld:

"Detailer card"

spend_limit
number

Spending limit amount, in dollars.

Voorbeeld:

500

spend_limit_frequency
enum<string>

The window the spend limit applies to.

Beschikbare opties:
daily,
weekly,
monthly,
one_time
Voorbeeld:

"weekly"

transaction_limit
number

Per-transaction limit amount, in dollars.

Voorbeeld:

200

user_id
string

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

Voorbeeld:

"user_xxxxxxxxxxxxxx"

Respons

card created

billing
object | null
vereist

The billing address.

canceled_at
string<date-time> | null
vereist

When the card was canceled.

Voorbeeld:

null

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:

"2030"

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:

"Detailing supplies"

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:

0

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.