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 info method exchanges version information and device metadata between the client application (POS/FCC) and the VPOS terminal. This typically serves as the first command sent after establishing a TCP connection to ensure compatibility between both systems. Use this method to:
  • Exchange vendor, model, and serial number details for system identification.
  • Synchronize software and hardware versions to ensure protocol feature alignment.
  • Retrieve critical terminal settings, such as the defined decimal place for transaction amounts.

Requests

All requests must include the command and a unique requestId. The data object should contain the details of the client system making the request. The following example shows a typical request:
{
"command": "info",
"requestId": "req-020",
"data": {
"vendor": "Nayax Fuel",
"model": "FCC-3000",
"serialNumber": "FCC-12345678",
"swVersion": "1.2.3.4",
"hwVersion": "4.3.2.1"
}
}

Parameter Definitions

The table below describes the parameters provided by your system in this request:
NameTypeRequiredDescription
vendorstringYesThe vendor name of the client system (e.g., “Nayax Fuel”).
modelstringYesThe model identifier of the POS or FCC hardware.
serialNumberstringYesThe unique serial number of the client system.
swVersionstringYesThe current software version of the client application.
hwVersionstringYesThe hardware version of the client device.

Responses

The VPOS terminal returns its own hardware and software specifications, along with regional settings required for payment processing. The following example shows a typical response:
{
"requestId": "req-020",
"data": {
"serialNumber": "P129901X251AD",
"osVersion": "16.0",
"appVersion": "2.3.4.5",
"paymentVersion": "0.0.2.68",
"decimalPlace": 2
}
}

Response Parameters

Below are the parameters returned by the VPOS terminal:
NameTypeDescription
serialNumberstringThe unique serial number of the VPOS terminal.
osVersionstringThe operating system version running on the device.
appVersionstringThe version of the primary terminal application.
paymentVersionstringThe specific version of the payment processing module.
decimalPlaceintegerThe number of decimal places to be used for all transaction amounts (e.g., 2 means an amount of 5000 represents $50.00).