v1

latestOpenAPI 3.0.12026-07-26181265484.9 KB
Transactions

AvailabilityCheck

post/AvailabilityCheck

Request body

HwSerialstring

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

MachineIdinteger

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

SparkTransactionIdstring nullable

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.

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

ServiceStationNumberstring nullable

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.

SiteIdinteger

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

Response

Success

SparkTransactionIdstring nullable

The unique transaction ID from the original request.

HwSerialstring

The unique serial number of the Nayax hardware terminal.

MachineIdinteger

The unique identifier for the machine or device.

SiteIdinteger

The ID of the site where the terminal is operating.

ServiceStationNumberstring nullable

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

ServiceStationAvailabilityinteger

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

PosDisplaystring nullable

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

Amountnumber double

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