CLclover
DEVICE

Get a text response

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.

post/v1/device/read-input

Request

  • Base URL
    https://deviceIpOrHost:12346/connect
  • URL
    https://deviceIpOrHost:12346/connect/v1/device/read-input
  • Auth
    HTTP bearer

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

beepboolean

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.

textstring required

Example request

{
  "format": "MONTHYEAR",
  "text": "Enter card expiration date"
}

Response

Returns a text response based on user input

responsestring

Example response

{
  "response": "mike@clover.com"
}

Changes

No recorded changes to this operation across all 1 revision of this API.