Skip to main content
GET
/
registers
/
{registerId}
/
status
Get register operational status
curl --request GET \
  --url https://api.openfiskal.com/v1/registers/{registerId}/status \
  --header 'Authorization: Bearer <token>'
{
  "register_id": "<string>",
  "status": "operational",
  "last_heartbeat_at": "2023-11-07T05:31:56Z",
  "open_operations": [
    {
      "id": "<string>",
      "type": "sale",
      "started_at": "2023-11-07T05:31:56Z"
    }
  ],
  "unsynced_operations": 123,
  "software": {
    "pos_vendor": "<string>",
    "pos_version": "<string>",
    "agent_version": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

Platform API key sent as Authorization: Bearer ofk_platform_.... Platform integrators also pass OpenFiskal-Organization: org_xxx to act on behalf of a merchant.

Headers

​
OpenFiskal-Organization
string

Merchant organization ID. Required for platform integrators acting on behalf of a specific merchant. Omit when using an organization-scoped API key directly.

Path Parameters

​
registerId
string
required

Response

Register status

​
register_id
string
​
status
enum<string>
  • operational: Heartbeat received within expected interval
  • degraded: Register self-reported degraded status
  • offline: No heartbeat for 2× expected interval
  • stale: No heartbeat for an extended period
Available options:
operational,
degraded,
offline,
stale
​
last_heartbeat_at
string<date-time> | null
​
open_operations
object[]

Currently open operations on this register

​
unsynced_operations
integer | null
​
software
object