Get a list of plastics for a given card - Enfuce

GET

/

v3

/

{id}

/

plastic

Get a list of plastics for a given card

curl --request GET \
  --url 'https://integration-api-cat2.{{environment}}.ext.{{realm}}.cia.enfuce.com/card/v3/{id}/plastic' \
  --header 'Authorization: Bearer <token>'

[
  {
    "cardId": "<string>",
    "createdDate": "2023-12-25",
    "embossing": {
      "additionalField1": "<string>",
      "additionalField2": "<string>",
      "additionalField3": "<string>",
      "additionalField4": "<string>",
      "additionalField5": "<string>",
      "companyName": "Enfuce Financial Services",
      "externalLayoutCode": "BlueCard",
      "firstName": "Monica",
      "lastName": "Liikamaa",
      "manufacturer": "FACTORY_X",
      "physical": true
    },
    "expiration": {
      "year": 2019,
      "month": 1
    },
    "id": "1234567890",
    "productionDate": "2023-12-25",
    "productionType": "ALL",
    "sequenceNumber": 123,
    "status": "ACTIVE"
  }
]

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id

string<biginteger>

required

The card id for given card

Query Parameters

auditUser

string

required

The audit user to log the request

Response

Successful lookup of plastics

cardId

string

CardId to which the plastic is connected

createdDate

string<date>

Date when plastic was created

embossing

object

Default set of allowed characters for fields embossed onto the card:

A-Z, a-z, Áá, Ää, Åå, Ææ, Éé, Íí, Ðð, Óó, Öö, Øø, Úú, Üü, Ýý, Þþ, 0-9, symbols -/.,&+' and space.

For printed cards allowed characters are: (including the above)

ÀÁÂÃÄÅÆÇÈÉÊËÌÍÎÏÐÑÒÓÔÕÖØÙÚÛÜÝÞßàáâãäåæçèéêëìíîïðñòóôõöøùúûüý þÿĀāĂăĄąĆćĈĉĊċČčĎďĐđĒēĔĕĖėĘęĚěĜĝĞğĠġĢģĤĥĦħĨĩĪīĬĭĮįİıĲĳĴĵĶķĸĹ ĺĻļĽľĿŀŁłŃńŅņŇňŉŊŋŌōŎŏŐőŒœŔŕŖŗŘřŚśŜŝŞşŠšŢţŤťŦŧŨũŪūŬŭŮůŰűŲųŴŵ ŶŷŸŹźŻżŽžſǪǫȘșȚțȪȫȮȯȲȳḐḑṢṣẞỌọ

Printed or others characters sets must be agreed in advance.

Show child attributes

embossing.additionalField1

string

Field value is forwarded to embossing house in order to be used as additional embossing lines. In order to use this field selected embossing house must in advance agree where this is put.

Maximum string length: 32

embossing.additionalField2

string

Field value is forwarded to embossing house in order to be used as additional embossing lines. In order to use this field selected embossing house must in advance agree where this is put.

Maximum string length: 32

embossing.additionalField3

string

Field value is forwarded to embossing house in order to be used as additional embossing lines. In order to use this field selected embossing house must in advance agree where this is put.

Maximum string length: 32

embossing.additionalField4

string

Field value is forwarded to embossing house in order to be used as additional embossing lines. In order to use this field selected embossing house must in advance agree where this is put.

Maximum string length: 32

embossing.additionalField5

string

Field value is forwarded to embossing house in order to be used as additional embossing lines. In order to use this field selected embossing house must in advance agree where this is put.

Maximum string length: 32

embossing.companyName

string

Maximum string length: 26

Example:

"Enfuce Financial Services"

embossing.externalLayoutCode

string

Code forwarded to embossing house in order to select which plastic layout to use. In order to use this field selected embossing house must in advance agree on name for each layout.

Maximum string length: 32

Example:

"BlueCard"

embossing.firstName

string

The length of firstName should not exceed 26 characters length. A combined length of firstName and lastName should not exceed 26 characters length.

Maximum string length: 26

Example:

"Monica"

embossing.lastName

string

The length of lastName should not exceed 26 characters length. A combined length of firstName and lastName should not exceed 26 characters length.

Maximum string length: 26

Example:

"Liikamaa"

embossing.manufacturer

string

Name of manufacturer for the card. This has to be agreed in advance with Enfuce in order to support multiple embossing houses.

Example:

"FACTORY_X"

embossing.physical

boolean

This tag will indicate will there be a physical representation of the card. If true, the card will be placed for card personalisation and end user will receive a physical plastic. If false, the card will not be placed for card personalisation and end user will not receive a physical plastic.

Example:

true

expiration

expiration · object

Show child attributes

expiration.year

integer<int32>

Expiration year in format YYYY

Example:

2019

expiration.month

integer<int32>

Expiration month in format MM

Example:

1

id

string

Unique plastic id for plastic

Example:

"1234567890"

productionDate

string<date>

Date when plastic was embossed

productionType

enum<string>

Type of production change

Available options:

ALL,

NEW_PLASTIC,

NEW_PIN,

NEW_CVV,

PIN,

ADD_PARMS,

CHIP_DATA

sequenceNumber

integer

Sequence number starting from 1

status

enum<string>

ACTIVE - The plastic is active and may be used to perform transactions
CLOSED - Status of an old card after a new card is issued. Transactions with the old card may be performed until the new card is activated
DEFERRED
FROM_FILE - A batch application to reissue the card is being processed
INACTIVE - Plastic has been ordered and plastic is not in use right away
LOCKED - Plastic is locked and card cannot be used. Plastic goes from inactive to locked right away after card has been embossed
LOCKED_FOR_ONLINE
REJECTED - An error occurred during embossing process

Available options:

ACTIVE,

CLOSED,

DEFERRED,

FROM_FILE,

INACTIVE,

LOCKED,

LOCKED_FOR_ONLINE,

REJECTED

⌘I

Get a list of plastics for a given card

curl --request GET \
  --url 'https://integration-api-cat2.{{environment}}.ext.{{realm}}.cia.enfuce.com/card/v3/{id}/plastic' \
  --header 'Authorization: Bearer <token>'

[
  {
    "cardId": "<string>",
    "createdDate": "2023-12-25",
    "embossing": {
      "additionalField1": "<string>",
      "additionalField2": "<string>",
      "additionalField3": "<string>",
      "additionalField4": "<string>",
      "additionalField5": "<string>",
      "companyName": "Enfuce Financial Services",
      "externalLayoutCode": "BlueCard",
      "firstName": "Monica",
      "lastName": "Liikamaa",
      "manufacturer": "FACTORY_X",
      "physical": true
    },
    "expiration": {
      "year": 2019,
      "month": 1
    },
    "id": "1234567890",
    "productionDate": "2023-12-25",
    "productionType": "ALL",
    "sequenceNumber": 123,
    "status": "ACTIVE"
  }
]