Skip to main content
GET
admin_terminals_operations_get

Authorizations

Authorization
string
header
required

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).

Query Parameters

terminal_id
string

Filter operations by terminal identifier.

operation_id
string<uuid>

Filter by operation identifier.

limit
integer
default:100

Maximum number of operations to return.

starting_after
string<uuid>

Return operations created before the operation with this identifier, for paging through the list.

Response

Terminal operations

Terminal operation. The shape depends on the operation field. When present, the fields inside result are camelCase, unlike the rest of the operation.

id
string<uuid>
required

Unique identifier for the terminal operation.

terminal_id
string
required

Identifier of the terminal the operation was sent to.

operation
enum<string>
required

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.
Available options:
end_of_day
status
enum<string>
required

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.

Available options:
PENDING,
COMPLETED,
FAILED,
TIMEOUT
created_at
string<date-time>
required

When the operation was created.

created_by
string
required

Identity of the user or system that created the operation.

updated_at
string<date-time>
required

When the operation was last updated.

updated_by
string
required

Identity of the user or system that last updated the operation.

account_id
string

Account identifier the operation belongs to.

parameters
object

Parameters of the operation.

result
object

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.

Last modified on September 28, 2026