Readers

Get a Reader Status

Provides the last known status for a Reader.

This endpoint allows you to retrieve updates from the connected card reader, including the current screen being displayed during the payment process and the device status (battery level, connectivity, and update state).

Supported States

IDLE – Reader ready for next transaction
SELECTING_TIP – Waiting for tip input
WAITING_FOR_CARD – Awaiting card insert/tap
WAITING_FOR_PIN – Waiting for PIN entry
WAITING_FOR_SIGNATURE – Waiting for customer signature
UPDATING_FIRMWARE – Firmware update in progress

Device Status

ONLINE – Device connected and operational
OFFLINE – Device disconnected (last state persisted)

Note: If the target device is a Solo, it must be in version 3.3.39.0 or higher.

get/v0.1/merchants/{merchant_code}/readers/{reader_id}/status

Path parameters

merchant_codestring required

Merchant Code

reader_idstring required

The unique identifier of the Reader

Response

Response with the device status.

Example response

{
  "data": {
    "battery_level": 10,
    "battery_temperature": 35,
    "connection_type": "Wi-Fi",
    "firmware_version": "3.3.3.21",
    "last_activity": "2025-09-25T15:20:00Z",
    "state": "IDLE",
    "status": "ONLINE"
  }
}

Changes

Changed in 5 of the 53 revisions of this API.338

Mar 11, 2026cd79d83b07e017See the full diff
- ▲
  the response property errors/type became optional for the status 401
  response-property-became-optional
- ○
  added the media type application/problem+json for the response with the status 400
  response-media-type-added
- ○
  added the media type application/problem+json for the response with the status 401
  response-media-type-added
- ○
  added the media type application/problem+json for the response with the status 404
  response-media-type-added
- ○
  removed the non-success response with the status 500
  response-non-success-status-removed
- ○
  removed the non-success response with the status 502
  response-non-success-status-removed
- ○
  removed the non-success response with the status 504
  response-non-success-status-removed
- ○
  the response property errors/detail became required for the status 401
  response-property-became-required
This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Feb 25, 2026bef1083e05803See the full diff
- ●
  deleted the header request parameter Accept
  request-parameter-removed
- ●
  deleted the header request parameter Authorization
  request-parameter-removed
- ●
  deleted the header request parameter Content-Type
  request-parameter-removed
This revision also has 10 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Dec 20, 2025ebe39fb0eb0b1See the full diff
- ▲
  the data/battery_level response's property type/format changed from float/ to number/float for status 200
  response-property-type-changed
Dec 19, 2025bdda188d36dd1See the full diff
- ▲
  the data response's property type/format changed from / to object/ for status 200
  response-property-type-changed
Dec 18, 2025132e5091a8851See the full diff
- ○
  endpoint added
  endpoint-added

Full history