Update Terminal

Renames a terminal or changes its description.

Only friendlyName and description can change. The hardware ID and type are fixed; to replace a device, disable the
old terminal and register the new one.

Permission: Merchant Write.

Errors

  • 400 VALIDATION_ERROR: a field is not a string, or the body has a field other than friendlyName and description.
  • 404 NOT_FOUND: the terminal does not exist in your account.
  • 409 terminal: the terminal is still PENDING_VALIDATION. Wait until validation finishes, then retry.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The terminal ID (TL-…), as returned by Register Terminal.

Body Params

Terminal update payload (for modifying existing terminals)

string
string
Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json