Sign in

v1

latestOpenAPI 3.0.12026-07-242871595.3 MB
DEVICE

Get a user confirmation response

Retrieves a confirmation response (true or false) from the specified Clover terminal. This is typically used to ask a customer a yes-no question.

post/v1/device/read-confirmation

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.

Idempotency-Keystring

The idempotency key transmitted during the request, if any.

Request body

acceptTextstring

Label text displayed on the button for positive confirmation

beepboolean

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

rejectTextstring

Label text displayed on the button for negative confirmation

textstring required

Example request

{
  "acceptText": "Yes",
  "rejectText": "No",
  "text": "Would you like to continue?"
}

Response

Returns a true or false response based on user input

responseboolean

Example response

{
  "response": true
}