Skip to main content
POST
/
v1
/
merchants
/
{merchant_id}
/
terminals
Register a terminal
curl --request POST \
  --url https://api.clearbox.example.com/v1/merchants/{merchant_id}/terminals \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "location_id": "<string>",
  "label": "Beer Garden Reader 3",
  "external_id": "<string>"
}
'
{
  "terminal_id": "trm_6a2c",
  "merchant_id": "<string>",
  "location_id": "<string>",
  "type": "<string>",
  "label": "<string>",
  "external_id": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.clear-box.io/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

ClearBox API key. Use cb_sandbox_... in the sandbox and cb_live_... in production.

Path Parameters

​
merchant_id
string
required
Example:

"mer_7d3a"

Body

application/json
​
location_id
string
required
​
type
enum<string>
required
Available options:
pos_legacy,
rist_wristband,
mobile_reader,
qr_kiosk
​
label
string
Example:

"Beer Garden Reader 3"

​
external_id
string

ID of the terminal in your existing POS or RIST system.

Response

201 - application/json

Terminal registered.

​
terminal_id
string
Example:

"trm_6a2c"

​
merchant_id
string
​
location_id
string
​
type
string
​
label
string
​
external_id
string
​
status
enum<string>
Available options:
active,
inactive