Card Unload and Change Status

API: Ws_UnLoad_StatusChange

This web service simultaneously unloads the card and changes the card status (for example to expired).

if the option dpan_over_fpan = “N” is set for your cards, changing the card's status also updates the status of any linked digital payment tokens. For details, see the Tokenisation Service Guide.

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

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

Conditional

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.

Conditional

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

<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

<StatCode>

AN

2

2

The card status to set the card to (e.g. Lost, Stolen and Destroyed). See Status Code.

Note: You can’t set an MFX card’s status to 98 or 99.

Mandatory

Omit

<Reason>

AN

1

60

Reason for the status change.

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

<ItemSrc>

N

1

5

Source field to define alternate fees. It is used in conjunction with existing fee server Item. See Item Source Types.

Mandatory

Omit

<LoadedBy>

AN

1

30

User who unload amount from the card.

Optional

Omit

<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

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_StatusChange>
         <hyp:WSID>2021123456789</hyp:WSID>
         <hyp:IssCode>PMT</hyp:IssCode>
         <hyp:TxnCode>11</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>5</hyp:AmtUnLoad>
         <hyp:CurCode>GBP</hyp:CurCode>
         <hyp:StatCode>56</hyp:StatCode>
         <hyp:Reason>Unload and Status Change</hyp:Reason>
         <hyp:ItemSrc>2</hyp:ItemSrc>
         <hyp:LoadedBy>Admin</hyp:LoadedBy>
         <hyp:Note>Test unload and status change</hyp:Sms_Required>
      </hyp:Ws_UnLoad_StatusChange>
   </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_UnLoad_StatusChangeResponse xmlns="http://www.globalprocessing.ae/HyperionWeb">
         <Ws_UnLoad_StatusChangeResult>
            <WSID>2021123456789</WSID>
            <IssCode>PMT</IssCode>
            <TxnCode>11</TxnCode>
            <PublicToken>123456789</PublicToken>
            <LocDate>2021-01-01</LocDate>
            <LocTime>120000</LocTime>
            <AmtUnLoad>5</AmtUnLoad>
            <ClientCode/>
            <SysDate>2021-01-01</SysDate>
            <ActionCode>000</ActionCode>
            <AvlBal>17</AvlBal>
            <BlkAmt>1</BlkAmt>
            <ItemID>1234</ItemID>
            <CurCode>GBP</CurCode>
            <WebServiceResult/>
         </Ws_UnLoad_StatusChangeResult>
      </Ws_UnLoad_StatusChangeResponse>
   </soap:Body>
</soap:Envelope>