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
Bearer authentication (token authentication) should be used for accessing the API.
Use Get Token to get an access token for client credentials. Pass the token in the request header:
where the access_token is JSON Web Tokens (JWT).
Path Parameters
Query Parameters
Response
Terminal operations
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.print_text: print lines on the terminal's printer. Dintero does not compose or check the content.print_receipt: print a copy of a transaction's payment receipt.
end_of_day, send_logs, check_update, open_menu, poll_terminal, print_text, print_receipt 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, check_update, print_text and print_receipt can be FAILED when the terminal answers but reports a problem; the result of the operation says what it was.
PENDING, COMPLETED, FAILED, TIMEOUT