An Integration Request allows Centrapay users to request the creation of an Integration API on a Centrapay Account.
Attributes
Terminal
Attributes
terminalId
deviceId
Product
Attributes
name
Integration Types
Name | Description |
---|---|
epay | Asset provider ePay |
invenco | Terminal vendor invenco |
skyzer | Terminal vendor skyzer |
smartpay | Terminal vendor smartpay |
verifone | Terminal vendor Verifone |
vista | Terminal vendor vista |
windcave | Terminal vendor Windcave |
/api/integration-requests
This endpoint allows you to create an Integration Request.
Attributes
merchantId
type
terminal
product
Request
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"
}
}
/api/integration-requests/{integrationRequestId}
This endpoint allows you to get an Integration Request.
Request
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"
}
/api/integration-requests
Returns a paginated API response of Integration Requests.
Query Parameters
Attributes
accountId
type
pending
Request
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"
}
}
]
}
/api/integration-requests/{integrationRequestId}/configs
This endpoint allows you to supply configuration values for the Integration Request.
Attributes
terminalId
Request
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"
}
}
/api/integration-requests/{integrationRequestId}/configs
This endpoint allows you to get the configuration values for the Integration Request.
Request
curl -X GET \
https://service.centrapay.com/api/integration-requests/DKTs3U38hdhfEqwF1JKoT2/configs \
-H 'x-api-key: <TOKEN>'
Response
{
"terminalId": "11000021"
}
/api/integration-requests/{integrationRequestId}/activate
This endpoint allows you to activate an Integration Request.
Errors
INTEGRATION_PARAM_MISSING
INTEGRATION_ALREADY_ACTIVATED
Request
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"
}
}
/api/integration-requests/{integrationRequestId}
This endpoint allows you to delete an Integration Request.
Request
curl -X DELETE \
https://service.centrapay.com/api/integration-requests/DKTs3U38hdhfEqwF1JKoT2 \
-H 'x-api-key: <TOKEN>'
Response
{}