Skip to main content
POST
/
TransactionNotify
TransactionNotify
curl --request POST \
  --url https://{domain}/api/TransactionNotify \
  --header 'Content-Type: application/json' \
  --data '
{
  "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"
}
'
{
  "NayaxTransactionId": 2004545072,
  "SparkTransactionId": "12c7cec2-c690-4425-9a1f-db0db60e2d8c",
  "HwSerial": "0434334921100366",
  "MachineId": 71234996,
  "SiteId": 2,
  "ServiceStationNumber": "5",
  "Status": {
    "Verdict": "Approved",
    "StatusMessage": "Session will begin immediately."
  }
}
The TransactionNotify endpoint is used to notify the integrator about the final details of a charging session, including charger availability, amount, and display information.

Body

application/json

The request payload containing final session details.

The request payload for the TransactionNotify endpoint, which provides final details of a charging session. This request is made after a session has been prepared and the charger is ready for use.

HwSerial
string

The hardware serial number of the terminal.

MachineId
integer<int64>

The ID of the vending machine or service device.

NayaxTransactionId
integer<int64>

The unique Nayax internal transaction ID.

SparkTransactionId
string | null

The unique ID generated in StartAuthentication.

Amount
number<double>

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

CardLast4Digits
string

The last four digits of the card presented.

CardHash
string

The one-way hash of the whole card number.

CardUid
string | null

The UID of the card (for prepaid cards).

ServiceStationNumber
string | null

The number identifying the service station.

SiteId
integer<int16>

The identifier for the Spark site.

MachineAuTime
string | null

The timestamp from the device in yyyyMMddHHmmssSSS format.

Response

200 - application/json
object | null

Success. The transaction notification was received.

The response payload from the integrator to the TransactionNotify request. This response confirms the session status and echoes key identifiers.

NayaxTransactionId
integer<int64>

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

SparkTransactionId
string | null

The unique session ID, echoed from the request.

HwSerial
string

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

MachineId
integer<int64>

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

SiteId
integer<int16> | null

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

ServiceStationNumber
string | null

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

Status
object

An object confirming how to proceed. The Verdict is typically "Approved" or "Declined".