Get Device Info

Overview

The Get Device Info Command allows an POS or POS system to retrieve detailed information about a Moneris Go terminal, including software versions, hardware capabilities, and unique identifiers. This command is essential for diagnostics, inventory management, and ensuring compatibility with integrated applications.

In addition to basic device metadata, the command returns information about installed payment processing applications and terminal configuration parameters—such as support for tips, cashback, surcharges, and other settings. This insight is valuable for understanding the terminal’s operational capabilities and ensuring it aligns with the merchant’s configuration requirements.

📘
NOTE
It is strongly recommended to issue this command during POS/POS startup and log the returned details. Capturing this information early helps streamline troubleshooting and provides a reliable reference point for investigating any issues that may arise during operation.

Request Structure

Element	Type	Description	Size	Required
apiVersion	String	API version number	V20	Required
istConfigCode	String	Moneris provided integration configuration code	V50	Required
dataId	String	Merchant defined unique identifier for the data object	V50	Required
dataTimestamp	String	Date and time of the request (YYYY-MM-DD HH:MM:SS)	F19	Required
data	Object	Object that contains all transaction requests	—	—
request	Array	Contains data applicable to transaction request	—	—
idempotencyKey	String	Unique transaction identifier to avoid duplicate request	V50	Required
action	String	"getDeviceInfo"	V50	Required
terminalId	String	Destination Terminal ID	F8	Optional

Request example

{
  "apiVersion": "3.0",
  "istConfigCode": "example_istConfigCode",
  "dataId": "example_dataId",
  "dataTimestamp": "1969-12-31 23:59:59",
  "data": {
    "request": [
      {
        "idempotencyKey": "example_idempotencyKey",
        "action": "getDeviceInfo"
      }
    ]
  }
}

Element	Type	Description	Size	Required
apiVersion	String	API version number	V20	Required
apiToken	String	Moneris assigned identifier	V50	Required
storeId	String	Store ID of requestor	V50	Required
istConfigCode	String	Moneris provided integration configuration code	V50	Required
postBackUrl	String	This field is required for postback and combined integration	V2000	Conditional
polling	String	This field is required for combined integration	V5	Conditional
dataId	String	Merchant defined unique identifier for the data object	V50	Required
dataTimestamp	String	Date and time of the request (YYYY-MM-DD HH:MM:SS)	F19	Required
data	Object	Object that contains all transaction requests	—	—
request	Array	Contains data applicable to transaction request	—	—
idempotencyKey	String	Unique transaction identifier to avoid duplicate request	V50	Required
action	String	"displayMessage"	V50	Required
terminalId	String	Destination Terminal ID	F8	Required

Request example

{
  "apiVersion": "3.0",
  "apiToken": "example_apiToken",
  "storeId": "example_storeId",
  "istConfigCode": "example_istConfigCode",
  "polling": "true",
  "postBackUrl": "https://example.client.url",
  "dataId": "example_dataId",
  "dataTimestamp": "1969-12-31 23:59:59",
  "data": {
    "request": [
      {
        "idempotencyKey": "example_idempotencyKey",
        "terminalId": "example_terminalId",
        "action": "getDeviceInfo"
      }
    ]
  }
}

Response Structure

Element	Type	Description	Size	Required
apiVersion	String	API version number	V20	Required
statusCode	String	Status code for the overall transaction request	V4	Required
status	String	Description of the statusCode	V50	Required
dataId	String	Merchant defined unique identifier for the data object	V50	Required
dataTimestamp	String	Date and time of the request (YYYY-MM-DD HH:MM:SS)	F19	Required
data	Object	Object that contains all transaction requests	—	—
response	Array	Contains data applicable to transaction request	—	—
idempotencyKey	String	Unique transaction identifier to avoid duplicate request	V50	Required
action	String	"getDeviceInfo"	V50	Required
statusCode	String	Status code for individual request	V4	Required
status	String	Description of the individual statusCode	V50	Required
completed	String	"true" or "false"	V5	Required
appVersions	Array	Contains data applicable to transaction request	—	—
name	String	Application name	V100	Optional
version	String	Application version	V100	Optional
build	String	Application build	V100	Optional
buildTime	String	Application build time (YYYY-MM-DD HH:MM:SS)	F19	Optional
mac	String	Active network media access control (mac) address	V50	Optional
hardwareSn	String	Manufacturer serial number	V50	Optional
terminalId	String	Destination Terminal ID	F8	Optional
printerSupported	String	Returns "true" if device has a built-in printer	F5	Optional
scannerSupported	String	Returns "true" if device has a built-in optical scanner	F19	Optional

Response example

{
  "apiVersion": "3.0",
  "statusCode": "example_statusCode",
  "status": "example_status",
  "dataId": "example_dataId",
  "dataTimestamp": "1969-12-31 23:59:59",
  "data": {
    "response": [
      {
        "idempotencyKey": "example_idempotencyKey",
        "action": "getDeviceInfo",
        "statusCode": "example_statusCode",
        "status": "example_status",
        "completed": "true",
        "appVersions": [
          {
            "name": "example_name",
            "version": "example_version",
            "build": "example_build",
            "buildTime": "1969-12-31 23:59:59"
          },
          {
            "name": "example_name",
            "version": "example_version",
            "build": "example_build",
            "buildTime": "1969-12-31 23:59:59"
          }
        ]
      }
    ]
  }
}

Element	Type	Description	Size	Required
receipt	Object	Contains the response data message	—	—
apiVersion	String	API version number	V20	Required
statusCode	String	Status code for the overall transaction request	V4	Required
status	String	Description of the statusCode	V50	Required
dataId	String	Merchant defined unique identifier for the data object	V50	Required
dataTimestamp	String	Date and time of the request (YYYY-MM-DD HH:MM:SS)	F19	Required
data	Object	Object that contains all transaction requests	—	—
response	Array	Contains data applicable to transaction request	—	—
idempotencyKey	String	Unique transaction identifier to avoid duplicate request	V50	Required
action	String	"getDeviceInfo"	V50	Required
statusCode	String	Status code for individual request	V4	Required
status	String	Description of the individual statusCode	V50	Required
completed	String	"true" or "false"	V5	Required
terminalId	String	Destination Terminal ID	F8	Required
cloudTicket	String	This is the unique reference id of the cloud request	V100	Required
appVersions	Array	Contains data applicable to transaction request	—	—
name	String	Application name	V100	Optional
version	String	Application version	V100	Optional
build	String	Application build	V100	Optional
buildTime	String	Application build time (YYYY-MM-DD HH:MM:SS)	F19	Optional
printerSupported	String	Returns "true" if device has a built-in printer	F5	Optional
scannerSupported	String	Returns "true" if device has a built-in optical scanner	F19	Optional

Response example

{
  "receipt": {
    "apiVersion": "3.0",
    "statusCode": "example_statusCode",
    "status": "example_status",
    "dataId": "example_dataId",
    "dataTimestamp": "1969-12-31 23:59:59",
    "data": {
      "response": [
        {
          "idempotencyKey": "example_idempotencyKey",
          "terminalId": "example_terminalId",
          "cloudTicket": "example_cloudTicket",
          "action": "getDeviceInfo",
          "statusCode": "example_statusCode",
          "status": "example_status",
          "completed": "true",
          "appVersions": [
            {
              "name": "example_name",
              "version": "example_version",
              "build": "example_build",
              "buildTime": "1969-12-31 23:59:59"
            },
            {
              "name": "example_name",
              "version": "example_version",
              "build": "example_build",
              "buildTime": "1969-12-31 23:59:59"
            }
          ]
        }
      ]
    }
  }
}

Errors

If your response contains errors, visit the Errors page for a detailed description of each one.