Search

Are you looking for test card numbers?

Would you like to contact support?

Point-of-sale icon

Show the standby screen

Idle the display of the payment terminal.

In certain situations you may want to idle the terminal display and make it show the standby screen. This screen shows your own branded logo as it is usually shown when no other process is going on.

Idle the terminal display

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's 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:

    • DisplayRequest.DisplayOutput : An array containing a single array item with:

      Parameter Value
      Device CustomerDisplay
      InfoQualify Display
      OutputContent.OutputFormat MessageRef
      OutputContent.PredefinedContent.ReferenceID Idle
    {
        "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"
            }
        }
    }
    String serviceID = "YOUR_UNIQUE_ATTEMPT_ID";
    String saleID = "YOUR_CASH_REGISTER_ID";
    String POIID = "YOUR_TERMINAL_ID";
    
    SaleToPOIRequest saleToPOIRequest = new SaleToPOIRequest();
    DisplayRequest displayRequest = new DisplayRequest();
    DisplayOutput displayOutput = new DisplayOutput();
    displayOutput.setDevice( DeviceType.CUSTOMER_DISPLAY );
    displayOutput.setInfoQualify( InfoQualifyType.DISPLAY );
    OutputContent outputContent = new OutputContent();
    outputContent.setOutputFormat( OutputFormatType.MESSAGEREF );
    PredefinedContent predefinedContent = new PredefinedContent();
    predefinedContent.setReferenceID("Idle");
    outputContent.setPredefinedContent(predefinedContent);
    displayOutput.setOutputContent(outputContent);
    displayRequest.setDisplayOutput(displayOutput);
    saleToPOIRequest.setDisplayRequest(displayRequest);
    
    MessageHeader messageHeader = new MessageHeader();
    messageHeader.setProtocolVersion("3.0");
    messageHeader.setMessageClass( MessageClassType.DEVICE );
    messageHeader.setMessageCategory( MessageCategoryType.DISPLAY );
    messageHeader.setMessageType( MessageType.REQUEST );
    messageHeader.setServiceID(serviceID);
    messageHeader.setSaleID(saleID);
    messageHeader.setPOIID(POIID);
    saleToPOIRequest.setMessageHeader(messageHeader);
    terminalAPIRequest.setSaleToPOIRequest(saleToPOIRequest);

    If the request is successful, you receive a display response with:

    • OutputResult.Response.Result: Success
  • Make a POST request to a Terminal API endpoint, specifying:

    • DisplayRequest.DisplayOutput : An array containing a single array item with:

      Parameter Description
      Device CustomerDisplay
      InfoQualify Display
      OutputContent.OutputFormat XHTML
      OutputContent.OutputXHTML The following string, which contains XML code converted to Base64:
      PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz4NCjxzY3JlZW4gbmFtZT0iIj4NCiAgDQo8L3NjcmVlbj4NCg==
    {
        "SaleToPOIRequest":{
            "DisplayRequest":{
                "DisplayOutput":[
                    {
                        "Device":"CustomerDisplay",
                        "InfoQualify":"Display",
                        "OutputContent":{
                            "OutputFormat":"XHTML",
                            "OutputXHTML": "PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz4NCjxzY3JlZW4gbmFtZT0iIj4NCiAgDQo8L3NjcmVlbj4NCg=="
                        }
                    }
                ]
            },
            "MessageHeader":{
                "ProtocolVersion":"3.0",
                "MessageClass":"Device",
                "MessageCategory":"Display",
                "MessageType":"Request",
                "ServiceID":"043001",
                "SaleID":"POSSystemID12345",
                "POIID":"V400m-346403161"
            }
        }
    }
    String serviceID = "YOUR_UNIQUE_ATTEMPT_ID";
    String saleID = "YOUR_CASH_REGISTER_ID";
    String POIID = "YOUR_TERMINAL_ID";
    
    SaleToPOIRequest saleToPOIRequest = new SaleToPOIRequest();
    DisplayRequest displayRequest = new DisplayRequest();
    DisplayOutput displayOutput = new DisplayOutput();
    displayOutput.setDevice( DeviceType.CUSTOMER_DISPLAY );
    displayOutput.setInfoQualify( InfoQualifyType.DISPLAY );
    OutputContent outputContent = new OutputContent();
    outputContent.setOutputFormat( OutputFormatType.XHTML );
    outputContent.setOutputXHTML("PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz4NCjxzY3JlZW4gbmFtZT0iIj4NCiAgDQo8L3NjcmVlbj4NCg==");
    displayOutput.setOutputContent(outputContent);
    displayRequest.setDisplayOutput(displayOutput);
    saleToPOIRequest.setDisplayRequest(displayRequest);
    
    MessageHeader messageHeader = new MessageHeader();
    messageHeader.setProtocolVersion("3.0");
    messageHeader.setMessageClass( MessageClassType.DEVICE );
    messageHeader.setMessageCategory( MessageCategoryType.DISPLAY );
    messageHeader.setMessageType( MessageType.REQUEST );
    messageHeader.setServiceID(serviceID);
    messageHeader.setSaleID(saleID);
    messageHeader.setPOIID(POIID);
    saleToPOIRequest.setMessageHeader(messageHeader);
    terminalAPIRequest.setSaleToPOIRequest(saleToPOIRequest);

    If the request is successful, you receive a display response with:

    • OutputResult.Response.Result: Success

See also