kepa
Device/getDeviceHealth

Terminal Health Check

Verify the terminal is reachable and ready to accept transactions.

GET/v1/device/health
Returns the current health, battery, connectivity, and firmware of the terminal. Call this before initiating a sale to confirm the terminal is reachable and ready. In cloud mode the call is routed through Atlas infrastructure, so the response also reflects relay and WAN health — not just the local terminal state.

Response

application/json

connectedbooleanrequired

Whether the terminal is connected and operational.

Example: true
terminalIdstringrequired

Terminal identifier (TID).

Example: "TID-00012345"
serialNumberstring

Device serial number.

Example: "SN-9876543210"
firmwareVersionstring

Current firmware version.

Example: "1.4.2"
batteryLevelintegernullable

Battery level percentage (null for mains-powered terminals).

Example: 87
connectivityobject

Network connectivity details.

methodenum

Connectivity method.

WIFICELLULARETHERNETUSB
signalStrengthintegernullable

Signal strength in dBm (null for wired).

networkNamestringnullable

Network SSID or name.

lastTransactionTimestring · ISO 8601nullable

Timestamp of the last completed transaction.

uptimeinteger

Terminal uptime in seconds since last boot.

Example: 86400

commerce-api/openapi.yaml · getDeviceHealth

GETLocal
http://terminal:8443/v1/device/health
Request
curl http://terminal:8443/v1/device/health \
  -H "X-Api-Key: $ATLAS_API_KEY"
Response
{
  "connected": true,
  "terminalId": "TID-00012345",
  "serialNumber": "SN-9876543210",
  "firmwareVersion": "1.4.2",
  "batteryLevel": 87,
  "connectivity": {
    "method": "WIFI",
    "signalStrength": -42,
    "networkName": "StoreNetwork-5G"
  },
  "lastTransactionTime": "2026-03-28T09:14:22Z",
  "uptime": 86400
}