Prompt (Input)

Displays a text input prompt on the terminal for the customer or clerk to enter free-form data (e.g., table number, PO reference). Returns the entered string in the response.

Usage:

  • Provide register.
  • Optional title customizes terminal screen header.

Considerations: Length and character restrictions depend on device; keep alphanumeric to ensure compatibility. Provide client-side validation if a specific format is needed.

Security: ApiKeyAuth or EphemeralAuth.

Errors: Cancelled entry, timeout, unsupported character input.

Body Params
string
required

The id of the register performing this operation. This should be the 'id' value returned by GET /terminal/register.

string

Title for this prompt, displayed on the top of the terminal screen. Defaults to '' (empty string).

Response

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