Cardholder Details Enquiry

API: Ws_CardHolder_Details_Enquiry and Ws_CardHolder_Details_Enquiry_V2

This web service returns the details of a cardholder.

V2 of this web service has some additional parameters and does not return the details of archived cards. See below.

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

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

<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

Mandatory

<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

<CrdProduct>

AN

4

4

Card product associated with the card. Legacy field.

Omit

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.

Not available in V2.

Conditional

Conditional

<CustAccount>

AN

1

25

Cardholder account number or reference number. You can use this reference to find the cards linked to a cardholder. Also displayed in Smart Client and in Thredd Portal as Customer Reference.

Only available in V2

Omit

Optional

<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

<LastName>

AN

1

20

Cardholder's last name for authenticating the cardholder if the value of <AuthType> is ‘6’.

Conditional

Mandatory

<StatCode>

AN

2

3

The status code of the card. See Status Codes.

Omit

Mandatory

<Title>

AN

1

4

Cardholder’s title.

Omit

Optional

<MiddleName>

AN

1

100

Cardholder's middle name. The <MiddleName> is not part of the <EmbossName> and therefore, does not check manufacture-approved characters. If a delivery address is not supplied, the cardholder's middle name will be the card purchaser's middle name.

Only available in V2

Omit

Optional

<FirstName>

AN

1

20

Cardholder’s first name.

Omit

Optional

<Addrl1>

AN

1

50

Address line 1.

Omit

Optional

<Addrl2>

AN

1

50

Address line 2.

Omit

Optional

<Addrl3>

AN

1

50

Address line 3.

Only available in V2

Omit

Optional

<City>

AN

1

50

City.

Omit

Optional

<PostCode>

AN

1

10

Postcode.

Omit

Optional

<Country>

AN

1

3

Cardholder’s country of residence. This is represented as a 3 digit ISO country code (e.g. 826 for UK).

Omit

Optional

<Tel>

AN

1

20

Telephone number. See Processing of Phone Numbers.

Omit

Optional

<WorkAddrl1>

AN

1

35

Work address line 1.

Omit

Optional

<WorkAddrl2>

AN

1

35

Work address line 2.

Omit

Optional

<WorkAddrl3>

AN

1

35

Work address line 3.

Omit

Optional

<WorkCity>

AN

1

15

Work city.

Omit

Optional

<WorkPostCode>

AN

1

10

Work postcode.

Omit

Optional

<WorkCounty>

AN

1

20

Work county.

Omit

Optional

<WorkCountry>

AN

1

3

Work country of residence. This is represented as a 3 digit ISO country code (e.g. 826 for UK).

Omit

Optional

<WorkTel>

AN

1

20

Work telephone number. See Processing of Phone Numbers.

Omit

Optional

<EMail>

AN

1

64

Email address of the cardholder.

Omit

Optional

<Fax>

AN

1

20

Fax number.

Omit

Optional

<PObox>

AN

1

8

Post office box number.

Omit

Optional

<MobTel>

AN

1

20

Cardholder’s mobile phone number (including dialing code if applicable). See Processing of Telephone Numbers.

Omit

Optional

<MaritalStatus>

AN

1

1

Marital status: S= single; M= married; D = divorced; W = widowed; space = not specified.

Omit

Optional

<Sex>

AN

1

1

Gender: M = male; F= female; space= Not specified.

Omit

Optional

<AccNo>

AN

1

28

Account number of the card.

Not available in V2.

Omit

Optional

<EmbossName>

AN

1

27

Name embossed on the card.

Omit

Optional

<RefuseCheck>

AN

1

1

Whether cheques should be refused.

0 = No; 1= Yes. For customer use only. Thredd ignore this field.

Omit

Optional

<MailShots>

AN

1

1

Whether the cardholder accepts mailshots or member contact. 0 = No; 1 = Yes

For customer use only. Thredd ignore this field.

Omit

Optional

<Discret>

AN

1

25

Discretionary data, for customer use only. Thredd ignores this field.

Omit

Optional

<UsrData>

AN

1

30

Cardholder information stored at card level, free text field. For customer use only. Thredd ignores this field.

Omit

Optional

<UsrData1>

AN

1

12

Cardholder information stored at member level, free text field. For customer use only. Thredd ignores this field.

Omit

Optional

<UsrData2>

AN

1

12

Cardholder information stored at member level, free text field. For customer use only. Thredd ignores this field.

Omit

Optional

<UsrData3>

AN

1

12

Cardholder information stored at member level, free text field. For customer use only. Thredd ignores this field.

Omit

Optional

<UsrData4>

AN

1

32

Cardholder information stored at member level, free text field. Thredd ignores this field.

Omit

Optional

<CurrCode>

AN

1

3

3-letter ISO currency code for the account billing currency.

Omit

Optional

<ExpDate>

YYYY-MM-DD

10

10

Expiry date of the card in YYYY-MM-DD format. This is the Thredd expiry date. If the Thredd expiry date is not set, this is the expiry date printed on the card.

Omit

Optional

<EffDate>

YYYY-MM-DD

10

10

The issue date of the card. If the issue date is not set, then is the <DateCreated>.

Omit

Optional

<SvcCode>

AN

1

3

Card Service CodeClosed 3 digit code on the magnetic strip of a card which indicates where it is valid for use.. The three-digit number which indicates where the card is valid for use.

Omit

Optional

<AdditionalNo>

N

1

1

Number of additional cards. Zero indicates the card is a primary card. Currently always set to 0.

Reserved for future use.

Omit

Optional

<DateCreated>

YYYY-MM-DD

10

10

The date created, or the issue date of the card if this is set.

Omit

Optional

<DateActivated>

YYYY-MM-DD

10

10

Date the card was activated in the system.

Omit

Optional

<CrdDesign>

AN

1

50

The card manufacturer's card design reference. Also known as PRODUCT_REF in the XML file sent to the card manufacturer.

Omit

Optional

<PIN>

AN

1

1

Indicates whether the card should have a PIN: 0=No; 1=Yes

Reserved for future use

Omit

Optional

<DlvMethod>

AN

1

1

The delivery method for the card. Options include:

0 = Standard delivery;

1 = Registered mail;

2 = Direct delivery;

3 = Customized DelvMethod 1;

4 = Customized DelvMethod 2;

5 = Customized DelvMethod 3;

6= Customized DelvMethod 4;

7 = Customized DelvMethod 5;

Default value is 0

Omit

Optional

<ImageID>

AN

1

16

Reference which identifies the card manufacturer's image file that is printed on the face of the card.

Omit

Optional

<BrnCode>

AN

8

8

Branch code (or Agent code) with which the card is associated.

Omit

Optional

<ReNew>

AN

1

1

Indicates whether the card should be renewed on expiry: 0= No; 1= Yes.

Omit

Optional

<DenyMCC>

AN

1

192

List of MCC’s (merchant category codes) that are denied for the card. MCC’s can be comma-separated, specified as a range, or combinations of both(e.g., 4546,5462,5667-5673,5957). These restrictions are in addition to MCC restrictions defined at the card product level.

Legacy field. Do not use.

Omit

Optional

<DenySVC>

AN

1

64

(missing or bad snippet)

Omit

Optional

<AccType>

AN

2

2

Type code for the account associated with the card.

Legacy field. Not used.

Omit

Optional

<CVC2>

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.

Omit

Conditional

<DlvTitle>

AN

4

16

Delivery address title.

Omit

Optional

<DlvFirstName>

AN

1

20

Delivery first name.

Omit

Optional

<DlvMiddleName>

AN

1

50

Delivery middle name.

Only available in V2

Omit

Optional

<DlvLastName>

AN

1

20

Delivery last name.

Omit

Optional

<DlvAddrL1>

AN

1

50

Delivery address line 1.

Omit

Optional

<DlvAddrL2>

AN

1

50

Delivery address line 2.

Omit

Optional

<DlvAddrL3>

AN

1

50

Delivery address line 3.

Omit

Optional

<DlvCity>

AN

1

50

Delivery city.

Omit

Optional

<DlvPostcode>

AN

1

10

Delivery Post code

Only available in V2.

Omit

Optional

<DlvCounty>

AN

1

20

Card purchaser's /delivery address county.

Omit

Optional

<DlvCountry>

AN

1

3

Card purchaser's /delivery address country 3-digit ISO country code (e.g., 826 for UK).

Omit

Optional

<DlvTel>

AN

1

20

Delivery telephone number.

Omit

Optional

<DlvEffDate>

YYYY-MM-DD

10

10

Date at which the delivery name and/or address became effective. If not present, the current date is the effective date.

Legacy field. Not used.

Omit

Optional

<DlvExpDate>

YYYY-MM-DD

10

10

Date after which the delivery name and/or address expires. Mandatory if name and/or address delivery fields are present.

Legacy field. Not used.

Omit

Optional

<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

<IsoLang>

AN

2

2

The language code in ISO 639-1 format. The language is used for card mailers, and also used if bespoke SMS templates are set up.

Omit

Optional

<OptOut>

AN

4

5

Indicator for opting out of Visa Account Updater (VAU) or the Automatic Billing Updater (ABU) service for Mastercard.

Only available in V2

Omit

Mandatory

Request

Copy
<?xml version="1.0" encoding="UTF-8"?>
<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_CardHolder_Details_Enquiry>
         <hyp:WSID>12345678</hyp:WSID>
         <hyp:IssCode>PMT</hyp:IssCode>
         <hyp:TxnCode>13</hyp:TxnCode>
         <hyp:LocDate>2021-02-17</hyp:LocDate>
         <hyp:LocTime>094300</hyp:LocTime>
         <hyp:AuthType>1</hyp:AuthType>
         <hyp:PAN />
         <hyp:Track2 />
         <hyp:PublicToken>123456789</hyp:PublicToken>
         <hyp:DOB />
         <hyp:CVV />
         <hyp:AccCode />
         <hyp:ClientCode />
         <hyp:ItemSrc>0</hyp:ItemSrc>
         <hyp:LastName />         
      </hyp:Ws_CardHolder_Details_Enquiry>
   </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_CardHolder_Details_EnquiryResponse xmlns="http://www.globalprocessing.ae/HyperionWeb">
         <Ws_CardHolder_Details_EnquiryResult>
            <WSID>2021123456789678</WSID>
            <IssCode>PMT</IssCode>
            <TxnCode>13</TxnCode>
            <LocDate>2021-02-17</LocDate>
            <LocTime>094300</LocTime>
            <ClientCode/>
            <PublicToken>123456789</PublicToken>
            <DOB>1990-01-01</DOB>
            <StatCode>00</StatCode>
            <CrdProduct/>
            <Title>Mr</Title>
            <FirstName>Bloggs</FirstName>
            <MiddleName>N</MiddleName>
            <LastName>Joe</LastName>
            <Addrl1>Office 13, The High Street</Addrl1>
            <Addrl2>6-8 Aldgate</Addrl2>
            <City>London</City>
            <PostCode>EC3A 7BB</PostCode>
            <Country>826</Country>
            <Tel/>
            <WorkAddrl1/>
            <WorkAddrl2/>
            <WorkAddrl3/>
            <WorkCity/>
            <WorkPostCode/>
            <WorkCounty/>
            <WorkCountry/>
            <WorkTel/>
            <EMail>joe.bloggs@google.com</EMail>
            <Fax/>
            <POBox>EC3A 7BB</POBox>
            <MobTel/>
            <MaritalStatus/>
            <Sex/>
            <AccNo/>
            <EmbossName>GIFT CARD</EmbossName>
            <RefuseCheck>0</RefuseCheck>
            <MailShots>1</MailShots>
            <Discret/>
            <UsrData/>
            <UsrData1/>
            <UsrData2/>
            <UsrData3/>
            <UsrData4/>
            <CurrCode>GBP</CurrCode>
            <ExpDate>2021-12-31</ExpDate>
            <EffDate>2021-01-19</EffDate>
            <SvcCode>221</SvcCode>
            <AdditionalNo>0</AdditionalNo>
            <DateCreated>2021-01-19</DateCreated>
            <DateActivated>2021-01-20</DateActivated>
            <CrdDesign>PMTPPU</CrdDesign>
            <PIN>0</PIN>
            <DlvMethod>0</DlvMethod>
            <ImageID/>
            <BrnCode/>
            <ReNew>0</ReNew>
            <DenyMCC/>
            <DenySVC/>
            <AccType/>
            <CVC2>554</CVC2>
            <DlvTitle>Mr</DlvTitle>
            <DlvFirstName>Bloggs</DlvFirstName>
            <DlvMiddleName>M</DlvMiddleName>
            <DlvLastName>Joe</DlvLastName>
            <DlvAddrL1>Office 13, The High Street</DlvAddrL1>
            <DlvAddrL2>6-8 Aldgate</DlvAddrL2>
            <DlvAddrL3/>
            <DlvCity>London</DlvCity>
            <DlvCounty/>
            <DlvCountry>826</DlvCountry>
            <DlvTel/>
            <DlvEffDate/>
            <DlvExpDate/>
            <IsoLang/>
            <SysDate>2021-02-17</SysDate>
            <ActionCode>000</ActionCode>
            <OptOut>false</OptOut>            
         </Ws_CardHolder_Details_EnquiryResult>
      </Ws_CardHolder_Details_EnquiryResponse>
   </soap:Body>
</soap:Envelope>