Device Interaction/requestInput

Request Input from Cardholder

Planned

Planned. This contract is published ahead of the build. It is not callable yet — treat it as the shape to design against, not a live endpoint.

Prompt the cardholder for text, a selection, or a rating.

POST/v1/terminal/input

Ask the cardholder (or operator) for input using the terminal screen. Supports text, numeric, email, phone, selection lists, yes/no prompts, and star ratings. The call blocks until the user responds, cancels, or the timeout is reached — perfect for capturing emails for digital receipts, dine-in vs takeaway choices, or post-payment NPS prompts.

Request body

application/json

promptstringRequired

Prompt text displayed to the user (max 100 chars).

Example "Enter your email for receipt"

inputTypeenumRequired

Type of input to request.

TEXTNUMERICEMAILPHONESELECTIONYES_NORATING

optionsarray

Options for SELECTION input type.

minLengthinteger

Minimum input length (TEXT/NUMERIC/EMAIL/PHONE).

maxLengthinteger

Maximum input length (TEXT/NUMERIC/EMAIL/PHONE).

timeoutMsinteger

Timeout in milliseconds (1000–120000).

Example 30000

Response

application/json

valuestringnullable

The user's input. Null if cancelled or timed out.

cancelledbooleanRequired

User explicitly cancelled.

Example false

timedOutbooleanRequired

Input timed out.

Example false

requestInput