Card Balance Transfer

API: Ws_BalanceTransfer

This web service is for transferring an amount from one card to another.

You can transfer funds from a primary card to its secondary card if:

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

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.

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

The cardholder's date of birth. Mandatory if the value of <actMethod> is ‘1’ or <AuthType> is ‘2’ or ‘6’. Otherwise, may be supplied for informational purposes or as part of cardholder registration.

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.

Conditional

Omit

<NewPAN>

AN

16

19

The new card number to where funds should be transferred. Mandatory in the request if <newToken> is not present.

Conditional

Mandatory

<NewToken>

AN

16

19

The public token to where funds should be transferred to. Mandatory in the request if <newPAN> is not present.

Conditional

Omit

<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

<AmtTxn>

D

1

20

The requested amount to transfer. If AmtTxn = 0, it is assumed the full card balance is requested to be transferred. If the amount is specified, this amount is returned in the response. Otherwise, the actual amount transferred (net of fees) is returned.

Mandatory

Mandatory

<CurrCode>

AN

3

3

3-letter ISO currency code for the currency (e.g. EUR). Must be supplied in the request if an <AmtTxn> is specified.

Conditional

Mandatory

<SysDate>

YYYY-MM-DD

10

10

The system processing date.

Omit

Mandatory

<LoadSrc>

AN

1

3

The source of the transfer  request. For transfers between Primary and Secondary cards, the value must be “68”. See Load Sources. If omitted, defaults to “14” =  “Unknown” for normal transfers, but “68” for Primary-Secondary card transfers.

Optional

Omit

<ItemID>

AN

1

20

The unique item ID for this card transfer. The ID returned is the ID relating to the ‘unload’ leg of the transfer from the source card.

Omit

Mandatory

<ActionCode>

AN

3

3

The action code for the response. See Action Codes.

Omit

Mandatory

<LoadedBy>

AN

1

30

Name of person/cashier making the transfer.

Optional

Omit

<Description>

AN**

1

150

Description of balance transfer. Will appear in <Account Enquiry> if supplied.

Optional

Omit

<FeeWaiver>

N

1

1

Indicates whether to waive any web service fee set up on Thredd. Options are:

0 = No;

1= Yes, waive all fees, on “from” and “to” card

2 = Waive the fee on the “from” card only.

3 = Waive the fee on the “to” card only.

Default is 0.

Optional

Omit

<BrnCode>

AN

8

8

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

Optional

Omit

<Fee>

D

1

9

Allows you to override the configured fee for specific transfers.

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

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_BalanceTransfer>
         <hyp:WSID>2021123456789</hyp:WSID>
         <hyp:IssCode>PMT</hyp:IssCode>
         <hyp:TxnCode>7</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:NewPAN></hyp:NewPAN>
         <hyp:NewToken>987654321</hyp:NewToken>
         <hyp:AmtTxn>10</hyp:AmtTxn>
         <hyp:CurrCode>GBP</hyp:CurrCode>
         <hyp:LoadSrc>10</hyp:LoadSrc>
         <hyp:Description>Test Balance Transfer</hyp:Description >
         <hyp:LoadedBy>Agent Grey</hyp:LoadedBy >
         <hyp:FeeWaiver>0</hyp:FeeWaiver >
      </hyp:Ws_BalanceTransfer>
   </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_BalanceTransferResponse xmlns="http://www.globalprocessing.ae/HyperionWeb">
         <Ws_BalanceTransferResult>
            <WSID>2021123456789</WSID>
            <IssCode>PMT</IssCode>
            <TxnCode>7</TxnCode>
            <PublicToken>123456789</PublicToken>
            <LocDate>2021-01-01</LocDate>
            <LocTime>120000</LocTime>
            <NewPAN>9876543219876543</NewPAN>
            <ClientCode>0</ClientCode>
            <SysDate>2021-01-01</SysDate>
            <ActionCode>000</ActionCode>
            <AvlBal>10</AvlBal>
            <BlkAmt>0</BlkAmt>
            <AmtTxn>10</AmtTxn>
            <CurCode>GBP</CurCode>
            <ItemID>1234</ItemID>
            <WebServiceResult/>
         </Ws_BalanceTransferResult>
      </Ws_BalanceTransferResponse>
   </soap:Body>
</soap:Envelope>