Manage AXIUM devices

Use the Payabli API to register, list, and monitor AXIUM devices — Ingenico semi-integrated terminals that capture card data at the terminal.

Add a device

Register an AXIUM terminal to a paypoint by generating a one-time activation code, then entering it on the device. The terminal binds to the paypoint the first time an operator enters a valid code.

To generate an activation code, send a POST request to the /api/Device/challenge/{entry} endpoint, where {entry} is the entrypoint of the paypoint the device registers to. Authenticate with an OAuth2 Bearer token that has the device_registry scope.

For complete details, see the API reference for this endpoint.

This example generates an activation code for the 8cfec329267 paypoint.

1
curl -X POST https://api-sandbox.payabli.com/api/Device/challenge/8cfec329267 \
2
     -H "Authorization: Bearer <token>"

The response returns a 6-digit code and its expiresAt timestamp. A code expires 5 minutes after it’s issued.

1
{
2
  "responseText": "Success",
3
  "responseData": {
4
    "code": "748801",
5
    "expiresAt": "2026-08-13T19:58:27.5860203Z"
6
  },
7
  "responseCode": 1,
8
  "pageIdentifier": "",
9
  "roomId": 0,
10
  "isSuccess": true
11
}

An operator enters the code on the terminal, along with a device name, and the terminal registers itself to the paypoint. A paypoint can have several codes active at once — for example, when registering a batch of devices — and each code binds to whichever device enters it first.

After the terminal is registered, list the paypoint’s devices to find it by its device name (friendlyName) and copy its deviceId. You use the deviceId to target the terminal when you run transactions.

List devices for a paypoint

Send a GET request to /api/Query/devices/{entry} to retrieve the devices registered to a paypoint. The response includes both cloud and AXIUM hardware — see Devices overview for how to tell them apart.

This example lists devices for the 8cfec329267 paypoint.

1
curl -G https://api-sandbox.payabli.com/api/Query/devices/8cfec329267 \
2
     -H "Authorization: Bearer <token>" \
3
     -d fromRecord=0 \
4
     -d limitRecord=20 \
5
     -d sortBy=desc(createdAt)

The response returns matching devices in Records and aggregate totals in Summary. Use Summary.totalRecords and Summary.totalPages with the fromRecord and limitRecord query parameters to page through results.

1
{
2
  "Summary": {
3
    "pageIdentifier": null,
4
    "pageSize": 20,
5
    "totalAmount": 0,
6
    "totalNetAmount": 0,
7
    "totalPages": 2,
8
    "totalRecords": 28
9
  },
10
  "Records": [
11
    {
12
      "deviceId": "499585-389fj484-3jcj8hj3",
13
      "idCloud": 142,
14
      "description": "Front Counter Terminal",
15
      "serialNumber": "SN-90210-XR",
16
      "friendlyName": "Front Counter",
17
      "make": null,
18
      "model": null,
19
      "deviceType": 1,
20
      "deviceStatus": 1,
21
      "deviceOs": null,
22
      "macAddress": "1A2B3C4D5E6F",
23
      "lastHealthCheck": "2026-04-09T14:49:42Z",
24
      "registrationCode": "REG-A1B2C3D4",
25
      "activationAttempts": 0,
26
      "activationCodeExpiry": "2026-04-09T14:49:42Z",
27
      "createdAt": "2026-04-09T01:14:37Z",
28
      "updatedAt": "2026-04-09T14:49:42Z",
29
      "paypointId": 3040,
30
      "paypointDba": "Gruzya Adventure Outfitters",
31
      "paypointLegal": "Gruzya Adventure Outfitters, LLC",
32
      "paypointEntry": "8cfec329267",
33
      "paypointLogo": "https://payabli-public-objects.s3.amazonaws.com/pe3040.png",
34
      "externalPaypointId": "GRUZYA-01",
35
      "parentOrgId": 100,
36
      "parentOrgName": "Mountain View Services",
37
      "transactionCount": 342,
38
      "volumeProcessed": 28650.75
39
    }
40
  ]
41
}

Filter and sort results with query parameters — for example, status(eq)=1 for active devices only. The full list of filterable fields is on the List devices by paypoint API reference; for operator syntax and pagination, see the Filters and conditions reference.

List devices for an organization

Send a GET request to /api/Query/devices/org/{orgId} to retrieve the devices registered anywhere in an organization, across all its paypoints. This is the same DeviceQueryRecord shape as the paypoint-level list, with paypointId, paypointDba, and paypointEntry on each record to identify which paypoint a device belongs to.

This example lists devices for the organization with ID 123.

1
curl -G https://api-sandbox.payabli.com/api/Query/devices/org/123 \
2
     -H "Authorization: Bearer <token>" \
3
     -d fromRecord=0 \
4
     -d limitRecord=20 \
5
     -d sortBy=desc(createdAt)

The response returns matching devices in Records and aggregate totals in Summary, with the same pagination fields as the paypoint-level list.

1
{
2
  "Summary": {
3
    "pageIdentifier": null,
4
    "pageSize": 20,
5
    "totalAmount": 0,
6
    "totalNetAmount": 0,
7
    "totalPages": 2,
8
    "totalRecords": 28
9
  },
10
  "Records": [
11
    {
12
      "deviceId": "499585-389fj484-3jcj8hj3",
13
      "idCloud": 142,
14
      "description": "Front Counter Terminal",
15
      "serialNumber": "SN-90210-XR",
16
      "friendlyName": "Front Counter",
17
      "make": null,
18
      "model": null,
19
      "deviceType": 1,
20
      "deviceStatus": 1,
21
      "deviceOs": null,
22
      "macAddress": "1A2B3C4D5E6F",
23
      "lastHealthCheck": "2026-04-09T14:49:42Z",
24
      "registrationCode": "REG-A1B2C3D4",
25
      "activationAttempts": 0,
26
      "activationCodeExpiry": "2026-04-09T14:49:42Z",
27
      "createdAt": "2026-04-09T01:14:37Z",
28
      "updatedAt": "2026-04-09T14:49:42Z",
29
      "paypointId": 3040,
30
      "paypointDba": "Gruzya Adventure Outfitters",
31
      "paypointLegal": "Gruzya Adventure Outfitters, LLC",
32
      "paypointEntry": "8cfec329267",
33
      "paypointLogo": "https://payabli-public-objects.s3.amazonaws.com/pe3040.png",
34
      "externalPaypointId": "GRUZYA-01",
35
      "parentOrgId": 100,
36
      "parentOrgName": "Mountain View Services",
37
      "transactionCount": 342,
38
      "volumeProcessed": 28650.75
39
    }
40
  ]
41
}

Filter and sort the same way as the paypoint-level list — for example, paypointEntry(eq)=8cfec329267 to scope results to one paypoint within the org. The full list of filterable fields is on the List devices by organization API reference.

Related resources

See these related resources to help you get the most out of Payabli.