Skip to main content
PATCH
Update terminal

Authorizations

Authorization
string
header
required

API key authentication. Include your API key as a Bearer token.

Example: Bearer sk_prod_xxxxxx

Get your API key from the Stell Dashboard.

Path Parameters

terminalId
string
required

Body

application/json

Fields to update on an existing terminal.

note
string

Additional notes about the terminal

Maximum string length: 1000
serialNumber
string

Hardware serial number

Maximum string length: 100
name
string

Terminal display name

Required string length: 1 - 200
externalId
string

External reference ID

Maximum string length: 255
status
enum<string>

Terminal operational status

Available options:
ONLINE,
OFFLINE,
SWITCHED_OFF,
MAINTENANCE,
ERROR

Response

200 response

Response envelope carrying a terminal.

data
TerminalModel · object
required

Terminal for tap-to-scan pass validation.

requestId
string
required

Unique request identifier for debugging

Pattern: ^[0-9A-Z]{26}$