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 displayScreen method allows the client application (POS/FCC) to take control of the terminal’s display. This serves to guide the customer through the fueling process by showing status updates, instructions, or custom alerts that are not part of the standard payment flow. Use this method to:
  • Direct the customer with workflow instructions like “Please Lift Handle” or “Insert Fuel Nozzle.”
  • Inform the user of system status updates, such as “Pump 4 Authorized” or “Tank Full.”
  • Display localized or custom error messages if a pump-side issue occurs.
  • Show custom welcome messages or promotional text during idle moments to reinforce branding.
Examples of display prompts on a Nayax device:

​
Requests

All requests must include the command, requestId, and the specific text content you wish to display. The following example shows a typical request: 
{
"command": "displayScreen",
"requestId": "req-007",
"data": {
"title": "Welcome",
"line1": "Ready to Process Payment",
"line2": "Please select payment method",
"textColor": "WHITE",
"alignmentHor": "CENTER",
"alignmentVer": "TOP",
"mediaId": "idle",
"fitImage": "FULL",
"loop": false
}
}

​
Parameter Definitions

The table below describes the parameters available for this request:
NameTypeRequiredDescription
commandstringYesSet to "displayScreen".
requestIdstringYesA unique identifier for tracking the response.
textstringYesThe message to be displayed on the terminal screen.
timeoutintegerNoDuration (in seconds) the message should remain visible before returning to the default screen.

​
Responses

The terminal returns a simple acknowledgement once the screen has been updated with the requested text. The following example shows a typical response: 
{
"requestId": "req-007"
}

​
Response Parameters

The response confirms that the terminal has processed the visual update:
NameTypeDescription
requestIdstringEchoes the unique identifier of the original request.
statusstringReturns SUCCESS if the message was successfully rendered on the display.