POST
/
Cloud
/
register
/
{entry}
curl --request POST \
  --url https://api-sandbox.payabli.com/api/Cloud/register/{entry} \
  --header 'Content-Type: application/json' \
  --header 'requestToken: <api-key>' \
  --data '{
  "registrationCode": "GHTYY",
  "description": "Front Desk POS"
}'
{
  "isSuccess": true,
  "responseCode": 1,
  "responseText": "Success",
  "responseData": "3f4a3fd1-5f46-4e54-8dfe-83d3ac1b5ad3",
  "pageIdentifier": null
}

Authorizations

requestToken
string
header
required

Most endpoints require an organization token. Some endpoints require an application token, and those endpoints are noted.

Headers

idempotencyKey
string

A unique ID you can include to prevent duplicating objects or transactions if a request is sent more than once. This key is not generated in Payabli, you must generate it yourself.

Example:

"6B29FC40-CA47-1067-B31D-00DD010662DA"

Path Parameters

entry
string
required

The paypoint's entrypoint identifier. Learn more

Example:

"8cfec329267"

Body

registrationCode
string | null
required

The device registration code or serial number, depending on the model.

  • Ingenico devices: This is the activation code that's displayed on the device screen during setup.

  • PAX A920 device: This code is the serial number on the back of the device.

Example:

"GHTYY"

description
string | null

Description or name for the device. This can be anything, but Payabli recommends entering the name of the paypoint, or some other easily-identifiable descriptor. If you have several devices for one paypoint, you can give them descriptions like "Cashier 1" and "Cashier 2", or "Front Desk" and "Back Office"

Example:

"Front Desk POS"

Response

200
application/json
Success
isSuccess
boolean

Boolean indicating whether the operation was successful. A true value indicates success. A false value indicates failure.

Example:

true

responseText
string | null

Response text for operation: 'Success' or 'Declined'.

Example:

"Success"

responseData
object

If isSuccess = true, this contains the device identifier. If isSuccess = false, this contains the reason for the error.

pageIdentifier
string | null

Auxiliary validation used internally by payment pages and components.

Example:

null