Get customer input

There are many points in a customer interaction where a merchant may want to ask the customer for input and store the response. Use the /v1/device/read-input endpoint to display a custom question and get the response.

📘

NOTE

If you need the customer to provide a yes or no response to a question, and log the answer, use the /v1/device/read-confirmation 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.

Collecting a month/year response

To get information related to month and year, example: age verification:

{
  "text": "Please enter your birth month/year",
  "format": "MONTHYEAR"
}

1. Construct a request with text set to your question and format set to MONTHYEAR.
2. Send a POST request to the /v1/device/read-input endpoint.
3. Required. Include the required headers for your request.
   The text displays on the device. A success message appears when the customer enters information and taps OK.

{
  "response": "1277"
}

Collect a phone number

To collect the customer's phone number:

1. Construct a request with text set to your question and format set to PHONE.

{
  "text": "Please enter your phone number",
  "format": "PHONE"
}

2. Send a POST request to the /v1/device/read-input endpoint.
   The text displays on the device. A success message appears when the customer enters information and taps OK.

{
  "response": "17725559392"
}

Collect a customer-entered amount

To get information in numeric format, example: a number to confirm the number of items ordered:

1. Construct a request with text set to your question and format set to AMOUNT.

{
  "text": "Please enter the number of items",
  "format": "AMOUNT"
}

2. Send a POST request to the /v1/device/read-input endpoint.
   The text displays on the device. A success message appears when the customer enters information and taps OK.

{
  "response": "3"
}

Collect customer-provided text

To get information in text format:

1. Construct a request with text set to your question and format set to TEXT.

{
  "text": "Please enter your name",
  "format": "TEXT"
}

2. Send a POST request to the /v1/device/read-input endpoint.
   The text displays on the device. A success message appears when the customer enters information and taps OK.

{
  "response": "Customer Name"
}

See Display the welcome screen for instructions to display the default idle screen or take other appropriate action.