---
title: "Renew a card"
method: POST
path: "/issuing/cards/{cardId}/renew"
tags: ["Cards"]
---

# Renew a card

`POST /issuing/cards/{cardId}/renew`

## Request

- Base URL: `https://{prefix}.api.sandbox.checkout.com`
- URL: `https://{prefix}.api.sandbox.checkout.com/issuing/cards/{cardId}/renew`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `string` scopes: `issuing:card-management-write`
- TypeScript: <https://skmtc.dev/checkout/apis/checkout-com-api-reference/docs/issuing/cards/:cardId/renew/post.ts> (a function with typed inputs; its response is checked against the schema)

Renew an `active`, `inactive`, or `suspended` card. A card cannot be renewed if it is `revoked`, `expired`, or is a single use virtual card. 

The renewed card will have a different, nonconsecutive number (PAN), expiry date, and CVV. 

Any configuration set on the parent card will be copied to the renewed card when the renewed card is activated. This includes 3DS enrollment, card controls, control profiles, and tokenisation.

## Path parameters

- `cardId` string, required: The card's unique identifier.

## Request body

- union
  - PhysicalCard
    - `display_name` string: The name to display on the card.
    - `shipping_instructions` IssuingShippingInstruction
      - `shipping_address` IssuingAddress, required
        - `address_line1` string, required: The first line of the address.
        - `address_line2` string: The second line of the address.
        - `city` string, required: The address city.
        - `state` string: The address state.
        - `zip` string, required: The address zip code, or postal code.
        - `country` string, required: The address country, as an <a href="https://www.checkout.com/docs/resources/codes/country-codes" target="blank">ISO country code</a>.
      - `shipping_recipient` string: The name of the person the card will be shipped to.
      - `additional_comment` string: Any additional comment on shipping.
    - `reference` string: Your reference.
    - `metadata` IssuingCardMetadata: User's metadata.
      - `udf1` string: User defined field 1
      - `udf2` string: User defined field 2
      - `udf3` string: User defined field 3
      - `udf4` string: User defined field 4
      - `udf5` string: User defined field 5
  - VirtualCard
    - `display_name` string: The name to display on the card.
    - `reference` string: Your reference.
    - `metadata` IssuingCardMetadata: User's metadata.
      - `udf1` string: User defined field 1
      - `udf2` string: User defined field 2
      - `udf3` string: User defined field 3
      - `udf4` string: User defined field 4
      - `udf5` string: User defined field 5

## Response `200`

Card renewed successfully

- RenewCardResponse
  - `parent_card_id` string: The card's unique identifier.
  - `cardholder_id` string: The cardholder's unique identifier.
  - `status` 'active' | 'inactive' | 'revoked' | 'suspended': The card's status, which determines whether it can approve incoming authorizations: - `inactive`: the default state - authorizations will be declined until the card is activated - `active`: authorization requests can be approved - `suspended`: incoming authorization requests will be declined - the card can be reactivated to accept new authorizations - `revoked`: incoming authorization requests will be permanently declined - the card cannot be reactivated from this state
  - `type` string: The card type.
  - `id` string: The card's unique identifier.
  - `client_id` string: The client's unique identifier.
  - `entity_id` string: The entity's unique identifier.
  - `last_four` string: The last four digits of the card number, also known as the PAN.
  - `expiry_year` integer: The card's expiration year.
  - `expiry_month` integer: The card's expiration month.
  - `display_name` string: The name to display on the card.
  - `reference` string: Your reference.
  - `created_date` string, UTC
  - `billing_currency` string, ISO4217: The issuing currency, as a three-letter <a href="https://docs.checkout.com/docs/currency-codes" target="blank">ISO currency code</a>.
  - `issuing_country` string: The issuing country, as a two-letter <a href="https://www.checkout.com/docs/resources/codes/country-codes" target="blank" >ISO country code</a>.
  - `_links` RenewedCardLinks: The links related to the card.
    - `self` IssuingLink, required
      - `href` string, required: The link URL.
      - `actions` string[], required: The HTTP Methods that can be performed on the link.
      - `types` string[], required: The Content Types for the link to the resource
    - `credentials` IssuingLink, required
      - `href` string, required: The link URL.
      - `actions` string[], required: The HTTP Methods that can be performed on the link.
      - `types` string[], required: The Content Types for the link to the resource
    - `activate` IssuingLink, required
      - `href` string, required: The link URL.
      - `actions` string[], required: The HTTP Methods that can be performed on the link.
      - `types` string[], required: The Content Types for the link to the resource
    - `controls` IssuingLink, required
      - `href` string, required: The link URL.
      - `actions` string[], required: The HTTP Methods that can be performed on the link.
      - `types` string[], required: The Content Types for the link to the resource

## Other responses

- `401`: Unauthorized
- `404`: Card not found
- `406`: Not Acceptable
- `415`: Unsupported Media Type
- `422`: Invalid data was sent
- `429`: Too Many Requests

---

[API](https://skmtc.dev/checkout/apis/checkout-com-api-reference.md) - [All operations](https://skmtc.dev/checkout/apis/checkout-com-api-reference/llms.txt) - [OpenAPI document](https://skmtc.dev/checkout/apis/checkout-com-api-reference/revisions/0f1abdb1c3e9?raw)