Skip to content

payments_device_display

GET
/api/payments/v1/devices/display/
curl --request GET \
--url https://example.com/api/payments/v1/devices/display/ \
--header 'Authorization: Bearer <token>'

Current display state for the device’s station: idle | total | qr | paid. Supports ETag/If-None-Match polling (304 when unchanged). qr_payload renders only on devices declaring the qr_dynamic_present capability.

Media typeapplication/json

What a customer-facing display should render right now.

state ∈ idle | total | qr | paid — a stable vocabulary the device renders verbatim; qr_payload is set only in the qr state and only for devices whose capabilities include qr_dynamic_present.

object
state
required
string
order_display_number
required
integer
nullable
amount
required
string format: decimal
nullable /^-?\d{0,10}(?:\.\d{0,2})?$/
currency
required
string
qr_payload
required
string
intent_status
required
string
server_time
required
string format: date-time
Examplegenerated
{
"state": "example",
"order_display_number": 1,
"amount": "example",
"currency": "example",
"qr_payload": "example",
"intent_status": "example",
"server_time": "2026-04-15T12:00:00Z"
}