SumUp · Schema

StatusResponse

Status of a device

PaymentsPOSPoint of SaleCard ReadersCheckoutFintechMobile PaymentsOnline Payments

Properties

Name Type Description
data object
View JSON Schema on GitHub

JSON Schema

statusresponse.json Raw ↑
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "StatusResponse",
  "description": "Status of a device",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "battery_level": {
          "description": "Battery level percentage",
          "type": "number",
          "format": "float",
          "example": 10.5,
          "maximum": 100,
          "minimum": 0
        },
        "battery_temperature": {
          "description": "Battery temperature in Celsius",
          "type": "integer",
          "example": 35
        },
        "connection_type": {
          "description": "Type of connection used by the device",
          "type": "string",
          "example": "Wi-Fi",
          "enum": [
            "btle",
            "edge",
            "gprs",
            "lte",
            "umts",
            "usb",
            "Wi-Fi"
          ]
        },
        "firmware_version": {
          "description": "Firmware version of the device",
          "type": "string",
          "example": "3.3.3.21"
        },
        "last_activity": {
          "description": "Timestamp of the last activity from the device",
          "type": "string",
          "format": "date-time",
          "example": "2025-09-25T15:20:00+00:00"
        },
        "state": {
          "description": "Latest state of the device",
          "type": "string",
          "example": "IDLE",
          "enum": [
            "IDLE",
            "SELECTING_TIP",
            "WAITING_FOR_CARD",
            "WAITING_FOR_PIN",
            "WAITING_FOR_SIGNATURE",
            "UPDATING_FIRMWARE"
          ]
        },
        "status": {
          "description": "Status of a device",
          "type": "string",
          "example": "ONLINE",
          "enum": [
            "ONLINE",
            "OFFLINE"
          ]
        }
      },
      "required": [
        "status"
      ]
    }
  },
  "example": {
    "data": {
      "battery_level": 10,
      "battery_temperature": 35,
      "connection_type": "Wi-Fi",
      "firmware_version": "3.3.3.21",
      "last_activity": "2025-09-25T15:20:00+00:00",
      "state": "IDLE",
      "status": "ONLINE"
    }
  },
  "required": [
    "data"
  ]
}