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.

Body Params
boolean

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

string
enum
required

The data format to be used for the prompt.
The device will show a format-appropriate keyboard for each value.

Allowed:
string
required
Headers
string
required

The Clover device to route the request to.

string
required

An identifier for the POS making the request.

integer
0 to 300

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.

string

The idempotency key transmitted during the request, if any.

Responses

Language
Credentials
Bearer
URL
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json