Displaying a message to the customer

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

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.
  2. Required. Include the required headers for your request.
    The message displays on the device and an empty JSON object is returned.

The message displays on the screen until you take another action. There is no automatic timeout. See Displaying the welcome screen for instructions to display the default idle screen, or take other appropriate action.


Did this page help you?