Terminal Management

List terminals belonging to a branch. Returns terminal IDs, config IDs, online status, and assigned gateways. Tenant-isolated.

Auth: Bearer JWT

{
  "status": true,
  "data": [
    {
      "configId": 42,                        // long — pass to requestTerminal / capabilities
      "terminalId": "T-123",                 // string — opaque terminal id
      "accessId": "<branch access id>",      // string? — pass to requestTerminal
      "terminalTag": "Till 1",               // string? — operator label
      "laneTag": "A",                        // string? — physical lane id
      "posTag": "front-desk",                // string? — pos pairing hint
      "active": true,                        // bool  — admin hasn't disabled the terminal
      "activated": true,                     // bool  — merchant has completed pairing
      "online": true,                        // bool  — currently connected on WebSocket
      "currency": "NZD",                     // string
      "queueDestination": "/queue/terminal/42", // string — STOMP destination for cloud-ws
      "channels": {                          // map<string,bool> — enabled gateways
        "card": true,
        "wechat": true,
        "alipay": true,
        "unionPay": false,
        "centraPay": true
      }
    }
  ]
}

Secret-free capability lookup for a terminal: which channels are enabled (wechat/alipay/unionPay/centraPay), the resolved gateway for each, and QR timing. Use it to offer only the channels the backend has enabled — never hardcode the channel list. Ownership-checked; returns no credentials (unlike /terminal/info, which is for the on-device app).

Auth: Bearer JWT

{
  "status": true,
  "data": {
    "configId": 123,
    "terminalId": "TERM-001",
    "channels": { "wechat": true, "alipay": true, "unionPay": false, "centraPay": true },
    "wechatGatewayConfig": { "id": 100, "gatewayName": "E-Payments", "testMode": false,
                             "supportsWechat": true, "supportsAlipay": true, "supportsUnionpay": false },
    "qrDisplayMs": 180000,
    "qrGraceMs": 210000,
    "paymentTimeoutMs": 360000,
    "configVersion": 3
  }
}

Lightweight liveness poll — far cheaper than /terminal/info and secret-free. Returns activation/active flags and a derived reason. Call it on app resume, cold start, and before starting a transaction; block the trading UI when active or activated is false. Ownership-checked.

Auth: Bearer JWT

{
  "status": true,
  "data": {
    "configId": 123,
    "terminalId": "TERM-001",
    "activated": true,
    "active": true,
    "reason": "ACTIVE"
  }
}

LAN TLS leaf material (Q-022, Option B). Returns the terminal's per-terminal certificate + private key and the PayUs CA cert, so the on-device LAN server can run TLS and peers verify each other against the PayUs CA. Minted lazily on first fetch and persisted, so re-fetches are stable until rotation. Ownership-checked; the private key never leaves the owning tenant. (The matching per-branch LAN HMAC secret is delivered as lanSecret on the activation response and /terminal/info.)

Auth: Bearer JWT

{
  "status": true,
  "data": {
    "configId": 123,
    "terminalId": "TERM-001",
    "leafCertPem": "-----BEGIN CERTIFICATE-----\n…",
    "leafKeyPem": "-----BEGIN PRIVATE KEY-----\n…",
    "caCertPem": "-----BEGIN CERTIFICATE-----\n…",
    "notAfter": "2028-07-14T10:30:00Z"
  }
}

Send a trigger command to a terminal via WebSocket. If the terminal is offline there is no durable queue — the command is NOT delivered and NOT replayed; requestStatus reports deliveryStatus TERMINAL_OFFLINE (vs SENT). Re-issue once the terminal is back online (listTerminals.online). See /docs/cloud-ws for the full hub ⇄ terminal flow (how the result comes back on your STOMP queue, or via requestStatus below).

Auth: Bearer JWT

{
  "status": true,
  "data": {
    "id": 7,                        // numeric — poll requestStatus with this id
    "status": false,               // boolean — terminal has not reported a result yet
    "executed": false,             // boolean — set true once the terminal runs it
    "requestType": "PAY",
    "configId": 123,
    "referenceId": "ORD-42",
    "deliveryStatus": "SENT",      // SENT | TERMINAL_OFFLINE
    "requestInfo": null            // string — the terminal's result JSON, once available
  }
}

Poll for the result of a previously sent trigger. Equivalent to subscribing on STOMP and waiting for the COMMAND_RESULT frame — pick whichever fits your controller (see /docs/cloud-ws).

Auth: Bearer JWT

{
  "status": true,
  "data": {
    "id": 7,                        // numeric
    "status": true,                // boolean — terminal has reported a result
    "executed": true,              // boolean — the terminal ran the command
    "requestType": "PAY",
    "configId": 123,
    "referenceId": "ORD-42",
    "deliveryStatus": "SENT",      // SENT | TERMINAL_OFFLINE
    // requestInfo is a STRING holding the terminal's result JSON — parse it for the detail
    "requestInfo": "{\"paymentStatus\":\"SUCCESS\",\"tradeNo\":\"TRADE-123\",\"grandTotal\":\"12.50\",\"channel\":\"WECHAT\",\"currency\":\"NZD\"}"
  }
}