---
title: "Get a text response"
method: POST
path: "/v1/device/read-input"
tags: ["DEVICE"]
---

# Get a text response

`POST /v1/device/read-input`

Displays a request for information and returns the data entered by the customer. The request can also specify a data entry format to make it easier for the customer to provide their information.

## Headers

- `User-Agent` string, required
- `X-Clover-Device-Id` string, required
- `X-POS-Id` string, required
- `X-Clover-Timeout` integer
- `Idempotency-Key` string

## Request body

- FormatDisplayRequest — Message used to call to the display endpoint sends a text string.
  - `beep` boolean — A true/false flag that indicates if a beep should be played when the screen is initially displayed.
  - `format` 'PHONE' | 'AMOUNT' | 'MONTHYEAR' | 'TEXT', required — The data format to be used for the prompt. The device will show a format-appropriate keyboard for each value.
  - `text` string, required

## Response `200`

Returns a text response based on user input

- TextResponse
  - `response` string

## Other responses

- `209` — Operation was canceled.
- `400` — The request is invalid, and subsequent calls will continue to fail; do not repeat the call.
- `401` — An invalid bearer token has been provided. The call may be repeated if the provided bearer token is updated.
- `415` — The request is invalid, and contains request data in an unsupported format. This call may be repeated if the content is changed to a supported format.
- `500` — The request processing failed with an unknown error, and the processing state of the operation is indeterminate. Do not repeat the call without additional analysis.
- `501` — The device does not have the ability to respond to the requested operation; do not repeat the call.
- `503` — The device is not available because it is currently servicing another call. This can be repeated at a later time, or cancel may be called to end the current operation.
- `504` — The Device did not respond in a timely manner. This can be repeated at a later time.

---

[API](https://skmtc.net/clover/apis/platform-api.md) · [All operations](https://skmtc.net/clover/apis/platform-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/clover/platform-api/versions/08da265101a3/schema)