Sign in

v1

latestOpenAPI 3.0.32026-07-26208618579.9 KB
Get application

Get application

This operation will respond with an application

get/v1/application/{id}

Path parameters

idstring biginteger required

The card id for given application

Query parameters

auditUserstring required

The audit user to log the request

Response

Successful lookup of the application

applicationNamestring

Name of the application displayed on the POS terminal in text

enabledboolean

Allows to define if an application (PAN) is active on the chip. Only active applications are displayed

printedboolean

To indicate if this PAN is printed on the physical card

contactPriorityLevelinteger

Priority level of the application (PAN) on a POS terminal (Lowest is the first application listed)

contactlessPriorityLevelinteger

Priority level of the contactless application (PAN) (not visible on terminal). Application with the lowest value will be used for contactless purchases

digitalLayoutCodestring

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

accountIdstring

The account id card is linked to

idstring

Unique transaction id

maskedCardNumberstring

Card number, masked in order to protect sensitive data

productCodestring

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.

referenceNumberstring

Unique card identifier for given card

status'CARD_OK' | 'CARD_BLOCKED' | 'SUSPECTED_FRAUD' | 'CARD_CLOSED_DUE_TO_FRAUD' | 'CARD_NO_RENEWAL' | 'CARD_LOST' | 'CARD_STOLEN' | 'CARD_CLOSED' | 'CARD_EXPIRED'
  • 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
statusDatestring date-time

Last updated on

Example response

{
  "applicationName": "APPLICATION",
  "digitalLayoutCode": "abc123abc",
  "accountId": "1234567890",
  "maskedCardNumber": "123456______4285",
  "productCode": "MC_CARD_2, VISA_CARD1, VISA_VIRTUAL_3, MC_VIRTUAL_2, VISA_CARD",
  "referenceNumber": "123456789123456",
  "statusDate": "2020-05-12T13:18:05",
  "usageLimits": [
    {
      "values": [
        {
          "reset": true,
          "singleAmount": 1000,
          "count": 5,
          "sumAmount": 1200,
          "availableAmount": 1200,
          "availableCount": 1200,
          "usedAmount": 1200,
          "usedCount": 1200
        }
      ]
    }
  ]
}