Skip to content
Sitora Docs

payments_device_enroll

POST
/api/payments/v1/devices/enroll/
curl --request POST \
  --url https://example.com/api/payments/v1/devices/enroll/ \
  --header 'Content-Type: application/json' \
  --data '{ "code": "example" }'

Claim a one-time enrollment code. Returns the device credential exactly once; unknown, spent, and expired codes answer identically.

Authorizations

Section titled “Authorizations”
  • None

Request Bodyrequired

Section titled “Request Bodyrequired”
object
code
required
string
>= 1 characters <= 64 characters
Examplegenerated
{
  "code": "example"
}

Responses

Section titled “Responses”

200

Section titled “200”
Media typeapplication/json
object
credential
required
string
scopes
required
Array<string>
device
required
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
{
  "credential": "example",
  "scopes": [
    "example"
  ],
  "device": {
    "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"
  }
}