Sign in

v1

latestOpenAPI 3.0.12026-07-2662118182.1 KB
Cards

Create a Card

post/api/v1/cards

Request body

cardType'Physical' | 'Virtual' | 'MasterVirtual' required

The form factor of the card.

cardProductinteger required

The unique ID of the card product linked to the card.

designIdstring nullable

The name of the card visual design.

urlstring nullable

QR Code or delivery id

customerReferencestring nullable

An external customer reference provided in the request.

parentCardstring nullable

Where the card is a secondary card, the public token of the primary card.

nameOnCardstring nullable

Name embossed on card. This field is required for Physical cards.

expiryDatestring date-time nullable

Optional Expiry Date. It will be embossed on the card. Format YYYY-MM.

freetext1string nullable

Fulfilment additional text field

freetext2string nullable

Fulfilment additional text field

activateNowboolean nullable

If true, activates the card during card creation. Defaults to false for a physical card. Defaults to true for a virtual card.

isSingleUseboolean nullable

Flag to check whether the card is for single use or not

isNonReloadableboolean nullable

Flag to check whether the card is a reloadable one or not

language3dsstring nullable

Language3ds should be bcp-47 format.

oobAppUrlstring uri nullable

3DS OOBAppURL at card level.

Example request

{
  "cardType": "Physical",
  "cardProduct": 578,
  "designId": "New Card Brand",
  "customerReference": "my ref 12345",
  "parentCard": "123456789",
  "cardHolder": {
    "title": "Mr",
    "firstName": "John",
    "lastName": "Smith",
    "dateOfBirth": "1963-11-22",
    "mobile": "07471234567",
    "email": "john.smith@example.com"
  }
}

Response

Success

publicTokenstring nullable

Public token of the newly created card.

customerReferencestring nullable

Customer Reference (Account number)

embossNamestring nullable

Embossed name of card

maskedPanstring nullable

Masked PAN

startDatestring nullable

Start Date (yyyy-MM-dd)

expiryDatestring nullable

Expiry Date (yyyy-MM-dd)

Example response

{
  "publicToken": "5678901234",
  "customerReference": "sales",
  "embossName": "Joseph Bloggs",
  "maskedPan": "123456******3456",
  "startDate": "2022-06-06",
  "expiryDate": "2025-06-06"
}
All 62 operations