PApayarc
Terminal

Get terminal status

Returns the full status of the terminal identified by serial number. online reflects the terminal's own status as reported by PAXSTORE. payarcConnectOnline reflects whether the terminal currently has a live connection to the Payarc Connect platform (AWS IoT); it is true/false, or null when no connection event has been observed for the terminal yet. Device details (network, battery, model, firmware, IP) come from PAXSTORE; when the terminal is offline these are the last-known values as of lastSeenTime.

get/v3/terminals/{serialNum}/status

Request

  • Base URL
    https://testpayarcconnectapi.payarc.net
  • URL
    https://testpayarcconnectapi.payarc.net/v3/terminals/{serialNum}/status
  • Auth
    HTTP bearer

Path parameters

serialNumstring required

Terminal serial number.

Headers

Authorizationstring required

Bearer token used to authenticate API requests.

Response

Terminal status.

serialNumberstring

Terminal serial number.

onlineboolean

The terminal's own status as reported by PAXSTORE.

payarcConnectOnlineboolean nullable

Whether the terminal currently has a live connection to the Payarc Connect platform (AWS IoT). null when no connection event has been observed for the terminal yet.

networkstring nullable

Active network interface reported by PAXSTORE (e.g. NETWORK_WIFI, NETWORK_ETHERNET).

batteryLevelnumber nullable

Battery level percentage.

modelstring nullable

Terminal model.

firmwarestring nullable

Installed firmware name/version.

ipAddressstring nullable

Terminal IP address.

lastSeenTimestring date-time nullable

Last time the terminal checked in with PAXSTORE. When the terminal is offline, the device-reported fields are last-known as of this time.

Changes

No recorded changes to this operation across all 1 revision of this API.