Wallet Balance Enquiry
API: Ws_Balance_Enquiry_Wallet
This web service returns the current available balance on each of the currency wallets for a multi-FX card.
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 ‘3’. |
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. |
Conditional |
Conditional |
<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 |
<AuthType> |
AN |
1 |
1 |
Parameter to specify how the card is authenticated. See Authentication Methods. |
Mandatory |
Omit |
<PAN> |
AN |
14 |
19 |
Card Number. Mandatory 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 |
<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 |
<PINStatus> |
N |
1 |
1 |
Indicates whether the allowed number of card PIN tries has been exceeded. 0 = No; 1 = Yes. |
Omit |
Mandatory |
<EWALLET> |
|
|
|
See EWALLET Details below. |
Omit |
Mandatory |
EWALLET Details
Tag |
Type |
Minimum Length |
Maximum Length |
Description |
Request |
Response |
---|---|---|---|---|---|---|
<IDENTITY> |
AN |
1 |
16 |
The Thredd 16-digit public token. Mandatory in the response. |
Omit |
Mandatory |
<CARD> |
|
|
|
See CARD Details below. |
Omit |
Mandatory |
<ACCOUNT> |
|
|
|
See ACCOUNT Details below; may occur multiple times. |
Omit |
Mandatory |
ACCOUNT Details
Tag |
Type |
Minimum Length |
Maximum Length |
Description |
Request |
Response |
---|---|---|---|---|---|---|
<ACCNO> |
AN |
1 |
9 |
Account number. |
Omit |
Mandatory |
<ACCTYPE> |
AN |
2 |
2 |
Type of card account. See Account Types. |
Omit |
Mandatory |
<CURRCODE> |
AN |
3 |
3 |
Alpha currency code of the account. |
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 |
CARD Details
Tag |
Type |
Minimum Length |
Maximum Length |
Description |
Request |
Response |
---|---|---|---|---|---|---|
<PAN> |
AN |
1 |
9 |
The Thredd 16-digit public token. Mandatory in the response. |
Omit |
Mandatory |
<CRDCURRCODE> |
AN |
3 |
3 |
Physical card alpha-currency code. |
Omit |
Mandatory |
<CRDPRODUCT> |
AN |
1 |
50 |
Card product type: MCRD (Mastercard), VISA, MAES (Maestro). |
Omit |
Mandatory |
<PROGRAMID> |
AN |
1 |
50 |
Card’s program ID. |
Omit |
Mandatory |
<CUSTCODE> |
AN |
1 |
50 |
Customer account number. Mandatory in the response if present. |
Omit |
Conditional |
<PRIMARY> |
AN |
1 |
1 |
Indicates if the card is the Primary card. Y = Yes. N= No. |
Omit |
Mandatory |
<STATCODE> |
AN |
2 |
2 |
Card’s status. |
Omit |
Mandatory |
<EXPDATE> |
AN |
10 |
10 |
Expiry date. |
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_Balance_Enquiry_Wallet>
<hyp:WSID>2021123456789</hyp:WSID>
<hyp:IssCode>PMT</hyp:IssCode>
<hyp:TxnCode>3</hyp:TxnCode>
<hyp:ClientCode></hyp:ClientCode>
<hyp:ItemSrc>0</hyp:ItemSrc>
<hyp:AuthType>1</hyp:AuthType>
<hyp:PAN></hyp:PAN>
<hyp:PublicToken>100432911</hyp:PublicToken>
<hyp:DOB></hyp:DOB>
<hyp:CVV></hyp:CVV>
<hyp:AccCode></hyp:AccCode>
<hyp:LastName></hyp:LastName>
<hyp:LocDate>2014-09-01</hyp:LocDate>
<hyp:LocTime>105000</hyp:LocTime>
</hyp:Ws_Balance_Enquiry_Wallet>
</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_Balance_Enquiry_WalletResponse xmlns="http://www.globalprocessing.ae/HyperionWeb">
<Ws_Balance_Enquiry_WalletResult>
<WSID>2021123456789</WSID>
<IssCode>PMT</IssCode>
<TxnCode>3</TxnCode>
<PublicToken>123456789</PublicToken>
<LocDate>2014-09-01</LocDate>
<LocTime>105000</LocTime>
<ClientCode/>
<SysDate>2014-09-01</SysDate>
<ActionCode>000</ActionCode>
<PINStatus>0</PINStatus>
<EWALLET>
<EWALLET xmlns="">
<IDENTITY>9876543210123456</IDENTITY>
<CARDS>
<CARD>
<PAN>9876543210123456</PAN>
<CRDCURRCODE>GBP</CRDCURRCODE>
<CRDPRODUCT>MCRD</CRDPRODUCT>
<CUSTCODE/>
<PRIMARY>Y</PRIMARY>
<PROGRAMID>ABC123</PROGRAMID>
<STATCODE>00</STATCODE>
<EXPDATE>2017-09-30</EXPDATE>
</CARD>
</CARDS>
<ACCOUNTS>
<ACCOUNT>
<ACCNO>9876543210123458</ACCNO>
<ACCTYPE>01</ACCTYPE>
<CURRCODE>EUR</CURRCODE>
<FINAMT>0.00</FINAMT>
<BLKAMT>0.00</BLKAMT>
<AMTAVL>0.00</AMTAVL>
</ACCOUNT>
<ACCOUNT>
<ACCNO>9876543210123457</ACCNO>
<ACCTYPE>01</ACCTYPE>
<CURRCODE>USD</CURRCODE>
<FINAMT>10.00</FINAMT>
<BLKAMT>0.00</BLKAMT>
<AMTAVL>10.00</AMTAVL>
</ACCOUNT>
<ACCOUNT>
<ACCNO>9876543210123456</ACCNO>
<ACCTYPE>01</ACCTYPE>
<CURRCODE>GBP</CURRCODE>
<FINAMT>0.00</FINAMT>
<BLKAMT>0.00</BLKAMT>
<AMTAVL>0.00</AMTAVL>
</ACCOUNT>
</ACCOUNTS>
</EWALLET>
</EWALLET>
</Ws_Balance_Enquiry_WalletResult>
</Ws_Balance_Enquiry_WalletResponse>
</soap:Body>
</soap:Envelope>