Update card details
Last updated: November 28, 2024
You can update a card's details using the Dashboard and the API at any point in its lifetime.
Note
- Updating a card's expiry month and/or year automatically updates the CVC2 code. Ensure you notify the cardholder so they can continue using the card with the new credentials.
- All cards have a maximum lifetime of three years from creation. You cannot update a card's expiry beyond this lifetime.
In the Dashboard, you can update the card reference for identifying the card and the five user-defined fields available when you created the card. You must have have user permissions to manage Issuing data.
- Sign in to the Dashboard.
- Go to Issuing > Cards.
- Use search or filters to find the required card, and select it to view the Card details page.
- In the Custom data tile, select Edit.
- Make the required changes, and then select Save.
Call the Update card details endpoint, and provide the {cardId}
in the path.
You can then set, update, or remove the following details:
- The card
reference
for identifying the card – To remove, set tonull
. - The user-defined metadata fields:
udf1
,udf2
,udf3
,udf4
,udf5
– To remove, set tonull
. - The
expiry_month
andexpiry_year
– You cannot set these fields tonull
. If you do not want to provide a value, do not include them in the request.
To receive a notification whenever a card's details are updated, subscribe to the card_details_changed webhook.
patch
https://api.checkout.com/issuing/cards/{cardId}
1{2"reference": "X-123456-N11",3"metadata": {4"udf1": "metadata1",5"udf2": "metadata2",6"udf3": "metadata3",7"udf4": "metadata4",8"udf5": "metadata5"9},10"expiry_month": 5,11"expiry_year": 202512}
1{2"last_modified_date": "2019-09-10T10:11:12Z",3"_links": {4"self": {5"href": "https://api.checkout.com/issuing/card/crd_d3ozhf43pcq2xbldn2g45qnb44",6"actions": [7"GET"8],9"types": [10"application/json"11]12}13}14}