In certain situations you may want to force the terminal to show the standby screen. This screen shows your own branded logo as it is usually shown when no other process is going on.
Switch to the standby screen
To force the payment terminal to show the standby screen, we recommend using a display request with PredefinedContent
. This works regardless of the terminal model.
There is also another method that we support. This uses OutputXHTML
in the display request. However, it only works on terminals that accept XHTML: M400, P400 Plus, and V400m.
Select the tabs below for details.
-
Make a POST request to a Terminal API endpoint, specifying:
-
MessageHeader
: the standardSaleToPOIRequest.MessageHeader
object. Specify:Parameter Required Description ProtocolVersion
3.0 MessageClass
Device MessageCategory
Display MessageType
Request ServiceID
Your unique ID for this request, consisting of 1-10 alphanumeric characters. Must be unique within the last 48 hours for the terminal ( POIID
) being used.SaleID
Your unique ID for the POS system component to send this request from. POIID
The unique ID of the terminal to send this request to. Format: [device model]-[serial number].
-
DisplayRequest.DisplayOutput: An array containing a single item with:
Parameter Value Device
CustomerDisplay InfoQualify
Display OutputContent.OutputFormat
MessageRef OutputContent.PredefinedContent.ReferenceID
Idle
Expand viewCopy link to code blockCopy code{ "SaleToPOIRequest":{ "DisplayRequest":{ "DisplayOutput":[ { "Device":"CustomerDisplay", "InfoQualify":"Display", "OutputContent":{ "OutputFormat":"MessageRef", "PredefinedContent":{ "ReferenceID":"Idle" } } } ] }, "MessageHeader":{ "ProtocolVersion":"3.0", "MessageClass":"Device", "MessageCategory":"Display", "MessageType":"Request", "ServiceID":"043001", "SaleID":"POSSystemID12345", "POIID":"V400m-346403161" } } } -
-
Check the response. If the request is successful, the response contains:
OutputResult.Response.Result
: Success
Response when using PredefinedContentExpand viewCopy link to code blockCopy code{ "SaleToPOIResponse": { "DisplayResponse": { "OutputResult": [ { "Device": "CustomerDisplay", "InfoQualify": "Display", "Response": { "Result": "Success" } } ] }, "MessageHeader": {...} } }