Display Message

Overview

The Display Message Command is used to present a plain text message on a Moneris Go terminal screen for the cardholder or end user. This functionality is typically used to provide instructions, confirmations, or other contextual information during the transaction flow.

Once displayed, the message remains visible on the terminal until one of the following occurs:

A new command is issued by the POS system
The specified timeout period elapses
The POS session times out.

This command is especially useful in guiding customers through custom workflows, alerting them to wait states, or providing reassurance during longer processing times.

📘
NOTE
The message content is defined by the POS and can be customized to suit the merchant’s business flow or customer experience strategy.

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
terminalId	String	Destination Terminal ID	F8	Optional
action	String	"displayMessage"	V50	Required
displayMessage	String	Message to be displayed	V512	Required
timeout	String	Enable the message to be displayed for a set period of time	V2	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": "displayMessage",
        "displayMessage": "example message",
        "timeout": "10"
      }
    ]
  }
}

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
terminalId	String	Destination Terminal ID	F8	Required
action	String	"displayMessage"	V50	Required
displayMessage	String	Message to be displayed	V512	Required
timeout	String	Enable the message to be displayed for a set period of time	V2	Optional

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": "displayMessage",
        "displayMessage": "example message",
        "timeout": "10"
      }
    ]
  }
}

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	"displayMessage"	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

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",
        "statusCode": "example_statusCode",
        "status": "example_status",
        "completed": "true",
        "action": "displayMessage"
      }
    ]
  }
}

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	—	—
action	String	"displayMessage"	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
idempotencyKey	String	Unique transaction identifier to avoid duplicate request	V50	Required

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",
          "statusCode": "example_statusCode",
          "status": "example_status",
          "completed": "true",
          "action": "displayMessage"
        }
      ]
    }
  }
}

Errors

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

Updated 8 days ago

Did this page help you?