Sign in

v1

latestOpenAPI 3.0.12026-07-26181265484.9 KB
Transactions

TransactionNotify

post/TransactionNotify

Request body

HwSerialstring

The hardware serial number of the terminal.

MachineIdinteger

The ID of the vending machine or service device.

NayaxTransactionIdinteger

The unique Nayax internal transaction ID.

SparkTransactionIdstring nullable

The unique ID generated in StartAuthentication.

Amountnumber double

The final amount to charge in central currency units (e.g., dollars).

CardLast4Digitsstring

The last four digits of the card presented.

CardHashstring

The one-way hash of the whole card number.

CardUidstring nullable

The UID of the card (for prepaid cards).

ServiceStationNumberstring nullable

The number identifying the service station.

SiteIdinteger

The identifier for the Spark site.

MachineAuTimestring nullable

The timestamp from the device in yyyyMMddHHmmssSSS format.

Example request

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

Response

Success. The transaction notification was received.

NayaxTransactionIdinteger

The Nayax internal unique identifier of the transaction, echoed from the request.

SparkTransactionIdstring nullable

The unique session ID, echoed from the request.

HwSerialstring

The unique hardware serial number of the terminal, echoed from the request.

MachineIdinteger

The unique ID of the machine, echoed from the request.

SiteIdinteger nullable

The ID of the site where the transaction originated, echoed from the request.

ServiceStationNumberstring nullable

The identifier of the service station, echoed from the request.

Example response

{
  "NayaxTransactionId": 2004545072,
  "SparkTransactionId": "12c7cec2-c690-4425-9a1f-db0db60e2d8c",
  "HwSerial": "0434334921100366",
  "MachineId": 71234996,
  "SiteId": 2,
  "ServiceStationNumber": "5",
  "Status": {
    "Verdict": "Approved",
    "StatusMessage": "Session will begin immediately."
  }
}