Skip to main content
POST
/
StopCallback
StopCallback
curl --request POST \
  --url https://{domain}/api/StopCallback \
  --header 'Content-Type: application/json' \
  --data '
{
  "StopSiteId": 4,
  "MachineId": 71234996,
  "HwSerial": "0434334921100366",
  "CardLast4Digits": "1234",
  "CardHash": "7f2082ba5dbccf706b6987e75b62083f65b5695bc2d8c827c3e46769d007a9e6",
  "SparkTransactionId": "12c7cec2-c690-4425-9a1f-db0db60e2d8c",
  "NayaxTransactionId": 2004545072,
  "CardUid": "1288528281124927",
  "MachineAuTime": "20240205194122328",
  "ServiceStationNumber": "5"
}
'
{
  "Status": {
    "Verdict": "Approved",
    "ErrorDescription": "No Errors"
  },
  "SparkTransactionId": "12c7cec2-c690-4425-9a1f-db0db60e2d8c",
  "ServiceStationNumber": "5"
}
The StopCallback endpoint notifies the integrator that a consumer has presented a payment card to stop an ongoing session.

Body

application/json

The request payload containing details of the card and session to be stopped.

The request payload sent by Spark to an integrator's configured StopCallback endpoint to notify that a consumer has presented a card to stop an ongoing session. This is used to validate and match the card against an active session.

​
StopSiteId
integer<int16>

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

​
MachineId
integer<int64>

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

​
HwSerial
string

The hardware serial number of the terminal.

​
CardLast4Digits
string | null

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

​
CardHash
string

The hashed value of the payment card presented.

​
SparkTransactionId
string | null

The Spark transaction identifier of the original initiated session.

​
NayaxTransactionId
integer<int64> | null

The unique Nayax transaction ID associated with the open session.

​
CardUid
string | null

A unique identifier of the card, if available.

​
MachineAuTime
string | null

The terminal's local timestamp in the format yyyyMMddHHmmssSSS.

​
ServiceStationNumber
string | null

The identifier of the charging point or station used.

Response

200 - application/json
object | null

Success. A simple 200 OK server acknowledgment is sufficient.

The response payload from the integrator to Nayax's StopCallback, acknowledging the request and providing a status.

​
Status
object

Transaction Status Details

​
SparkTransactionId
string | null

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

​
ServiceStationNumber
string | null

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.