Skip to main content
StopNotify
The StopNotify endpoint enables Spark to determine whether a card presented at the payment terminal while idle is authorized to stop an ongoing session. A matching card should result in an Approved response; otherwise, the Spark integrator should return a Declined verdict.

Body

application/json

The request payload containing card and terminal identifiers to validate a stop request.

desc

StopSiteId
integer<int16>

Indication for Nayax Engine in which Site the transaction originated

MachineId
integer<int64>
  • Length: 255
  • Unique Identifier for the Nayax Machine
HwSerial
string
  • Length: 255
  • Unique Identifier for the Nayax Device
CardLast4Digits
string | null

Payment card's last 4 digits

CardHash
string
CardUid
string | null

Payment card's Unique identifier

ServiceStationNumber
string | null
  • Identifies the Spark Provider’s Point of Interaction number
  • Will be provided by Nayax when the Nayax Device is configured to support several service points via the Nayax backoffice system

Response

200 - application/json
object | null

Success. The stop request was successfully processed.

The response sent by the integrator to Nayax's StopNotify request, which indicates whether the card presented can be used to stop a session on the terminal. A Verdict of "Approved" indicates that the card matches an ongoing session and the flow can proceed.

SparkTransactionId
string | null

The Spark session identifier for the matched transaction.

NayaxTransactionId
integer<int64> | null

The unique ID for the Nayax transaction.

SiteId
integer<int16>

The original site ID where the transaction was initiated.

StopSiteId
integer<int16>

The site ID where the card was presented to stop the session.

MachineId
integer<int64>

The ID of the machine where the card was presented.

HwSerial
string

The serial number of the machine.

MachineAuTime
string | null

The local machine timestamp of the authorization in the format yyyyMMddHHmmssSSS.

Status
object

Transaction Status Details