Skip to main content

BulkCard

Information about the created card from the Bulk Card Ordering endpoint.

cardIdstring<uuid>required

Card id is a unique identifier for a specific card. It will be used for most operations to the prepaid card.

externalIdstring

External card identifier in merchant system.

Possible values: non-empty and <= 40 characters

Example: B-1111111
customerIdstringrequired

If the status is ASSIGNED the customerId will represent the real id of the customer or if the status is NOT_ASSIGNED customerId will contain the merchant id (provided in the request).

Example: 1231122232
statusstring

ASSIGNED - Bulk card is assigned to a customer. NOT_ASSIGNED - Bulk card is not assigned to a customer.

Possible values: [ASSIGNED, NOT_ASSIGNED]

embossedNamestring

The name that appears on the card. If not provided, firstName lastName from the customer will be used. Only ASCII characters are allowed.

Possible values: non-empty and <= 27 characters

Example: John Doe
expiry object

Card expiry date.

monthintegerrequired

The month of the card expiry date.

Example: 3
yearintegerrequired

The year of the card expiry date.

Example: 2028
cardTypestringrequired

Supported card types. Currently we support only VIRTUAL and PHYSICAL

Possible values: [PHYSICAL, VIRTUAL]

programNamestringrequired

Card program name.

lastFourstring

Card last four digits.

Possible values: >= 4 characters and <= 4 characters

Example: 3234
currencystringrequired

Currency code in three-letter format ("Alpha-3").

Possible values: >= 3 characters and <= 3 characters

Example: EUR
schemestringrequired

Possible values: [VISA, MC]

isPinSetbooleanrequired

Indicates that the card PIN has been set or not.

Default value: false
BulkCard
{
  "cardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "externalId": "B-1111111",
  "customerId": "1231122232",
  "status": "ASSIGNED",
  "embossedName": "John Doe",
  "expiry": {
    "month": 3,
    "year": 2028
  },
  "cardType": "PHYSICAL",
  "programName": "string",
  "lastFour": "3234",
  "currency": "EUR",
  "scheme": "VISA",
  "isPinSet": false
}