Payment API

Overview

Account Details

Overview
Create an account
Update an account
Get account information

Authorisation Control

Overview
Authorisation Control Webhook

Authorisation Forwarding

Overview
Forward authorisation webhook

Card details

Customer

Overview
Get customer information
Create a customer
Update a customer
Customer hierarchy

Exchange Rates API

Overview
Get ECB exchange rate
Get ECB supported currencies
Get FX exchange rates

ID

Overview
Initiate 3rd party authentication flow
Callback to complete authentication flow

Instalment

Overview
Instalment Controller

Invoice

Overview
Get invoice information
Update invoice information

Notification

Overview
Receive a notification

Overview
PIN operations with pre-shared key
PIN operations using PKI

PIN Control

Overview
PIN Control handling

Purchase Details

Overview
Trigger repricing
Get purchase details
Create purchase details
Update purchase details

RBA Forwarding

Overview
RBA forwarding

Repricing

Overview
Create repricing agreements
Get repricing agreements
Update repricing agreements
Create price lists
Get price lists
Update price lists

Transaction

Overview
Test transactions
Test authorizations
Get transaction data
Create transactions
Create fees
Update a transaction
Batch payment

Transfer API

Overview
Post account to account transfer
Account to account batch transfer
Post card to card transfer

Wallet

Overview
Push Provision
Activation data
Get tokens

Test API

Overview
test-auth-request-templates
test-authorizations

Hierarchy API

Overview
Card Hierarchy Management
Card Hierarchy Group Management
Card Management in Card Hierarchy Groups

Spend Control API

Overview
Rule Sets Endpoints
Rules Endpoints
Spend Control Test Endpoint

Get card

Get card using card number (PAN)

This is a web service designed to lookup an card based on the card number. The payload in the request is encrypted with JWE (JSON Web Encryption), to enable end-to-end encryption from source system to Enfuce.

PCI DSS compliance

Processing payment information (PAN, expiry, CVC2/CVV2) is controlled with strict compliance regulations by the card schemes. There are multiple ways to access the card payment information in Enfuce’s APIs depending on the client solution, and whether the client is a card schema member themselves and therefore responsible for compliance.

The alternative shown here (Get card using card number) relies on that the client is responsible for PCI DSS compliance themselves to the card schema.

POST

card

cardnumber

curl --request POST \
  --url https://integration-api-cat2./%7B{environment}%7D.ext.%7B{realm}%7D.cia.enfuce.com/card/v4/card/cardnumber \
  --header 'Content-Type: application/json' \
  --data '{
  "encryptedData": "<string>"
}'

{
  "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
        }
      ]
    }
  ]
}

Query Parameters

auditUser

string

required

The audit user to log the request

Body

application/json

encryptedData

string

JWE encrypted card number, see details above

Response

200

application/json

Successful lookup of the card

The response is of type any.

Get card Get card using reference number

curl --request POST \
  --url https://integration-api-cat2./%7B{environment}%7D.ext.%7B{realm}%7D.cia.enfuce.com/card/v4/card/cardnumber \
  --header 'Content-Type: application/json' \
  --data '{
  "encryptedData": "<string>"
}'

{
  "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
        }
      ]
    }
  ]
}