Terminal actions
Remote management actions — reboot, update, and lock VINR terminals.
Terminal actions let you remotely manage VINR terminals from your server. You can reboot a terminal, push a software update, or lock a device from accepting payments — all without physical access to the hardware.
Illustrative content. Hand-authored to demonstrate the Standard/Advanced pattern; the production page will be generated from the VINR OpenAPI spec (roadmap item #1). Field names are representative.
The terminal action objectAsk
idstringUnique identifier for the terminal action, e.g. tact_7Yp2.
terminalIdstringThe ID of the terminal this action targets, e.g. term_4Kx9.
actionenumThe action to perform. One of reboot, update, or lock.
statusenumCurrent lifecycle status. One of queued, processing, completed, or failed.
resultobject nullablePresent once the action reaches a terminal state.
createdAtintegerUnix timestamp of when the action was created.
Create a terminal actionAsk
Send a POST request with the desired action to queue a management command on a specific terminal. The response always returns the action object with status: "queued".
Actions are delivered over the terminal's persistent cloud connection. If the terminal is offline at
the time of the request, the action will queue and execute automatically when the device reconnects.
Poll the action using Retrieve a terminal action or listen for the
terminal_action.completed webhook event to confirm completion.
Retrieve a terminal actionAsk
Fetch a single terminal action by its ID to check the current status and inspect the result once the action completes.
List terminal actionsAsk
Returns a paginated list of terminal actions. Filter by terminalId, action type, or status. Results are ordered with the most recent action first.
Query parameters
| Parameter | Type | Description |
|---|---|---|
terminalId | string | Filter to actions for a specific terminal. |
action | enum | Filter by action type: reboot, update, or lock. |
status | enum | Filter by status: queued, processing, completed, or failed. |
limit | integer | Number of results to return (1–100, default 20). |
starting_after | string | Cursor for forward pagination — pass the last action ID from the previous page. |
Action referenceAsk
| Action | Effect | Notes |
|---|---|---|
reboot | Restarts the terminal OS | Active payments are cancelled before reboot |
update | Downloads and applies the latest VINR software | Terminal reboots after update; schedule during off-hours |
lock | Disables the terminal from accepting payments | Reversible via reboot or dashboard unlock |
