Sign in

v1

latestOpenAPI 3.1.0MIT2026-08-0659118508.8 KB
Terminals

Update terminal

Updates the terminal details.

Required scope: <code style="background:#e8f0fe;color:#1a73e8;padding:2px 8px;border-radius:12px;font-size:0.85em">terminal:update</code>

patch/terminal/{id}

Path parameters

idstring uuid required

Resource Identification

Request body

namestring

The name of the terminal. Must be unique.

Example request

{
  "name": "Terminal Checkout 2"
}

Response

OK

idstring uuid

The unique identifier of the terminal.

serial_numberstring

The serial number of the terminal device. Unique per acquirer.

namestring

The name of the terminal. Must be unique.

status'ACTIVE' | 'INACTIVE' | 'DELETED'

The current status of the terminal. Determined by the device state.

acquirer'VERIFONE'

The acquirer associated with the terminal.

modelstring

The model of the terminal device. Inferred from the serial number.

last_transaction_atstring date-time nullable

The date and time of the last transaction processed by the terminal. Null if no transactions have been processed.

created_atstring date-time

The date and time when the terminal was created.

Example response

{
  "id": "458b2fc4-3092-4de3-abd4-fe1600c09420",
  "serial_number": "123-456-789",
  "name": "Terminal Checkout 1",
  "status": "ACTIVE",
  "acquirer": "VERIFONE",
  "model": "V240m",
  "last_transaction_at": "2025-08-05T13:44:29Z",
  "created_at": "2025-08-05T13:44:29Z"
}