In a cloud Terminal API integration, terminals establish a websockets connection to access Terminal API over the cloud. Our POS Support Team needs to enable websockets for you. After websockets are enabled, you can verify in real time whether terminals have a live cloud connection.
You can verify this:
Check in the Customer Area
In your Customer Area, you can view the terminals list or the terminal details to verify whether terminals have a live cloud connection to Terminal API:
In your Customer Area, go to Point of sale > Terminals.
Check the Websocket column. This uses cloud symbols to indicate the cloud connection status of each terminal, or a minus sign () if web sockets aren't enabled.
If the Websocket column isn't shown, select the settings icon and select the column.
There is a delay between the actual status and the status shown in the list. You may want to check an individual terminal as described below.
Select the terminal from the list.
The page Settings > About this terminal appears.
If you don't see the field Cloud connection, websockets aren't enabled for the terminal.
At Cloud connection, select Check connection.
An icon indicates the result, and a message pops up, either:
- Terminal is connected
- Terminal is disconnected
The terminal is turned off, or there is a problem with the terminal's cloud connection.
The connection icon is not updated automatically. You need to click Check connection each time you want to know the current state.
Check using an API call
/connectedTerminals API, returns a list of terminals for a specific merchant account or store that have a live cloud connection. You can also use this API to check if a specific terminal has a live cloud connection.
The endpoint to use differs for test and live terminals:
- For test terminals:
- For live terminals:
Authenticate your requests using the same API key that you use for your Terminal API requests.
To verify whether terminals have a live cloud connection to Terminal API:
Make a POST request to the test or live
Parameter Required Description
The merchant account that you want to check.
The store that you want to check. Must belong to the specified
The POIID of the terminal that you want to check, in the format [device model]-[serial number]. Must belong to the specified
Here are some example requests:
You receive a response with:
uniqueTerminalIds: An array with the POIIDs of the terminals that have a live cloud connection. If you checked a specific terminal, the same
uniqueTerminalIdfrom the request is returned.
uniqueTerminalIdsarray from the response is empty, this can indicate:
- No terminal found with a live cloud connection.
- Websockets are not enabled.
Check on the terminal
To verify on the physical terminal whether it has a live cloud connection to Terminal API, run a Terminal API connection test:
- Check the icons in the top row of the terminal display.
There should be a cloud icon.
- Go to the Admin menu.
- Select Network > Diagnostics > Terminal API.
The items API enabled, WebSocket enabled, and WebSocket connection should all have a green check mark .
Restore the cloud connection
If the result from your check indicates the terminal doesn't have a live cloud connection to Terminal API:
Check that websockets are enabled:
In your Customer Area > Point of sale select the terminal and go to Settings > Integrations > field Enable WebSockets.
If disabled, ask our POS Support Team to enable websockets.
If you checked remotely, verify that the terminal wasn't turned off at the time.
- If the terminal is turned on, restart/reboot it.