Card Convert to Physical
API: Ws_Convert_Card
This web service enables you to upgrade a virtual card to a physical card. It triggers the inclusion of the card in the next XML card manufacturer or personalisation bureau file for your programme. As part of the upgrade to a physical card, a new expiry date and CVV2 The Card Verification Value (CVV) on a credit card or debit card is a 3 digit number on VISA, MasterCard and Discover branded credit and debit cards.
Cardholder's are typically required to enter the CVV during any online or cardholder not present transactions.
CVV numbers are also known as CSC numbers (Card Security Code), as well as CVV2 numbers, which are the same as CVV numbers, except that they have been generated by a 2nd generation process that makes them harder to guess. is generated if the conversion and production of the XML card file falls in a different calendar month to the virtual card creation.
Following successful conversion, replacement or renewal, cards are generated as physical card records.
Where a virtual card has been activated, the physical card is also active in transit. Thredd recommends that you enforce virtual only usage until the cardholder has received the card. You also need to use Ws_Activate
(see Card Activate) to ensure Thredd has the updated card record data (where CVV2 and expiry date differ to the virtual card).
Record Description
Tag |
Type |
Minimum Length |
Maximum Length |
Description |
Request |
Response |
---|---|---|---|---|---|---|
<PublicToken> |
AN |
1 |
9 |
The card’s public token. Mandatory in request and response. |
Mandatory |
Mandatory |
<ConvertDate> |
YYYY-MM-DD |
10 |
10 |
The date on which the virtual card is upgraded to a physical card. |
Optional |
Mandatory |
<Apply_Fee> |
N |
1 |
1 |
Whether to apply a card upgrade fee. 0 or blank = No, 1 = Yes. |
Mandatory |
Omit |
<ExpDate> |
YYYY-MM-DD |
10 |
10 |
Card expiry date. If left blank, updates with the default expiry date, based on the Card Scheme's validity period in months, otherwise updates with the input value. The date returned of the actual physical expiry is in MM/YY. |
Optional |
Omit |
<ImageId> |
AN |
1 |
16 |
Reference which identifies the card manufacturer's image file that is printed on the face of the card. If not supplied, then the |
Optional |
Omit |
< CarrierType> |
AN |
1 |
30 |
The Carrier Product design reference as used by the Card Manufacturer. This is the letter onto which the card is attached when sent to the cardholder. Identifies the Carrier Product type of the Card Manufacturer. |
Optional |
Omit |
<ActionCode> |
AN |
3 |
3 |
The action code for the response. See Action Codes. |
Omit |
Mandatory |
Request
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:hyp="http://www.globalprocessing.ae/HyperionWeb">
<soapenv:Header>
<hyp:AuthSoapHeader>
<hyp:strUserName>******</hyp:strUserName>
<hyp:strPassword>******</hyp:strPassword>
</hyp:AuthSoapHeader>
</soapenv:Header>
<soapenv:Body>
<hyp:Ws_Convert_Card>
<hyp:PublicToken>123456789</hyp:PublicToken>
<hyp:ConvertDate>2021-01-01</hyp:ConvertDate>
<hyp:Apply_Fee>0</hyp:Apply_Fee>
<hyp:ExpDate>2025-03-31</hyp:ExpDate>
<hyp:ImageId></hyp:ImageId>
<hyp:CarrierType>123456789012345678901234567890123</hyp:CarrierType>
</hyp:Ws_Convert_Card>
</soapenv:Body>
</soapenv:Envelope>
Response
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Body>
<Ws_Convert_CardResponse xmlns="http://www.globalprocessing.ae/HyperionWeb">
<Ws_Convert_CardResult>
<ActionCode>000</ActionCode>
<PublicToken>123456789</PublicToken>
<ConvertDate>2021-01-01</ConvertDate>
</Ws_Convert_CardResult>
</Ws_Convert_CardResponse>
</soap:Body>
</soap:Envelope>