displayInput

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:

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:

Name	Type	Required	Description
command	string	Yes	Set to `"displayInput"`.
requestId	string	Yes	A unique identifier for tracking the response.
title	string	No	The heading text displayed at the top of the input screen.
prompt	string	Yes	The input question (must match the signed value in `prompts.json`).
signature	string	Yes	The signature provided for the specific prompt.
inputType	string	No	`NUMERIC`, `ALPHANUMERIC`, or `PASSWORD` (masked).
minLength	integer	No	The minimum number of characters required to submit.
maxLength	integer	Yes	The maximum number of characters allowed.
mask	boolean	No	If `true`, hides the user’s input (replaces characters with dots/asterisks) for passwords.
skipButton	boolean	No	If `true`, a button is displayed to bypass the input.
skipButtonText	string	No	The 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:

Name	Type	Description
value	string	The actual string entered by the user.
key	string	Indicates the action taken if the input was not completed (e.g., `SKIP/CANCEL`).

Marshall Pro Guides

Payment Flows

Messaging Protocol

Methods

FAQ

Requests

Parameter Definitions

Responses

Response Parameters

​Requests

​Parameter Definitions

​Responses

​Response Parameters

Requests

Parameter Definitions

Responses

Response Parameters