---
title: "Create Card."
method: POST
path: "/api/v1/card/create"
tags: ["Card"]
---

# Create Card.

`POST /api/v1/card/create`

## Headers

- `X-Correlation-ID` string

## Request body

- CreateCardBody — Request to create card.
  - `productReference` string, nullable — The physical card design reference as used by the Card Manufacturer. If supplied, this will send to card manufacturer otherwise the default one.
  - `customerAccount` string, nullable — Customer reference for the Card.
  - `expiryDate` string, 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.
  - `accessCode` string, 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.
  - `coBrand` string, nullable — The Co-Brand code for the card. If supplied, it will replace the PROGRAMID field in the Balance XML file.
  - `fulfil1` string, nullable — Free text field which can be used for transferring extra information to the card manufacturer.
  - `fulfil2` string, nullable — Free text field which can be used for transferring extra information to the card manufacturer.
  - `cardName` string, 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.
  - `singleUse` boolean — 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.
  - `nonReloadable` boolean — 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.
  - `cardHolder` CardHolderRequest — Card holder details.
    - `title` string, nullable — Card Holder's title.
    - `firstName` string, nullable — Card Holder's first name.
    - `lastName` string, nullable — Card Holder's last name.
    - `dob` string, nullable — Card Holder's date of birth, YYYY-MM-DD format.
    - `gender` string, nullable — Card Holder's gender.
    - `mobile` string, nullable — Card Holder's mobile.
    - `telephone` string, nullable — Card Holder's telephone.
    - `email` string, nullable — Card Holder's email.
    - `address` Address — Address.
      - `addressLine1` string, nullable — Address line 1.
      - `addressLine2` string, nullable — Address line 2.
      - `addressLine3` string, nullable — Address line 3.
      - `city` string, nullable — City.
      - `county` string, nullable — County.
      - `country` string, nullable — Country.
      - `postCode` string, nullable — Postcode.
    - `deliveryAddress` Address — Address.
      - `addressLine1` string, nullable — Address line 1.
      - `addressLine2` string, nullable — Address line 2.
      - `addressLine3` string, nullable — Address line 3.
      - `city` string, nullable — City.
      - `county` string, nullable — County.
      - `country` string, nullable — Country.
      - `postCode` string, nullable — Postcode.
  - `groups` GroupCodes — Card Control Groups. If not specified, the default values from Product are used.
    - `limit` string, nullable — Code of the group limit.
    - `mcc` string, nullable — Code of the MCC group.
    - `usage` string, nullable — Code of the Usage group.
    - `authorisationFee` string, nullable — Code of the Authorisation Fee group.
    - `scheduledFee` string, nullable — Code of the Scheduled fee group.
    - `webServiceFee` string, nullable — Code of the Webservice fee group.
    - `cardLinkage` string, nullable — Code of the Card linkage group.
    - `foreignExchange` string, nullable — Code of the foriegn exchange group.
    - `authorisationCalendar` string, nullable — Code of the authorisation calendar group.
    - `whitelist` string, nullable — Code of the card acceptor whitelist.
    - `blacklist` string, nullable — Code of the card acceptor blacklist.
  - `customPan` string, nullable — Last 6 digits of the cardholder supplied PAN. (Mandatory if chose customised card number).
  - `referenceNumber` integer, nullable — Custom Pan internal reference number. Mandatory if customPan present in the request.
  - `productId` integer, required — Unique identification number of a product.
  - `manufacturerDetails` BaseManufacturerDetails — Manufacturer details. Used to override manufacturer setting. If not specified, the default values from Product are used.
    - `deliveryMethod` 'StandardDelivery' | 'RegisteredMail' | 'DirectDelivery', nullable — The delivery method for the card.Default value is StandardDelivery.
    - `deliveryCode` string, nullable — The delivery code for the card. If specified, the card manufacturer sends all cards with the same delivery code to the specified delivery address.
    - `languageCode` string, nullable — Two characters ISO 639-1 Language code to be used for card mailers (e.g. En = English, Fr = French).
    - `carrierType` string, nullable — 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.
    - `vanityName` string, nullable — Enables you to add an additional alternative form of title to the card, e.g. “Company Director”.
    - `url` string, nullable — This value will be included in the Thredd Card Generation file, in the <QRCode> field.
    - `cardPhysicalLayout` BaseCardPhysicalLayout — Layout of the card. If not specified, the default values from Product are used.
      - `imageId` string, nullable — Identifies the image file that will be printed on the face of the card.
      - `embossLine4` string, nullable — The card's embossed line 4 on the front of the card.
      - `thermalLine1` string, nullable — Free text field which can be used for transferring extra information to be printed on the card.
      - `thermalLine2` string, nullable — Free text field which can be used for transferring extra information to be printed on the card.
      - `logoFrontId` string, nullable — Identifies the logo file that will be printed on the face of the card.
      - `logoBackId` string, nullable — Identifies the image file that will be printed on the back of the card, if supported.

## Response `200`

Success

- CreateCardDto — Response for the Create Card.
  - `messageId` string, nullable — Unique to each request.

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `409` — Conflict
- `500` — Server Error

---

[API](https://skmtc.dev/thredd/apis/core-cards.md) · [All operations](https://skmtc.dev/thredd/apis/core-cards/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/thredd/core-cards/revisions/841f62def5bf/schema)