Skip to main content
POST
/
AvailabilityCheck
AvailabilityCheck
curl --request POST \
  --url https://{domain}/api/AvailabilityCheck \
  --header 'Content-Type: application/json' \
  --data '
{
  "HwSerial": "<string>",
  "MachineId": 123,
  "SparkTransactionId": "<string>",
  "Amount": 123,
  "ServiceStationNumber": "<string>",
  "SiteId": 123
}
'
{
  "SparkTransactionId": "<string>",
  "HwSerial": "<string>",
  "MachineId": 123,
  "SiteId": 123,
  "ServiceStationNumber": "<string>",
  "ServiceStationAvailability": 123,
  "PosDisplay": "<string>",
  "Amount": 123,
  "Status": {
    "Verdict": "<string>",
    "StatusMessage": "<string>",
    "Status": {
      "Verdict": "<string>",
      "ErrorCode": 123,
      "ErrorDescription": "<string>",
      "StatusMessage": "<string>"
    }
  }
}

Body

This object is used to check the availability of a service station and retrieve details to display on the Nayax device before initiating a transaction. It's sent after a successful StartSession response to gather information for the POS device.

​
HwSerial
string

The unique serial number of the hardware terminal, used to identify the Nayax device.

Maximum string length: 255
​
MachineId
integer<int64>

The unique ID of the vending machine or terminal, as configured in the Nayax system.

​
SparkTransactionId
string | null

The unique transaction ID assigned by Spark for the open session. This ID is provided in the /StartSession and /StartAuthentication responses and must be used for all subsequent calls within the same transaction lifecycle.

​
Amount
number<double>

The estimated amount for the session, to be displayed on the terminal. This value is used for Pre-Authorization and Pre-Selection flows to provide the consumer with a transaction estimate.

​
ServiceStationNumber
string | null

The identifier for the selected service station or point of interaction. This parameter is included when the Nayax device is configured to support multiple service points.

​
SiteId
integer<int16>

The ID of the site where the transaction originated. This value helps the Nayax Engine route the transaction to the correct location.

Response

object | null

Success

The response object for the InfoQuery API, providing status, availability, and display information to the Nayax device before a transaction begins.

​
SparkTransactionId
string | null

The unique transaction ID from the original request.

​
HwSerial
string

The unique serial number of the Nayax hardware terminal.

Maximum string length: 255
​
MachineId
integer<int64>

The unique identifier for the machine or device.

​
SiteId
integer<int16>

The ID of the site where the terminal is operating.

​
ServiceStationNumber
string | null

Identifies the selected service station or point of interaction number. This parameter is provided by Nayax when the device supports multiple service points.

​
ServiceStationAvailability
integer

The availability status of the service station. A value of 1 indicates it's Available, 2 means Busy, and 3 signifies Out of Service.

​
PosDisplay
string | null

A custom message to be displayed on the terminal screen, formatted as a semicolon-delimited string.

​
Amount
number<double>

The estimated total amount for the session, in major currency units.

​
Status
object

An object containing the verdict of the availability check and a descriptive message.