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. Once websockets are enabled, you can verify remotely and in real time whether terminals are turned on and have a live cloud connection.
You can verify this:
Use the Customer Area
To verify from your Customer Area whether a specific terminal has a live cloud connection to Terminal API:
In your Customer Area, go to Point of sale > Terminals.
Select the terminal from the list.
The page Settings > About this terminal appears.
At Cloud connection, select Check connection.
An icon indicates the result, and a message pops up, either:
- Terminal is connected
- Terminal is disconnected
- The connection icon is not updated automatically. You need to press Check connection each time you want to know the current state.
- If you don't see Cloud connection, websockets are not enabled for the terminal.
Use an API call
/connectedTerminals API, you can get a list of terminals registered to a specific merchant account or store that have a live cloud connection. You can also 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.