A valid request URL is required to generate request examples{
"id": "tprov_R7pA3nB9qK2mX5sJ4wF8tL6h",
"object": "terminal.provisioning_request",
"merchant_id": "mer_J4wF8tL6hC9vN2",
"livemode": false,
"location_id": "loc_R7pA3nB9qK2mX5",
"label": "Front counter",
"status": "requested",
"required_actions": [],
"terminal_id": null,
"metadata": {
"lane": "1"
},
"created_at": 1787625600,
"updated_at": 1787625600
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}Request physical Terminal hardware
Requests one physical Terminal for an existing Location. Ionic manages
hardware selection, delivery, activation, and supported capabilities.
Poll the returned request until it becomes ready, then retain its
terminal_id for payments. A request in requires_action includes the
next steps in required_actions.
A valid request URL is required to generate request examples{
"id": "tprov_R7pA3nB9qK2mX5sJ4wF8tL6h",
"object": "terminal.provisioning_request",
"merchant_id": "mer_J4wF8tL6hC9vN2",
"livemode": false,
"location_id": "loc_R7pA3nB9qK2mX5",
"label": "Front counter",
"status": "requested",
"required_actions": [],
"terminal_id": null,
"metadata": {
"lane": "1"
},
"created_at": 1787625600,
"updated_at": 1787625600
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}Authorizations
Merchant secret key, or an authorized Platform secret key with delegation where documented.
Headers
Merchant ID when an authorized Platform acts for a connected Merchant.
^mer_[0-9A-Za-z]{14}$Reuse only when retrying the same route and request body.
1 - 255Body
Location owned by the same Merchant and key mode.
^loc_[0-9A-Za-z]{14}$Name for the terminal, shown in your records.
1 - 100Up to 50 string keys; keys are at most 40 characters and values are at most 500 characters.
Show child attributes
Show child attributes
Response
The durable provisioning request.
Unique identifier for the provisioning request (tprov_…).
^tprov_[0-9A-Za-z]{24}$terminal.provisioning_request ID of the account that owns the provisioning request (mer_…).
^mer_[0-9A-Za-z]{14}$ID of the location where the terminal will be used (loc_…).
^loc_[0-9A-Za-z]{14}$Name for the terminal, shown in your records.
ready means terminal_id is assigned and the Terminal resource can be retrieved.
requested, processing, requires_action, ready, failed, canceled Additive action identifiers. Empty unless Merchant action is required.
ID of the terminal created by this request (tmr_…). Null until the request is ready.
^tmr_[0-9A-Za-z]{14}$Up to 50 string keys; keys are at most 40 characters and values are at most 500 characters.
Show child attributes
Show child attributes
Unix epoch seconds.
Unix epoch seconds.