Skip to main content

Documentation Index

Fetch the complete documentation index at: https://devzone.nayax.com/llms.txt

Use this file to discover all available pages before exploring further.

The displayInput method allows the client application to prompt the customer for specific information using the terminal’s keypad or touchscreen. This serves as an essential tool for workflows that require additional data points beyond standard card details. Use this method to:
  • Prompt for identification and security details like a PIN, Zip Code, or custom “Employee ID” for fleet cards.
  • Request operational metadata such as Odometer readings, Unit Numbers, or Hubometer values.
  • Ask for specific customer inputs like “Enter Pump Number” or “Enter Phone Number” for loyalty programs.
Example of the display prompt on a Nayax device: displayInput

​
Requests

When calling this method, you must define the prompt and its corresponding cryptographic signature.
All prompt/signature pairs are managed via the prompts.json file on your device. If you require a new or custom prompt, please email your request to the support team, and we will provide the updated file and signature for you.
{
  "command": "displayInput",
  "requestId": "req-008",
  "data": {
    "title": "Loyalty",
    "prompt": "Enter mobile number",
    "signature": "HvWRJ2...",
    "inputType": "NUMERIC",
    "minLength": 6,
    "maxLength": 10,
    "mask": false,
    "skipButton": true,
    "skipButtonText": "Skip"
  }
}

​
Parameter Definitions

The table below describes the parameters available for this request:
NameTypeRequiredDescription
commandstringYesSet to "displayInput".
requestIdstringYesA unique identifier for tracking the response.
titlestringNoThe heading text displayed at the top of the input screen.
promptstringYesThe input question (must match the signed value in prompts.json).
signaturestringYesThe signature provided for the specific prompt.
inputTypestringNoNUMERIC, ALPHANUMERIC, or PASSWORD (masked).
minLengthintegerNoThe minimum number of characters required to submit.
maxLengthintegerYesThe maximum number of characters allowed.
maskbooleanNoIf true, hides the user’s input (replaces characters with dots/asterisks) for passwords.
skipButtonbooleanNoIf true, a button is displayed to bypass the input.
skipButtonTextstringNoThe label for the skip button (e.g., “Skip”).

​
Responses

The terminal returns the data entered by the customer once they press the Enter (→) key on the keyboard. The following example shows a typical response: 
{
"requestId": "req-008",
"data": {
"value": "0501234567"
}
}
The following example shows a canceled/skipped response: 
{
"requestId": "req-008",
"data": {
"key": "SKIP/CANCEL"
}
}

​
Response Parameters

The data object contains the following fields:
NameTypeDescription
valuestringThe actual string entered by the user.
keystringIndicates the action taken if the input was not completed (e.g., SKIP/CANCEL).