Card Extend Expiry Date

API: Ws_ExtendExpiry

This web service enables you to change the Thredd expiry date of a card.

The Thredd expiry refers to the expiry date held by Thredd, which is calculated based on the Thredd validity period from the ProductMasterClosed Card product-level master record. This web service does not allow you to change the physical expiry date embossed on the card. The calculation of this date is based on the card validity period from the SchemeMasterClosed Card scheme-level master record. 

The use of this web service is primarily when a scheme operates a shorter validity period within Thredd than the embossed expiry validity period. In this case you can extend the cardholder’s Thredd-held expiry period and potentially charge a fee.

Changing the expiry date also updates the card status to '00' (All Good).

You cannot extend the expiry date of a card which has been set to an irreversible status (such as Stolen or Destroyed); see Status Codes. If the card is in an irreversible status, this web service returns the Action Code 654.

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

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

<LastName>

AN

1

20

Cardholder’s last name.

Optional

Omit

<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 and response if <PAN> and <PublicToken> are not present or when <AuthTyp> is ‘4’.

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 value of <AuthType> is ‘2’. Otherwise, may be supplied for informational purposes or as part of cardholder registration. If age-verification is configured and conditions are met, the <crdProduct> associated with the card is changed. Refer to the <crdProduct> field description in the Cardholder Update message for the impact of this change.

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 for setting a code which is validated during activation (e.g. via the Thredd IVR systemClosed Interactive Voice Response System Typically a telephony-based system, where the user calls in and selects options via an automated voice prompt.). If provided, must be 6 digits; leading zeroes are acceptable. Mandatory if the value of <AuthType> is ‘4’. Leave empty if not required. If <AuthType> is ‘4’, the provided access code is used for activation only; the Thredd stored value will not be updated.

Conditional

Omit

<ExpDate>

YYYY-MM-DD

10

10

New Thredd-held expiry date.

Mandatory

Mandatory

<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

<Reason>

AN

1

60

Reason for the status change.

Optional

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

<CurCode>

AN

3

3

3-letter ISO currency code for the currency (e.g. EUR).

Omit

Mandatory

<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

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_ExtendExpiry>
         <hyp:WSID>2021123456789</hyp:WSID>
         <hyp:IssCode>PMT</hyp:IssCode>
         <hyp:TxnCode>17</hyp:TxnCode>
         <hyp:ClientCode></hyp:ClientCode>
         <hyp:LastName></hyp:LastName>
         <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:ExpDate>2025-03-31</hyp:ExpDate>
         <hyp:LocDate>2021-01-01</hyp:LocDate>
         <hyp:LocTime>120000</hyp:LocTime>
         <hyp:Reason></hyp:Reason>
      </hyp:Ws_ExtendExpiry>
   </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_ExtendExpiryResponse xmlns="http://www.globalprocessing.ae/HyperionWeb">
         <Ws_ExtendExpiryResult>
            <WSID>2021123456789</WSID>
            <IssCode>PMT</IssCode>
            <TxnCode>17</TxnCode>
            <PublicToken>123456789</PublicToken>
            <LocDate>2021-01-01</LocDate>
            <LocTime>120000</LocTime>
            <ExpDate>2025-03-31</ExpDate>
            <ClientCode/>
            <SysDate>2021-01-01</SysDate>
            <ActionCode>000</ActionCode>
            <AvlBal>17</AvlBal>
            <BlkAmt>1</BlkAmt>
            <CurCode>GBP</CurCode>
         </Ws_ExtendExpiryResult>
      </Ws_ExtendExpiryResponse>
   </soap:Body>
</soap:Envelope>