Converting a Card from Virtual to Physical
You can create both physical and Virtual Cards. The type of card created can be seen in the CardType attribute of the card object. For more information see Creating a Card.
You can convert a virtual card to a physical card at any time via an API call.
NoteThe convert virtual card to physical option must be configured at the time of your card program setup. For details, contact your Implementation Manager.
When converted, the new physical card will have the same Primary Account Number (PAN) as the virtual card (as long as it's converted in the first 30 days of the virtual card being created). The Cardholder can continue to use their existing virtual card until the cardholder has received and activated their physical card.
Virtual cards are activated by default (status 00), unless the activateNow field is set to false when creating the card. A virtual card must be active before it can be converted to a physical card. If you try to convert a card that is not active, a 400 response is returned.
If you convert a virtual card to a physical card within a month of the virtual card's creation, the new physical card retains the same PAN, CVV, and expiry date (unless changed via the newExpiryDate field in the request) as the virtual card. If you convert the card after a month, the physical card has a different expiry date and CVV.
NoteThredd recommends that clients either convert cards within a month or, if this is not possible, issue a new virtual card and then convert it to physical.
Converting a Virtual Card to a Physical Card
Step 1: Identify the card's public token
Before converting a card, identify the corresponding public token in the API Call. This is returned in the response to creating a card.
Step 2: Convert the Card
When you have the public token, convert the card using the Convert Card endpoint. For example:
https://uat-api.thredd.com/api/v1/cards/{{publicToken}}/card-typeWhen converting a card, you have two optional fields you can use to determine the converted card's expiry date.
- The moveExpiryDate field, if set to true. will move the expiry date to the new card.
- The newExpiryDate field enables you to set a new expiry date in a YYYY-MM format.
NoteThe moveExpiryDate and newExpiryDate fields cannot be used as part of the same API call.
See below for examples of different types of Convert Card calls.
{
"cardType": "Physical",
"moveExpiryDate": true
}{
"cardType": "Physical",
"newExpiryDate": "2025-05"
}If successful, a 200 response will be returned confirming the conversion has been completed, as well as the expiry date for the card.
{
"cardType": "Physical",
"expiryDate": "2023-05"
}
API ExplorerSee the Convert card endpoint.
The API triggers the inclusion of the card in the next XML card manufacturer file for your programme. Following successful conversion, replacement or renewal, cards are generated as physical card records.
NoteCurrently Thredd does not support a card conversion from a
PhysicalCard Type to aVirtualCard type.
