Skip to main content
POST
Error

Authorizations

Authorization
string
header
required

Merchant secret key, or an authorized Platform secret key with delegation where documented.

Headers

Ionic-Account
string

Merchant ID when an authorized Platform acts for a connected Merchant.

Pattern: ^mer_[0-9A-Za-z]{14}$

Path Parameters

id
string
required

Ionic Terminal ID.

Pattern: ^tmr_[0-9A-Za-z]{14}$

Response

The Terminal with the newly persisted connection observation.

id
string
required
Pattern: ^tmr_[0-9A-Za-z]{14}$
object
enum<string>
required
Available options:
terminal
merchant_id
string
required
Pattern: ^mer_[0-9A-Za-z]{14}$
location_id
string
required
Pattern: ^loc_[0-9A-Za-z]{14}$
livemode
boolean
required
label
string
required
device
object
required
status
enum<string>
required
Available options:
provisioning,
requires_action,
ready,
disabled,
replacing,
failed
connection_status
enum<string>
required

Freshness-aware connection status; stale observations are returned as unknown.

Available options:
online,
offline,
unknown
connection_status_stale
boolean
required
connection_observed_at
integer<int64> | null
required

Unix epoch seconds of the last connection observation.

capabilities
object
required

Capability names are additive; inspect each entry's status before use.

last_seen_at
integer<int64> | null
required
metadata
object
required

Up to 50 string keys; keys are at most 40 characters and values are at most 500 characters.

created_at
integer<int64>
required
updated_at
integer<int64>
required
test_profile
enum<string>

Built-in deterministic outcome for this Account-owned test Terminal. Omitted for physical and non-fixture Terminals. An exact test-helper override for a PaymentIntent takes precedence.

Available options:
approved,
declined,
delayed