PENDING operation, and the terminal processes the command in the background. You then poll the operation to see how it finished.
Terminal operations are administrative commands. They do not start a payment. To take a payment on a terminal, see creating a terminal session.
Available operations
| Operation | Description |
|---|---|
end_of_day | Run the end-of-day routine on the terminal. |
send_logs | Instruct the terminal to upload its logs. |
check_update | Have the terminal check for a software update. |
open_menu | Open the settings menu on the terminal. |
Send a command
PENDING.
Idempotency
Pass anIdempotency-Key header to ensure the same command is only executed once, for example when retrying after a network error.
One operation at a time
A terminal processes one operation at a time. If an operation is already pending for the terminal, the API responds with409 Conflict and a Retry-After header indicating how many seconds to wait before retrying.
List operation results
Poll operations to see how a command finished. The endpoint returns operations and supports filtering byterminal_id and operation_id.
id returned when you sent the command.
Operation status
| Status | Meaning |
|---|---|
PENDING | The operation has been dispatched to the terminal and is awaiting a response. |
COMPLETED | The terminal responded and the operation finished successfully. |
FAILED | The terminal responded but reported a failure. |
TIMEOUT | No response was received from the terminal within the timeout window. A new operation can be dispatched. |
Scopes
| Endpoint | Scopes |
|---|---|
POST /admin/terminals/operations | admin:checkout or write:checkout:/admin/terminals |
GET /admin/terminals/operations | admin:checkout or read:checkout:/admin/terminals |