Skip to content

Ping

Ping Request

Direction: Device -> Backend

Generic ping can be used by a client to keep the WSS connection alive.

json
{
  "action": "ping",
  "method": "ping"
}

Ping Response

Direction: Backend -> Device

Sent back to originating client by TaaS Backend.

json
{
  "action": "ping",
  "method": "pong",
  "data": {
    "ConnectionId": ""
  }
}

Ping Device Request

Direction: Device1 -> Device2

Device-to-device ping requests can be used to check in from the POS to a specific terminal or vice versa. The request data will use either the PosId or TerminalId, not both.

json
{
  "action": "ping",
  "method": "ping",
  "data": {
    "PosId": "",
    "TerminalId": ""
  }
}

Ping Device Response

Direction: Device2 -> Device1

The expected return from the device being pinged. A POS will returns its own PosId, a terminal will return its own TerminalId.

json
{
  "action": "ping",
  "method": "pong",
  "data": {
    "PosId": "",
    "TerminalId": ""
  }
}