POST
/
Cloud
/
register
/
{entry}

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.

Path Parameters

entry
string
required

The paypoint's entrypoint identifier. Learn more

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.

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"

Response

200 - application/json
isSuccess
boolean

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

pageIdentifier
string | null

Auxiliary validation used internally by payment pages and components.

responseData
object

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

responseText
string | null

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