Integration Requests

An Integration Request allows Centrapay users to request the creation of an Integration  API  on a Centrapay Account.

Attributes

  • id

    string

    The unique identifier of the Integration Request.

  • accountId

    string

    The Integration Request’s owning Centrapay Account  API  id.

  • merchantId

    string

    The Merchant  API  id for the Integration Request.

  • type

    object

    The type of the Integration Request. Refer to Integration Types.

  • status

    string

    The current status of the Integration Request. Supported values are active, available, pending, rejected and disabled.

  • terminalId

    string

    Epay terminalId for the Integration Request. Required if type is epay.

  • terminal

    object

    The terminal configuration. Required for all terminal vendors except Vista. Refer to Terminal.

  • product

    object

    The requested Epay gift card types to support. Refer to Product.

  • createdAt

    timestamp

    When the Integration Request was created.

  • createdBy

    crn

    The User or API Key that created the Integration Request.

  • updatedAt

    timestamp

    When the Integration Request was updated.

  • updatedBy

    crn

    The User or API Key that updated the Integration Request.

  • notifiedAt

    timestamp

    When the Integration Request was submitted to the terminal provider in order to enable the terminal for Centrapay acceptance.

Terminal

Attributes

  • terminalId

    string

    The software or logical id of the payment terminal.

  • deviceId

    string

    The hardware id or serial number of the payment terminal.


Product

Attributes

  • name

    string

    The name of the requested Epay product.

Integration Types

NameDescription
epayAsset provider ePay
invencoTerminal vendor invenco
skyzerTerminal vendor skyzer
smartpayTerminal vendor smartpay
verifoneTerminal vendor Verifone
vistaTerminal vendor vista
windcaveTerminal vendor Windcave

POST/api/integration-requests

This endpoint allows you to create an Integration Request.

Attributes

  • merchantId

    stringrequired

    The Merchant  API  id for the Integration Request.

  • type

    objectrequired

    The type of the Integration Request. Refer to Integration Types.

  • terminal

    object

    The terminal configuration. Required for all terminal vendors except Vista. Refer to Terminal.

  • product

    object

    The requested Epay gift card types to support. Refer to Product.

Request
POST/api/integration-requests
curl -X POST \
 https://service.centrapay.com/api/integration-requests \
 -H 'content-type: application/json' \
 -H 'x-api-key: <TOKEN>' \
 -d '
{
 "merchantId": "5ee0c486308f590260d9a07f",
 "type": "verifone",
 "terminal": {
  "terminalId": "002039390093939",
  "deviceId": "002-039-390"
 }
}
'
Response
{
  "id": "DKTs3U38hdhfEqwF1JKoT2",
  "accountId": "Jaim1Cu1Q55uooxSens6yk",
  "merchantId": "5ee0c486308f590260d9a07f",
  "type": "verifone",
  "status": "pending",
  "createdAt": "2020-06-12 01:17:46 UTC",
  "updatedAt": "2020-06-12 01:17:46 UTC",
  "createdBy": "crn:WIj211vFs9cNACwBb04vQw:api-key:MyApiKey",
  "updatedBy": "crn:WIj211vFs9cNACwBb04vQw:api-key:MyApiKey",
  "terminal": {
    "terminalId": "002039390093939",
    "deviceId": "002-039-390"
  }
}

GET/api/integration-requests/{integrationRequestId}

This endpoint allows you to get an Integration Request.

Request
GET/api/integration-requests/DKTs3U38hdhfEqwF1JKoT2
curl -X GET \
 https://service.centrapay.com/api/integration-requests/DKTs3U38hdhfEqwF1JKoT2 \
 -H 'x-api-key: <TOKEN>'
Response
{
  "id": "DKTs3U38hdhfEqwF1JKoT2",
  "accountId": "Jaim1Cu1Q55uooxSens6yk",
  "merchantId": "5ee0c486308f590260d9a07f",
  "type": "epay",
  "status": "pending",
  "terminalId": "11000021",
  "createdAt": "2020-06-12T01:17:46.499Z",
  "updatedAt": "2020-06-12T01:17:46.499Z",
  "createdBy": "crn:WIj211vFs9cNACwBb04vQw:api-key:MyApiKey",
  "updatedBy": "crn:WIj211vFs9cNACwBb04vQw:api-key:MyApiKey",
  "product": {
    "name": "koha-card"
  },
  "notifiedAt": "2020-06-13T05:00:00.000Z"
}

GET/api/integration-requests

Returns a paginated  API  response of Integration Requests.

Query Parameters

Attributes

  • accountId

    string

    The Integration Request’s owning Centrapay Account id. Required unless caller has global read access permission.

  • type

    string

    The type of Integration Request.

  • pending

    boolean

    When set to true, only include Integration Requests with pending status.

Request
GET/api/integration-requests
curl -X GET \
 'https://service.centrapay.com/api/integration-requests?type=epay&pending=true&accountId=Jaim1Cu1Q55uooxSens6yk' \
 -H 'x-api-key: <TOKEN>'
Response
{
  "items": [
    {
      "id": "DKTs3U38hdhfEqwF1JKoT2",
      "accountId": "Jaim1Cu1Q55uooxSens6yk",
      "merchantId": "5ee0c486308f590260d9a07f",
      "type": "epay",
      "status": "pending",
      "terminalId": "11000021",
      "createdAt": "2020-06-12T01:17:46.499Z",
      "updatedAt": "2020-06-12T01:17:46.499Z",
      "createdBy": "crn:WIj211vFs9cNACwBb04vQw:api-key:MyApiKey",
      "updatedBy": "crn:WIj211vFs9cNACwBb04vQw:api-key:MyApiKey",
      "product": {
        "name": "koha-card"
      }
    }
  ]
}

PUT/api/integration-requests/{integrationRequestId}/configs

This endpoint allows you to supply configuration values for the Integration Request.

Attributes

  • terminalId

    string

    Epay terminalId for the Integration Request. Required if type is epay.

Request
PUT/api/integration-requests/DKTs3U38hdhfEqwF1JKoT2/configs
curl -X PUT \
 https://service.centrapay.com/api/integration-requests/DKTs3U38hdhfEqwF1JKoT2/configs \
 -H 'content-type: application/json' \
 -H 'x-api-key: <TOKEN>' \
 -d '
{
 "terminalId": "11000021"
}
'
Response
{
  "id": "DKTs3U38hdhfEqwF1JKoT2",
  "accountId": "Jaim1Cu1Q55uooxSens6yk",
  "merchantId": "5ee0c486308f590260d9a07f",
  "type": "epay",
  "status": "pending",
  "terminalId": "11000021",
  "createdAt": "2020-06-12T01:17:46.499Z",
  "updatedAt": "2020-06-12T01:17:46.499Z",
  "createdBy": "crn:WIj211vFs9cNACwBb04vQw:api-key:MyApiKey",
  "updatedBy": "crn:WIj211vFs9cNACwBb04vQw:api-key:MyApiKey",
  "product": {
    "name": "koha-card"
  }
}

GET/api/integration-requests/{integrationRequestId}/configs

This endpoint allows you to get the configuration values for the Integration Request.

Request
GET/api/integration-requests/DKTs3U38hdhfEqwF1JKoT2/configs
curl -X GET \
 https://service.centrapay.com/api/integration-requests/DKTs3U38hdhfEqwF1JKoT2/configs \
 -H 'x-api-key: <TOKEN>'
Response
{
  "terminalId": "11000021"
}

POST/api/integration-requests/{integrationRequestId}/activate

This endpoint allows you to activate an Integration Request.

Errors

  • INTEGRATION_PARAM_MISSING

    403

    Integration Request needs updating with the required parameters before activating.

  • INTEGRATION_ALREADY_ACTIVATED

    403

    Integration Request is already activated.

Request
POST/api/integration-requests/DKTs3U38hdhfEqwF1JKoT2/activate
curl -X POST \
 https://service.centrapay.com/api/integration-requests/DKTs3U38hdhfEqwF1JKoT2/activate \
 -H 'x-api-key: <TOKEN>'
Response
{
  "id": "DKTs3U38hdhfEqwF1JKoT2",
  "accountId": "Jaim1Cu1Q55uooxSens6yk",
  "merchantId": "5ee0c486308f590260d9a07f",
  "type": "epay",
  "status": "active",
  "terminalId": "11000021",
  "createdAt": "2020-06-12T01:17:46.499Z",
  "updatedAt": "2020-06-12T01:17:46.499Z",
  "createdBy": "crn:WIj211vFs9cNACwBb04vQw:api-key:MyApiKey",
  "updatedBy": "crn:WIj211vFs9cNACwBb04vQw:api-key:MyApiKey",
  "product": {
    "name": "koha-card"
  }
}

DELETE/api/integration-requests/{integrationRequestId}

This endpoint allows you to delete an Integration Request.

Request
DELETE/api/integration-requests/DKTs3U38hdhfEqwF1JKoT2
curl -X DELETE \
 https://service.centrapay.com/api/integration-requests/DKTs3U38hdhfEqwF1JKoT2 \
 -H 'x-api-key: <TOKEN>'
Response
{}