Cards

Deactivate card

Permanently deactivate a card. The card's status changes to deactivated and cannot be reactivated. If the card has card tokens that aren't deactivated, set deactivate_card_tokens to true to deactivate them as well; otherwise the request is rejected.

patch/issuing/cards/{card_id}/deactivate

Request

Base URL: https://api.column.com
URL: https://api.column.com/issuing/cards/{card_id}/deactivate
Auth: HTTP basic

Path parameters

card_idstring required

Request body

deactivate_card_tokensboolean

When true, all card tokens in a non-terminal state are automatically deactivated before the card is deactivated. When false or omitted, the request is rejected if the card has tokens in a non-terminal state.

The reason for deactivating the card. Defaults to voluntary when omitted.

Example request

{
  "deactivation_reason": "voluntary"
}

Response

Successful response

authorized_user_entity_idstring required

The ID of the person entity authorized to use this card

binstring

The 6 or 8-digit BIN (Bank Identification Number) for the card

card_account_idstring required

The ID of the card account

card_authorization_policy_idstring

The ID of the card authorization policy

card_program_idstring required

The ID of the card program

card_template_idstring nullable

The ID of the card template the physical card was created with: the card_template_id from the create request, or the card program's default card template when none was given. Renewed and replaced cards keep the original card's template. This field is null for virtual cards.

created_atstring date-time required

The creation date of the card

deactivated_atstring date-time nullable

The timestamp when the card was deactivated

The reason this card was deactivated. Null until deactivation. When a card is replaced, this reason is recorded on the original card, not the new replacement card. Historical cards may return an inferred reason; generic legacy deactivations are reported as voluntary.

expiration_monthinteger required

The expiration month of the card (1-12)

expiration_yearinteger required

The expiration year of the card (4-digit year, e.g. 2025)

first_activated_atstring date-time nullable

The timestamp when the card was first activated

idstring required

The ID of the card

last_active_atstring date-time nullable

Timestamp when the card was last set to active status

last_four_digitsstring required

The last four digits of the card PAN

last_inactive_atstring date-time nullable

Timestamp when the card was last set to deactivated status

last_paused_atstring date-time nullable

Timestamp when the card was last set to paused status

original_card_idstring nullable

The ID of the card that this card replaced. Populated on the replacement card

platform_idstring required

The ID of the platform that owns this card

replacement_card_idstring nullable

The ID of the card that replaced this one. Populated on the original card after replacement

sequence_numberinteger required

The sequence number of the card. Starts at 1 for new cards and increments when a card is renewed (same PAN, new expiration). Resets to 1 when a card is replaced (new PAN)

status'active' | 'paused' | 'deactivated' required

The current status of the card. Possible values: active, paused, deactivated

typestring required

The form factor of the card. Possible values: virtual, physical.

Example response

{
  "bin": "41234567",
  "card_account_id": "cacc_2x8gszy5folpA9s0TOCseE9ABDM",
  "card_authorization_policy_id": "caup_2x8gszy5folpA9s0TOCseE9ABDM",
  "card_program_id": "cpgm_2x8gszy5folpA9s0TOCseE9ABDM",
  "card_template_id": "ctmp_2x8gszy5folpA9s0TOCseE9ABDM",
  "expiration_month": 12,
  "expiration_year": 2029,
  "id": "card_2x8gszy5folpA9s0TOCseE9ABDM",
  "last_four_digits": "1234",
  "manufacturing_details": {
    "shipping_details": {
      "name": "Oliver Hockey"
    }
  },
  "sequence_number": 1,
  "type": "physical"
}

Changes

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