Card Balance Adjustment
API: Ws_BalanceAdjustment
This web service enables you to apply debits and credits to a card record.
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  | 
                                                
| 
                                                         <TxnCode>  | 
                                                    
                                                         AN  | 
                                                    
                                                         1  | 
                                                    
                                                         2  | 
                                                    
                                                         The Transaction Code. See Transaction Codes. Default value 16.  | 
                                                    
                                                         Mandatory  | 
                                                    
                                                         Mandatory  | 
                                                
| 
                                                         <ClientCode>  | 
                                                    
                                                         AN  | 
                                                    
                                                         1  | 
                                                    
                                                         64  | 
                                                    
                                                         User ID of the customer using the service. Only applicable to systems using member logins. Returned in the response if present in the request. Note: Legacy field. Not used. Mandatory if the value of   | 
                                                    
                                                         Conditional  | 
                                                    
                                                         Conditional  | 
                                                
| 
                                                         <AuthType>  | 
                                                    
                                                         AN  | 
                                                    
                                                         1  | 
                                                    
                                                         1  | 
                                                    
                                                         Parameter to specify how the card is authenticated. See Authentication Methods.  | 
                                                    
                                                         Mandatory  | 
                                                    
                                                         Omit  | 
                                                
| 
                                                         <PAN>  | 
                                                    
                                                         AN  | 
                                                    
                                                         14  | 
                                                    
                                                         19  | 
                                                    
                                                         Card Number. Unique card identifier.  | 
                                                    
                                                         Conditional  | 
                                                    
                                                         Omit  | 
                                                
| 
                                                         <Track2>  | 
                                                    
                                                         AN  | 
                                                    
                                                         1  | 
                                                    
                                                         40  | 
                                                    
                                                         The card’s Track 2. Mandatory in request if   | 
                                                    
                                                         Conditional  | 
                                                    
                                                         Omit  | 
                                                
| 
                                                         <PublicToken>  | 
                                                    
                                                         AN  | 
                                                    
                                                         1  | 
                                                    
                                                         9  | 
                                                    
                                                         The card’s public token, Mandatory in request if   | 
                                                    
                                                         Conditional  | 
                                                    
                                                         Mandatory  | 
                                                
| 
                                                         <DOB>  | 
                                                    
                                                         YYYY-MM- DD  | 
                                                    
                                                         10  | 
                                                    
                                                         10  | 
                                                    
                                                         Date of Birth. Mandatory if value of   | 
                                                    
                                                         Conditional  | 
                                                    
                                                         Omit  | 
                                                
| 
                                                         <CVV>  | 
                                                    
                                                         AN  | 
                                                    
                                                         3  | 
                                                    
                                                         3  | 
                                                    
                                                         Card Verification Value  | 
                                                    
                                                         Conditional  | 
                                                    
                                                         Omit  | 
                                                
| 
                                                         <AccCode>  | 
                                                    
                                                         AN  | 
                                                    
                                                         0  | 
                                                    
                                                         6  | 
                                                    
                                                         Access code or passcode for setting a code which is validated during activation (e.g. via the Thredd IVR system  | 
                                                    
                                                         Conditional  | 
                                                    
                                                         Omit  | 
                                                
| 
                                                         <LastName>  | 
                                                    
                                                         AN  | 
                                                    
                                                         1  | 
                                                    
                                                         20  | 
                                                    
                                                         Cardholder's last name for authenticating the cardholder if the value of   | 
                                                    
                                                         Conditional  | 
                                                    
                                                         Omit  | 
                                                
| 
                                                         <LocDate>  | 
                                                    
                                                         YYYY-MM- DD  | 
                                                    
                                                         10  | 
                                                    
                                                         10  | 
                                                    
                                                         The local current date in year-month-date format.  | 
                                                    
                                                         Mandatory  | 
                                                    
                                                         Mandatory  | 
                                                
| 
                                                         <LocTime>  | 
                                                    
                                                         HHMMSS  | 
                                                    
                                                         6  | 
                                                    
                                                         6  | 
                                                    
                                                         The local current time, in hour-minute-second format.  | 
                                                    
                                                         Mandatory  | 
                                                    
                                                         Mandatory  | 
                                                
| 
                                                         <AmtAdjustment>  | 
                                                    
                                                         N  | 
                                                    
                                                         1  | 
                                                    
                                                         7  | 
                                                    
                                                         The amount to debit or credit the card.  | 
                                                    
                                                         Mandatory  | 
                                                    
                                                         Omit  | 
                                                
| 
                                                         <CurCode>  | 
                                                    
                                                         AN  | 
                                                    
                                                         3  | 
                                                    
                                                         3  | 
                                                    
                                                         In Request: the currency alpha code of  In Response: the currency alpha code of the   | 
                                                    
                                                         Mandatory  | 
                                                    
                                                         Mandatory  | 
                                                
| 
                                                         <DebOrCred>  | 
                                                    
                                                         AN  | 
                                                    
                                                         1  | 
                                                    
                                                         2  | 
                                                    
                                                         Whether a transaction is a debit or credit.  | 
                                                    
                                                         Mandatory  | 
                                                    
                                                         Omit  | 
                                                
| 
                                                         <Description>  | 
                                                    
                                                         AN**  | 
                                                    
                                                         1  | 
                                                    
                                                         150  | 
                                                    
                                                         Description of balance adjustment. Will appear in Card Statement (account enquiry).  | 
                                                    
                                                         Mandatory  | 
                                                    
                                                         Omit  | 
                                                
| 
                                                         <AvlBal>  | 
                                                    
                                                         D  | 
                                                    
                                                         1  | 
                                                    
                                                         7  | 
                                                    
                                                         The balance on the card following the adjustment. This includes all the financials received, but excludes pending authorisations.  | 
                                                    
                                                         Omit  | 
                                                    
                                                         Mandatory  | 
                                                
| 
                                                         <ForcePost>  | 
                                                    
                                                         N  | 
                                                    
                                                         1  | 
                                                    
                                                         1  | 
                                                    
                                                         Whether to force post the adjustment to the account: False = do not force posting; true = force posting.   | 
                                                    
                                                         Optional  | 
                                                    
                                                         Omit  | 
                                                
| 
                                                         <ExtCode>  | 
                                                    
                                                         AN  | 
                                                    
                                                         1  | 
                                                    
                                                         16  | 
                                                    
                                                         External code associated with the posting. Only supported for legacy reasons, do not use.  | 
                                                    
                                                         Optional  | 
                                                    
                                                         Omit  | 
                                                
| 
                                                         <SysDate>  | 
                                                    
                                                         YYYY-MM-DD  | 
                                                    
                                                         10  | 
                                                    
                                                         10  | 
                                                    
                                                         The system processing date.  | 
                                                    
                                                         Omit  | 
                                                    
                                                         Mandatory  | 
                                                
| 
                                                         <ItemID>  | 
                                                    
                                                         AN  | 
                                                    
                                                         1  | 
                                                    
                                                         20  | 
                                                    
                                                         The unique item ID returned for the adjustment.  | 
                                                    
                                                         Omit  | 
                                                    
                                                         Mandatory  | 
                                                
| 
                                                         <ActionCode>  | 
                                                    
                                                         AN  | 
                                                    
                                                         3  | 
                                                    
                                                         3  | 
                                                    
                                                         The action code for the response. See Action Codes.  | 
                                                    
                                                         Omit  | 
                                                    
                                                         Mandatory  | 
                                                
| 
                                                         <LoadedBy>  | 
                                                    
                                                         AN  | 
                                                    
                                                         1  | 
                                                    
                                                         30  | 
                                                    
                                                         Name of person or cashier making the adjustment.  | 
                                                    
                                                         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  | 
                                                
** Some formatting may be done on this string, see String Cleaning and Approved Characters.
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_BalanceAdjustment>
         <hyp:WSID>2021123456789</hyp:WSID>
         <hyp:IssCode>PMT</hyp:IssCode>
         <hyp:TxnCode>16</hyp:TxnCode>
         <hyp:ClientCode></hyp:ClientCode>
         <hyp:AuthType>1</hyp:AuthType>
         <hyp:PAN></hyp:PAN>
         <hyp:Track2></hyp:Track2>
         <hyp:PublicToken>123456789</hyp:PublicToken>
         <hyp:DOB></hyp:DOB>
         <hyp:CVV></hyp:CVV>
         <hyp:AccCode></hyp:AccCode>
         <hyp:LastName></hyp:LastName>
         <hyp:LocDate>2021-01-01</hyp:LocDate>
         <hyp:LocTime>120000</hyp:LocTime>
         <hyp:AmtAdjustment>10</hyp:AmtAdjustment>
         <hyp:CurCode>GBP</hyp:CurCode>
         <hyp:DebOrCred>1</hyp:DebOrCred>
         <hyp:Description>Balance Ajustement</hyp:Description>
         <hyp:ForcePost>0</hyp:ForcePost>
         <hyp:ExtCode></hyp:ExtCode>
      </hyp:Ws_BalanceAdjustment>
   </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_BalanceAdjustmentResponse xmlns="http://www.globalprocessing.ae/HyperionWeb">
         <Ws_BalanceAdjustmentResult>
            <WSID>2021123456789</WSID>
            <IssCode>PMT</IssCode>
            <TxnCode>16</TxnCode>
            <PublicToken>123456789</PublicToken>
            <LocDate>2021-01-01</LocDate>
            <LocTime>120000</LocTime>
            <ClientCode>0</ClientCode>
            <SysDate>2021-01-01</SysDate>
            <ActionCode>000</ActionCode>
            <AvlBal>20</AvlBal>
            <CurCode>826</CurCode>
            <ItemID>123</ItemID>
            <WebServiceResult/>    
         </Ws_BalanceAdjustmentResult>
      </Ws_BalanceAdjustmentResponse>
   </soap:Body>
</soap:Envelope>