List terminal operation results
List administrative operations sent to any of the account’s terminals,
most recently created first. Filter to a single terminal with
terminal_id, or a single operation with operation_id.
Poll this endpoint to see how a command finished: an operation is
created as PENDING and reaches COMPLETED, FAILED or TIMEOUT once the
terminal answers or the timeout window passes. The result of a
completed operation is specific to the operation that was run.
scopes:
- admin:checkout
- read:checkout:/admin/terminals
Authorizations
Query Parameters
Filter operations by terminal identifier.
Filter by operation identifier.
Maximum number of operations to return.
Return operations created before the operation with this identifier, for paging through the list.
Response
Terminal operations
- end_of_day
- send_logs
- check_update
- poll_terminal
Terminal operation. The shape depends on the operation field. When
present, the fields inside result are camelCase, unlike the rest of
the operation.
Unique identifier for the terminal operation.
Identifier of the terminal the operation was sent to.
The command that was sent to the terminal.
end_of_day: close the terminal's current batch and settle it with the acquirer. Run once per trading day, after the last payment.send_logs: have the terminal upload its log files for troubleshooting. The logs are not returned through this API.check_update: have the terminal check for a software update and install one if available. May reboot the terminal.open_menu: open the settings menu on the terminal's own screen for an operator standing at the device. The terminal cannot take payments while the menu is open.poll_terminal: ping the terminal to see whether it is online and responding. Has no effect on the device.
end_of_day Status of the terminal operation.
PENDING: Operation has been dispatched to the terminal and is awaiting a response.COMPLETED: Terminal has responded and the operation finished successfully.FAILED: Terminal responded but reported a failure.TIMEOUT: No response was received from the terminal within the timeout window. A new operation can be dispatched.
Which statuses an operation can reach depends on the operation.
open_menu and poll_terminal are never reported as FAILED, since
the terminal does not report a failure for them - an unreachable
terminal ends those operations as TIMEOUT. end_of_day,
send_logs and check_update can be FAILED when the terminal
answers but reports a problem; the result of the operation says
what it was.
PENDING, COMPLETED, FAILED, TIMEOUT When the operation was created.
Identity of the user or system that created the operation.
When the operation was last updated.
Identity of the user or system that last updated the operation.
Account identifier the operation belongs to.
Parameters of the operation.
Batch totals as reported by the terminal. Present when status is
COMPLETED or FAILED - on FAILED, result says why the day was
not accepted.
The counts and amounts are the strings the terminal reported
rather than numbers. All fields except result are only present
if the terminal included them.