Skip to main content
PATCH
TypeScript

Autorisationer

Authorization
string
header
påkrævet

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

Overskrifter

Api-Version-Date
string

Pins the request to a dated API version.

Eksempel:

"2026-11-17"

Sti-parametre

id
string
påkrævet

Card ID to retrieve, prefixed icrd_.

Krop

application/json
account_id
string

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

Eksempel:

"biz_xxxxxxxxxxxxxx"

billing
object

The billing address. On an issued card this replaces the card's billing address and region is also required. On an invited card, sending it as the invited user completes onboarding and starts card provisioning.

canceled
boolean

Pass true to permanently cancel the card. A canceled card cannot be uncanceled. Cannot be combined with other fields.

Eksempel:

true

cardholder
object

Details for the invited cardholder, accepted only while completing onboarding on an invited card. The legal name comes from an approved identity verification when the invited user has one, and from these fields when they do not.

frozen
boolean

Pass true to freeze the card, false to unfreeze it. The assigned cardholder may freeze their own card without the payout:account:update scope.

Eksempel:

true

name
string

A display name for the card.

Eksempel:

"Detailing supplies"

pin
string

New 4-digit PIN. Can only be set on a card assigned to the acting user, who may set it without the payout:account:update scope.

Eksempel:

"1234"

remove_limit
boolean

Pass true to remove the spending limit (make the card unlimited).

Eksempel:

true

spend_limit
number

Spending limit amount, in dollars.

Eksempel:

2500

spend_limit_frequency
enum<string>

The window the spend limit applies to.

Tilgængelige muligheder:
daily,
weekly,
monthly,
one_time
Eksempel:

"monthly"

transaction_limit
number

Per-transaction limit amount, in dollars.

Eksempel:

500

user_id
string

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

Eksempel:

"user_xxxxxxxxxxxxxx"

Svar

invited card onboarding completed: card provisioning started

billing
object | null
påkrævet

The billing address.

canceled_at
string<date-time> | null
påkrævet

When the card was canceled.

Eksempel:

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

created_at
string<date-time> | null
påkrævet

When the card was created.

Eksempel:

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

digital_wallets
enum<string>[] | null
påkrævet

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.

Tilgængelige muligheder:
apple_pay,
google_pay
expiration_month
string | null
påkrævet

Card expiration month.

Eksempel:

"12"

expiration_year
string | null
påkrævet

Card expiration year.

Eksempel:

"2027"

id
string
påkrævet

Card ID, prefixed icrd_.

Eksempel:

"icrd_xxxxxxxxxxxxxx"

issued
boolean
påkrævet

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.

Eksempel:

true

last4
string | null
påkrævet

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

Eksempel:

"4242"

limit
object | null
påkrævet

The spending limit configuration.

name
string | null
påkrævet

Card display name.

Eksempel:

"Detailing supplies"

object
enum<string>
påkrævet
Tilgængelige muligheder:
card
Eksempel:

"card"

spent_last_month
integer | null
påkrævet

Total spend in the last 30 days, in cents.

Eksempel:

1234

status
enum<string> | null
påkrævet

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

Tilgængelige muligheder:
null,
active,
frozen,
canceled,
invited,
denied
Eksempel:

"active"

type
enum<string> | null
påkrævet

The card type.

Tilgængelige muligheder:
null,
virtual,
physical
Eksempel:

"virtual"

user_id
string | null
påkrævet

Cardholder user ID, prefixed user_, when assigned.

Eksempel:

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