Appendix D: Card Details Fields
The table below lists the Card Details field values and provides additional information where applicable. You can edit the cardholder details and change the rules governing card acceptance methods using the Edit Card Details option. The different types of Card Acceptance Methods available in the form of Usage Groups are set up using Edit Card Configuration.
For more information, read Card Actions and Appendix C: Usage Groups.
Cardholder Details
You can edit the cardholder details using the APIs:
- For the REST APIs, this is the Update Card endpoint.
- For Web Services SOAP API, this is the Ws_Update_Cardholder_Details endpoint.
For more information, see Updating Cardholder Details in the Cards API website and Update Cardholder Details (V1) in the Web Services Guide.
|
Field |
Description |
|---|---|
|
First Name |
Cardholder's first name. Also used as the card purchaser's first name if no delivery address is supplied. |
|
Last Name |
Cardholder's last name. If no delivery address is supplied it is also assumed to be the card purchaser’s last name. |
|
Address 1 |
Cardholder's address line 1. Also used as the card purchaser's address line 1 if no delivery address is supplied. The cardholder address reflects the Address Verification Service (AVS) checks that are performed. |
|
Address 2 |
Cardholder's address line 2. Also used as the card purchaser's address line 1 if no delivery address is supplied. The cardholder address reflects the Address Verification Service (AVS) checks that are performed. |
|
Address 3 |
Cardholder's address line 3. Also used as the card purchaser's address line 1 if no delivery address is supplied. The cardholder address reflects the Address Verification Service (AVS) checks that are performed. |
|
Postcode |
Cardholder's home postcode. Also used as the card purchaser's postcode if no postcode is supplied. The cardholder address reflects the Address Verification Service (AVS) checks that are performed. |
|
Country |
Cardholder’s country of residence. This is represented as a 3 digit ISO country code (e.g. 826 for UK). |
|
City |
Cardholder's home city. Also used as the card purchaser's city if no delivery address is supplied. The cardholder address reflects the Address Verification Service (AVS) checks that are performed. |
|
Mobile No |
Cardholder’s mobile phone number (including dialling code if applicable). |
|
Email ID |
The cardholder's email address. |
|
Date of Birth |
The cardholder's date of birth. |
|
Customer Reference Number |
Cardholder account number or reference number. |
Card Details
You can also update the card details with the Cards REST API endpoint, Update Card and the Web Services SOAP API, Ws_Update_Cardholder_Details. For more information, read Updating a Card in the Cards API website and Update Cardholder Details (V1) in the Web Services Guide.
|
Field |
Description |
|---|---|
|
Card Status |
The status of the card. Available statuses are described in Appendix B: Card Status Codes. |
|
Product |
The unique ID of the card product. |
|
Scheme |
The scheme the card belongs to. |
|
Currency |
The currency of the card. |
|
Expiry Date |
The expiry date of the card. |
|
Type |
The type of the card, physical or virtual. |
|
Activation Date |
The date the card was activated. |
|
Thredd Expiry Date |
The date when the card will cease to work. The status of the card changes to Expired when this date is passed. |
|
Network Type |
The name of the network associated with the card. For example, Visa, Mastercard, or Discover Global Network (DGN). |
|
Linked Cards |
Any linked cards. Displays N/A if there are no linked cards. |
Card Configuration Details
You can edit the card configuration details using the APIs:
- For the REST APIs, this is the List Card Control Groups and Update Card Control Groups endpoints.
- For the SOAP APIs, this is the Ws_Card_Change_Cardacceptor_List and Ws_Card_Change_Groups endpoints.
For more information, read Managing Card Usage Groups in the Cards API website and Card Change Acceptor List and Card Change Groups in the Web Services Guide.
|
Field |
Description |
|---|---|
|
Card Acceptor List |
The Card Acceptor List associated with the card. You can specify at the merchant ID level where authorisations will be accepted (based on DE42). For example, you can allow a card to be used only in specific shops or locations. This can be applied via the Thredd API. |
|
Card Disallow List |
The Card Disallow List associated with the card. You can specify at the merchant ID level where authorisations will be declined (based on DE42). For example, you can prevent a card from being used in specific shops or locations. This can be applied via the Thredd API. |
|
Group MCC |
Group code for the MCC Group. The MCC group allows the card to be linked to a list of Merchant Category Codes (MCCs) that the card is allowed to or conversely is not allowed to transact at. You can allow or disallow card acceptance (auths) based on one or more merchant category codes (MCC). For example, you can disallow gambling sites. The MCC Group is set up and configured in Smart Client. |
|
Group Usage |
Group code for Group Usage. You can apply the specific “Card Usage Rules” which dictate card behaviour such as PAN entry method rules, cardholder verification, regional based rules and transaction types. Check the usage rules if a card has been declined. For example, to show if transactions are prevented from going through on an unknown acceptance method. |
|
Group Limit |
Group code for the Group Limit. Displays specific limits assigned to that token. For example, the maximum balance permitted to be held on the card. |
|
Card Linkage |
Group code for Card Linkage. Used to link primary and secondary cards. You can apply card linkage on a shared balance or a separate balance. |
|
Card Calendar Group |
Group code for the Calendar. You can restrict card acceptance based on specific time and date parameters. For example, a trucking company may restrict card use to weekdays from 9 until 5 to allow employees to pay for fuel. Some usage cases include religious observances or working hours. |
|
Limited Network |
The Limited Network the card is associated with. A limited network refers to a payment network that restricts the use of a card to a specific group of merchants or locations. This type of network is often used for specialised purposes, such as gift or store cards, where the card can only be used within a particular store or chain of stores. This rule is based on three different data elements:
|
|
Fees & Amount Configuration |
The fees configuration associated with the card, covering Group Auth, Group Web and Recurring Fee details. See Appendix L: Fee Configuration for more information. |
|
Group Auth |
The authorisation fee group the card is associated with. The Group Auth field enables you to apply a fee to Authorisations based on the processing code, for example, an authorisation to check a balance. |
|
Group Web |
The Group Web the card is associated with. The Group Web field enables you to charge a fee for specific web services such as a PIN change request. |
|
Recurring Fee |
The Recurring Fee Group the card is associated with. Recurring fee determines whether you can apply fees based on rules or actions you set on the card. For example: inactivity fees, and/or dormancy fees. These are configured by Thredd. |
|
Card FX Group |
Group code for FX Fees. You can upload and manage your own Foreign Exchange rates which can be applied to authorisations and presentments. The FX Fee Group is set up and configured in Smart Client. |
|
Payment Token Usage Group |
Group code for the Payment Token Usage Group. Defines configuration options specific to the provisioning of a digital payment token. For more information, read the Tokenisation Guide. |