Update Cardholder Details (V1)

API: Ws_Update_Cardholder_Details

This web service allows you to update cardholder details, such as: name and address.

You can also use Ws_Update_Cardholder_Details_V2, which provides additional fields. See Update Cardholder Details (V2).

You must use Ws_Update_Cardholder_Details_V2 if you want to update the card profile ID (ProductRef field) used for card tokenisation.

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

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

<newAccCode>

AN

0

6

The new access code for the card.

This can be updated by the primary card and by additional cards that share the same customer record. If provided, must be 6 digits, leading zeroes are acceptable. Leave empty if not required.

Optional

Omit

<crdProduct>

AN

4

4

Card product associated with the card. Legacy field. Will always be blank.

Optional

Conditional

<lastName>

AN

1

20

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

C

Omit

<Title>

AN

1

4

Cardholder’s title. This can be updated by the primary card and by additional cards that share the same customer record.

Optional

Omit

<firstName>

AN

1

20

Cardholder's first name. Also used as the card purchaser's first name if no delivery address is supplied. Mandatory if <lastName> is present

and the value of <AuthType> is not ‘6’.

Conditional

Omit

<addr1>

AN

1

50

Cardholder's address line 1. Also used as the card purchaser's address line 1 if no delivery address is supplied. Mandatory if ‘Address’ fields are specified.

Conditional

Omit

<addr2>

AN

1

50

Cardholder's address line 2. Also used as the card purchaser's address line 2 if no delivery address is supplied.

Optional

Omit

<addr3>

AN

1

50

Cardholder's address line 3. Also used as the card purchaser's address line 3 if no delivery address is supplied.

Optional

Omit

<city>

AN

1

50

Cardholder's home city. Also used as the card purchaser's city if no delivery address is supplied. Mandatory if <addrL1> is present, and <postcode> is not present.

Conditional

Omit

<postcode>

AN

1

10

Cardholder's home postcode. Also used as the card purchaser's postcode if no postcode is supplied. Mandatory if <addrL1> is present, and <city> is not present. See Postcode Permitted Characters.

Conditional

Omit

<country>

AN

1

3

Cardholder’s country of residence. This is represented as a 3 digit ISO country code (e.g. 826 for UK). Mandatory if <addrL1> is present.

Conditional

Omit

<tel>

AN

1

20

Telephone number. See Processing of Phone Numbers.

Optional

Omit

<Workaddr1>

AN

1

35

Work address line 1. Mandatory if work address fields are being specified. If set to <space>, then clears all work address fields.

Conditional

Omit

<Workaddr2>

AN

1

35

Work address line 2.

Optional

Omit

<Workaddr3>

AN

1

35

Work address line 3.

Optional

Omit

<Workcity>

AN

1

15

Work city. Mandatory if <workAddrL1> is present, and <workPostcode> is not present.

Conditional

Omit

<Workpostcode>

AN

1

10

Work postcode. Mandatory if <addrL1> is present, and <workCity> is not present. See Postcode Permitted Characters.

Conditional

Omit

<Workcounty>

AN

1

20

Work county.

Optional

Omit

<Workcountry>

AN

1

3

Work country of residence. This is represented as a 3 digit ISO country code (e.g. 826 for UK). Mandatory if <workAddrL1> is present.

Conditional

Omit

<Worktel>

AN

1

20

Work telephone number. See Processing of Phone Numbers.

Optional

Omit

<pobox>

AN

1

8

Post office box number.

Optional

Omit

<email>

AN

1

64

Email address of the cardholder.

Optional

Omit

<fax>

AN

1

20

Fax number.

Optional

Omit

<mobTel>

AN

1

25

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

Optional

Omit

<maritalStatus>

AN

1

1

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

Optional

Omit

<sex>

AN

1

1

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

Optional

Omit

<embossName>

AN

1

27

Name embossed on the card. Note that actual embossed name does not change until the card is re-issued. This can be updated by the primary card and by additional cards that share the same customer record.

Optional

Omit

<refuseCheck>

AN

1

1

Whether cheques should be refused.

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

Optional

Omit

<mailShots>

AN

1

1

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

For customer use only. Thredd ignore this field.

Optional

Omit

<discret>

AN

1

25

Discretionary data, for information only.

Optional

Omit

<userdata>

AN

1

30

Cardholder information stored at card level, free text field.

Optional

Omit

<userdata1>

AN

1

12

Cardholder information stored at member level, free text field.

Optional

Omit

<userdata2>

AN

1

12

Cardholder information stored at member level, free text field.

Optional

Omit

<userdata3>

AN

1

12

Cardholder information stored at member level, free text field.

Optional

Omit

<userdata4>

AN

1

32

Cardholder information stored at member level, free text field.

Optional

Omit

<pin>

AN

1

1

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

This can be updated by the primary card and by additional cards that share the same member record.

Note: Updating this value to reflect that the card has a PIN does not trigger a PIN-generation request. The update must be initiated by another means. An update from 0 to 1 means that a PIN may be requested.

Optional

Omit

<imageID>

AN

1

16

ID of the card manufacturer image to be printed on the card. This can be updated by the primary card and by additional cards that share the same member record.

Optional

Omit

<brncode>

AN

8

8

Branch code (or Agent code) with which the card is associated. This can be updated by the primary card and by additional cards that share the same member record.

Optional

Omit

<renew>

AN

1

1

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

Note: The value is stored,but currently not used. Future feature.

Optional

Omit

<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

Optional

Omit

<denyMCC>

AN

1

192

List of MCC’s (merchant category codes) that should be 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.

Note: For legacy use only.

Optional

Omit

<denySvc>

AN

1

64

(missing or bad snippet)

Optional

Omit

<accType>

AN

2

2

Type of card account. See Account Types.

Optional

Omit

<memo>

AN

1

4096

Add a memo to the customer details that will be visible to CSR’s on the GUI application.

Optional

Omit

<memoScope>

N

1

3

Scope of visibility for the memo.

0 – full visibility (any user logged in to the GUI application is able to view this memo).

To set more restrictive scopes, the Member and Thredd must agree the value for each level before using it here.

Default value as 0.

Mandatory

Omit

<memoUser>

AN

1

15

The user that created the memo.

Optional

Omit

<itemSrc>

N

1

5

Source field to define alternate fees. Legacy field for information purposes only; see Item Source Types. Suggest using 0.

Mandatory

Omit

<dlvTitle>

AN

4

16

Delivery address title.

Optional

Omit

<dlvfirstName>

AN

1

20

Delivery first name. Mandatory if <dlvLastName> is present.

Conditional

Omit

<dlvlastName>

AN

1

20

Delivery last name.

Mandatory if delivery name fields are being specified.

Conditional

Omit

<dlvaddr1>

AN

1

50

Delivery address line 1.

Mandatory if delivery address fields are being specified.

Conditional

Omit

<dlvaddr2>

AN

1

50

Delivery address line 2.

Optional

Omit

<dlvaddr3>

AN

1

50

Delivery address line 3.

Optional

Omit

<dlvcity>

AN

1

50

Delivery city. Mandatory if <dlvAddrL1> is present, and <dlvPostcode> is not present.

Conditional

Omit

<dlvpostcode>

AN

1

10

Delivery postcode. Mandatory if <dlvAddrL1> is present, and <dlvCity> is not present. See Postcode Permitted Characters.

Conditional

Omit

<dlvcounty>

AN

1

20

Delivery county.

Optional

Omit

<dlvcountry>

AN

1

3

Card purchaser's /delivery address country 3-digit ISO country code (e.g., 826 for UK). Mandatory if <dlvAddrL1> is present.

Conditional

Omit

<dlvtel>

AN

1

20

Delivery telephone number.

Optional

Omit

<dlvEffDate>

YYYY-MM-DD

10

10

Date at which delivery name and/or address becomes effective. If not specified, the current date is used as the effective date.

Optional

Omit

<dlvDaysValid>

N

1

3

No longer used. Set to 0.

Mandatory

Omit

<crdprogram>

AN

1

6

Pre-defined program reference code associated with the card. This can be updated by the primary card and by additional cards that share the same customer record.

Optional

Omit

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

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

<feeTier>

AN

1

3

The fee tier based on which fees are charged for the card.

Optional

Omit

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

Optional

Omit

<fundcrdPAN>

AN

13

19

PAN of source-of-funds card.

Reserved for future use. DO NOT USE

Optional

Omit

<fundCrdEffDate>

YYYY-MM-DD

10

10

Start Date of source-of-funds card.

Reserved for future use. DO NOT USE

Optional

Omit

<fundCrdExpDate>

YYYY-MM-DD

10

10

Expiry Date of source-of-funds card.

Reserved for future use. DO NOT USE

Optional

Omit

<fundCrdType>

AN

1

15

Type of card used as source of funds:

MC = MasterCard

VISA = Visa

DELTA =Visa Debit/Delta

SWITCH = UK Maestro

MASTRO = International Maestro

SOLO = Solo

AMEX = American Express

Reserved for future use. DO NOT USE

Optional

Omit

<fundCrdIssNum>

N

1

2

Issuer number of source of card funds.

Reserved for future use. Set to 0.

Mandatory

Omit

<fundCrdCVC>

N

3

4

Card verification code of source of card funds.

Reserved for future use. Set to 0.

Mandatory

Omit

<SmsBalance>

N

1

1

Whether to send an SMS regarding the details of transaction amount and available balance to the customer after each card use. 0 or False = Do not send; 1 or True = Send; 2 = Do not change current value.

Mandatory

Omit

<CustAccount>

AN

1

25

Client reference for the card.

Optional

Omit

< VanityName>

AN

1

32

Enables you to add an additional alternative form of title to the card, e.g. “Company Director”. Can appear on Embossed Line 4, or Thermal Line 1 and Thermal Line 2, if configured in Smart Client, and be recorded in the card purchaser details.

Optional

Omit

< CarrierType>

AN

1

30

The Carrier Product design reference as used by the Card Manufacturer. This is the letter onto which the card is attached when sent to the cardholder. Identifies the Carrier Product type of the Card Manufacturer.

Optional

Omit

<Url>

AN

1

100

This value is included in the Thredd Card Generation file, in the <QRCode> field. For example: https://www.your-e-card.com/balance/2909680989632389

For details, see the Card Generation Interface Specifications.

Optional

Omit

Service Details

Tag

Type

Minimum Length

Maximum Length

Description

Request

Response

<svcSrc>

N

1

2

RESERVED FOR FUTURE USE
Source of the service. Please use the value 4 (has no effect)

Mandatory

Omit

<svcType>

N

1

3

RESERVED FOR FUTURE USE
The service type. Please use the value 1 (has no effect)

Mandatory

Omit

<svcStatus>

N

1

1

RESERVED FOR FUTURE USE

The service status associated with <SMSSVCTYPE>. Please use the value 1 (has no effect)

Mandatory

Omit

Clearing Field Values

The following fields can have their values cleared by sending a <space>:

Title

lastName

firstName

addr1

addr2

addr3

city

county

postcode

country

tel

userdata

workAddr1

workAddr2

workAddr3

workcity

workcounty

workpostcode

workcountry

worktel

maritalStatus

sex

userdata1

userdata2

userdata3

userdata4

email

fax

mobTel

embossName

imageID

VanityName

dlvpostcode

dlvaddr1

dlvaddr2

dlvaddr3

dlvcity

dlvcountry

EmbossLine4

Fulfil1

Fulfil2

ProductRef

ThermalLine1

ThermalLine2

 

 

 

 

 

 

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_Update_Cardholder_Details>
         <hyp:WSID>2021123456789</hyp:WSID>
         <hyp:IssCode>PMT</hyp:IssCode>
         <hyp:TxnCode>13</hyp:TxnCode>
         <hyp:ClientCode></hyp:ClientCode>
         <hyp:AuthType>1</hyp:AuthType>
         <hyp:PAN></hyp:PAN>
         <hyp:Track2></hyp:Track2>
         <hyp:DOB></hyp:DOB>
         <hyp:CVV></hyp:CVV>
         <hyp:accCode></hyp:accCode>
         <hyp:newAccCode></hyp:newAccCode>
         <hyp:crdProduct></hyp:crdProduct>
         <hyp:lastName></hyp:lastName>
         <hyp:Title></hyp:Title>
         <hyp:firstName></hyp:firstName>
         <hyp:addr1></hyp:addr1>
         <hyp:addr2></hyp:addr2>
         <hyp:city></hyp:city>
         <hyp:postcode></hyp:postcode>
         <hyp:country></hyp:country>
         <hyp:tel></hyp:tel>
         <hyp:Workaddr1>Office 13, Telfords Yard</hyp:Workaddr1>
         <hyp:Workaddr2>6-8 The Highway, Wapping </hyp:Workaddr2>
         <hyp:Workaddr3></hyp:Workaddr3>
         <hyp:Workcity>London</hyp:Workcity>
         <hyp:Workpostcode>E1W 2BS</hyp:Workpostcode>
         <hyp:Workcounty></hyp:Workcounty>
         <hyp:Workcountry>826</hyp:Workcountry>
         <hyp:Worktel></hyp:Worktel>
         <hyp:pobox></hyp:pobox>
         <hyp:email></hyp:email>
         <hyp:fax></hyp:fax>
         <hyp:mobTel></hyp:mobTel>
         <hyp:maritalStatus>M</hyp:maritalStatus>
         <hyp:sex>M</hyp:sex>
         <hyp:embossName></hyp:embossName>
         <hyp:refuseCheck></hyp:refuseCheck>
         <hyp:mailShots></hyp:mailShots>
         <hyp:discret></hyp:discret>
         <hyp:userdata></hyp:userdata>
         <hyp:userdata1></hyp:userdata1>
         <hyp:userdata2></hyp:userdata2>
         <hyp:userdata3></hyp:userdata3>
         <hyp:userdata4></hyp:userdata4>
         <hyp:pin></hyp:pin>
         <hyp:imageID></hyp:imageID>
         <hyp:brncode></hyp:brncode>
         <hyp:renew></hyp:renew>
         <hyp:dlvMethod></hyp:dlvMethod>
         <hyp:denyMCC></hyp:denyMCC>
         <hyp:denySvc></hyp:denySvc>
         <hyp:accType></hyp:accType>
         <hyp:memo></hyp:memo>
         <hyp:memoScope>0</hyp:memoScope>
         <hyp:memoUser></hyp:memoUser>
         <hyp:itemSrc>2</hyp:itemSrc>
         <hyp:dlvTitle></hyp:dlvTitle>
         <hyp:dlvfirstName></hyp:dlvfirstName>
         <hyp:dlvlastName></hyp:dlvlastName>
         <hyp:dlvaddr1></hyp:dlvaddr1>
         <hyp:dlvaddr2></hyp:dlvaddr2>
         <hyp:dlvaddr3></hyp:dlvaddr3>
         <hyp:dlvcity></hyp:dlvcity>
         <hyp:dlvpostcode></hyp:dlvpostcode>
         <hyp:dlvcounty></hyp:dlvcounty>
         <hyp:dlvcountry></hyp:dlvcountry>
         <hyp:dlvtel></hyp:dlvtel>
         <hyp:dlvEffDate></hyp:dlvEffDate>
         <hyp:dlvDaysValid>0</hyp:dlvDaysValid>
         <hyp:crdprogram></hyp:crdprogram>
         <hyp:crddesign></hyp:crddesign>
         <hyp:feeTier></hyp:feeTier>
         <hyp:isoLang></hyp:isoLang>
         <hyp:fundcrdPAN></hyp:fundcrdPAN>
         <hyp:fundCrdEffDate></hyp:fundCrdEffDate>
         <hyp:fundCrdExpDate></hyp:fundCrdExpDate>
         <hyp:fundCrdType>1</hyp:fundCrdType>
         <hyp:fundCrdIssNum>1</hyp:fundCrdIssNum>
         <hyp:fundCrdCVC>1</hyp:fundCrdCVC>
         <hyp:svcSrc>1</hyp:svcSrc>
         <hyp:svcType>1</hyp:svcType>
         <hyp:svcStatus>1</hyp:svcStatus>
         <hyp:PublicToken>123456789</hyp:PublicToken>
         <hyp:SmsBalance>0</hyp:SmsBalance>
         <hyp:Url></hyp:Url>
      </hyp:Ws_Update_Cardholder_Details>
   </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_Update_Cardholder_DetailsResponse xmlns="http://www.globalprocessing.ae/HyperionWeb">
         <Ws_Update_Cardholder_DetailsResult>
            <WSID>2021123456789</WSID>
            <IssCode>PMT</IssCode>
            <TxnCode>13</TxnCode>
            <ClientCode/>
            <PublicToken>123456789</PublicToken>
            <CrdProduct/>
            <SysDate>2013-01-01</SysDate>
            <ActionCode>000</ActionCode>
         </Ws_Update_Cardholder_DetailsResult>
      </Ws_Update_Cardholder_DetailsResponse>
   </soap:Body>
</soap:Envelope>