Card Load

API: Ws_Load

This web service loads or re-loads a card with a specified amount.

The following card statuses prevent the ability to load a card with funds: 04 (Capture Card), 14 (Invalid), 33 (Expired Card), 36 (Restricted Card), 37 (Card acceptor call acquirer security), 41 (Lost), 43 (Stolen), 54 (Expired), 62 (Restricted), 67 (Card to be picked up at ATM), 83 (Destroyed) and G9 (IVR Lost/Stolen Block (like 41 Lost)).

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. See Transaction Codes. Default value is 1 for the initial load and 20 for any subsequent load.

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.

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, when the value of <AuthType> is ‘7’ or when the value of <actMethod> is ‘4’.   In virtual card creation <track2> is not present in the request.

Conditional

Omit

<PublicToken>

AN

1

9

The card’s public token. Mandatory in request if <PAN> and <Track2> are not present. In virtual card creation <PublicToken> is not required in the request. Mandatory in the response.

Conditional

Mandatory

<DOB>

YYYY-MM-

DD

10

10

The cardholder's date of birth. Mandatory if the 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.

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.

Conditional

Omit

<LastName>

AN

1

20

Cardholder's last name. If no delivery address is supplied, this is the card purchaser’s last name. Mandatory 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

<LoadValue>

D

1

20

Load value to put on the card. 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.

Mandatory

Omit

<CurrCode>

AN

3

3

3-letter ISO currency code for the currency to load (e.g. EUR). Mandatory only when specifying a LoadValue that is not zero. This must match the card’s currency or the action will fail (Note: For a Multi-FX card, the card can be loaded in any of the card's currencies).

Mandatory

Omit

<LoadFundsType>

AN

1

3

Payment method of funds for the load. 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

<LoadFee>

D

1

20

Fixed fee amount charged to the card purchaser for handling the card purchase and load. 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 no load fee is required, specify 0. The load fee does not affect the card balance. It is only reported in the XML.

Optional

Omit

<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

<BrnCode>

AN

8

8

Branch code (or Agent code) with which the card is associated. If supplied, it is exported in the XML in CardLoadUnload > Card > branchcode.

Optional

Omit

<Sms_Required>

AN

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.

Optional

Omit

<Note>

AN

1

256

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

Optional

Optional

<SysDate>

YYYY-MM-DD

10

10

The system processing date.

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

<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_Load>
         <hyp:WSID>2021123456789</hyp:WSID>
         <hyp:IssCode>PMT</hyp:IssCode>
         <hyp:TxnCode>1</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:LoadValue>10</hyp:LoadValue>
         <hyp:CurrCode>GBP</hyp:CurrCode>
         <hyp:LoadFundsType>4</hyp:LoadFundsType>
         <hyp:LoadSrc>10</hyp:LoadSrc>
         <hyp:LoadFee>0.0</hyp:LoadFee>
         <hyp:LoadedBy>Admin</hyp:LoadedBy>
         <hyp:Description>Test Load</hyp:Description>
         <hyp:Sms_Required>0</hyp:Sms_Required>
         <hyp:BrnCode>Branch 12</hyp:BrnCode>
         <hyp:Note>Test load</hyp:Sms_Required>
      </hyp:Ws_Load>
   </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_LoadResponse xmlns="http://www.globalprocessing.ae/HyperionWeb">
         <Ws_LoadResult>
            <WSID>2021123456789</WSID>
            <IssCode>PMT</IssCode>
            <TxnCode>1</TxnCode>
            <PublicToken>123456789</PublicToken>
            <LocDate>2021-01-01</LocDate>
            <LocTime>120000</LocTime>
            <ItemID>123</ItemID>
            <ClientCode/>
            <SysDate>2021-01-01</SysDate>
            <ActionCode>000</ActionCode>
            <WebServiceResult/>
         </Ws_LoadResult>    
      </Ws_LoadResponse>
   </soap:Body>
</soap:Envelope>