Sign in

v1

latestOpenAPI 3.0.12026-07-26106359429.8 KB
Compliance

Deactivate a card

Beta: This endpoint is in beta and may change before general availability.

Transitions a card from active or closed to inactive status.

Idempotency

The Idempotency-Key header is required.

post/v0/cards/{id}/deactivate

Path parameters

idstring required

The server-generated ID of the Card object.

Example:card_xyz123

The server-generated Card ID.

Headers

Idempotency-Keystring required

Unique key to ensure idempotent requests

Request body

status_reason'dormant' | 'frozen' | 'other' required

Valid reasons for deactivating a card.

Response

Card deactivated successfully.

idstring

The server-generated ID of the Card object.

client_card_idstring

Client-provided identifier for the card. Optional: present only for cards created via file upload, and omitted for cards created through the API, which are identified solely by their server-generated ID.

account_idstring

The ID of the Account object.

entity_idstring

The ID of your entity.

status'active' | 'inactive' | 'closed'

Status is system-managed and cannot be set on create; status changes go through the status-transition endpoints.

status_reasonstring

The reason for the card's current status. Empty when the card is active; otherwise populated. Set via the status-transition endpoints.

created_atstring date-time

Creation timestamp.

updated_atstring date-time

Last update timestamp.

metadataMetadata

A set of key-value pairs that can be used to store additional information related to this object.

Example response

{
  "id": "card_xyz123",
  "account_id": "account_xyz123",
  "entity_id": "entity_xyz123",
  "details": {
    "last_four": "1234",
    "replacement_for": "card_xyz123"
  }
}