CHcheckout
Cards

Renew a card

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.

post/issuing/cards/{cardId}/renew

Request

Path parameters

cardIdstring required

The card's unique identifier.

Example:crd_fa6psq242dcd6fdn5gifcq1491

Request body

OR

Example request

{
  "display_name": "JOHN KENNEDY",
  "shipping_instructions": {
    "shipping_address": {
      "address_line1": "Checkout.com",
      "address_line2": "90 Tottenham Court Road",
      "city": "London",
      "state": "London",
      "zip": "W1T 4TJ",
      "country": "GB"
    },
    "shipping_recipient": "john kennedy"
  },
  "reference": "X-123456-N11",
  "metadata": {
    "udf1": "metadata1",
    "udf2": "metadata2",
    "udf3": "metadata3",
    "udf4": "metadata4",
    "udf5": "metadata5"
  }
}

Response

Card renewed successfully

parent_card_idstring

The card's unique identifier.

cardholder_idstring

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
typestring

The card type.

idstring

The card's unique identifier.

client_idstring

The client's unique identifier.

entity_idstring

The entity's unique identifier.

last_fourstring

The last four digits of the card number, also known as the PAN.

expiry_yearinteger

The card's expiration year.

expiry_monthinteger

The card's expiration month.

display_namestring

The name to display on the card.

referencestring

Your reference.

created_datestring UTC
billing_currencystring ISO4217

The issuing currency, as a three-letter <a href="https://docs.checkout.com/docs/currency-codes" target="blank">ISO currency code</a>.

issuing_countrystring

The issuing country, as a two-letter <a href="https://www.checkout.com/docs/resources/codes/country-codes" target="blank" >ISO country code</a>.

Example response

{
  "parent_card_id": "crd_fa6psq242dcd6fdn5gifcq1491",
  "cardholder_id": "crh_d3ozhf43pcq2xbldn2g45qnb44",
  "status": "active",
  "id": "crd_fa6psq242dcd6fdn5gifcq1491",
  "client_id": "cli_vkuhvk4vjn2edkps7dfsq6emqm",
  "entity_id": "ent_fa6psq242dcd6fdn5gifcq1491",
  "last_four": "1234",
  "expiry_year": 2025,
  "expiry_month": 5,
  "display_name": "JOHN KENNEDY",
  "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"
      ]
    }
  }
}

Changes

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