Bolt Device
A Bolt Device is a device that runs Beam Bolt and is registered to your merchant account. It is either a Bolt+
terminal supplied by Beam (BOLT_PLUS) or your own Android device running the Beam Bolt app (BOLT_APP).
A Bolt Device is not created through the API. It is registered automatically once the device is running Beam Bolt on your merchant account.
What a Bolt Device contains
| Field | Meaning |
|---|---|
id | The Bolt Device ID. You use it to read the device, rename it, or run a health check. |
name | The label you give the device, such as Front counter. You can change it at any time. |
type | BOLT_PLUS or BOLT_APP. |
deviceIdentifier | The identifier of the physical device. |
latestMetric | The most recent report from the device, or null if it has never reported. See What a metric contains. |
createdAt | When the device was registered. |
Device health
Device health is the current health of your Bolt Device: whether it is still working, and the state it is in. Each
device reports a metric about itself, and the latest one is the latestMetric field on the device. You can also ask
a device to report now with a health check.
Keep your devices up to date for the best experience. Health checks work best on Beam Bolt v1.15.0 or later. If a
device runs an older version, please contact Beam support and they can help you update it.
Bolt Device health check flow
The 202 Accepted from
Health Check Bolt Device by ID only means that
Beam passed your request on. The result arrives later, when the device sends its metric. A device that is switched off
or has no network cannot send one, so latestMetric keeps the value it had before.
To read the result, call
Get Bolt Device by ID and compare
latestMetric.createdAt with the time you sent the health check. A newer timestamp means the device answered, and a
latestMetric that is still null means it has never reported. A healthy device usually answers in a few seconds, and
a device on a slow mobile network takes longer, so wait 2 to 5 minutes before you decide.
Do not send health checks in quick succession. Each one makes the device collect and send a metric, so too many checks can overwhelm your device.
What a metric contains
| Field | Meaning |
|---|---|
mode | The mode the device runs in: STANDALONE, PAIRING or DEEP_LINK. |
versionName | The version of Beam Bolt installed on the device. |
batteryPercentage | Battery level, from 0 to 100. |
isBatteryCharging | Whether the device is charging. |
connectivityType | The connection the device uses: WIFI or CELLULAR. |
wifiConnectivityStrengthLevel | Wi-Fi signal strength, from 0 (weakest) to 100 (strongest). null if not reported. |
cellularConnectivityStrengthLevel | Mobile signal strength, from 0 (weakest) to 100 (strongest). null if not reported. |
createdAt | When the device reported this metric. |
wifiConnectivityStrengthLevel and cellularConnectivityStrengthLevel are not the internet speed. They only tell you how strong the connection is. A device can have a
strong signal and still be slow, for example on a busy network.
When a device needs attention
- No answer to a health check within 2 to 5 minutes. The device is offline, switched off, or has no network.
- A low
batteryPercentagewhileisBatteryChargingisfalse. The battery is running out. - A low strength level for the connection in
connectivityType. Payments may be slow or may fail.