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}$
Idempotency-Key
string
required

Reuse only when retrying the same route and request body.

Required string length: 1 - 255

Body

application/json
location_id
string
required

Location owned by the same Merchant and key mode.

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

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

Response

The durable provisioning request.

id
string
required
Pattern: ^tprov_[0-9A-Za-z]{24}$
object
enum<string>
required
Available options:
terminal.provisioning_request
merchant_id
string
required
Pattern: ^mer_[0-9A-Za-z]{14}$
livemode
boolean
required
location_id
string
required
Pattern: ^loc_[0-9A-Za-z]{14}$
label
string
required
status
enum<string>
required

ready means terminal_id is assigned and the Terminal resource can be retrieved.

Available options:
requested,
processing,
requires_action,
ready,
failed,
canceled
required_actions
string[]
required

Additive action identifiers. Empty unless Merchant action is required.

terminal_id
string | null
required
Pattern: ^tmr_[0-9A-Za-z]{14}$
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

Unix epoch seconds.

updated_at
integer<int64>
required

Unix epoch seconds.