Skip to main content
POST
/
InfoQuery
InfoQuery
curl --request POST \
  --url https://{domain}/api/InfoQuery \
  --header 'Content-Type: application/json' \
  --data '
{
  "HwSerial": "0434334921100366",
  "MachineId": 71234996,
  "SparkTransactionId": "12c7cec2-c690-4425-9a1f-db0db60e2d8c",
  "ServiceStationNumber": "5",
  "SiteId": 2
}
'
{
  "SparkTransactionId": "<string>",
  "HwSerial": "<string>",
  "MachineId": 123,
  "ServiceStationNumber": "<string>",
  "ServiceStationAvailability": 123,
  "PosDisplay": "<string>",
  "Amount": 123,
  "SiteId": 123,
  "Status": {
    "Verdict": "<string>",
    "ErrorCode": 123,
    "ErrorDescription": "<string>",
    "StatusMessage": "<string>"
  }
}
Nayax sends an InfoQuery API after a successful StartSession response. Its main purposes are to retrieve information to be shown on the POS device before payment begins and to check the availability status of the requested service station.

Body

application/json

The request payload containing details to query for.

The request payload sent by Spark to the integrator's configured InfoQuery endpoint to retrieve information about a service and its availability.

​
HwSerial
string

The serial number of the hardware terminal where the InfoQuery originated.

​
MachineId
integer<int64>

The unique identifier for the machine or device.

​
SparkTransactionId
string | null

The unique transaction ID assigned by Spark. This ID is used to track the session throughout its lifecycle.

​
ServiceStationNumber
string | null

An identifier for the selected service station (e.g., a charging point number). This value identifies the Point of Interaction number provided by the Spark Provider.

​
SiteId
integer<int16>

The ID of the site where the terminal is operating. This indicates the location where the transaction flow originated.

Response

200 - application/json
object | null

Success. The requested information has been successfully retrieved.

desc

​
SparkTransactionId
string | null
  • Transaction ID generated in the /StartSession response
​
HwSerial
string
  • Length: 255
  • Unique Identifier for the Nayax Device
  • Echo value from InfoQuery Request
​
MachineId
integer<int64>
  • Length: 255
  • Unique Identifier for the Nayax Machine
  • Echo value from InfoQuery Request
​
ServiceStationNumber
string | null
  • Identifies the Spark Provider’s Point of Interaction number
  • Will be provided by Nayax when the Nayax Device is configured to support several service points via the Nayax backoffice system
  • Echo value from InfoQuery Request
​
ServiceStationAvailability
integer<int32>
  • Indictaes if selected Service Station is (1) Available, (2) In Session / Busy, (3) Out of Service
​
PosDisplay
string | null
  • Optional
  • Allows presenting information on the payment terminal screen
​
Amount
number<double>
  • Length: 3
  • A value that will be provided to the Terminal for transaction initiation
​
SiteId
integer<int16>
  • Mandatory
  • Echo value from InfoQuery Request
​
Status
object

Transaction Status Details