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 LengthTypeMandatory
cardTypeThe type of card. Select from:
- physical
- virtual
- masterVirtual
713StringYes
cardProductThe unique ID of the card product linked to the card.12147483647int32Yes
designIdThe name of the card visual design.150StringNo
customerReferenceAn external customer reference provided in the request.025StringNo
parentCardWhere the card is a secondary card, the public token of the primary card.910StringNo
expiryDateExpiry Date. It will be embossed on the card. Format YYYY-MM.77date-timeNo
freeText1A free text field to communicate details to the card manufacturer.150StringNo
freeText2A free text field to communicate details to the card manufacturer.150StringNo
nameOnCardThe name that appears on the card. Note this is mandatory for physical card types.026StringYes for physical cards, No for MVC and virtual cards.
activateNowIf true, will set the card status as active on creation of the card.05BooleanNo
IsSingleUseIf true, the created card is only allowed for a single spend transaction only.05BooleanNo
IsNonReloadableIf true, the card is only allowed to have a single load.05BooleanNo
cardHolderThe cardHolder object contains fields that are used to capture the details of the cardholder.
titleTitle of the cardholder.05StringNo
firstNameFirst name of the cardholder.020StringYes
middleNameMiddle name of cardholder.030StringNo
lastNameLast name of the cardholder.030StringYes
dateOfBirthDate of Birth of the cardholder. Format YYYY-MM-DD.1010StringYes
mobileMobile number of cardholder.016StringNo
emailEmail address of the cardholder.0100StringNo
addressThe address object contains fields that are used to capture the cardholder's address
addressLine1First line of the address.0100StringYes
addressLine2Second line of the address.0100StringNo
addressLine3Third line of the address.0100StringNo
cityCity name.0100StringNo
stateState.0100StringNo
countyCounty, region or province.0100StringNo
postCodePostcode / Zip code of the address.016StringYes
countryCountry of residence. This is represented as a 3-letter alphanumeric ISO country code (e.g. GBR for UK).33StringYes
fulfilmentThe fulfilment object contains fields that are used to capture the cardholder's fulfilment address.
addressLine1First line of the address.0100StringYes
addressLine2Second line of the address.0100StringNo
addressLine3Third line of the address.0100StringNo
cityCity name.0100StringNo
stateState.0100StringNo
countyCounty, region or province.0100StringNo
postCodePostcode / Zip code of the address.016StringYes
countryCountry of residence. This is represented as a 3-letter alphanumeric ISO country code (e.g. GBR for UK).33StringYes
virtualCardImageDetailsThe virtualCardImageDetails object contains fields that are used to capture the Image details required for a virtual card.
virtualCardImageIdThe image ID for the virtual card.016StringNo
imageSizeThe image size of the virtual card as a multiple of 100%. For example, 1 is 100%, 2 is 200% etc.15int32No
manufacturingDetailsThe manufacturingDetails object contains fields that are used to capture the manufacturing details required for physical card
cardManufacturerThe name of the card manufacturer.110StringNo
deliveryMethodThe delivery method for the physical card.1521StringNo
carrierTypeCarrier Product Design reference as used by the card printer.130StringNo
languageThe language used on the card.02StringNo
thermalLine1Free text field which can be used for transferring extra information to be printed on the card.0120StringNo
thermalLine2Free text field which can be used for transferring extra information to be printed on the card.0120StringNo
embossLine4Embossed card line 4. Actual maximum length will depend on the card design.027StringNo
vanityNameCan add an additional title to the card holder name (for example "Company Director").032StringNo
imageDetailsThe imageDetails object contains fields that are used to capture the image details for a physical card.
imageIdThe ID for the physical card image.120StringNo
logoFrontIdThe logo ID for the front of the physical card.130StringNo
logoBackIdThe logo ID for the back of the physical card.130StringNo

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.