Sign in

v1

latestOpenAPI 3.0.12026-07-26181265484.9 KB
Transactions

TransactionCallback

post/TransactionCallback

Request body

NayaxTransactionIdinteger

The unique internal transaction ID assigned by Nayax.

SparkTransactionIdstring nullable

The unique session ID generated in StartAuthentication.

SiteIdinteger

The ID of the vending site or Spark location.

TerminalIdstring

The unique ID of the terminal that read the card.

MachineIdinteger

The identifier of the vending machine or device.

HwSerialstring

The hardware serial number of the terminal.

MachineAuTimestring nullable

The timestamp from the machine in the format yyyyMMddHHmmssSSS.

CardLast4Digitsstring nullable

The last four digits of the presented card.

CardHashstring

The one-way hash of the full card number.

CardUidstring nullable

The unique identifier of the card (for prepaid cards).

Amountnumber double

The transaction amount in the main currency unit (decimal place 0, e.g., 15 for $15.00).

Example request

{
  "NayaxTransactionId": 2004545072,
  "SparkTransactionId": "12c7cec2-c690-4425-9a1f-db0db60e2d8c",
  "SiteId": 2,
  "TerminalId": "0434334921100366",
  "MachineId": 71234996,
  "HwSerial": "0434334921100366",
  "AuthStatus": {
    "Verdict": "Approved",
    "ErrorCode": 0,
    "ErrorDescription": "",
    "StatusMessage": ""
  },
  "CardLast4Digits": "1234",
  "CardHash": "7f2082ba5dbccf706b6987e75b62083f65b5695bc2d8c827c3e46769d007a9e6",
  "CardUid": "1288528281124927",
  "MachineAuTime": "20240205194122328",
  "Amount": 15
}

Response

Success. A simple 200 OK server acknowledgment is sufficient.

SparkTransactionIdstring nullable

The unique identifier for the Spark session. This ID is generated during StartAuthentication.

Example response

{
  "SparkTransactionId": "12c7cec2-c690-4425-9a1f-db0db60e2d8c",
  "Status": {
    "Verdict": "Approved",
    "ErrorDescription": "No Errors"
  }
}