Guides

StopCallback

Suggest Edits

🚧

Enable StopCallback

This feature must be enabled in Nayax Core during the integration.

The StopCallback API call is part of the Pre-Authorization transaction flow. It is used to notify the integrator that a consumer has presented their payment card at the terminal in an attempt to stop an ongoing session. This process allows Spark to validate and match the card against an active session that was originally authorized on the same terminal.

While the payment terminal is in Idle mode, it can accept a card presentation. If Nayax recognizes the card as belonging to an active transaction, it sends the StopCallback with the transaction details. If a session match is found, you need to send a Settlement request to complete the session termination.

🚧

Timeout

If no ACK is received within 5 seconds, the consumer experience is considered failed.

Request

Spark sends a POST request to your configured StopCallback endpoint. The body parameters are as in the example below:

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

Request Parameters

The table below describes the parameters of the request:

FieldTypeRequiredDescription
StopSiteIdIntegerYesID of the site where the session stop was triggered.
MachineIdIntegerYesUnique ID of the vending machine or device.
HwSerialStringYesHardware serial number of the terminal.
CardLast4DigitsStringYesLast 4 digits of the card used for the transaction.
CardHashStringYesHashed value of the payment card.
SparkTransactionIdStringYesSpark transaction identifier to match the session.
NayaxTransactionIdIntegerYesUnique Nayax transaction ID.
CardUidStringNoUnique identifier of the card, if available. See a more detailed explanation on the SMC Support page.
MachineAuTimeStringYesTerminal's local timestamp in format yyyyMMddHHmmssSSS.
ServiceStationNumberStringNoIdentifier of the charging point or station used.

📘

Nayax Callback

This is a callback from Nayax, no response body is required. A simple 200 OK server acknowledgment is sufficient.

Updated 8 days ago