Terminal Management
Discover terminals and send trigger commands. List terminals requires terminals:read; sending triggers requires terminals:trigger.
GET
/api/v1/{system}/listTerminals🔒 terminals:readList terminals belonging to a branch. Returns terminal IDs, config IDs, online status, and assigned gateways. Tenant-isolated.
Auth: Bearer JWT
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
| branchId | long (query) | Yes | Branch user ID |
| excludeConfigId | long (query) | No | Exclude a specific terminal (useful for the caller's own terminal) |
SandboxCalls go to
https://payus.co.nzAuthentication
POST
/api/v1/{system}/requestTerminal🔒 terminals:triggerSend a trigger command to a terminal via WebSocket. If the terminal is offline, the command is queued and delivered when it reconnects.
Auth: Bearer JWT
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
| configId | long | Yes | Target terminal config ID |
| type | string | Yes | Trigger type: PRINT, FORCE_REFRESH, SESSION_KICK, PAYMENT |
| payload | string | No | Trigger payload (e.g. print content, payment details) |
Response Example
{
"status": true,
"message": "Trigger sent",
"handle": "trig-abc123"
} SandboxCalls go to
https://payus.co.nzAuthentication
POST
/api/v1/{system}/requestStatus🔒 terminals:readCheck the delivery status of a previously sent trigger.
Auth: Bearer JWT
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
| handle | string | Yes | Trigger handle from requestTerminal response |
SandboxCalls go to
https://payus.co.nz