Sign in

v1

latestOpenAPI 3.0.12026-07-2662118182.1 KB
Card

Create Card.

post/api/v1/card/create

Headers

X-Correlation-IDstring

A GUID, that used to identify a card creation flow.

Request body

productReferencestring nullable

The physical card design reference as used by the Card Manufacturer. If supplied, this will send to card manufacturer otherwise the default one.

customerAccountstring nullable

Customer reference for the Card.

expiryDatestring nullable

Expiry date. 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.

accessCodestring nullable

Access code or passcode, which can be used to set a code which is validated during activation (e.g. via the Thredd IVR system). If provided, must be 6 digits leading zeroes are acceptable.

coBrandstring nullable

The Co-Brand code for the card. If supplied, it will replace the PROGRAMID field in the Balance XML file.

fulfil1string nullable

Free text field which can be used for transferring extra information to the card manufacturer.

fulfil2string nullable

Free text field which can be used for transferring extra information to the card manufacturer.

cardNamestring nullable

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 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.

singleUseboolean

Enables you to specify whether the card is single use only. Boolean values of true, false are accepted. If not specified, then the default value from the card Product is used.

nonReloadableboolean

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.

customPanstring nullable

Last 6 digits of the cardholder supplied PAN. (Mandatory if chose customised card number).

referenceNumberinteger nullable

Custom Pan internal reference number. Mandatory if customPan present in the request.

productIdinteger required

Unique identification number of a product.

Response

Success

messageIdstring nullable

Unique to each request.

Example response

{
  "messageId": "60b83k64-526e-4d25-84c7-32b6e47c02b3"
}