Update Cardholder Details (V2)
API: Ws_Update_Cardholder_Details_V2
This web service updates the details of a cardholder.
This web service is an enhancement to Ws_Update_Cardholder_Details
(see Update Cardholder Details (V1). It allows you to update additional cardholder details, such as EmbossLine4
, ProductRef andThermalLine1
.
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 |
<PublicToken> |
AN |
1 |
9 |
The card’s public token, Mandatory in request if |
Conditional |
Mandatory |
<DOB> |
YYYY-MM- DD |
10 |
10 |
Date of Birth. Mandatory if value of |
Conditional |
Omit |
<CVV> |
AN |
3 |
3 |
Card Verification Value |
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 |
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 |
<lastName> |
AN |
1 |
20 |
Cardholder's last name for authenticating the cardholder if the value of |
C |
Omit |
<middleName> |
AN |
1 |
100 |
Cardholder's middle name. The Only available in V2 |
Optional |
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 and the value of |
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 |
Conditional |
Omit |
<postcode> |
AN |
1 |
10 |
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 |
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 |
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 |
Conditional |
Omit |
<Workpostcode> |
AN |
1 |
10 |
Work postcode. Mandatory if |
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 |
Conditional |
Omit |
<Worktel> |
AN |
1 |
20 |
Work telephone number. See Processing of Phone Numbers. |
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 |
<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 |
<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 |
<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 |
<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 |
Conditional |
Omit |
<dlvmiddleName> |
AN |
1 |
50 |
Delivery middle name. Only available in V2 |
Optional |
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 |
Conditional |
Omit |
<dlvpostcode> |
AN |
1 |
10 |
Delivery postcode. Mandatory if |
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 |
Conditional |
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 |
<ProductRef> |
AN |
1 |
50 |
The card manufacturer's card design reference. Also known as PRODUCT_REF in the XML file sent to the card manufacturer. Note: This field serves dual purposes and can also be used during mobile wallet tokenisation, to specify which card profile (image artwork and terms and conditions) the card scheme should use. For details, see the Tokenisation Service Guide. |
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 |
<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 |
<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 |
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. |
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 |
<Fulfil1> |
AN |
1 |
50 |
Free text field for transferring extra information to the card manufacturer, for example, to be printed on the Carrier. Identifies the FULFIL1 field in the XML file sent to the card manufacturer. |
Optional |
Omit |
<Fulfil2> |
AN |
1 |
50 |
Free text field for transferring extra information to the card manufacturer, for example, to be printed on the Carrier. Identifies the FULFIL2 field in the XML file sent to the card manufacturer. |
Optional |
Omit |
<ThermalLine1> |
AN |
1 |
120 |
Free text field for transferring extra information to be printed on the card. For example, to add a customer service phone number. |
Optional |
Omit |
<ThermalLine2> |
AN |
1 |
70 |
Free text field for transferring extra information to be printed on the card. For example, to add a link to your service terms and conditions. |
Optional |
Omit |
<EmbossLine4> |
AN |
1 |
27 |
The card’s embossed line 4 on the front of the card. Could be used for example, to add an account number or sort code. |
Optional |
Omit |
<LogoFrontId> |
AN |
1 |
30 |
Reference which identifies the card manufacturer's logo file that is printed on the face of the card. |
Optional |
Omit |
<LogoBackId> |
AN |
1 |
30 |
Reference which identifies the card manufacturer's logo file that is printed on the back of the card, if supported. |
Optional |
Omit |
<Delv_Code> |
AN |
1 |
12 |
The delivery code for the card. If specified, the card manufacturer sends all cards with the same delivery code to the specified delivery address. |
Optional |
Omit |
<Url> |
AN |
1 |
100 |
This value is included in the Thredd Card Generation file, in the For details, see the Card Generation Interface Specifications. |
Optional |
Omit |
<OptOut> |
Boolean |
1 |
1 |
Flag for opting out of Visa Account Updater (VAU) or the Automatic Billing Updater (ABU) service for Mastercard. |
Optional |
Omit |
<OOBAppURL> |
AN |
1 |
2048 |
Out Of Band app URL used in a 3D Secure authentication session. The Card Scheme (e.g., Mastercard) requires issuers using Out of Band/Biometric authentication to support the automatic redirection of cardholders from the merchant app to the authenticator app. OOBAppURL is the URL of this authenticator app. |
Optional |
Omit |
Clearing field values
The following fields may have their values cleared by sending a <space>:
Title lastName middleName firstName addr1 addr2 addr3 city county postcode country |
tel userdata workAddr1 workAddr2 workAddr3 workcity workcounty workpostcode workcountry worktel |
maritalStatus sex userdata1 userdata2 userdata3 userdata4 fax mobTel embossName |
imageID VanityName dlvpostcode dlvaddr1 dlvaddr2 dlvaddr3 dlvcity dlvcountry EmbossLine4 Fulfil1 |
Fulfil2 ProductRef ThermalLine1 ThermalLine2
|
Request
<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_V2>
<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:PublicToken>123456789</hyp:PublicToken>
<hyp:DOB></hyp:DOB>
<hyp:CVV></hyp:CVV>
<hyp:accCode></hyp:accCode>
<hyp:newAccCode></hyp:newAccCode>
<hyp:lastName></hyp:lastName>
<hyp:middleName></hyp:middleName>
<hyp:Title></hyp:Title>
<hyp:firstName></hyp:firstName>
<hyp:addr1></hyp:addr1>
<hyp:addr2></hyp:addr2>
<hyp:addr3></hyp:addr3>
<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: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:discret></hyp:discret>
<hyp:userdata></hyp:userdata>
<hyp:userdata1></hyp:userdata1>
<hyp:userdata2></hyp:userdata2>
<hyp:userdata3></hyp:userdata3>
<hyp:userdata4></hyp:userdata4>
<hyp:imageID></hyp:imageID>
<hyp:brncode></hyp:brncode>
<hyp:dlvMethod></hyp:dlvMethod>
<hyp:itemSrc>2</hyp:itemSrc>
<hyp:dlvTitle></hyp:dlvTitle>
<hyp:dlvfirstName></hyp:dlvfirstName>
<hyp:dlvmiddleName></hyp:dlvmiddleName>
<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:crdprogram></hyp:crdprogram>
<hyp:ProductRef></hyp:ProductRef>
<hyp:isoLang></hyp:isoLang>
<hyp:SmsBalance>0</hyp:SmsBalance>
<hyp:CustAccount></hyp:CustAccount>
<hyp:VanityName></hyp:VanityName>
<hyp:CarrierType></hyp:CarrierType>
<hyp:Fulfil1></hyp:Fulfil1>
<hyp:Fulfil2></hyp:Fulfil2>
<hyp:ThermalLine1></hyp:ThermalLine1>
<hyp:ThermalLine2></hyp:ThermalLine2>
<hyp:EmbossLine4></hyp:EmbossLine4>
<hyp:LogoFrontId></hyp:LogoFrontId>
<hyp:LogoBackId></hyp:LogoBackId>
<hyp:Delv_Code></hyp:Delv_Code>
<hyp:Url></hyp:Url>
<hyp:OptOut>1</hyp:OptOut>
<hyp:OOBAppURL>https://login.app.bank1.com/</hyp:OOBAppURL>
</hyp:Ws_Update_Cardholder_Details_V2>
</soapenv:Body>
</soapenv:Envelope>
Response
<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_Details_V2Response xmlns="http://www.globalprocessing.ae/HyperionWeb">
<Ws_Update_Cardholder_Details_V2Result>
<WSID>2021123456789</WSID>
<IssCode>PMT</IssCode>
<TxnCode>13</TxnCode>
<ClientCode/>
<PublicToken>123456789</PublicToken>
<SysDate>2020-08-01</SysDate>
<ActionCode>000</ActionCode>
</Ws_Update_Cardholder_Details_V2Result>
</Ws_Update_Cardholder_Details_V2Response>
</soap:Body>
</soap:Envelope>