Sign in

v1

latestOpenAPI 3.0.12026-07-26181265484.9 KB
Transactions

StartSession

post/StartSession

Request body

HwSerialstring

The serial number of the payment terminal hardware.

MachineIdinteger

The unique identifier for the Nayax machine.

TokenIdinteger

A unique token provided by Nayax for secure authentication.

Randomstring

A random alphanumeric string used for session verification.

Example request

{
  "HwSerial": "0434334921100366",
  "MachineId": 71234996,
  "TokenId": 116383,
  "Random": "123456789qwertyui"
}

Response

Success. A new session has been successfully initiated.

Cipherstring

The encrypted data used to authenticate and initiate the session.

SparkTransactionIdstring nullable

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

Example response

{
  "Cipher": "X305dITNTAw2vHsxE+taVcn6UvgBC3fdI6QbqeABgHbo8CKsoZhqISJfslehCiA+L7XYrqvKFci7C6BNj/trzBuNJwBEjgBzKhhgpJ5ggnw=",
  "Status": {
    "Verdict": "Approved"
  }
}