v1

latestOpenAPI 3.0.12026-07-26181265484.9 KB
Transactions

StopCallback

post/StopCallback

Request body

StopSiteIdinteger

The ID of the site where the session stop was triggered.

MachineIdinteger

The unique ID of the vending machine or device where the card was presented.

HwSerialstring

The hardware serial number of the terminal.

CardLast4Digitsstring nullable

The last four digits of the card used for the transaction.

CardHashstring

The hashed value of the payment card presented.

SparkTransactionIdstring nullable

The Spark transaction identifier of the original initiated session.

NayaxTransactionIdinteger nullable

The unique Nayax transaction ID associated with the open session.

CardUidstring nullable

A unique identifier of the card, if available.

MachineAuTimestring nullable

The terminal's local timestamp in the format yyyyMMddHHmmssSSS.

ServiceStationNumberstring nullable

The identifier of the charging point or station used.

Example request

{
  "StopSiteId": 4,
  "MachineId": 71234996,
  "HwSerial": "0434334921100366",
  "CardLast4Digits": "1234",
  "CardHash": "7f2082ba5dbccf706b6987e75b62083f65b5695bc2d8c827c3e46769d007a9e6",
  "SparkTransactionId": "12c7cec2-c690-4425-9a1f-db0db60e2d8c",
  "NayaxTransactionId": 2004545072,
  "CardUid": "1288528281124927",
  "MachineAuTime": "20240205194122328",
  "ServiceStationNumber": "5"
}

Response

Success. A simple 200 OK server acknowledgment is sufficient.

SparkTransactionIdstring nullable

The unique identifier for the Spark transaction that was requested to be stopped.

ServiceStationNumberstring nullable

The number identifying the service station where the session stop was attempted. This value is provided by Nayax if the device is configured to support multiple service points.

Example response

{
  "Status": {
    "Verdict": "Approved",
    "ErrorDescription": "No Errors"
  },
  "SparkTransactionId": "12c7cec2-c690-4425-9a1f-db0db60e2d8c",
  "ServiceStationNumber": "5"
}