Disable a Device

Sometimes, you may want to disable a device associated with a Machine to stop it from processing payments and orders. This can quickly be done programmatically with Lynx API using the endpoint below.

🚧

Authentication

Refer to the Security & Token page of this documentation to learn how to access your tokens, and how to properly use it to authenticate your API requests.

Disabling the Device

Use the Update Device endpoint to update the device's status. You need to provide the DeviceID, ActorID (operator ID), and the new status flag. See an example request in the code block below:

curl -X PUT "https://lynx.nayax.com/operational/api/v1/devices/<DEVICE_ID>" \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{
  "ActorID": "<ACTOR_ID>",
  "StatusID": 2
}'

📘

Path Params

Replace <DEVICE_ID> with the actual identifier of the device you want to disable.

In the Body Parameters, you need to provide the following:

So, to disable the device, change the StatusID to 2. The response will show details about the device, confirming that the device's status has been disabled.

Validate the Updates

You can also use the Get Device by DeviceID endpoint to retrieve the device's information and validate the update's success.

Another way to validate this is within Nayax Core, where you can check the details of each device and validate their current status. Follow the steps below to do so:

1. In your Dashboard, go to Administration > Devices.
2. Use the search function to filter through the list of devices.
3. Select the desired device from the list.
4. Open the General Information tab and see the Status field.