Displaying a message to the customer

When the POS needs to show a message to the customer, use the /v1/device/display endpoint to show a custom message.

Prerequisites

  • The POS is connected to the device using a network or cloud connection
  • The Clover device is in an idle state (that is, no payment is being taken)

Steps

  1. Construct a request with the minimum required data (the text field).
{
    "text": "A message to be displayed to the customer on the Clover device",
    "beep": false
}
  1. Send a POST request to the /v1/device/display endpoint. Be sure to include the required headers for the request you are making.

The message is shown on the device and an empty JSON object is returned.

The message remains on the screen until you take another action. There is no automatic timeout. See Showing the welcome screen for instructions on displaying the default idle screen, or take the action that is appropriate for your situation.


Did this page help you?