Update Card
Update, freeze, or cancel a card. Updating the card’s name, billing address, or limits requires both payout:account:update and company:balance:read; a card’s assigned holder may update their own card’s pin and frozen state with any user token.
Authorizations
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
Pins the request to a dated API version.
"2026-09-15"
Path Parameters
Card ID to retrieve, prefixed icrd_.
Body
The owning account ID (a biz_ identifier). Provide this or user_id.
"biz_xxxxxxxxxxxxxx"
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.
Pass true to permanently cancel the card. A canceled card cannot be uncanceled. Cannot be combined with other fields.
true
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.
Pass true to freeze the card, false to unfreeze it. The assigned cardholder may freeze their own card without the payout:account:update scope.
true
A display name for the card.
"Detailing supplies"
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.
"1234"
Pass true to remove the spending limit (make the card unlimited).
true
Spending limit amount, in dollars.
2500
The window the spend limit applies to.
daily, weekly, monthly, one_time "monthly"
Per-transaction limit amount, in dollars.
500
The owning user ID (a user_ identifier). Provide this or account_id.
"user_xxxxxxxxxxxxxx"
Response
invited card onboarding completed: card provisioning started
The billing address.
When the card was canceled.
"2026-01-01T12:00:00.000Z"
When the card was created.
"2026-01-01T12:00:00.000Z"
Card expiration month.
"12"
Card expiration year.
"2027"
Card ID, prefixed icrd_.
"icrd_xxxxxxxxxxxxxx"
Last four digits of the card number. null for pending invitation cards.
"4242"
The spending limit configuration.
Card display name.
"Detailing supplies"
card "card"
Total spend in the last 30 days, in cents.
1234
The card status. denied means the issuer declined the cardholder, so the card will never be issued.
null, active, frozen, canceled, invited, denied "active"
The card type.
null, virtual, physical "virtual"
Cardholder user ID, prefixed user_, when assigned.
"user_xxxxxxxxxxxxxx"
Sensitive card details. Present only on GET /cards/:id for active cards; null when the card is inactive or details cannot be retrieved.

