Device/getTerminalHealth

Terminal Health Check

Planned

Planned. This contract is published ahead of the build. It is not callable yet. Treat it as the shape to design against, not a live endpoint.

Verify the terminal is reachable and ready to accept transactions.

GET/v1/terminal/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 kepa 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.

lastTransactionTimestring · ISO 8601nullable

Timestamp of the last completed transaction.

uptimeinteger

Terminal uptime in seconds since last boot.

Example 86400

getTerminalHealth