Manage cloud devices

Use Payabli’s device management functions to register, unregister, and list cloud devices. This guide covers the key operations for managing devices through the API.

Register a device

Send a POST request to /api/Cloud/register/{paypointId} to register a new cloud device. See the API reference for this endpoint for full documentation.

The registration code you need varies depending on your device. For an Ingenico device, you need the activation code that appears on the screen after you configure WiFi. For a PAX A920 device, you need the serial number on the back of the device.

This example registers the device with the registration code YS7DS5 to the 8cfec329267 paypoint, and gives it the description of “Front Desk POS”.

1
curl -X POST https://api-sandbox.payabli.com/api/Cloud/register/8cfec329267 \
2
     -H "requestToken: <apiKey>" \
3
     -H "Content-Type: application/json" \
4
     -d '{
5
  "description": "Front Desk POS",
6
  "registrationCode": "YS7DS5"
7
}'

A successful registration returns a response with the device ID in the body.

1
{
2
  "isSuccess": true,
3
  "responseData": "6c361c7d-674c-44cc-b790-382b75d1xxx",
4
  "responseText": "Success"
5
}

List devices

Send a GET request to /api/Cloud/list/{paypointId} to retrieve a list of registered devices for a paypoint. See the API reference for this endpoint for full documentation.

This example lists devices for the 8cfec329267 paypoint.

1
curl https://api-sandbox.payabli.com/api/Cloud/list/8cfec329267 \
2
     -H "requestToken: <apiKey>"

This request returns a list of devices registered to the paypoint.

1
{
2
  "isSuccess": true,
3
  "responseList": [
4
    {
5
      "connected": true,
6
      "dateRegistered": "2024-03-05T15:56:04Z",
7
      "deviceId": "36103e24-41d8-47c9-b5f7-119f0000000",
8
      "deviceNickName": "Front Desk POS",
9
      "make": "ingenico",
10
      "model": "LK2500",
11
      "registered": true,
12
      "serialNumber": "312345692080000000"
13
    }
14
  ],
15
  "responseText": "Success"
16
}

Unregister a device

Send a DELETE request to /api/Cloud/register/{paypointId}/{deviceId} to remove a device registration. See the API reference for this endpoint for full documentation.

This example unregisters the device with the deviceId 6c361c7d-674c-44cc-b790-382b75d1xxx from the 8cfec329267 paypoint.

1
curl -X DELETE https://api-sandbox.payabli.com/api/Cloud/register/8cfec329267/6c361c7d-674c-44cc-b790-382b75d1xxx \
2
     -H "requestToken: <apiKey>"

A successful operation returns a 200 response with the device ID in the body.

1
{
2
  "isSuccess": true,
3
  "responseData": "6c361c7d-674c-44cc-b790-382b75d1xxx",
4
  "responseText": "Success"
5
}