Card Change Status

API: Ws_StatusChange

This web service enables you to change the status of a card, for example to: Do not honor, lost, stolen and Card destroyed. For details see Status Codes.

Changes made to the card's status will also update the status of any linked digital payment tokens if the option dpan_over_fpan = “N” is set for your cards. 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 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 2.

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

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

<NewStatCode>

AN

2

2

New status code to change the card to. See Status Codes.

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

Mandatory

Omit

<Reason>

AN**

1

60

Reason for the status change.

Optional

Omit

<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

<TerminalID>

AN**

1

15

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

Optional

Omit

<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

<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

<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_StatusChange>
         <hyp:WSID>2021123456789</hyp:WSID>
         <hyp:IssCode>PMT</hyp:IssCode>
         <hyp:TxnCode>2</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:NewStatCode>00</hyp:NewStatCode>
         <hyp:Reason></hyp:Reason>
         <hyp:ItemSrc>2</hyp:ItemSrc>
         <hyp:TerminalID></hyp:TerminalID>
      </hyp:Ws_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_StatusChangeResponse xmlns="http://www.globalprocessing.ae/HyperionWeb">
         <Ws_StatusChangeResult>
            <WSID>2021123456789</WSID>
            <IssCode>PMT</IssCode>
            <TxnCode>2</TxnCode>
            <PublicToken>123456789</PublicToken>
            <WebServiceResult/>    
        </Ws_StatusChangeResult>
      </Ws_StatusChangeResponse>
  </soap:Body>
</soap:Envelope>