Managing Cards
Learn how to renew, replace, and reissue cards or update a virtual card to a physical card.
Manage Cards Overview
Note: We recommend customers use the Renew Card or Replace Card endpoints if possible. Please reference the table below to understand the differences
Reissue Renew Replace Convert to Physical Supported Card Types PHYSICAL
PHYSICAL
VIRTUAL
PHYSICAL
VIRTUAL
VIRTUAL
Card token same same new same PAN same same new same Expiry same new new same CVC2 same new new same PIN same same new same New card can transact once activated once activated once activated Physical card can once activated Old card can transact until new card is activated until new card is activated old card is closed immediately Virtual card continues to work
Renew Card
As cards approach expiry, customers can renew cards, generating a card with the same card token and PAN, but updated expiry and CVC2 code. This can be done with both PHYSICAL
and VIRTUAL
cards. API Reference: Renew Card
For PHYSICAL
cards, this flow is best suited for replacing a card approaching expiry. To set up a card renewal flow:
- Make a POST request to
/cards/{card_token_UUID}/renew
. - This POST request will trigger a physical card shipment. As part of this POST request, you must specify an address for the card to be shipped.
- The card's state will change to
PENDING_FULFILLMENT
. Once the card has been created by the card manufacturer, the state will change again toÂPENDING_ACTIVATION
. Once the card is delivered to the cardholder, you should activate it by changing state toOPEN
. - The new physical card will only start working for card-present transactions once activated (the state is changed from
PENDING_ACTIVATION
back toOPEN
) - The original physical card will keep working for card-present transactions until the new card is activated. For card-not-present transactions, the original card details (expiry, CVC2) will also keep working until the new card is activated.
- Lithic will pass along the updated card details to Mastercard's Automatic Billing Updater. Participating merchants will be able to update the card-on-file information.
For VIRTUAL
cards:
- Make a POST request to
/cards/{card_token_UUID}/renew
. - The card's state will remain unchanged. If the card was
PAUSED
, it will remain inPAUSED
state. - Lithic will pass along the updated card details to Mastercard's Automatic Billing Updater. Participating merchants will be able to update the card-on-file information.
Replace Card
Replace a PHYSICAL
card with a new physical card with a different PAN (e.g. card was stolen) or replace a VIRTUAL
card with a virtual card with a different PAN and card token. API Reference: Create Card.
This flow closes the original card and creates a new card with a new PAN, expiry, CVC2, and card token. This is best suited for replacing a lost or stolen card whose number is no longer secure.
For PHYSICAL
cards, to set up a card replacement flow:
- Make a POST request to the
/cards
endpoint. In your request, specify the UUID of the card you want to replace in thereplacement_for
field. Specify a new PIN same as a standard card create. - This POST request will trigger a physical card shipment. As part of this POST request, you must specify an address for the card to be shipped.
- Please note: this POST request will immediately change the predecessor physical card's state to
CLOSED
and that physical card will no longer be able to transact. - The new card's state will change to
PENDING_FULFILLMENT
. Once the card has been created by the card manufacturer, the state will change again toÂPENDING_ACTIVATION
. Once the card is delivered to the cardholder, you should activate it by changing state toOPEN
. - The replacement card will be created with the
replacement_for
field populated with the predecessor card'stoken
for future reference. The replacement card will be created with the replacement_for field populated with the predecessor card's token for future reference. - Lithic will pass along the updated card details to Mastercard's Automatic Billing Updater. Participating merchants will be able to update the card-on-file information.
For VIRTUAL
cards:
- Make a POST request to the
/cards
endpoint. In your request, specify the token of the card you want to replace in thereplacement_for
field. Specify a new PIN same as a standard card create. - The predecessor virtual card's state will be changed to
CLOSED
and no longer be able to transact. - The new card's state will change to
OPEN
and able to transact immediately. - The replacement card will be created with the replacement_for field populated with the predecessor card's token for future reference.
- Lithic will pass along the updated card details to Mastercard's Automatic Billing Updater. Participating merch
Reissue Physical Card
Initiate print and shipment of a replacement physical card (e.g. card is physically damaged). A card can be reissued a maximum of 8 times. API Reference: Reissue card. This is not available for a VIRTUAL
card since the data is the same and the current card.
When you reissue a physical card, the following will happen:
- The card state will change from
OPEN
toPENDING_FULFILLMENT
. Once the card has been created by the card manufacturer, the state will change again toPENDING_ACTIVATION
. Once the card is delivered to the cardholder, you should activate it by changing state toOPEN
. - The PAN, expiry, and CVC2 will remain the same (with the exception of cards created before 5/2023 - CVC2 will change in those cases). These credentials can be used for card-not-present transactions at any time.
- The new physical card will only start working for card-present transactions once activated (the state is changed from
PENDING_ACTIVATION
back toOPEN
) - The original physical card will keep working for card-present transactions until the new card is activated.
Convert Virtual to Physical Cards
Convert a card from a VIRTUAL
card to a PHYSICAL
card and manufacture it.
- Customer must supply relevant fields for physical card creation including
product_id
,carrier
andshipping_address
. - The
card_token
will be unchanged. The card's type will be altered toPHYSICAL
. - The card will be set to state
PENDING_FULFILLMENT
and fulfilled at the next fulfillment cycle.
Virtual cards created on card programs which do not support physical cards cannot be converted. The card program cannot be changed as part of the conversion. Cards must be in a state ofOPEN
. - Only applies to cards of type
VIRTUAL
(existing cards with deprecated types ofDIGITAL_WALLET
orUNLOCKED
will also be supported).
Updated 3 days ago