Skip to main content
POST
Error

Authorizations

Authorization
string
header
required

A test-mode Merchant secret key, or an authorized Platform test key with delegation.

Headers

Ionic-Account
string

Merchant ID when an authorized Platform acts for a connected Merchant. Omit when authenticating directly as that Merchant.

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

Reuse only when retrying the same route and request body.

Required string length: 1 - 255

Body

application/json
type
enum<string>
required

Creates a logical test Terminal. Physical hardware uses terminal provisioning instead.

Available options:
simulated
location_id
string
required

Test-mode location owned by the same Merchant.

Pattern: ^loc_[0-9A-Za-z]{14}$
label
string
required
Required string length: 1 - 100
metadata
object

Response

A ready simulated Terminal.

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
enum<boolean>
required
Available options:
false
label
string
required
device
object
required
status
enum<string>
required
Available options:
provisioning,
requires_action,
ready,
disabled,
replacing,
failed
connection_status
enum<string>
required
Available options:
online,
offline,
unknown
connection_status_stale
boolean
required
connection_observed_at
integer<int64> | null
required
capabilities
object
required
last_seen_at
integer<int64> | null
required
metadata
object
required
created_at
integer<int64>
required
updated_at
integer<int64>
required