Card Unload

API: Ws_UnLoad

This web service unloads a card. Note that any outstanding, unsettled authorisations on the card could result in the card going into a negative balance.

This service is only applicable for EHI ModesClosed For authorisation type of transactions, the External Host Interface (EHI) can operate in one of five modes: Gateway Processing (mode 1) the External Host maintains card balances and participates in transaction authorisation by approving or declining the transaction. Cooperative Processing (mode 2) - Thredd maintains balances and performs all types of the authorization, but the External Host can overrule in some circumstances. Full Service Processing (mode 3) - read-only data feed from the Thredd system to the Client's system. Gateway Processing with STIP (mode 4) - External Host maintains Balance (with Thredd stand-in). 2 (Cooperative Processing) or 3 (Full Service Processing).

Record Description

Tag

Type

Minimum Length

Maximum Length

Description

Request

Response

<WSID>

N

1

19

Web service ID. Must be unique for every web service request sent. For details, see the FAQs.Tip: You could use a number based on the current date and time, as long as it is unique (e.g., 20201217145006).

Mandatory

Mandatory

<IssCode>

AN

1

4

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

Mandatory

Mandatory

<TxnCode>

AN

1

2

The Transaction Code. The default value is '8'. See Transaction Codes.

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 <AuthType> is '5'.

Optional

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. Mandatory in request if <track2> and <PublicToken> are not present.

Conditional

Omit

<Track2>

AN

1

40

The card’s Track 2. Mandatory in request if <PAN> and <PublicToken> are not present or when <AuthType> is ‘7’.

Conditional

Omit

<PublicToken>

AN

1

9

The card’s public token, Mandatory in request if <PAN> and <Track2> are not present. Mandatory in the response.

Conditional

Mandatory

<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

<LastName>

AN

1

20

Cardholder's last name for authenticating the cardholder if the value of <AuthType> is ‘6’.

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

<TerminalID>

AN

1

15

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

Optional

Omit

<LoadFundsType>

AN

1

3

Payment method for loading funds onto the card. See Load Fund Types.

Optional

Omit

<LoadSrc>

AN

1

3

The source of the load request for determining the fee of the load, if applicable. If omitted, defaults to 14 “Unknown”. See Load Sources.

Optional

Omit

<AmtUnLoad>

D

1

20

The requested amount to unload. The 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. If 0 will unload the whole amount remaining on the card. If the amount is specified, this amount is returned in the response. Otherwise, the actual amount unloaded (net of fees) is returned.

Mandatory

Mandatory

<CurCode>

AN

3

3

3-letter ISO currency code for the currency (e.g. EUR). If supplied, it will be validated against the cards billing currency.

Optional

Mandatory

<LoadedBy>

AN

1

30

User who loaded the card.

Optional

Omit

<Description>

AN**

1

150

Description of the load. If supplied, appears in the <description> tag of a response to a card or account query. See Card Statement (V1).

Optional

Omit

<Note>

AN

1

256

Add a note. The text is displayed in the Smart Client notes field for the transaction.

Optional

Optional

<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

<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

<ItemId>

AN

1

20

The unique item ID returned for this load.

Omit

Mandatory

<ActionCode>

AN

3

3

The action code for the response. See Action Codes.

Omit

Mandatory

<SysDate>

YYYY-MM-

DD

10

10

The system processing date.

Omit

Mandatory

<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

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_UnLoad>
         <hyp:WSID>2021123456789</hyp:WSID>
         <hyp:IssCode>PMT</hyp:IssCode>
         <hyp:TxnCode>8</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:TerminalID></hyp:TerminalID>
         <hyp:LoadFundsType>4</hyp:LoadFundsType>
         <hyp:LoadSrc>10</hyp:LoadSrc>
         <hyp:AmtUnLoad>10</hyp:AmtUnLoad>
         <hyp:LoadedBy> </hyp:LoadedBy>
         <hyp:Note>Test unload</hyp:Sms_Required>
      </hyp:Ws_UnLoad>
   </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_UnLoadResponse xmlns="http://www.globalprocessing.ae/HyperionWeb">
         <Ws_UnLoadResult>
            <WSID>2021123456789</WSID>
            <IssCode>PMT</IssCode>
            <TxnCode>8</TxnCode>
            <PublicToken>123456789</PublicToken>
            <LocDate>2021-01-01</LocDate>
            <LocTime>120000</LocTime>
            <AmtUnLoad>10</AmtUnLoad>
            <ClientCode/>
            <SysDate>2021-01-01</SysDate>
            <ActionCode>000</ActionCode>
            <AvlBal>3</AvlBal>
            <BlkAmt>1</BlkAmt>
            <ItemID>1234</ItemID>
            <CurCode>GBP</CurCode>
            <WebServiceResult/>
         </Ws_UnLoadResult>    
      </Ws_UnLoadResponse>
   </soap:Body>
</soap:Envelope>