# Renew a card Renewing a card means creating a new card based on the configuration of a previous card. --- ## How it works 1. You request to renew a physical or virtual card via the API. The renewed card has new, unique credentials, including: - Primary account number (PAN) - Security code (CVV) - Expiry date, based on the lifetime inherited from the original card product configuration
You can edit the expiry date, if needed. 2. For physical cards, the renewed card is delivered to the same address as the original card by default. Alternatively, you can specify a new delivery address in your API request. 3. When the cardholder receives the renewed card, it must be activated using one of the following methods: - By the cardholder at a point of sale (PoS) - By you via the API 4. Once activated: - The [wallet token](https://www.checkout.com/docs/card-issuing/manage-cards/add-a-card-to-a-digital-wallet.md) is transferred from the original card to the renewed card. - The renewed card is enrolled with the same [3DS authentication](https://www.checkout.com/docs/card-issuing/manage-cards/enroll-a-card-in-3d-secure.md) method as the original card. - The [velocity controls](https://www.checkout.com/docs/card-issuing/manage-cards/control-card-spending.md#Apply_a_velocity_limit) and [control profiles](https://www.checkout.com/docs/card-issuing/manage-cards/create-a-control-profile.md) on the original card are applied to the renewed card. 5. The cardholder can start using the renewed card. They can also continue using the original card until it expires since all card controls and control profiles are linked across both cards. > **Note** > > You must renew an active card before it expires. You cannot renew a card that is inactive or suspended. --- ## Renew a card To renew a card, call the [Renew card](https://api-reference.checkout.com/tag/Cards/#operation/renewCard) endpoint, providing the `cardId` and optionally: - A display name for the card - Shipping instructions for physical cards - Your reference for the card - Any relevant metadata **Live** `POST` `https://{prefix}.api.checkout.com/issuing/cards/{cardId}/renew` **Sandbox** `POST` `https://{prefix}.api.sandbox.checkout.com/issuing/cards/{cardId}/renew` ### Request example **Physical card** ```json { "display_name": "HANNAH BRET", "shipping_instructions": { "shipping_recipient": "Hannah Bret", "shipping_address": { "address_line1": "123 High St.", "address_line2": "Flat 456", "city": "London", "state": "London", "zip": "SW1A 1AA", "country": "GB" }, "additional_comment": "string" }, "reference": "X-123456-N11", "metadata": { "udf1": "metadata1", "udf2": "metadata2", "udf3": "metadata3", "udf4": "metadata4", "udf5": "metadata5" } } ``` **Virtual card** ```json { "display_name": "HANNAH BRET", "reference": "X-123456-N11", "metadata": { "udf1": "metadata1", "udf2": "metadata2", "udf3": "metadata3", "udf4": "metadata4", "udf5": "metadata5" } } ``` ### Response example The response returns the full card details and credentials, and possible next actions. ```json { "parent_card_id": "crd_fa6psq242dcd6fdn5gifcq1491", "cardholder_id": "crh_d3ozhf43pcq2xbldn2g45qnb44", "status": "inactive", "type": "virtual", "id": "crd_zdihd7452165pk5lgywaa52147", "client_id": "cli_vkuhvk4vjn2edkps7dfsq6emqm", "entity_id": "ent_fa6psq242dcd6fdn5gifcq1491", "last_four": 1234, "expiry_year": 2025, "expiry_month": 5, "display_name": "HANNAH BRET", "reference": "X-123456-N11", "created_date": "2021-09-09T19:41:39Z", "billing_currency": "USD", "issuing_country": "US", "_links": { "self": { "href": "https://{prefix}.api.checkout.com/issuing/cards/crd_fa6psq42dcdd6fdn5gifcq1491", "actions": [ "GET" ], "types": [ "application/json" ] }, "credentials": { "href": "https://{prefix}.api.checkout.com/issuing/cards/crd_fa6psq42dcdd6fdn5gifcq1491/credentials", "actions": [ "GET" ], "types": [ "application/json" ] }, "activate": { "href": "https://{prefix}.api.checkout.com/issuing/cards/crd_fa6psq42dcdd6fdn5gifcq1491/activate", "actions": [ "POST" ], "types": [ "application/json" ] }, "controls": { "href": "https://{prefix}.api.checkout.com/issuing/controls?target_id=crd_fa6psq42dcdd6fdn5gifcq1491", "actions": [ "GET" ], "types": [ "application/json" ] } } } ``` --- ## Activate a renewed card To activate a renewed card, call the [Activate card](https://api-reference.checkout.com/tag/Cards/#operation/activateCard) endpoint, providing the `cardId`. **Live** `POST` `https://{prefix}.api.checkout.com/issuing/cards/{cardId}/activate` **Sandbox** `POST` `https://{prefix}.api.sandbox.checkout.com/issuing/cards/{cardId}/activate` ### Response example The response returns the `cardId` and possible next actions. ```json { "_links": { "self": { "href": "https://{prefix}.api.checkout.com/issuing/cards/crd_fa6psq42dcdd6fdn5gifcq1491", "actions": [ "GET" ], "types": [ "application/json" ] }, "revoke": { "href": "https://{prefix}.api.checkout.com/issuing/cards/crd_fa6psq42dcdd6fdn5gifcq1491/revoke", "actions": [ "POST" ], "types": [ "application/json" ] }, "suspend": { "href": "https://{prefix}.api.checkout.com/issuing/cards/crd_fa6psq42dcdd6fdn5gifcq1491/suspend", "actions": [ "POST" ], "types": [ "application/json" ] } } } ``` --- ## Edit card expiry date A renewed card's expiry date is based on the lifetime inherited from the card product configuration. To edit the expiry date, call the [Update card details](https://www.checkout.com/docs/card-issuing/manage-cards/update-card-details.md) endpoint, providing: - The `cardId` - The expiry month and year **Live** `PATCH` `https://{prefix}.api.checkout.com/issuing/cards/{cardId}` **Sandbox** `PATCH` `https://{prefix}.api.sandbox.checkout.com/issuing/cards/{cardId}` ### Request example ```json { "expiry_month": 5, "expiry_year": 2030 } ``` ### Response example The response returns the `cardId` and the timestamp for the update. ```json { "last_modified_date": "2021-09-09T19:41:39Z", "_links": { "self": { "href": "https://{prefix}.api.checkout.com/issuing/cards/crd_fa6psq42dcdd6fdn5gifcq1491", "actions": [ "GET" ], "types": [ "application/json" ] } } } ```