Display

Display notifications are sent by the terminal to the ECR, or the other way around, to inform about the status during the processing of transactions.

Example request - terminal to ECR during transaction processing

{
  "SaleToPOIRequest": {
    "MessageHeader": {
      "MessageCategory": "Display",
      "MessageClass": "Device",
      "MessageType": "Request",
      "POIID": "AT12345",
      "ProtocolVersion": "3.1",
      "SaleID": "ECR123",
      "ServiceID": "1",
	  "DeviceID" : "3"
    },
    "DisplayRequest": {
      "DisplayOutput": [
        {
          "OutputContent": {
            "PredefinedContent": {
              "ReferenceID": "WAITING_FOR_CARD"
            },
            "OutputFormat": "MessageRef"
          },
          "Device": "CashierDisplay",
          "InfoQualify": "Status",
          "ResponseRequiredFlag": false
        }
      ]
    }
  }
}

Example request - ECR to terminal

{
  "SaleToPOIRequest": {
    "MessageHeader": {
      "MessageCategory": "Display",
      "MessageClass": "Device",
      "MessageType": "Request",
      "POIID": "AT12345",
      "ProtocolVersion": "3.1",
      "SaleID": "ECR123",
	  "DeviceID" : "3"
    },
    "DisplayRequest": {
      "DisplayOutput": [
        {
          "OutputContent": {
            "PredefinedContent": {
              "ReferenceID": "TRANSACTION_APPROVED"
            },
            "OutputFormat": "MessageRef"
          },
          "Device": "CustomerDisplay",
          "InfoQualify": "Display",
          "ResponseRequiredFlag": true
        }
      ]
    }
  }
}

Property	Description	Mandatory / Optional
DisplayRequest		Mandatory
DisplayOutput		Mandatory
OutputContent		Mandatory
PredefinedContent
ReferenceID	Enum. See table below for possible values	Mandatory
OutputFormat	Enum: MessageRef	Mandatory
Device	Enum: CashierDisplay, CustomerDisplay 'CashierDisplay' is used for messages to be displayed on the ECR screen. 'CustomerDisplay' is used for messages to be displayed on the terminal screen.	Mandatory
InfoQualify	Enum: Status, Display. 'Status' is used in DisplayRequests from terminal that informs ECR about the state the terminal is in 'Display' is used for DisplayRequests from ECR to terminal that shows a specific screen on the terminal display.	Mandatory
ResponseRequiredFlag	True or False. Whether a response is required or not. Must be set to True when sending DisplayRequest from ECR to terminal.	Mandatory

Example response - terminal to ECR

{
  "MessageHeader": {
    "MessageCategory": "Display",
    "MessageClass": "Device",
    "MessageType": "Response",
    "POIID": "AT12345",
    "ProtocolVersion": "3.1",
    "SaleID": "ECR123",
    "DeviceID": "3"
  },
  "DisplayResponse": {
    "OutputResult": [
      {
        "Device": "CustomerDisplay",
        "InfoQualify": "Status",
        "Response": {
          "Result": "Success"
        }
      }
    ]
  }
}

Property	Description	Mandatory / Optional
DisplayResponse		Mandatory
OutputResult		Mandatory
Device	Copied from request	Mandatory
InfoQualify	Copied from request	Mandatory
Response		Mandatory
Result	Enum: Success, Failure	Mandatory
ErrorCondition	Enum: NotAllowed	Optional

ReferenceID	Description	Sent from
WAITING_FOR_CARD	A transaction has been initiated and the terminal is waiting for a card	Terminal
WAITING_FOR_PIN	The terminal is waiting for the cardholder to enter the PIN	Terminal
WAITING_FOR_CUSTOMER_ACTION	The terminal is waiting for some action from the customer, such as confirming a choice or inputting a value.	Terminal
HOST_CONNECT	Terminal is connecting to transaction gateway	Terminal
HOST_SEND	Terminal is sending transaction request	Terminal
HOST_RECEIVE	Terminal is waiting for transaction response	Terminal
TRANSACTION_APPROVED	Show transaction completion screen with status approved.	ECR
TRANSACTION_DECLINED	Show transaction completion screen with status declined	ECR
TRANSACTION_ABORTED	Show transaction completion screen with status aborted	ECR

[!NOTE]

The TRANSACTION_* ReferenceID values can only be used in DisplayRequests that are used together with a PINRequest. They are not relevant and cannot be used in any other scenario. See [7] for additional information.