Sign in

v1

latestOpenAPI 3.0.12026-07-26181265484.9 KB
Transactions

StartAuthentication

post/StartAuthentication

Request body

TokenIdinteger

A unique token provided by Nayax to identify your integration.

TerminalIdstring

The unique device ID of the target terminal.

TerminalIdTypeinteger

Defines the type of TerminalId being used. Use 1 for the hardware serial number (HW Serial) or 2 for the Nayax Machine ID.

Randomstring

A random string used as part of the encryption handshake.

Cipherstring

The AES-256 ECB encrypted payload. This is a Base64-encoded string that contains the Spark Transaction ID, a random string, and a timestamp.

Example request

{
  "TokenId": 116383,
  "TerminalId": "0434334921100366",
  "TerminalIdType": 1,
  "Random": "123456789qwertyui",
  "Cipher": "X305dITNTAw2vHsxE+taVcn6UvgBC3fdI6QbqeABgHbo8CKsoZhqISJfslehCiA+L7XYrqvKFci7C6BNj/trzBuNJwBEjgBzKhhgpJ5ggnw="
}

Response

Success. The transaction request was successfully authenticated.

HashedSparkTransactionIdstring

A SHA256 hash of the SparkTransactionId sent in the request. This ID must be used for all subsequent steps of the transaction.

Example response

{
  "HashedSparkTransactionId": "9515af0d6b5c328b6383ff241fa7b03e489d6285a8db6a4f0d8369e3f044e8d7",
  "Status": {
    "Verdict": "Approved",
    "ErrorDescription": " No Errors "
  }
}