Sign in

v1

latestOpenAPI 3.0.12026-07-242871595.3 MB
DEVICE

Display a message

A call to the display endpoint sends a text string that is displayed on the idle terminal.

post/v1/device/display

Headers

User-Agentstring required

Identifies the application, operating system, vendor, and/or version of the requesting user agent. Format: <AppName>/<Version> <Comment>

X-Clover-Device-Idstring required

The Clover device to route the request to.

X-POS-Idstring required

An identifier for the POS making the request.

X-Clover-Timeoutinteger

The amount of time, in seconds, that this operation will process before timing out. A value of 0 indicates no timeout will be enforced by Remote Pay, although protocol specified timeouts may still apply.

Request body

beepboolean

A true/false flag that indicates if a beep should be played when the text is initially displayed.

textstring required

Example request

{
  "beep": true,
  "text": "Message to display to a customer"
}

Response

The text was displayed to the customer

object required