Skip to content

Get Terminal Status

METHOD NAME getTerminalStatus

Description

Get the status of the configured terminal on the device.

Parameters

null

Result

Object on success

  • terminalId string
    Installed terminal Id, e.g., 0883198
  • terminalName string
    Installed terminal Name, e.g., CODEBLOCKS

  • status TerminalStatus
    the terminal status
    (1) Show values

    1. TerminalStatus

      Describe the status of the terminal installed on the device.

      • READY Terminal ready to work
      • NOT_READY Terminal not ready to perform a transaction
      • SETTLE_NEEDED Terminal is ready to work, but the params are too old, and an update is needed through the settlement command
      • NO_PARAMS Terminal has no parameters. Settlement is required to start work and perform transactions.

    2. end

Errors

  • IllegalRequestException when the host is not configured

Example

Request

1
2
3
4
5
{
  "jsonrpc": "2.0",
  "id": "1234567890",
  "method": "getTerminalStatus"
}

Response

1
2
3
4
5
6
7
8
9
{
  "jsonrpc": "2.0",
  "id": "1234567890"
  "result": {
    "terminalId": "0883198",
    "terminalName": "Codeblocks",
    "terminalStatus": "READY"
  }
}