Create Card with Customisable Card Number

The following page details each of the fields received in the response when using the Create Card with Customisable Card Number endpoint.

Header

Description	Type	Status
X-Correlation-ID	A GUID, which is used to identify a card creation flow. Please use the same correlation ID for customised card number validation and creation.	String	Mandatory

Request Fields

The following table describes fields that can be included in the body of the request when creating a card with a customisable card number.

Field	Description	Minimum Length	Maximum Length	Type	Mandatory
productId	Unique identification number of a product.	1	2147483647	integer	Yes
customPan	Last 6 digits of the cardholder supplied PAN.	0	6	string	No
referenceNumber	Custom PAN internal reference number. Mandatory if the `customPan` is present in the request.	1		long	Yes (if customPan is present).
productReference	The physical card design reference as used by the Card Manufacturer. If supplied, this will be sent to the card manufacturer, otherwise it will use default one.	0	50	string	No
customerAccount	Client reference for the Card	0	50	string	No
expiryDate	If left blank, updates with the default expiry date, based on the Card Scheme's validity period in months, otherwise updates with the input value. YYYY-MM-DD format.	10	10	string	No
accessCode	Access code or passcode, which can be used to set a code which is validated during activation (For example, using the Thredd IVR system). If provided, must be 6 digits. Leading zeroes are acceptable.	6	6	string	No
cobrand	The Co-Brand code for the card. If supplied, it will replace the PROGRAMID field in the Balance XML file.	0	50	string	No
fulfil1	Free text field which can be used for transferring extra information to the card manufacturer.	0	50	string	No
fulfil2	Free text field which can be used for transferring extra information to the card manufacturer	0	50	string	No
cardName	The embossed name on the card. If present in the request, then the embossed name on the card should be the given value. If it is not available and firstName and lastName are available, then title + firstName + lastName will be the embossed name. If all the above parameters are unavailable in the request, then the default embossed name remains as the embossed name. If a blank embossed name is required, then pass a single space character.	0	27	string	No
singleUse	Enables you to specify whether the card is single use only. Boolean values of true or false are accepted. If not specified, then the default value from the card Product is used.	0	1	boolean	No
nonReloadable	Enables you to specify whether the card is non-reloadable. Boolean values of true, false are accepted. If not specified, then the default value from the card Product is used.	0	1	boolean	No
cardholder	Object that contains details on the cardholder.
title	The cardholder's title.	0	5	string	No
firstName	The cardholder's first name.	0	20	string	No
lastName	The cardholder's last name.	0	20	string	No
dob	The cardholder's date of birth. YYYY-MM-DD format.	10	10	string	No
gender	The cardholder's gender.	0	1	string	No
mobile	The cardholder's mobile phone number.	0	16	string	No
telephone	The cardholder's landline phone number.	0	16	string	No
email	The cardholder's email address.	0	100	string	No
address	Object that contains details on the cardholder's address.
addressLine1	Cardholder’s address line 1.	0	50	string	No
addressLine2	Cardholder’s address line 2.	0	50	string	No
addressLine3	Cardholder’s address line 3.	0	50	string	No
city	Cardholder’s city.	0	20	string	No
county	Cardholder’s county.	0	20	string	No
postCode	Cardholder’s post code.	0	10	string	No
country	Cardholder’s country.	3	3	string	No
deliveryAddress	Object that contains details on the delivery address for the card.
addressLine1	Delivery address line 1.	0	50	string	No
addressLine1	Delivery address line 2.	0	50	string	No
addressLine1	Delivery address line 3.	0	50	string	No
city	Delivery city.	0	20	string	No
county	Delivery county.	0	20	string	No
postCode	Delivery post code.	0	10	string	No
country	Delivery country.	3	3	string	No
manufacturingDetails	Object that contains details on the manufacturing of the card. Used to override manufacturer setting. If not specified, the default values from Product are used.
deliveryMethod	The delivery method for the card. Options include: 0 = Standard delivery; 1 = Registered mail; 2 = Direct delivery; Default value is 0.	0	1	string	No
deliveryCode	The delivery code for the card. If specified, the card manufacturer sends all cards with the same delivery code to the specified delivery address.	0	10	string	No
languageCode	Two character ISO 639-1 Language code to be used for card mailers (For example, En = English or Fr = French).	2	2	string	No
carrierType	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.	0	13	string	No
vanityName	Enables you to add an additional alternative form of title to the card. For example, "Company Director”	0	32	string	No
url	This value will be included in the field of the Thredd Card Generation file.	0	100	string	No
cardPhysicalLayout	Object that contains the layout of the card. If not specified, the default values from Product are used.
imageId	Identifies the image file that will be printed on the face of the card.	1	16	string	No
embossLine4	The card’s embossed line 4 on the front of the card.	0	27	string	No
thermalLine1	Free text field which can be used for transferring extra information to be printed on the card.	0	120	string	No
thermalLine2	Free text field which can be used for transferring extra information to be printed on the card.	0	120	string	No
logoFrontId	Identifies the logo file that will be printed on the face of the card.	0	30	string	No
logoBackId	Identifies the image file that will be printed on the back of the card, if supported.	0	30	string	No
groups	Object that contains information on the card's Card Control Groups. If not specified, the default values from Product are used.
limit	Code of the group limit.	0	10	string	No
mcc	Code of the MCC group.	0	10	string	No
usage	Code of the Usage group.	0	10	string	No
authorisationFee	Code of the Authorisation Fee Group.	0	10	string	No
scheduledFee	Code of the Scheduled Fee Group.	0	10	string	No
webserviceFee	Code of the Web Service Fee Group.	0	10	string	No
cardLinkage	Code of the card linkage group.	0	10	string	No
authorisationCalendar	Code of the authorisation calendar group.	0	10	string	No
foreignExchange	Code of the foreign exchange group.	0	10	string	No
whitelist	Code of the card acceptor whitelist.	0	10	string	No
blacklist	Code of the card acceptor blacklist	0	10	string	No

Response Fields

A successful response for the Create Card with the Customisable Card Number endpoint will return a 200 response.

Field	Description
messageId	Message ID, unique to each request. You should store the _messageId _on the cardholder app, as it will be needed later to link to the Event Delivery Service (EDS) webhook that communicates the public token and masked PAN to the customer. See Card Creation Success Event.