Card Balance Enquiry (Legacy)

API: Ws_Card_BalEnq

This web service retrieves the available balance of a card and the sum of any blocked amounts.

Alternative web services you can use include: ws_balance_enquiry and ws_balance enquiry_V2 . See Card Balance Enquiry.

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 is 9.

Mandatory

Mandatory

<AuthType>

AN

1

1

Parameter to specify how the card is authenticated. See Authentication Methods.

Mandatory

Omit

<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.

Conditional

Conditional

<PAN>

AN

14

19

Card Number. Mandatory if <ClientCode> or <accno> are not provided. Returned in the response if present in the request.

Optional

Omit

<AccNo>

AN

1

28

Account number of the card. Mandatory if neither <PublicToken> nor <PAN> are provided. Returned in the response if present in the request.

Conditional

Omit

<PublicToken>

AN

1

9

The card’s public token. Mandatory in request if <PAN> and <accno> are not provided. Mandatory in the response.

Conditional

Mandatory

<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

<ItemSrc>

N

1

5

Source field which defines the item source type. See Item Source Types. If used, overrides any existing fees for using this web service.

Mandatory

Omit

<LastName>

AN

1

20

Cardholder’s last name.

Optional

Omit

<DOB>

YYYY-MM-DD

10

10

Date of Birth. Mandatory if value of <AuthType> is ‘2’ or ‘6’.

Conditional

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. Mandatory if the value of <AuthType> is ‘3’.

Conditional

Omit

<AccCode>

AN

0

6

Access code or passcode. If provided, must be 6 digits, leading zeroes are acceptable. Leave empty if not required. Mandatory if the value of <AuthType> is ‘4’.

Conditional

Omit

<SysDate>

YYYY-MM-DD

10

10

The system processing date.

Omit

Mandatory

<ActionCode>

AN

3

3

The action code for the response. See Action Codes.

Omit

Mandatory

<Logical_Expiry>

YYYY-MM-DD

10

10

Logical expiry date of the card.

Omit

Mandatory

<Physical_Expiry>

YYYY-MM-DD

10

10

Physical expiry date of the card.

Omit

Mandatory

<StatCode>

AN

2

2

The status code of the card. See Status Codes.

Omit

Mandatory

<CurCode>

AN

3

3

3-letter ISO currency code for the currency (e.g. EUR).

Optional

Mandatory

<AvlBal>

D

1

20

The current balance on the card account. This includes all financial transactions and 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

<EmbossName>

AN

1

51

Name embossed on the card.

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

<IsLive>

N

1

1

Specifies whether the card is active or not. 1 or True = Active; 0 or False = Not Active.

Omit

Mandatory

<Scheme>

AN

1

50

The card’s Thredd schemeClosed The name of the high-level product type set up in Thredd, usually at a BIN level..

Omit

Mandatory

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_Card_BalEnq>
         <hyp:WSID>2021123456789</hyp:WSID>
         <hyp:IssCode>PMT</hyp:IssCode>
         <hyp:TxnCode>3</hyp:TxnCode>
         <hyp:AuthType>1</hyp:AuthType>
         <hyp:ClientCode></hyp:ClientCode>
         <hyp:PAN></hyp:PAN>
         <hyp:AccNo></hyp:AccNo>
         <hyp:PublicToken>123456789</hyp:PublicToken>
         <hyp:CurCode>GBP</hyp:CurCode>
         <hyp:LocDate>2021-01-01</hyp:LocDate>
         <hyp:LocTime>120000</hyp:LocTime>
         <hyp:ItemSrc>2</hyp:ItemSrc>
         <hyp:DOB></hyp:DOB>
         <hyp:CVV></hyp:CVV>
         <hyp:AccCode></hyp:AccCode>
         <hyp:LastName></hyp:LastName>
      </hyp:Ws_Card_BalEnq>
   </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_Card_BalEnqResponse xmlns="http://www.globalprocessing.ae/HyperionWeb">
         <Ws_Card_BalEnqResult>
            <WSID>2021123456789</WSID>
            <IssCode>PMT</IssCode>
            <TxnCode>3</TxnCode>
            <PublicToken>123456789</PublicToken>
            <LocDate>2021-01-01</LocDate>
            <LocTime>120000</LocTime>
            <Logical_Expiry>2025-03-31</Logical_Expiry>
            <Physical_Expiry>17/10</Physical_Expiry>
            <StatCode>00</StatCode>
            <EmbossName>GIFT CARD</EmbossName>
            <AvlBal>10</AvlBal>
            <BlkAmt>0</BlkAmt>
            <CurCode>GBP</CurCode>
            <ClientCode/>
            <SysDate>2021-01-01</SysDate>
            <ActionCode>000</ActionCode>
            <IsLive>true</IsLive>
            <Scheme>Giftcard</Scheme>
         </Ws_Card_BalEnqResult>
      </Ws_Card_BalEnqResponse>
   </soap:Body>
</soap:Envelope>