SUsumup
Readers

Get a Reader Status

Changed on

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

Request

  • Base URL
    https://api.sumup.com
  • URL
    https://api.sumup.com/v0.1/merchants/{merchant_code}/readers/{reader_id}/status
  • Auth
    • HTTP bearer
    • or OAuth 2
      Authorization code: https://api.sumup.com/authorize
      Token URL: https://api.sumup.com/token scopes: readers.read

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

  • 38138e18acd1Revision changes
    • warning

      added the new APP_OUTDATED enum value to the / response property for the response status

    • warning

      added the new INVALID_AFFILIATE_KEY enum value to the / response property for the response status

  • cd79d83b07e0Revision changes
    • breaking

      the response property / became optional for the status

    • info

      added the media type application/problem+json for the response with the status

    • info

      added the media type application/problem+json for the response with the status

    • info

      added the media type application/problem+json for the response with the status

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      the response property / became required for the status