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 Marshall Pro protocol uses a unified JSON structure for every message. This consistency allows you to build a single “wrapper” in your code to handle all terminal communications.

Request Object

Every command sent from your system to the VPOS must follow this structure:
FieldTypeRequiredDescription
commandstringYesThe name of the API method (e.g., "status", "pay").
requestIdstringYesA unique ID used to track the response.
dataobjectNoA container for the specific parameters of the command.

Request Example

{
  "command": "<command_name>",
  "requestId": "<unique_request_id>",
  "data": {
    "param1": "value1",
    "param2": "value2"
  }
}

Response Object

The terminal’s response always mirrors your requestId so your system knows exactly which command is being answered.

Success Response

If the command is processed successfully, the terminal returns the requested information inside the data object.
{
  "requestId": "<request_id_echo>",
  "data": {
    "status": "success",
    "details": "..."
  }
}

Error Response

If an issue occurs, the response will include an error code and a descriptive message.
{
  "requestId": "<request_id_echo>",
  "errorCode": 400,
  "errorMessage": "Invalid command parameters"
}