Get customer confirmation

United States
Canada
Europe

If a merchant requires the customer to acknowledge a question before completing a transaction, use the /v1/device/read-confirmation endpoint.

📘

NOTE

If you need the customer to input data in response to a question, use the /v1/device/read-input endpoint.

Prerequisites

  • POS is connected to the device using a network or cloud connection.
  • Clover device is idle; that is, no payment is being taken.

Steps

If the customer can provide a yes or no response, use the device to ask your question:

  1. Construct a request with text set to your question. You can also customize the acceptText and rejectText.
{
  "text": "Do you want to donate to the fundraiser?",
  "acceptText": "Yes, please",
  "rejectText": "No thanks"
}
  1. Send a POST request to the /v1/device/read-confirmation endpoint.
  2. Required. Include the required headers for your request.
    The text displays on the device. When the customer taps one of the following, a message appears.
  • Accept, the response value is true.
  • Reject, the response value is false.
{
  "response": true
}

To display the default idle screen, see Display the welcome screen for instructions.