API referencePay In endpointsCloud devices

Register device

Register a cloud device to an entrypoint. See Devices Quickstart for a complete guide.

Authentication

requestTokenstring
API Key authentication via header

Path Parameters

entrystringRequired

The paypoint’s entrypoint identifier. Learn more

Headers

idempotencyKeystringOptional
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.

Request

This endpoint expects an object.
descriptionstringOptional

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”

registrationCodestringOptional
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.

Response

Success
isSuccessboolean or null

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

pageIdentifierstring or null
Auxiliary validation used internally by payment pages and components.
responseDatastring or null

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

responseTextstring or null

Response text for operation: ‘Success’ or ‘Declined’.

Errors