Renew a card

Last updated: June 12, 2024

Renewing a card means creating a new card based on the configuration of a previous card.

Note

You must renew an active card before it expires. You cannot renew a card that is inactive or suspended.

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 using the API

Once activated, the:

wallet token is transferred from the original card to the renewed card
renewed card is enrolled with the same 3DS authentication method as the original card
velocity controls applied to the original card are applied to the renewed card
control profiles applied to the original card are applied to the renewed card

However, the renewed card has new, unique credentials, including:

primary account number (PAN)
security code (CVV)
expiry date, based on the card product's default lifetime

The cardholder can continue to use the original card until it expires, even if they've activated the renewed card. All card controls and control profiles are automatically linked and applied across both cards.

When you renew a physical card, it is delivered to the same address as the original card by default. Alternatively, you can specify a new delivery address in your API request.

For the full API specification, see the API reference.

post

https://api.checkout.com/issuing/cards/{cardId}/renew


1{
2  "display_name": "HANNAH BRET",
3  "shipping_instructions": {
4    "shipping_recipient": "Hannah Bret",
5    "shipping_address": {
6      "address_line1": "123 High St.",
7      "address_line2": "Flat 456",
8      "city": "London",
9      "state": "London",
10      "zip": "SW1A 1AA",
11      "country": "GB"
12    },
13    "additional_comment": "string"
14  },
15  "reference": "X-123456-N11",
16  "metadata": {
17    "udf1": "metadata1",
18    "udf2": "metadata2",
19    "udf3": "metadata3",
20    "udf4": "metadata4",
21    "udf5": "metadata5"
22  }
23}


1{
2  "display_name": "HANNAH BRET",
3  "reference": "X-123456-N11",
4  "metadata": {
5    "udf1": "metadata1",
6    "udf2": "metadata2",
7    "udf3": "metadata3",
8    "udf4": "metadata4",
9    "udf5": "metadata5"
10  }
11}


1{
2  "parent_card_id": "crd_fa6psq242dcd6fdn5gifcq1491",
3  "cardholder_id": "crh_d3ozhf43pcq2xbldn2g45qnb44",
4  "status": "inactive",
5  "type": "virtual",
6  "id": "crd_zdihd7452165pk5lgywaa52147",
7  "client_id": "cli_vkuhvk4vjn2edkps7dfsq6emqm",
8  "entity_id": "ent_fa6psq242dcd6fdn5gifcq1491",
9  "last_four": 1234,
10  "expiry_year": 2025,
11  "expiry_month": 5,
12  "display_name": "HANNAH BRET",
13  "reference": "X-123456-N11",
14  "created_date": "2021-09-09T19:41:39Z",
15  "billing_currency": "USD",
16  "issuing_country": "US",
17  "_links": {
18    "self": {
19      "href": "https://api.checkout.com/issuing/cards/crd_fa6psq42dcdd6fdn5gifcq1491",
20      "actions": [
21        "GET"
22      ],
23      "types": [
24        "application/json"
25      ]
26    },
27    "credentials": {
28      "href": "https://api.checkout.com/issuing/cards/crd_fa6psq42dcdd6fdn5gifcq1491/credentials",
29      "actions": [
30        "GET"
31      ],
32      "types": [
33        "application/json"
34      ]
35    },
36    "activate": {
37      "href": "https://api.checkout.com/issuing/cards/crd_fa6psq42dcdd6fdn5gifcq1491/activate",
38      "actions": [
39        "POST"
40      ],
41      "types": [
42        "application/json"
43      ]
44    },
45    "controls": {
46      "href": "https://api.checkout.com/issuing/controls?target_id=crd_fa6psq42dcdd6fdn5gifcq1491",
47      "actions": [
48        "GET"
49      ],
50      "types": [
51        "application/json"
52      ]
53    }
54  }
55}

Renew a card

Note

Request example

Request example

Response example