Accept paymentsWays to get paidCard-presentDevicesAPI

Manage PAX devices

Learn how to set up, register, list, and unregister PAX devices with the Payabli API
View as MarkdownOpen in Claude
Applies to:Developers

The PAX A920 is Payabli’s PAX device. This portable terminal accepts magnetic stripe, EMV chip, and NFC contactless payments. It processes transactions initiated through the Payabli Virtual Terminal or your integrated software. This guide covers how to set up, register, list, and unregister PAX devices through the API. For AXIUM devices, see Manage AXIUM devices.

Contact your Payabli solutions engineer to start the process of integrating with the PAX A920.

Set up the device

When you receive your PAX A920 device, follow these instructions to unbox and get the device ready to register in Payabli.

When you receive your PAX A920 device, follow these instructions to unbox and get the device ready to register in Payabli.

1

Unbox the Device

The PAX A920 comes with a USB power cord and 3 rolls of receipt paper (one roll preinstalled).

2

Power the Device

  1. Plug the device in to a power source. You can plug into a wall or a computer using the included USB power adapter.
  2. Fully charge the device before turning it on.
  3. When the device is charged, power it on by pressing and holding the small rectangle button on the right side of the device for 2 to 4 seconds.
3

Connect to WiFi

After the device boots up, it automatically launches the WSPLink app. You can’t use your own apps with the PAX device

  1. Exit the WSPLink app by pressing the top left and bottom right corners of the screen at the same time.
  2. Open the Settings app.
  3. Toggle WiFi on, then press Wi-Fi. The device will detect nearby WiFi networks.
  4. Select the network you want to connect to, enter password, and allow the device to connect.

The PAX A920 connects only to 2.4Ghz WiFi networks, and can’t connect to 5 GHz networks.

  1. Press the circle icon at the bottom of the screen to go back to the home screen.
4

Let the Device Update

After the device connects to WiFi, it will cycle through updating the embedded software. This step can take up to 15 minutes, and the device may make some noises or alerts during this process.

Don’t turn off the device, open any apps or disconnect WiFi during the update process.

When the updates have finished, the screen will be fully white.

6

Register the Device in Payabli

Now, you must register the device in Payabli before you can accept payments.

Register a device

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

The registration code is 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”.

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

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

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

List devices

Send a GET request to /api/Query/devices/{entry} to retrieve the devices registered to a paypoint. For organization-wide results, use /api/Query/devices/org/{orgId}. The response includes every device model registered to the paypoint or organization; see Devices overview for how to tell them apart.

This example lists devices for the 8cfec329267 paypoint.

GET
/api/Query/devices/:entry
1curl -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)
Try it

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.

Response
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, including make and model, is on the List devices by paypoint API reference; for operator syntax and pagination, see the Filters and conditions reference.

Unregister a device

Send a DELETE request to /api/Cloud/register/{entry}/{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.

DELETE
/api/Cloud/register/:entry/:deviceId
1curl -X DELETE https://api-sandbox.payabli.com/api/Cloud/register/8cfec329267/499585-389fj484-3jcj8hj3 \
2     -H "Authorization: Bearer <token>"
Try it

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

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

Asynchronous transaction flow

The PAX A920 device uses an asynchronous flow to process transactions. After you initiate a transaction via the Payabli Virtual Terminal or your own integrated software, the Payabli API sends a response to indicate the transaction has been initiated. The device is then ready to collect payment information from the customer. After the transaction is completed, the final status is sent to you in a webhook event.

1

Initiate transaction

A transaction is initiated from the Payabli Virtual Terminal or your own integrated software.

2

Initial response

The Payabli API responds with the current status of the transaction. The transaction isn’t complete yet.

3

Collect payment

The PAX A920 device collects payment information from the customer.

4

Webhook response

When the transaction is complete, the API sends a webhook event to notify you of the final status of the transaction.

You must enable webhook notifications to receive them. They are not sent by default. See Set up and receive events using Web for more information.

The response for an initiated transaction looks like this:

Initiated transaction response
1{
2  "responseText": "Success",
3  "isSuccess": true,
4  "pageIdentifier": null,
5  "responseData": {
6    "authCode": null,
7    "referenceId": "237-e2928ea2f73d473f95f4094d56870ffc",
8    "resultCode": 1,
9    "resultText": "Initiated",
10    "avsResponseText": null,
11    "cvvResponseText": null,
12    "customerId": 319082,
13    "methodReferenceId": null
14  }
15}

The resultText has a value of "Initiated", which means the transaction is in progress.

Webhooks

To get the final status of the transaction, you need to listen for either the ApprovedPayment webhook event or the DeclinedPayment webhook event. The webhook payloads for a completed transaction look like this:

1{
2  "Event": "ApprovedPayment",
3  "Paypoint": "Athlete Factory LLC\r\n",
4  "Text": "Payment Approved!",
5  "transId": "10-33eb676a-da48-401f-9494-e69a324b152d",
6  "NetAmount": "100.00",
7  "Fee": "0.00",
8  "TotalAmount": "100.00",
9  "transTime": "04/04/2022 13:56:17",
10  "CustomerId": "224",
11  "CustomerNumber": "888"
12}

See Notifications and Reports Overview for more information on how to set up webhooks.

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