> ## 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.

# displayScreen

> Control the terminal's visual interface to display custom messages to the customer.

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:

<Frame>
  <div className="grid grid-cols-4 gap-2">
    <img src="https://mintcdn.com/nayax-44d6e37b/yeBOHTTwlm5bRLCx/images/start-fueling.png?fit=max&auto=format&n=yeBOHTTwlm5bRLCx&q=85&s=60907e34530fb78bc47c50724386475e" width="288" height="512" data-path="images/start-fueling.png" />

    <img src="https://mintcdn.com/nayax-44d6e37b/yeBOHTTwlm5bRLCx/images/fueling-in-progress.png?fit=max&auto=format&n=yeBOHTTwlm5bRLCx&q=85&s=6781a86df52f816e2bd66d32512509e9" width="288" height="512" data-path="images/fueling-in-progress.png" />

    <img src="https://mintcdn.com/nayax-44d6e37b/Eugt9jmKRTFJAUVK/images/approved.png?fit=max&auto=format&n=Eugt9jmKRTFJAUVK&q=85&s=e305c638c2fdcfa906a263946d5405ac" width="288" height="512" data-path="images/approved.png" />

    <img src="https://mintcdn.com/nayax-44d6e37b/Eugt9jmKRTFJAUVK/images/declined.png?fit=max&auto=format&n=Eugt9jmKRTFJAUVK&q=85&s=0ac78a8cb31e0fd86b3d5aa716002ec9" width="288" height="512" data-path="images/declined.png" />
  </div>
</Frame>

## Requests

All requests must include the `command`, `requestId`, and the specific text content you wish to display.

The following example shows a typical request:

```json theme={null}
{
"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:

| Name          | Type    | Required | Description                                                                                     |
| :------------ | :------ | :------- | :---------------------------------------------------------------------------------------------- |
| **command**   | string  | Yes      | Set to `"displayScreen"`.                                                                       |
| **requestId** | string  | Yes      | A unique identifier for tracking the response.                                                  |
| **text**      | string  | Yes      | The message to be displayed on the terminal screen.                                             |
| **timeout**   | integer | No       | Duration (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:

```json theme={null}
{
"requestId": "req-007"
}
```

### Response parameters

The response confirms that the terminal has processed the visual update:

| Name          | Type   | Description                                                                |
| :------------ | :----- | :------------------------------------------------------------------------- |
| **requestId** | string | Echoes the unique identifier of the original request.                      |
| **status**    | string | Returns `SUCCESS` if the message was successfully rendered on the display. |