Card Regenerate Image

API: Ws_Regenerate

This web service enables you to retrieve the card image configured on the Thredd platform, which can then be displayed to the cardholder. Card images are stored for both virtual cards and physical cards that have been converted from virtual cards. If a customer wants to see the image some time after card creation, you can regenerate the image by using this web service.

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

<RegenType>

N

1

1

Whether the card is regenerated. 0 = Only return the CVV and do not regenerate. 1 = Regenerate the card only if it has a status of lost or stolen, OR recreate the card image (note: legacy only, use Ws_Renew_Card). 2 = Only create the card image, do not regenerate card. See Card Renew);

Mandatory

Omit

<Sms_Required>

N

1

1

Whether an SMS is sent to the cardholder with the card's CVV. 1 = yes; 0 =No. The default is ‘0’. The SMS is configurable.

Mandatory

Omit

<Sms_Content >

N

1

1

Reserved for future use; set to 0.

Mandatory

Omit

<CVV>

AN

3

3

Card Verification ValueClosed 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., the 3-digit code printed on the back of the card.

Omit

Mandatory

<ActionCode>

AN

3

3

The action code for the response. See Action Codes.

Omit

Mandatory

<Image>

Base64 Binary

 

 

PGP-encrypted image of the card. Is only returned if a PGP key has been shared and configured.

Omit

Conditional

<ExternalRef>

AN

1

30

External reference code for the card. Note: Legacy field. Not used.

Optional

Omit

<TerminalID>

AN

1

15

Point of Sale (POS) or other terminal identifier, such as a hostname.

Optional

Omit

< MailOrSMS>

AN

1

1

The cardholder's preferred contact method. 0 = SMS; 1 = email. 2 = SMS and email. Default value is ‘0’.

Optional

Omit

<CustAccount>

AN

1

25

Cardholder account number or reference number. You can use this reference to find the cards linked to a cardholder. Also displayed in Smart Client and in Thredd Portal as Customer Reference.

Optional

Optional

<PAN>

N

14

19

Card Number displayed as masked.

Note: For customers who are PCI DSS CompliantClosed The Payment Card Industry Data Security Standard (PCI DSS) is an information security standard for organisations that handle credit cards from the major Card Schemes (payment networks). All Program Managers who handle customer card data must be compliant with this standard. See: https://www.pcisecuritystandards.org/pci_security/, Thredd can return the full PAN if required. This must be enabled at Program Manager level and applies to all web services which return the PAN. Only returned for successful calls.

Omit

Conditional

<WSID>

N

1

19

Web service ID. Must be unique for every request. For details, see the FAQs.

Optional

Omit

<IssCode>

AN

1

4

Thredd Issuer (Program Manager) Code. Assigned by Thredd.

Optional

Omit

<FeeWaiver>

N

1

1

Indicates whether to waive any web service fee set up on the system: 0 = No, 1=Yes. Default is 0.

Optional

Omit

Request

Copy 
<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_Regenerate>
         <hyp:PublicToken>123456789</hyp:PublicToken>
         <hyp:RegenType>1</hyp:RegenType>
         <hyp:Sms_Required>0</hyp:Sms_Required>
         <hyp:Sms_Content>0</hyp:Sms_Content>
         <hyp:ExternalRef>ABCD001</hyp:ExternalRef>
         <hyp:TerminalID>POS-TEST</hyp:TerminalID>
         <hyp:MailOrSMS>0</hyp:MailOrSMS>
         <hyp:WSID>2021123456789678</hyp:WSID>
         <hyp:IssCode>CLIENT</hyp:IssCode>
      </hyp:Ws_Regenerate>
   </soapenv:Body>
</soapenv:Envelope>

Response

Copy 
<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_RegenerateResponse xmlns="http://www.globalprocessing.ae/HyperionWeb">
         <Ws_RegenerateResult>
            <PublicToken>123456789</PublicToken>
            <ActionCode>000</ActionCode>
            <CVV>123</CVV>
            <PAN>123456******4321</PAN>
         </Ws_RegenerateResult>
      </Ws_RegenerateResponse>
   </soap:Body>
</soap:Envelope>