Renew physical cards
Physical cards expire three years after they are printed. They're then automatically renewed for another three years unless the card is cancelled.
If you want the renewed physical card to be delivered to a new address, call the confirmPhysicalCardRenewal
mutation at least 8 weeks before the card expires. If no action is taken, the renewed card will be shipped to the original delivery address.
- Confirm that the card is in
ToRenew
status before calling this mutation. This status is automatically triggered 10 weeks before the expiration date. If you're subscribed to theCard.Updated
webhook, you'll receive a notification when the physical card status changes toToRenew
. - Verify the new physical card delivery address with the cardholder.
Guide​
- Call the
confirmPhysicalCardRenewal
mutation. - Add the
cardId
for the physical card you're renewing (line 4). - Add the updated physical card delivery
address
(line 5). - Add the
ConfirmPhysicalCardRenewalSuccessPayload
, including any information you'd like to review (line 8). - Add rejections (not shown).
You don't need to include the companyName
in any address
fields.
Please consult the guidelines for providing a card delivery address for more information.
Mutation​
Open in API Explorermutation RenewPhysicalCard {
confirmPhysicalCardRenewal(
input: {
cardId: "$YOUR_CARD_ID"
address: { addressLine1: "10 Rue de la Paix", city: "Paris", postalCode: "75000", country: "FRA" }
}
) {
... on ConfirmPhysicalCardRenewalSuccessPayload {
__typename
physicalCard {
expiryDate
statusInfo {
status
}
}
}
}
}
Payload​
The payload confirms that the physical card expires on 09/21 (line 6), and its renewal status is ToRenew
(line 8).
{
"data": {
"confirmPhysicalCardRenewal": {
"__typename": "ConfirmPhysicalCardRenewalSuccessPayload",
"physicalCard": {
"expiryDate": "09/21",
"statusInfo": {
"status": "ToRenew"
}
}
}
}
}