Skip to content

payments_device_heartbeat

POST
/api/payments/v1/devices/heartbeat/
curl --request POST \
--url https://example.com/api/payments/v1/devices/heartbeat/ \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "summary": { "additionalProperty": "example" } }'

Device liveness signal. Returns the device’s own snapshot so one call keeps the device honest about its standing.

object
summary
object
key
additional properties
Examplegenerated
{
"summary": {
"additionalProperty": "example"
}
}
Media typeapplication/json
object
device_id
required
integer
name
required
string
kind
required
string
capabilities
required
Array<string>
status
required
string
station_name
required
string
station_status
required
string
handoff_target
required
string
blocked_reason
required
string
server_time
required
string format: date-time
Examplegenerated
{
"device_id": 1,
"name": "example",
"kind": "example",
"capabilities": [
"example"
],
"status": "example",
"station_name": "example",
"station_status": "example",
"handoff_target": "example",
"blocked_reason": "example",
"server_time": "2026-04-15T12:00:00Z"
}