POST
/
api
/
terminal
/
list
curl --request POST \
  --url 'https://api.atoa.me/api/terminal/list' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
    "storeIds": [
      "43c7b991-0803-4177-9589-d165d9a779f6",
      "9f8e7d6c-5b4a-3210-fedc-ba9876543210"
    ],
    "availability": true
  }'
[
  {
    "id": "1",
    "name": "Front Till",
    "serialNumber": "100200300",
    "storeId": "43c7b991-0803-4177-9589-d165d9a779f6",
    "online": true,
    "lastActive": 1720512000,
    "tokenMissing": false
  }
]

Returns the POS terminals registered against the merchant, resolved from the SDK API key you authenticate with.

Live online status (online and lastActive) is resolved via a real-time presence lookup against the terminals’ push-notification devices. This runs by defaultavailability defaults to true. Pass availability: false in the body to skip the lookup (the request is then faster); online is returned as false and lastActive as null.

Authorization

Bearer <token>

Body

storeIds
string[]

Filter terminals by one or more stores. Each value must be a valid store UUID. If omitted, terminals across all of the merchant’s stores are returned.

availability
boolean
default: "true"

When true (the default), performs a live presence lookup and populates the online and lastActive fields for each terminal. Pass false to skip the lookup; those fields are then not resolved (online is false, lastActive is null).

Response

Returns an array of POS terminal objects.

id
string
required

Primary key of the POS terminal. Use this value as the id when initiating a remote payment.

name
string

Human-readable name of the POS terminal. Can be null when no name is set.

serialNumber
string
required

Hardware serial number of the POS terminal device.

storeId
string

ID of the store the terminal belongs to.

online
boolean
required

Whether the device is currently online according to its push-notification presence. Only meaningful when the request was made with availability: true (the default); otherwise always false.

lastActive
number

Unix timestamp (in seconds) of the device’s last presence activity. null when unknown or when availability: false was sent.

tokenMissing
boolean
required

true when no push-notification device token is registered against the terminal. Such a terminal cannot receive remote payments and will always report online: false.