Update Card - Field Descriptions
The following page details each of the fields that can be used in the request, and received in the response when using the Update Card endpoint.
Request Fields
The following table describes fields that can be included in the body of the request when updating a card.
| Field | Description | Minimum Length | Maximum Length | Type | Mandatory |
|---|---|---|---|---|---|
| customerReference | An external customer reference provided in the request. | 0 | 25 | String | No |
| designId | The name of the card visual design. | 1 | 50 | String | No |
| parentCard | Where the card is a secondary card, the public token of the primary card. | 9 | 10 | String | No |
| freeText1 | A free text field to communicate details to the card manufacturer. | 1 | 50 | String | No |
| freeText2 | A free text field to communicate details to the card manufacturer. | 1 | 50 | String | No |
| updatedBy | User who updated the card details. | 0 | 100 | String | No |
| cardHolder | The fields for the cardholder object are used to capture information on the cardholder. | ||||
| title | Title of the cardholder. | 0 | 5 | String | Yes |
| firstName | First name of the cardholder. Note: Any unpermitted characters are removed using string cleaning when submitting this field. | 0 | 100 | String | Yes |
| middleName | Middle name of cardholder. Note: Any unpermitted characters are removed using string cleaning when submitting this field. | 0 | 100 | String | No |
| lastName | Last name of the cardholder. Note: Any unpermitted characters are removed using string cleaning when submitting this field. | 0 | 100 | String | Yes |
| dateOfBirth | Date of Birth of the cardholder. Format YYYY-MM-DD. | 10 | 10 | String | Yes |
| mobile | Mobile number of cardholder. | 0 | 16 | String | No |
| Email address of the cardholder. | 0 | 100 | String | No | |
| address | The fields for the address object are used to capture the cardholder's address. | ||||
| addressLine1 | First line of the address. | 0 | 100 | String | Yes |
| addressLine2 | Second line of the address. | 0 | 100 | String | No |
| addressLine3 | Third line of the address. | 0 | 100 | String | No |
| city | City name. | 0 | 100 | String | No |
| state | State. | 0 | 100 | String | No |
| county | County, region or province. | 0 | 100 | String | No |
| postCode | Postcode / Zip code of the address. | 0 | 16 | String | Yes |
| country | Country of residence. This is represented as a 3-letter alphanumeric ISO country code (e.g. GBR for UK). See the IBAN list of country codes for a full list. | 3 | 3 | String | Yes |
| fulfilment | The fields for the fulfilment object are used to capture the cardholder's fulfilment address. | ||||
| addressLine1 | First line of the address. | 0 | 100 | String | Yes |
| addressLine2 | Second line of the address. | 0 | 100 | String | No |
| addressLine3 | Third line of the address. | 0 | 100 | String | No |
| city | City name. | 0 | 100 | String | No |
| state | State. | 0 | 100 | String | No |
| county | County, region or province. | 0 | 100 | String | No |
| postCode | Postcode / Zip code of the address. | 0 | 16 | String | Yes |
| country | Country of residence. This is represented as a 3-letter alphanumeric ISO country code (e.g. GBR for UK). See the IBAN list of country codes for a full list. | 3 | 3 | String | Yes |
| nameOnCard | The fields for the nameOnCard object are used to capture the name embossed on card. Maximum combined length of 26 characters (including spaces). | ||||
| title | The title that appears on the card. | 0 | 5 | String | No |
| firstName | The first name that appears on the card. | 0 | 100 | String | No |
| lastName | The last name that appears on the card. | 0 | 100 | String | No |
| virtualCardImageDetails | The fields for the virtualCardImageDetails object are used to capture the Image details required for a virtual card. | ||||
| virtualCardImageId | The image ID for the virtual card. | 0 | 16 | String | Yes (Where the cardType is Virtual or MasterVirtual) |
| imageSize | The image size of the virtual card as a multiple of 100%. For example, 1 is 100%, 2 is 200% etc. | 1 | 5 | String | Yes (Where the cardType is Virtual or MasterVirtual) |
| manufacturingDetails | The fields for the manufacturingDetails object are used to capture the manufacturing details required for a physical card. | ||||
| cardManufacturer | The name of the card manufacturer. | 1 | 10 | Yes (Where the cardType is Physical) | |
| deliveryMethod | The delivery method for the physical card. | 15 | 21 | Yes (Where the cardType is Physical) | |
| carrierType | Carrier Product Design reference as used by the card printer. | 1 | 30 | Yes (Where the cardType is Physical) | |
| quantity | The number of cards being manufactured. | 0 | 100 | No | |
| language | The language used on the card. | 0 | 2 | No | |
| thermalLine1 | Free text field which can be used for transferring extra information to be printed on the card. | 0 | 120 | No | |
| thermalLine2 | Free text field which can be used for transferring extra information to be printed on the card. | 0 | 120 | No | |
| embossLine4 | Embossed card line 4. Actual maximum length will depend on the card design. | 0 | 27 | No | |
| vanityName | Additional title to the card holder name (for example "Company Director"). | 0 | 32 | No | |
| imageDetails | The fields for the imageDetails object are used to capture the image details for a physical card. | No | |||
| imageId | The ID for the physical card image. | 1 | 20 | Yes (Where the cardType is Physical) | |
| logoFrontId | The logo ID for the front of the physical card. | 1 | 30 | Yes (Where the cardType is Physical) | |
| logoBackId | The logo ID for the back of the physical card. | 1 | 30 | Yes (Where the cardType is Physical) | |
| config3dSecure | The fields for the config3dSecure obejct are used to display values related to 3DS configuration for the card. | ||||
| language3ds | The language to apply to the 3DS challenge screens displayed to the cardholder. (In BCP-47 format. For example: en-EN,fr-FR.) Note: The language content must first be set up for your card products; once this is done, your 3DS Implementation Manager will share with you the language codes to use. Note: Default language is English. If card level value is not provided, then the product level setting will be used. | 0 | 20 | No | |
| apataConfig | The fields for the apataConfig object are used to display values related to the Apata 3DS configuration for the card. | ||||
| cardProgramId | Sets the card program identifier. | 0 | 255 | No | |
| challengeProfileId | Sets the challenge profile identifier. | 0 | 255 | No | |
| kbaNumberOfQuestionsToAnswer | Sets the KBA number of questions to answer. | No | |||
| kbaNumberOfIncorrectPermissible | Sets the KBA number of incorrect permissible | No |
Updated 5 days ago