You can show an image on the display of your payment terminal, for example an advertisement, or a special offer that’s generated by the cash register. By showing an image, you can use your terminal to increase shopper loyalty, or for marketing purposes.
The image can be a PNG, JPEG, GIF, or BMP file that you convert to Base64.
The terminal shows the image during the time you set in the request. If you don't set a time-out, the image continues to be shown until you send another request. For example, a payment request, a request for a different image, or a request to show the standby screen.
The following illustrations show an image on a portrait, small portrait (e285p), and landscape display.
Security
The terminal never runs or stores an image that it receives. The terminal only decodes the image, to be able to show it on the display.
Make a display request for an image
-
Convert a PNG, JPEG, GIF, or BMP image file to Base64.
-
Make a POST request to a Terminal API endpoint, specifying:
-
MessageHeader
: the standardSaleToPOIRequest.MessageHeader
object. This includes:Parameter Required Description MessageClass
Device MessageCategory
Display
-
DisplayRequest.DisplayOutput
: an array with one array item containing:Parameter Description Device
CustomerDisplay InfoQualify
Display MinimumDisplayTime
The number of seconds that the image is shown.
If you omit this parameter, the terminal shows the image until you send another request, for example, a request to show the standby screen.OutputContent.OutputFormat
MessageRef OutputContent.PredefinedContent.ReferenceID
Image OutputContent.OutputText
An array with a Text
parameter containing the image as a Base64-encoded string.
{ "SaleToPOIRequest":{ "MessageHeader":{ "ProtocolVersion":"3.0", "MessageClass":"Device", "MessageCategory":"Display", "MessageType":"Request", "ServiceID":"043001", "SaleID":"POSSystemID12345", "POIID":"V400m-346403161" }, "DisplayRequest":{ "DisplayOutput":[ { "Device":"CustomerDisplay", "InfoQualify":"Display", "MinimumDisplayTime":60, "OutputContent":{ "OutputFormat":"MessageRef", "PredefinedContent":{ "ReferenceID":"Image" }, "OutputText":[ { "Text":"iVBORw0KGgoAAAAN...AAASUVORK5CYII=" } ] } } ] } } }
If an error occurs while decoding the image, the image won't be shown.
If the request is successful, you receive a display response with:OutputResult.Response.Result
: Success
-