Cards

Renew card

Renew a card to extend its expiration date while keeping the same PAN. The card's sequence_number is incremented. Only active or paused cards can be renewed. A card can't be renewed while another card with the same PAN, such as an earlier renewal, isn't deactivated, or if any card with the same PAN was deactivated as lost, stolen, or fraud.

patch/issuing/cards/{card_id}/renew

Request

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

Path parameters

card_idstring required

Headers

Idempotency-Keystring

Idempotency keys can be up to 255 characters long and are case sensitive. Column reserves the right to expire idempotency keys after 30 days. Only ASCII printable characters (code 32 - 126) are allowed for idempotency keys.

Request body

encrypted_pinstring

Debit card programs only. Omit to keep the original card's PIN on the renewed card. Pass a base64-encoded encrypted PIN to set a new PIN, or SKIP to create the renewed card without a PIN and set one later with PATCH /issuing/cards/{card_id}/pin.

expiration_monthinteger

Optional new expiration month (1-12)

expiration_yearinteger

Optional new expiration year (4-digit year, e.g. 2025)

statusstring

Optional status for the renewed card

Example request

{
  "expiration_month": 12,
  "expiration_year": 2029,
  "status": "active"
}

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

deactivation_reason'lost' | 'stolen' | 'fraud' | 'expired' | 'voluntary' | 'renewed' | 'account_closed' | 'damaged' | 'null' nullable

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.