Event notifications

Outlines the event notifications sent from the terminal to the sale system.


Event messages are sent to the Sale System outside of the payment flow, for example, going down for maintenance, available after maintenance, etc.

Event notifications are sent from the POI (also known as Pin Entry Device (PED)) to the Sale system (also known as Point of Sale or Cash Register). Event notifications do not require any action by the cash register. They inform the staff of what is happening on the POI outside of the scope of payments.

To receive event notifications, the Sale System or Sale Server must run a HTTP server. Contact the Support Team to configure these end-points (IP or URL).

Event notifications are returned in the EventNotifcation and contain 3 elements: 

  • EventDetails
  • EventToNotify
  • Timestamp

The SaleID and ServiceID in the MessageHeader should be unique. SaleID and ServiceID combinations are rejected if used recently, within 48 hours.

No content is expected in the HTTP response body for these messages. If the response does not arrive, we do not retry

EventToNotify types

Name
Description
Shutdown

The POI Terminal or the POI System is shutting down.

BeginMaintenance Beginning POI maintenance.
EndMaintenance Ending POI maintenance.
OutOfOrder

The POI Terminal or the POI System is currently out of order.

Initialised The POI Terminal or the POI System is now ready to work.
Reject

A message request is rejected. An error explanation and the message in error have to be put in the EventDetails data element.

Code examples

 {  
   "SaleToPOIRequest":{  
      "EventNotification":{  
         "EventDetails":"newstate=IDLE&oldstate=START",
         "EventToNotify":"Initialised",
         "TimeStamp":"2018-02-07T10:16:10.000Z"
      },
      "MessageHeader":{  
         "SaleID":"POSSystemID12345",
         "ProtocolVersion":"3.0",
         "MessageType":"Notification",
         "POIID":"MX925-289173817",
         "MessageClass":"Event",
         "MessageCategory":"Event",
         "DeviceID":"1517998561"
      }
   }
}
 {  
   "SaleToPOIRequest":{  
      "EventNotification":{  
         "EventDetails":"newstate=IDLE&oldstate=TX_IN_PROGRESS",
         "EventToNotify":"Initialised",
         "TimeStamp":"2018-02-07T10:16:43.000Z"
      },
      "MessageHeader":{  
         "SaleID":"POSSystemID12345",
         "ProtocolVersion":"3.0",
         "MessageType":"Notification",
         "POIID":"MX925-289173817",
         "MessageClass":"Event",
         "MessageCategory":"Event",
         "DeviceID":"1517998574"
      }
   }
}