---
title: "AvailabilityCheck"
method: POST
path: "/AvailabilityCheck"
tags: ["Transactions"]
---

# AvailabilityCheck

`POST /AvailabilityCheck`

## Request body

- AvailabilityCheckRequest, nullable — 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.
  - `MachineId` integer — The unique ID of the vending machine or terminal, as configured in the Nayax system.
  - `SparkTransactionId` string, 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.
  - `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, 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.
  - `SiteId` integer — The ID of the site where the transaction originated. This value helps the Nayax Engine route the transaction to the correct location.

## Response `200`

Success

- AvailabilityCheckResponse, nullable — The response object for the InfoQuery API, providing status, availability, and display information to the Nayax device before a transaction begins.
  - `SparkTransactionId` string, nullable — The unique transaction ID from the original request.
  - `HwSerial` string — The unique serial number of the Nayax hardware terminal.
  - `MachineId` integer — The unique identifier for the machine or device.
  - `SiteId` integer — The ID of the site where the terminal is operating.
  - `ServiceStationNumber` string, nullable — 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, nullable — 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.
    - `Verdict` string — The result of the request. This will be `"Approved"` if the service station is available, or `"Declined"` if not.
    - `StatusMessage` string — A human-readable message providing more context about the status, such as "Charger is available for charging".
    - `Status` Status — Transaction Status Details
      - `Verdict` string — Status of the request (Approved / Declined)
      - `ErrorCode` integer, nullable — - Conditional - Reason for declined request
      - `ErrorDescription` string, nullable — - Conditional - Length: 255 - Error description
      - `StatusMessage` string, nullable — - Optional - Length: 255 - Transaction status message as free text field

---

[API](https://skmtc.net/nayax/apis/nayax-cortina-api.md) · [All operations](https://skmtc.net/nayax/apis/nayax-cortina-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/nayax/nayax-cortina-api/versions/421f6f83c257/schema)
