Create Card.

post

https://thredd-cg-custompan-uat.thredd.net/api/v1/card/create

Card creation requests are processed asynchronously. This endpoint returns an immediate 202 Accepted response containing a unique messageId. If background processing fails after the 202 response has been issued, Thredd sends an Event Delivery System (EDS) webhook notification with event code 121 (Card Creation Failure), correlated to the original request via messageId. On success, the public token and masked PAN are delivered via the Card Creation Success webhook event, also correlated via messageId.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

👍
Documentation
For more information on the Create Custom PAN endpoint, see Customisable Card Number

Body Params

Request to create card.

productReference

string | null

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

Customer reference for the Card.

expiryDate

string | null

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

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

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

fulfil1

string | null

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

fulfil2

string | null

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

cardName

string | null

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

object

Card holder details.

groups

object

Card Control Groups. If not specified, the default values from Product are used.

customPan

string | null

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

referenceNumber

int64 | null

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

productId

int32

required

Unique identification number of a product.

manufacturerDetails

object

Manufacturer details. Used to override manufacturer setting. If not specified, the default values from Product are used.

Headers

X-Correlation-ID

string

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

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Responses

Language

Credentials

OAuth2

URL

Loading…

Response

Choose an example:

text/plain

application/json

text/json

Documentation

202Accepted. The request has been accepted for asynchronous processing. If processing subsequently fails, an EDS webhook notification with event code 121 (Card Creation Failure) is sent, correlated to this request via messageId.

400Bad Request

401Unauthorized

409Conflict

500Server Error