GET
/
v4
/
{id}
curl --request GET \
  --url https://integration-api-cat2./%7B{environment}%7D.ext.%7B{realm}%7D.cia.enfuce.com/card/v4/{id}
{
  "additionalValues": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "cardAddress": {
    "address1": "Kings street 12",
    "address2": "string",
    "address3": "string",
    "address4": "string",
    "city": "Mariehamn",
    "country": "FIN",
    "region": "Åland Islands",
    "zipCode": 22100
  },
  "cardDeliveryType": "CUSTOM_1",
  "digitalLayoutCode": "abc123abc",
  "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": {
    "month": 1,
    "year": 2019
  },
  "pinAddress": {
    "address1": "Kings street 12",
    "address2": "string",
    "address3": "string",
    "address4": "string",
    "city": "Mariehamn",
    "country": "FIN",
    "region": "Åland Islands",
    "zipCode": 22100
  },
  "pinAttempts": {
    "counter": "integer",
    "max": "integer"
  },
  "pinDeliveryType": "CUSTOM_1",
  "pinStatus": "D",
  "productCode": "MC_CARD_2, VISA_CARD1, VISA_VIRTUAL_3, MC_VIRTUAL_2, VISA_CARD",
  "reason": "string",
  "referenceNumber": "123456789123456",
  "regionAndEcommBlocking": {
    "africa": true,
    "asia": true,
    "ecomm": true,
    "europe": true,
    "home": true,
    "northAmerica": true,
    "oceania": true,
    "southAmerica": true
  },
  "scheduledClosing": {
    "time": "2099-12-31T03:00:00.000Z",
    "type": "TIMEBASED"
  },
  "segment": "SEGMENT_A",
  "usageLimits": [
    {
      "code": "24H",
      "values": [
        {
          "availableAmount": 1200,
          "availableCount": 1200,
          "code": "ATM",
          "count": 5,
          "reset": true,
          "singleAmount": 12.5,
          "sumAmount": 1200,
          "usedAmount": 1200,
          "usedCount": 1200
        }
      ]
    }
  ]
}

{
  "additionalValues": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "cardAddress": {
    "address1": "Kings street 12",
    "address2": "string",
    "address3": "string",
    "address4": "string",
    "city": "Mariehamn",
    "country": "FIN",
    "region": "Åland Islands",
    "zipCode": 22100
  },
  "cardDeliveryType": "CUSTOM_1",
  "digitalLayoutCode": "abc123abc",
  "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": {
    "month": 1,
    "year": 2019
  },
  "pinAddress": {
    "address1": "Kings street 12",
    "address2": "string",
    "address3": "string",
    "address4": "string",
    "city": "Mariehamn",
    "country": "FIN",
    "region": "Åland Islands",
    "zipCode": 22100
  },
  "pinAttempts": {
    "counter": "integer",
    "max": "integer"
  },
  "pinDeliveryType": "CUSTOM_1",
  "pinStatus": "D",
  "productCode": "MC_CARD_2, VISA_CARD1, VISA_VIRTUAL_3, MC_VIRTUAL_2, VISA_CARD",
  "reason": "string",
  "referenceNumber": "123456789123456",
  "regionAndEcommBlocking": {
    "africa": true,
    "asia": true,
    "ecomm": true,
    "europe": true,
    "home": true,
    "northAmerica": true,
    "oceania": true,
    "southAmerica": true
  },
  "scheduledClosing": {
    "time": "2099-12-31T03:00:00.000Z",
    "type": "TIMEBASED"
  },
  "segment": "SEGMENT_A",
  "usageLimits": [
    {
      "code": "24H",
      "values": [
        {
          "availableAmount": 1200,
          "availableCount": 1200,
          "code": "ATM",
          "count": 5,
          "reset": true,
          "singleAmount": 12.5,
          "sumAmount": 1200,
          "usedAmount": 1200,
          "usedCount": 1200
        }
      ]
    }
  ]
}

Path Parameters

​
id
string
required

The card id for given card

Query Parameters

​
auditUser
string
required

The audit user to log the request

Response

200
application/json
Successful lookup of the card
​
customerId
string

The customer id card is linked to

Example:

"1234567890"

​
id
string

Unique card id for given card

Example:

"1234567890"

​
template
string

Template name for which the card is connected to

​
accountId
string

The account id card is linked to

Example:

"1234567890"

​
cardRole
enum<string>

A role needs to be provided for the connection to the account. Role is one way to categorize between primary and supplementary card holders. Role MAIN will always create a card to have same account holder and card holder. For a supplementary card there is a possibility to differ between account and card holder.

Available options:
MAIN,
SUPPLEMENTARY
​
status
enum<string>
  • CARD_OK - Card is open and in normal status. Card has to be in this status in order for it to be renewed
  • CARD_BLOCKED - Temporary block on the card that will prevent approval of authorisations. Can be used instead of account level temporary block if target is to block only a specific card
  • SUSPECTED_FRAUD - Temporary block on the card that will prevent approval of authorisations. Functionality the same as for "Card blocked", the different code allows to differentiate between the blocks
  • CARD_CLOSED_DUE_TO_FRAUD - Used to close a card due to known fraud
  • CARD_NO_RENEWAL - Status set to prevent following card renewal. Does not affect card functionality in any way, only renewal
  • CARD_LOST - Used to close a card because it is lost
  • CARD_STOLEN - Used to close a card because it is stolen
  • CARD_CLOSED - Used to close card by request from customer or bank, reason for closure is set with status update reason. Allows still clearing transaction posting
  • CARD_EXPIRED - Final card closure status, that blocks also clearing transaction posting
Available options:
CARD_OK,
CARD_BLOCKED,
SUSPECTED_FRAUD,
CARD_CLOSED_DUE_TO_FRAUD,
CARD_NO_RENEWAL,
CARD_LOST,
CARD_STOLEN,
CARD_CLOSED,
CARD_EXPIRED
​
maskedCardNumber
string

Card number, masked in order to protect sensitive data

Example:

"123456______4285"

​
statusDate
string

Last updated on

Example:

"2020-05-12T13:18:05"

​
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)

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

Printed or others characters sets must be agreed in advance.

​
productCode
string

This field is used when the institution has multiple card products setup. The productCode is used to determine the specific card product. Use of this field as well as the values of the field, is dependent on institution setup and should be aligned with Enfuce prior to use.

Example:

"MC_CARD_2, VISA_CARD1, VISA_VIRTUAL_3, MC_VIRTUAL_2, VISA_CARD"

​
expiration
object
​
regionAndEcommBlocking
object

Card ecomm and geo-region blocking

​
reason
string

Reason for card status change

Maximum length: 32
​
pinStatus
enum<string>

This flag will indicate current status for PIN generation. If not specified system will automatically assign D as default and make sure a PIN is calculated during next embossing process. If set to W, then card will be excluded from embossing process until a PIN has been set and status has been updated to S. It is also possible to revert to D, in order for system to generate PIN. Note that system will update to status S automatically when a PIN is set successfully.

New card

In order for a new card to not get a system generated PIN then pinStatus flag must be set to W when created, this will then halt the embossing process for given card until a PIN has been set.

Reissue card

When reissuing a card it is possible to set pinStatus to W in order to hold embossing process for given card until a PIN has been set. Update pinStatus is done on same card id that is reissued.

Replace card

When replacing a card it is possible to set pinStatus to W in order to hold embossing process for given card until a PIN has been set. Update pinStatus is done on new card id that is returned when replacing.

  • D - default and a random PIN will be generated
  • W - waiting for PIN to be manually set
  • S - PIN has been set successfully
Available options:
D,
W,
S
​
digitalLayoutCode
string

Id used for digital wallet artwork and other related assets. Use of this need to be agreed with Enfuce separately

Maximum length: 32
Example:

"abc123abc"

​
segment
enum<string>

Field enables to group an entity into a segment. This field will be exported but no logic is applied to this in Enfuce API

Available options:
SEGMENT_A,
SEGMENT_B,
SEGMENT_C,
SEGMENT_D,
SEGMENT_E,
SEGMENT_F
​
referenceNumber
string

Unique card identifier for given card

Required string length: 1 - 16
Example:

"123456789123456"

​
scheduledClosing
object

Scheduled closing of the card. Use of this object should be aligned with Enfuce prior to use.

​
additionalValues
object[]

The additionalValues array is used to store information in the form of key-value pairs. Enfuce does not perform any validation on these key-value pairs beyond ensuring they adhere to the character limit constraints. The primary purpose of these key-value pairs is to store data without further processing. In newer versions of the card personalization files, these key-value pairs are included in the file. However, this inclusion is version-dependent. We recommend consulting the specific version details of your card personalization files to confirm whether these values will be added to the card personalization file in your case.

​
usageLimits
object[]
​
cardAddress
object

Address used to deliver card

​
cardDeliveryType
enum<string>

Valid card delivery types in API

Available options:
CUSTOM_1,
CUSTOM_2,
CUSTOM_3,
CUSTOM_4,
CUSTOM_5,
MAIL,
COURIER
​
pinAddress
object

Address used to deliver pin

​
pinAttempts
object

These values refer to online PIN, not offline PIN.

​
pinDeliveryType
enum<string>

Valid pin delivery types in API

Available options:
CUSTOM_1,
CUSTOM_2,
CUSTOM_3,
CUSTOM_4,
CUSTOM_5,
MAIL,
COURIER,
EPIN