Skip to main content
StartSession
curl --request POST \
  --url https://{domain}/api/StartSession \
  --header 'Content-Type: application/json' \
  --data '
{
  "HwSerial": "0434334921100366",
  "MachineId": 71234996,
  "TokenId": 116383,
  "Random": "123456789qwertyui"
}
'
{
  "Cipher": "X305dITNTAw2vHsxE+taVcn6UvgBC3fdI6QbqeABgHbo8CKsoZhqISJfslehCiA+L7XYrqvKFci7C6BNj/trzBuNJwBEjgBzKhhgpJ5ggnw=",
  "Status": {
    "Verdict": "Approved"
  }
}

Documentation Index

Fetch the complete documentation index at: https://devzone.nayax.com/llms.txt

Use this file to discover all available pages before exploring further.

This is the initial API call sent by Nayax. It initiates the transaction session by authenticating both parties and generating a SparkTransactionId, which will be echoed in all subsequent calls throughout the transaction’s lifecycle.

Body

application/json

The payload to initiate a new session.

The request payload sent by the Spark platform to the integrator's configured StartSession endpoint to initiate a transaction session.

​
HwSerial
string

The serial number of the payment terminal hardware.

​
MachineId
integer<int64>

The unique identifier for the Nayax machine.

​
TokenId
integer<int32>

A unique token provided by Nayax for secure authentication.

​
Random
string

A random alphanumeric string used for session verification.

Response

200 - application/json
object | null

Success. A new session has been successfully initiated.

The response payload from the StartSession endpoint, containing encrypted data and the session status.

​
Cipher
string

The encrypted data used to authenticate and initiate the session.

​
SparkTransactionId
string | null

The unique identifier for this transaction, which is echoed in all subsequent calls throughout the transaction's lifecycle.

​
Status
object

Transaction Status Details