Regenerate the Wallet
API: Ws_RegenerateWallet
This web service regenerates an MFX card
 Payment card which supports payment and settlement transactions in multiple currencies. The MFX card typically has a single PAN with multiple currency wallets linked.. For regenerating the wallet, you can select whether to create a new physical linked card, regenerate the image for the virtual card or return the CVV.
Record Description
| 
                                                         Tag  | 
                                                    
                                                         Type  | 
                                                    
                                                         Minimum Length  | 
                                                    
                                                         Maximum Length  | 
                                                    
                                                         Description  | 
                                                    
                                                         Request  | 
                                                    
                                                         Response  | 
                                                
|---|---|---|---|---|---|---|
| 
                                                         <WSID>  | 
                                                    
                                                         N  | 
                                                    
                                                         1  | 
                                                    
                                                         19  | 
                                                    
                                                         Web service ID. Must be unique for every request. For details, see the FAQs.  | 
                                                    
                                                         Mandatory  | 
                                                    
                                                         Mandatory  | 
                                                
| 
                                                         <IssCode>  | 
                                                    
                                                         AN  | 
                                                    
                                                         1  | 
                                                    
                                                         4  | 
                                                    
                                                         Thredd Issuer (Program Manager) Code. Assigned by Thredd.  | 
                                                    
                                                         Mandatory  | 
                                                    
                                                         Mandatory  | 
                                                
| 
                                                         <PAN>  | 
                                                    
                                                         AN  | 
                                                    
                                                         14  | 
                                                    
                                                         19  | 
                                                    
                                                         Card Number. Mandatory if  If you are PCI compliant, the full PAN can be returned. Check with your Implementation Manager.  | 
                                                    
                                                         Conditional  | 
                                                    
                                                         Mandatory  | 
                                                
| 
                                                         <PublicToken>  | 
                                                    
                                                         AN  | 
                                                    
                                                         1  | 
                                                    
                                                         9  | 
                                                    
                                                         The card’s public token. Mandatory in request if   | 
                                                    
                                                         Conditional  | 
                                                    
                                                         Mandatory  | 
                                                
| 
                                                         <RegenType>  | 
                                                    
                                                         N  | 
                                                    
                                                         1  | 
                                                    
                                                         1  | 
                                                    
                                                         The type of card regeneration: 0 = only return the CVV. 1 = regenerate the physical card if its status is Lost or Stolen (for other card status, this regenerates the card image). 2 = only regenerate the card image.  | 
                                                    
                                                         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  | 
                                                    
                                                         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  | 
                                                    
                                                         Enables you to add your own external customer reference.  | 
                                                    
                                                         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  | 
                                                
| 
                                                         <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  | 
                                                
| 
                                                         <ImageSize>  | 
                                                    
                                                         N  | 
                                                    
                                                         1  | 
                                                    
                                                         1  | 
                                                    
                                                         The size of the virtual image: 1 = 100%; 2 = 200%; 3 = 300%; 4 = 400%; 5 = 500%. Default is 1.  | 
                                                    
                                                         Optional  | 
                                                    
                                                         Omit  | 
                                                
| 
                                                         <WebServiceResult>  | 
                                                    
                                                         AN  | 
                                                    
                                                         
  | 
                                                    
                                                         
  | 
                                                    
                                                         Parameter group describing the result of the Web Service call. Only has values if the current request returns an action code of 868 Duplicate WSID. See WebServiceResult.  | 
                                                    
                                                         Omit  | 
                                                    
                                                         Mandatory  | 
                                                
EWALLET Description
| 
                                                         Tag  | 
                                                    
                                                         Type  | 
                                                    
                                                         Minimum Length  | 
                                                    
                                                         Maximum Length  | 
                                                    
                                                         Description  | 
                                                    
                                                         Request  | 
                                                    
                                                         Response  | 
                                                
|---|---|---|---|---|---|---|
| 
                                                         <IDENTITY>  | 
                                                    
                                                         AN  | 
                                                    
                                                         1  | 
                                                    
                                                         9  | 
                                                    
                                                         The Thredd 16-digit public token. Mandatory in the response.  | 
                                                    
                                                         Omit  | 
                                                    
                                                         Mandatory  | 
                                                
| 
                                                         <CARDS>  | 
                                                    
                                                         
  | 
                                                    
                                                         
  | 
                                                    
                                                         
  | 
                                                    
                                                         An array of cards. See CARD Description below.  | 
                                                    
                                                         Omit  | 
                                                    
                                                         Mandatory  | 
                                                
| 
                                                         <ACCOUNTS>  | 
                                                    
                                                         
  | 
                                                    
                                                         
  | 
                                                    
                                                         
  | 
                                                    
                                                         An array of accounts. See ACCOUNT Description below; may occur multiple times.  | 
                                                    
                                                         Omit  | 
                                                    
                                                         Mandatory  | 
                                                
CARD Description
| 
                                                         Tag  | 
                                                    
                                                         Type  | 
                                                    
                                                         Minimum Length  | 
                                                    
                                                         Maximum Length  | 
                                                    
                                                         Description  | 
                                                    
                                                         Request  | 
                                                    
                                                         Response  | 
                                                
|---|---|---|---|---|---|---|
| 
                                                         <PAN>  | 
                                                    
                                                         AN  | 
                                                    
                                                         1  | 
                                                    
                                                         9  | 
                                                    
                                                         Card Number. Unique card identifier.  | 
                                                    
                                                         Omit  | 
                                                    
                                                         Mandatory  | 
                                                
| 
                                                         <CRDCURRCODE>  | 
                                                    
                                                         AN  | 
                                                    
                                                         3  | 
                                                    
                                                         3  | 
                                                    
                                                         3-letter ISO currency code for the account billing currency.  | 
                                                    
                                                         Omit  | 
                                                    
                                                         Mandatory  | 
                                                
| 
                                                         <CRDPRODUCT>  | 
                                                    
                                                         AN  | 
                                                    
                                                         1  | 
                                                    
                                                         50  | 
                                                    
                                                         The identifier of the card product, or   | 
                                                    
                                                         Omit  | 
                                                    
                                                         Mandatory  | 
                                                
| 
                                                         <CUSTCODE>  | 
                                                    
                                                         AN  | 
                                                    
                                                         1  | 
                                                    
                                                         50  | 
                                                    
                                                         Customer account number. Mandatory in the response if present. Also displayed in Smart Client as Customer Reference and Customer Reference Number in Thredd Portal.  | 
                                                    
                                                         Omit  | 
                                                    
                                                         Conditional  | 
                                                
| 
                                                         <PRIMARY>  | 
                                                    
                                                         AN  | 
                                                    
                                                         1  | 
                                                    
                                                         1  | 
                                                    
                                                         Indicates if the card is the Primary card. Default value 'Y'.  | 
                                                    
                                                         Omit  | 
                                                    
                                                         Mandatory  | 
                                                
| 
                                                         <PROGRAMID>  | 
                                                    
                                                         AN  | 
                                                    
                                                         1  | 
                                                    
                                                         50  | 
                                                    
                                                         The ID of the Program  | 
                                                    
                                                         Omit  | 
                                                    
                                                         Mandatory  | 
                                                
| 
                                                         <STATCODE>  | 
                                                    
                                                         AN  | 
                                                    
                                                         2  | 
                                                    
                                                         2  | 
                                                    
                                                         The status code of the card. See Status Codes.  | 
                                                    
                                                         Omit  | 
                                                    
                                                         Mandatory  | 
                                                
| 
                                                         <EXPDATE>  | 
                                                    
                                                         AN  | 
                                                    
                                                         10  | 
                                                    
                                                         10  | 
                                                    
                                                         Expiry date of the card in YYYY-MM-DD format.  | 
                                                    
                                                         Omit  | 
                                                    
                                                         Mandatory  | 
                                                
ACCOUNT Description
| 
                                                         Tag  | 
                                                    
                                                         Type  | 
                                                    
                                                         Minimum Length  | 
                                                    
                                                         Maximum Length  | 
                                                    
                                                         Description  | 
                                                    
                                                         Request  | 
                                                    
                                                         Response  | 
                                                
|---|---|---|---|---|---|---|
| 
                                                         <ACCNO>  | 
                                                    
                                                         AN  | 
                                                    
                                                         1  | 
                                                    
                                                         9  | 
                                                    
                                                         Account number of the card.  | 
                                                    
                                                         Omit  | 
                                                    
                                                         Mandatory  | 
                                                
| 
                                                         <ACCTYPE>  | 
                                                    
                                                         AN  | 
                                                    
                                                         2  | 
                                                    
                                                         2  | 
                                                    
                                                         Type of card account. See Account Types.  | 
                                                    
                                                         Omit  | 
                                                    
                                                         Mandatory  | 
                                                
| 
                                                         <CURRCODE>  | 
                                                    
                                                         AN  | 
                                                    
                                                         3  | 
                                                    
                                                         3  | 
                                                    
                                                         3-letter ISO currency code for the currency (e.g. EUR).  | 
                                                    
                                                         Omit  | 
                                                    
                                                         Mandatory  | 
                                                
| 
                                                         <FINAMT>  | 
                                                    
                                                         D  | 
                                                    
                                                         1  | 
                                                    
                                                         20  | 
                                                    
                                                         Balance of the account, excluding blocked amount.  | 
                                                    
                                                         Omit  | 
                                                    
                                                         Mandatory  | 
                                                
| 
                                                         <BLKAMT>  | 
                                                    
                                                         D  | 
                                                    
                                                         1  | 
                                                    
                                                         20  | 
                                                    
                                                         Amount of funds blocked on the card account as a result of all outstanding authorisations. The balance amount can include up to four decimal places, depending on the currency exponent (e.g., 10.99 for EUR which has a currency exponent of 2). See Currency Codes.  | 
                                                    
                                                         Omit  | 
                                                    
                                                         Mandatory  | 
                                                
| 
                                                         <AMTAVL>  | 
                                                    
                                                         D  | 
                                                    
                                                         1  | 
                                                    
                                                         20  | 
                                                    
                                                         Balance of the card account. This includes all financials and outstanding authorisations.  | 
                                                    
                                                         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_RegenerateWallet>
      <hyp:WSID>2021123456789</hyp:WSID>      
      <hyp:IssCode>PMT</hyp:IssCode>      
      <hyp:PAN></hyp:PAN>      
      <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:FeeWaiver>0</hyp:FeeWaiver>      
      <hyp:ImageSize>1</hyp:ImageSize>
    </hyp:Ws_RegenerateWallet>
  </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_RegenerateWalletResponse xmlns="http://www.globalprocessing.ae/HyperionWeb">
      <Ws_RegenerateWalletResult>
        <WSID>2021123456789</WSID>
        <IssCode>PMT</IssCode>
        <PAN/>
        <PublicToken>123456789</PublicToken>
        <ActionCode>000</ActionCode>
        <CVV>123</CVV>
        <WebServiceResult/> 
      </Ws_RegenerateWalletResult>     
    </Ws_RegenerateWalletResponse>
  </soap:Body>
</soap:Envelope>