Cards

Update Card

Updates an agent card, such as one you created via the API. Freeze or unfreeze it with the status field, replace its spend limits with spending_controls, or change its merchant restriction with spending_restriction and its allowed merchant categories. All fields are optional; omitted fields are left unchanged. Read the current limits back from Get Card Limits.

patch/cards/{card_id}

Request

Path parameters

card_idstring uuid required

Card to act on. Use list_cards to find one.

Headers

x-entity-idstring uuid

Optional entity_id to scope requests to a specific entity.

Request body

status'active' | 'inactive'
nicknamestring nullable

Rename the card's display name (max 30 characters).

allowed_categoriesCardTransactionCategory[] nullable

Restrict the card to these merchant categories. Pass null to clear all category restrictions.

Response

Successful Response

idstring uuid required

Unique card identifier.

display_namestring required

Card name or nickname.

last_fourstring nullable required

Last 4 digits of the card number. Null until the issuer assigns the card number, so pending cards have no value.

status'pending' | 'active' | 'suspended' | 'closed' | 'failed' required
is_physicalboolean required

Whether this is a physical card.

is_single_useboolean

Whether this is a single-use card.

created_atstring date-time required

ISO 8601 date-time in the format YYYY-MM-DDThh:mm:ss.nnn[Z|[+|-]hh:mm] (per IETF RFC 3339).

expirationstring date-time

ISO 8601 date-time in the format YYYY-MM-DDThh:mm:ss.nnn[Z|[+|-]hh:mm] (per IETF RFC 3339).

allowed_categoriesCardTransactionCategory[] nullable

Merchant categories the card is restricted to. Null means every category is allowed.

Changes

No recorded changes to this operation across all 1 revision of this API.