Create 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 Create Card endpoint.

Request Fields

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

FieldDescriptionMinimum LengthMaximum LengthMandatory
cardTypeThe type of card. Select from:
- physical
- virtual
- masterVirtual
713Yes
cardProductThe unique ID of the card product linked to the card.12147483647Yes
designIdThe name of the card visual design.150No
customerReferenceAn external customer reference provided in the request.025No
parentCardWhere the card is a secondary card, the public token of the primary card.910No
titleTitle of the cardholder.05No
firstNameFirst name of the cardholder.0100Yes
middleNameMiddle name of cardholder.0100No
lastNameLast name of the cardholder.0100Yes
dateOfBirthDate of Birth of the cardholder. Format YYYY-MM-DD.1010Yes
mobileMobile number of cardholder.016No
emailEmail address of the cardholder.0100No
expiryDateExpiry Date. It will be embossed on the card. Format YYYY-MM.77No
freeText1A free text field to communicate details to the card manufacturer.150No
freeText2A free text field to communicate details to the card manufacturer.150No
addressThe address nested fields are used to capture the cardholder's address
addressLine1First line of the address.0100Yes
addressLine2Second line of the address.0100No
addressLine3Third line of the address.0100No
cityCity name.0100No
stateState.0100No
countyCounty, region or province.0100No
postCodePostcode / Zip code of the address.016Yes
countryCountry of residence. This is represented as a 3-letter alphanumeric ISO country code (e.g. GBR for UK).33Yes
fulfilmentThe fulfilment nested fields are used to capture the cardholder's fulfilment address.
addressLine1First line of the address.0100Yes
addressLine2Second line of the address.0100No
addressLine3Third line of the address.0100No
cityCity name.0100No
stateState.0100No
countyCounty, region or province.0100No
postCodePostcode / Zip code of the address.016Yes
countryCountry of residence. This is represented as a 3-letter alphanumeric ISO country code (e.g. GBR for UK).33Yes
nameOnCardThe nameOnCard nested fields are used to capture the name embossed on card. Note: Maximum combined length of 26 characters (including spaces).
titleThe title that appears on the card.No
firstNameThe first name that appears on the card.No
lastNameThe last name that appears on the card.Yes
virtualCardImageDetailsThe virtualCardImageDetails nested fields are used to capture the Image details required for a virtual card.
virtualCardImageIdThe image ID for the virtual card.016No
imageSizeThe image size of the virtual card as a multiple of 100%. For example, 1 is 100%, 2 is 200% etc.15No
manufacturingDetailsThe manufacturingDetails nested fields are used to capture the manufacturing details required for physical card
cardManufacturerThe name of the card manufacturer.110Yes (Where the cardType is Physical)
deliveryMethodThe delivery method for the physical card.1521Yes (Where the cardType is Physical)
carrierTypeCarrier Product Design reference as used by the card printer.130Yes (Where the cardType is Physical)
quantityThe number of cards being manufactured.0100No
languageThe language used on the card.02No
thermalLine1Free text field which can be used for transferring extra information to be printed on the card.0120No
thermalLine2Free text field which can be used for transferring extra information to be printed on the card.0120No
embossLine4Embossed card line 4. Actual maximum length will depend on the card design.027No
vanityNameCan add an additional title to the card holder name (for example "Company Director").032No
imageDetailsThe imageDetails nested fields are used to capture the image details for a physical card.No
imageIdThe ID for the physical card image.120Yes (Where the cardType is Physical)
logoFrontIdThe logo ID for the front of the physical card.130No
logoBackIdThe logo ID for the back of the physical card.130No

Response Fields

The following table describes fields that included in the response after successfully creating a card.

FieldDescription
publicTokenThe unique identifier for the card.
customerReferenceThe external customer reference provided in the request.
embossNameThe name embossed on the card.
maskedPanThe masked PAN for the card created.
startDateThe start date of the card.
expiryDateThe expiry date of the card.