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.
Try it: Spark Auth Tool
Build or inspect the StartSession cipher in your browser, no code required. Opens the tool on the StartSession tab.
Nayax sends a Random string in the StartSession request. You return an encrypted string called a cipher in your response. The cipher proves that you hold the same Secret Token as Nayax.
Combine these three parts in the exact order and character positions shown below to make one long string:
Section
Type
Position
Description
Spark Transaction ID
String
1-36
A unique GUID (with hyphens) that you generate.
Separator
Special
37
Must be the = symbol.
Random String
String
38-64
The 27-character Random value from the Nayax request, exactly as received.
Example:12c7cec2-c690-4425-9a1f-db0db60e2d8c=123456789qwertyuioasdfghjklThe StartSession cipher has no timestamp. The Random value in the cipher must match the Random value in the Nayax request.
Nayax provides you with a Secret Token and its Token ID. The request carries the Token ID in TokenId. To create your key, take only the 32 characters on the far right of that token to create a 256-bit key.Example:
Full token example:...wRvTVTkungMIKThTVbj_fiXdfoGclhn0
What your key will look like:wRvTVTkungMIKThTVbj_fiXdfoGclhn0
Encrypt the 64-character string from Step 1 using AES-256 (ECB mode) with PKCS7 padding and your key from Step 2. Then, encode the result into Base64. The result is a 108-character string. Return it in the Cipher field of your StartSession response, together with the SparkTransactionId.This cipher is not the StartAuthentication cipher. The two ciphers use different plaintexts, so you can’t use one in place of the other.Nayax decrypts the cipher with the same key and checks the Random value and the cipher format.
Use the Spark Transaction ID in later calls: Nayax and you send the same SparkTransactionId in all later API calls of this transaction. When a call from Nayax arrives, check that its SparkTransactionId is one that you generated.
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.
The Base64 result of encrypting SparkTransactionId=Random with AES-256 in ECB mode and PKCS7 padding, using the 32 rightmost characters of the Secret Token as the key. The result is 108 characters.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Nayax Developer Portal","colors":{"primary":"#6352E0","light":"#FCC705","dark":"#6352E0"},"logo":{"light":"https://mintcdn.com/nayax-44d6e37b/ag7p0QchXLJNEuNE/images/home/logo_light.svg?fit=max\u0026auto=format\u0026n=ag7p0QchXLJNEuNE\u0026q=85\u0026s=b71aa1a61014633be60cee745d3e978c","dark":"https://mintcdn.com/nayax-44d6e37b/ag7p0QchXLJNEuNE/images/home/logo_dark.svg?fit=max\u0026auto=format\u0026n=ag7p0QchXLJNEuNE\u0026q=85\u0026s=26e496c2ba485bfe41389f473135944e"},"favicon":"https://mintcdn.com/nayax-44d6e37b/th_G6l3xpaCQbV-V/images/favicon.ico?fit=max\u0026auto=format\u0026n=th_G6l3xpaCQbV-V\u0026q=85\u0026s=96a64c93cc563f757e95a29a7ad6637d","api":{"playground":{"display":"none"}},"footer":{"links":[{"header":"Legal \u0026 Policies","items":[{"label":"Privacy Policy","href":"https://www.nayax.com/legal/nayax-general-privacy-policy"},{"label":"Cookie Policy","href":"https://www.nayax.com/cookie-policy"},{"label":"Terms of Use","href":"/docs/get-started/terms-of-service"},{"label":"Code of Ethics","href":"https://www.nayax.com/code-of-ethics"},{"label":"Whistleblowing","href":"https://www.nayax.com/whistleblowing-reporting-form"}]}]},"integrations":{"posthog":{"apiKey":"phc_trwjDEqjYgYGbwbd3aiMU6r4R5qcHqXt7pNzJCoVDtgg","sessionRecording":true}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":true},"navigation":{"languages":[{"language":"en","default":true,"href":""},{"language":"zh","href":"docs/zh"}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"nayax-44d6e37b","hasAudioNarration":false,"actualSubdomain":"nayax-44d6e37b","customDomains":["devzone.nayax.com"],"gitSource":{"type":"github","owner":"writechoiceorg","repo":"nayax-mintlify","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true,"agentFeedback":false},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6af1b49d0da5396f9632f099","clientVersion":"0.0.4102","searchFilterCounts":[{"language":"en","tag":"Terminal SDKs","count":220},{"language":"zh","tag":"Terminal SDKs","count":220},{"language":"en","tag":"API Reference","count":185},{"language":"zh","tag":"API Reference","count":185},{"language":"en","tag":"Platform Management","count":181},{"language":"zh","tag":"Platform Management","count":181},{"language":"en","tag":"Lynx API","count":173},{"language":"zh","tag":"Lynx API","count":173},{"language":"en","tag":"Endpoints","count":166},{"language":"zh","tag":"Endpoints","count":166},{"language":"en","tag":"Cortina","count":78},{"language":"zh","tag":"Cortina","count":78},{"language":"en","tag":"TweezerComm","count":69},{"language":"en","tag":"TweezerComm Guides","count":69},{"language":"zh","tag":"TweezerComm","count":69},{"language":"zh","tag":"TweezerComm Guides","count":69},{"language":"en","tag":"Marshall","count":44},{"language":"zh","tag":"Marshall","count":44},{"language":"en","tag":"Cortina Guides","count":42},{"language":"zh","tag":"Cortina Guides","count":42},{"language":"default","tag":"Platform Management","count":4},{"language":"default","tag":"Lynx API","count":4},{"language":"default","tag":"Lynx API Guides","count":4},{"language":"default","tag":"Operator","count":1},{"language":"default","tag":"Cards","count":1},{"language":"default","tag":"Machines","count":1}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":true,"enableAskAiSearchBar":true,"deflection":{"enabled":false,"type":"link"}},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":".card_content{font-feature-settings:\"clig\" off,\r\n \"liga\" off;font-family:Inter;font-style:normal;line-height:18px}.card_content span{position:absolute;top:10px;right:-5px;display:flex;align-items:center;justify-content:center;flex-shrink:0;color:#fff!important;text-align:center;font-size:8px;font-weight:700;text-transform:uppercase;width:40px;height:16px;flex-shrink:0;border-radius:10px;margin:0 15px 0 0}.card_content span.get{background:#0e9b71;text-shadow:1px 1px 0 #0d8d67,\r\n 0 1px 0 #0d8d67,\r\n 1px 0 0 #0d8d67}.card_content span.post{background:#0171c2;text-shadow:1px 1px 0 #0168b3,\r\n 0 1px 0 #0168b3,\r\n 1px 0 0 #0168b3}.card_content span.patch{background:#df7d03;text-shadow:1px 1px 0 #d07503,\r\n 0 1px 0 #d07503,\r\n 1px 0 0 #d07503}.card_content span.put{background:#674ead;text-shadow:1px 1px 0 #604aa2,\r\n 0 1px 0 #604aa2,\r\n 1px 0 0 #604aa2}footer .dark\\:hidden,footer .hidden.dark\\:block{display:none!important}footer .block.dark\\:hidden,footer .hidden.dark\\:block.active{display:block!important}footer .max-w-7xl>.flex{flex-direction:row!important;justify-content:space-between!important;align-items:center!important;flex-wrap:nowrap!important;width:100%!important}footer div:has(>a.md\\:truncate){display:flex!important;flex-direction:row!important;flex-wrap:nowrap!important;gap:1.5rem!important;margin-left:auto!important}footer a.md\\:truncate{max-width:none!important;white-space:nowrap!important;flex-shrink:0!important}footer h2{display:none!important}.nav-tabs{width:100%}.nav-tabs .nav-tabs-item:nth-last-child(3 of.nav-tabs-item){margin-left:auto}pre.bash{background-color:black;color:white;font-size:medium;font-family:Consolas,\r\n Monaco,\r\n Lucida Console,\r\n Liberation Mono,\r\n DejaVu Sans Mono,\r\n Bitstream Vera Sans Mono,\r\n Courier New,\r\n monospace;width:100%;display:inline-block}table{display:block;overflow-x:auto;white-space:normal}.nav-tabs>a:first-child::after{content:\"|\";position:absolute;right:-0.875rem;top:50%;transform:translateY(-50%);color:#d1d5db;font-weight:300;pointer-events:none;user-select:none}.dark .nav-tabs>a:first-child::after{color:#4b5563}[data-component-part=\"search-ask-ai-button\"]{display:none!important}#pagination{display:grid!important;grid-template-columns:1fr 1fr;gap:12px;align-items:stretch;margin-top:2rem}@media (max-width: 640px){#pagination{grid-template-columns:1fr}}#pagination>a{position:relative;display:flex;flex-direction:column;justify-content:center;gap:2px;width:100%;box-sizing:border-box;margin:0!important;padding:14px 16px;border-width:1px;border-style:solid;border-color:var(--pagination-border);border-radius:12px;background-color:rgb(var(--gray-50));text-decoration:none;transition:border-color 150ms ease;--pagination-accent: rgb(var(--primary-dark));--pagination-border: rgb(var(--gray-300))}.dark #pagination>a{background-color:rgb(var(--gray-900));--pagination-accent: rgb(var(--primary-light));--pagination-border: rgb(var(--default-border-color))}#pagination>a:hover{border-color:var(--pagination-accent)}#pagination>a:focus-visible{outline:2px solid var(--pagination-accent);outline-offset:2px}#pagination>a:not(.ml-auto){align-items:flex-start;text-align:left;padding-left:52px}#pagination>a.ml-auto{align-items:flex-end;text-align:right;padding-right:52px}#pagination>a::before{font-size:12px;font-weight:600;line-height:1.2;color:rgb(var(--gray-500))}.dark #pagination>a::before{color:rgb(var(--gray-400))}#pagination>a:not(.ml-auto)::before{content:\"Previous\"}#pagination>a.ml-auto::before{content:\"Next\"}#pagination>a span{font-size:15px;font-weight:600;line-height:1.3;color:#374151!important;margin:0!important}.dark #pagination>a span{color:#d1d5db!important}#pagination a svg{display:none}#pagination>a:not(.ml-auto){--arrow: url(\"data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24' fill='none' stroke='black' stroke-width='1.5' stroke-linecap='round' stroke-linejoin='round'%3E%3Cpath d='M19 12H5M11 5l-7 7 7 7'/%3E%3C/svg%3E\")}#pagination>a.ml-auto{--arrow: url(\"data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24' fill='none' stroke='black' stroke-width='1.5' stroke-linecap='round' stroke-linejoin='round'%3E%3Cpath d='M5 12h14M13 5l7 7-7 7'/%3E%3C/svg%3E\")}#pagination>a::after{content:\"\";position:absolute;top:50%;display:block;width:20px;height:20px;background:currentColor;-webkit-mask:var(--arrow) center / 20px 20px no-repeat;mask:var(--arrow) center / 20px 20px no-repeat;transform:translateY(-50%);color:#374151;transition:background-color 150ms ease}.dark #pagination>a::after{color:#d1d5db}#pagination>a:not(.ml-auto)::after{left:16px}#pagination>a.ml-auto::after{right:16px}#pagination>a:hover::after{color:var(--pagination-accent)}@media (prefers-reduced-motion: no-preference){#pagination>a::after{transition:background-color 150ms ease, transform 150ms ease}#pagination>a:not(.ml-auto):hover::after{transform:translate(-3px, -50%)}#pagination>a.ml-auto:hover::after{transform:translate(3px, -50%)}}"}],"page":{"pagePath":"reference/spark/transactions/startsession","slug":"/reference/spark/transactions/startsession","pageMetadata":{"title":"StartSession","description":null,"deprecated":null,"version":null,"hideFooterPagination":true,"openapi":"/openapi/spark.yaml post /StartSession","href":"/reference/spark/transactions/startsession","autogeneratedByOpenApi":true},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={code:`code`,li:`li`,p:`p`,strong:`strong`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,ul:`ul`,..._provideComponents(),...props.components},{Card,Heading,Note,Table}=_components;if(!Card)_missingMdxReference(`Card`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Note)_missingMdxReference(`Note`,true);if(!Table)_missingMdxReference(`Table`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`This is the initial API call sent by Nayax. It initiates the transaction session by authenticating both parties and generating a `,_jsx(_components.code,{children:`SparkTransactionId`}),`, which will be echoed in all subsequent calls throughout the transaction’s lifecycle.`]}),`\n`,_jsx(Card,{title:`Try it: Spark Auth Tool`,icon:`bolt`,href:`/docs/integrate-pos-device/spark/security-authentication/spark-auth-tool#startsession`,arrow:true,children:_jsxs(_components.p,{children:[`Build or inspect the `,_jsx(_components.code,{children:`StartSession`}),` cipher in your browser, no code required. Opens the tool on the StartSession tab.`]})}),`\n`,_jsx(Heading,{level:`2`,id:`how-to-build-the-cipher`,children:`How to Build the Cipher`}),`\n`,_jsxs(_components.p,{children:[`Nayax sends a `,_jsx(_components.code,{children:`Random`}),` string in the `,_jsx(_components.code,{children:`StartSession`}),` request. You return an encrypted string called a `,_jsx(_components.code,{children:`cipher`}),` in your response. The cipher proves that you hold the same Secret Token as Nayax.`]}),`\n`,_jsx(Heading,{level:`3`,id:`step-1-create-the-64-character-plaintext`,children:`Step 1: Create the 64-character Plaintext`}),`\n`,_jsx(_components.p,{children:`Combine these three parts in the exact order and character positions shown below to make one long string:`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Section`}),_jsx(_components.th,{children:`Type`}),_jsx(_components.th,{children:`Position`}),_jsx(_components.th,{children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.strong,{children:`Spark Transaction ID`})}),_jsx(_components.td,{children:`String`}),_jsx(_components.td,{\"data-numeric\":`true`,children:`1-36`}),_jsx(_components.td,{children:`A unique GUID (with hyphens) that you generate.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.strong,{children:`Separator`})}),_jsx(_components.td,{children:`Special`}),_jsx(_components.td,{\"data-numeric\":`true`,children:`37`}),_jsxs(_components.td,{children:[`Must be the `,_jsx(_components.code,{children:`=`}),` symbol.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.strong,{children:`Random String`})}),_jsx(_components.td,{children:`String`}),_jsx(_components.td,{\"data-numeric\":`true`,children:`38-64`}),_jsxs(_components.td,{children:[`The 27-character `,_jsx(_components.code,{children:`Random`}),` value from the Nayax request, exactly as received.`]})]})]})]}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Example:`}),` `,_jsx(_components.code,{children:`12c7cec2-c690-4425-9a1f-db0db60e2d8c=123456789qwertyuioasdfghjkl`})]}),`\n`,_jsxs(_components.p,{children:[`The `,_jsx(_components.code,{children:`StartSession`}),` cipher has no timestamp. The `,_jsx(_components.code,{children:`Random`}),` value in the cipher must match the `,_jsx(_components.code,{children:`Random`}),` value in the Nayax request.`]}),`\n`,_jsx(Heading,{level:`3`,id:`step-2-get-your-encryption-key`,children:`Step 2: Get Your Encryption Key`}),`\n`,_jsxs(_components.p,{children:[`Nayax provides you with a `,_jsx(_components.strong,{children:`Secret Token`}),` and its `,_jsx(_components.strong,{children:`Token ID`}),`. The request carries the Token ID in `,_jsx(_components.code,{children:`TokenId`}),`. To create your key, take only the `,_jsx(_components.strong,{children:`32 characters on the far right`}),` of that token to create a 256-bit key.`]}),`\n`,_jsx(_components.p,{children:_jsx(_components.strong,{children:`Example:`})}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Full token example:`}),` `,_jsx(_components.code,{children:`...wRvTVTkungMIKThTVbj_fiXdfoGclhn0`})]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`What your key will look like:`}),` `,_jsx(_components.code,{children:`wRvTVTkungMIKThTVbj_fiXdfoGclhn0`})]}),`\n`]}),`\n`,_jsx(Heading,{level:`3`,id:`step-3-encrypt-and-encode`,children:`Step 3: Encrypt and Encode`}),`\n`,_jsxs(_components.p,{children:[`Encrypt the 64-character string from Step 1 using `,_jsx(_components.strong,{children:`AES-256 (ECB mode)`}),` with `,_jsx(_components.strong,{children:`PKCS7 padding`}),` and your key from Step 2. Then, encode the result into `,_jsx(_components.strong,{children:`Base64`}),`. The result is a 108-character string. Return it in the `,_jsx(_components.code,{children:`Cipher`}),` field of your `,_jsx(_components.code,{children:`StartSession`}),` response, together with the `,_jsx(_components.code,{children:`SparkTransactionId`}),`.`]}),`\n`,_jsxs(_components.p,{children:[`This cipher is not the `,_jsx(_components.code,{children:`StartAuthentication`}),` cipher. The two ciphers use different plaintexts, so you can’t use one in place of the other.`]}),`\n`,_jsxs(_components.p,{children:[`Nayax decrypts the cipher with the same key and checks the `,_jsx(_components.code,{children:`Random`}),` value and the cipher format.`]}),`\n`,_jsx(Note,{children:_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Use the Spark Transaction ID in later calls:`}),` Nayax and you send the same `,_jsx(_components.code,{children:`SparkTransactionId`}),` in all later API calls of this transaction. When a call from Nayax arrives, check that its `,_jsx(_components.code,{children:`SparkTransactionId`}),` is one that you generated.`]})})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"StartSession","description":null,"deprecated":null,"version":null,"hideFooterPagination":true,"openapi":"/openapi/spark.yaml post /StartSession","href":"/reference/spark/transactions/startsession","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"How to Build the Cipher","slug":"how-to-build-the-cipher","depth":2,"children":[{"title":"Step 1: Create the 64-character Plaintext","slug":"step-1-create-the-64-character-plaintext","depth":3,"children":[]},{"title":"Step 2: Get Your Encryption Key","slug":"step-2-get-your-encryption-key","depth":3,"children":[]},{"title":"Step 3: Encrypt and Encode","slug":"step-3-encrypt-and-encode","depth":3,"children":[]}]}],"codeExamples":{}},"jsLinks":["/_mintlify/custom/nayax-44d6e37b/c0d908800bae3e5a/wcBadge.js"],"openApiReferenceData":{"operation":{"summary":"StartSession","x-mint":{"content":"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.\n\n\u003cCard title=\"Try it: Spark Auth Tool\" icon=\"bolt\" href=\"/docs/integrate-pos-device/spark/security-authentication/spark-auth-tool#startsession\" arrow>\n Build or inspect the `StartSession` cipher in your browser, no code required. Opens the tool on the StartSession tab.\n\u003c/Card>\n\n## How to Build the Cipher\n\nNayax sends a `Random` string in the `StartSession` request. You return an encrypted string called a `cipher` in your response. The cipher proves that you hold the same Secret Token as Nayax.\n\n### Step 1: Create the 64-character Plaintext\n\nCombine these three parts in the exact order and character positions shown below to make one long string:\n\n| Section | Type | Position | Description |\n| --- | --- | --- | --- |\n| **Spark Transaction ID** | String | 1-36 | A unique GUID (with hyphens) that you generate. |\n| **Separator** | Special | 37 | Must be the `=` symbol. |\n| **Random String** | String | 38-64 | The 27-character `Random` value from the Nayax request, exactly as received. |\n\n**Example:** `12c7cec2-c690-4425-9a1f-db0db60e2d8c=123456789qwertyuioasdfghjkl`\n\nThe `StartSession` cipher has no timestamp. The `Random` value in the cipher must match the `Random` value in the Nayax request.\n\n### Step 2: Get Your Encryption Key\n\nNayax provides you with a **Secret Token** and its **Token ID**. The request carries the Token ID in `TokenId`. To create your key, take only the **32 characters on the far right** of that token to create a 256-bit key.\n\n**Example:**\n\n* **Full token example:** `...wRvTVTkungMIKThTVbj_fiXdfoGclhn0`\n* **What your key will look like:** `wRvTVTkungMIKThTVbj_fiXdfoGclhn0`\n\n### Step 3: Encrypt and Encode\n\nEncrypt the 64-character string from Step 1 using **AES-256 (ECB mode)** with **PKCS7 padding** and your key from Step 2. Then, encode the result into **Base64**. The result is a 108-character string. Return it in the `Cipher` field of your `StartSession` response, together with the `SparkTransactionId`.\n\nThis cipher is not the `StartAuthentication` cipher. The two ciphers use different plaintexts, so you can't use one in place of the other.\n\nNayax decrypts the cipher with the same key and checks the `Random` value and the cipher format.\n\n\u003cNote>\n**Use the Spark Transaction ID in later calls:** Nayax and you send the same `SparkTransactionId` in all later API calls of this transaction. When a call from Nayax arrives, check that its `SparkTransactionId` is one that you generated.\n\u003c/Note>\n","metadata":{"hideFooterPagination":true}},"tags":["Transactions"],"requestBody":"31870ed4-1ca6-4bfa-8a47-040b6e3f896c","responses":{"200":"cf725aff-4c6a-4270-8b45-b039c7febbb5"},"method":"post","type":"path","servers":["7cb04a79-56d6-49f3-ac5c-35bc3aaf1f52"],"security":[],"path":"/StartSession","baseUrlOptions":["https://{domain}/api"],"title":"StartSession","description":"","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"description":"The payload to initiate a new session.","required":true,"content":{"application/json":{"schema":{"oneOf":[{"type":"object","description":"The request payload sent by the Spark platform to the integrator's configured `StartSession` endpoint to initiate a transaction session.\n","properties":{"HwSerial":{"type":"string","nullable":false,"description":"The serial number of the payment terminal hardware.\n","uniqueKey":"oneOf.0.HwSerial","typeLabel":"string"},"MachineId":{"type":"integer","format":"int64","description":"The unique identifier for the Nayax machine.\n","uniqueKey":"oneOf.0.MachineId","typeLabel":"integer\u003cint64>"},"TokenId":{"type":"integer","format":"int32","description":"A unique token provided by Nayax for secure authentication.\n","uniqueKey":"oneOf.0.TokenId","typeLabel":"integer\u003cint32>"},"Random":{"type":"string","nullable":false,"description":"A 27-character random alphanumeric string that Nayax creates for this session. Put it after the `=` in the cipher plaintext.\n","uniqueKey":"oneOf.0.Random","typeLabel":"string"}},"example":{"HwSerial":"0434334921100366","MachineId":71234996,"TokenId":116383,"Random":"123456789qwertyuioasdfghjkl"},"uniqueKey":"oneOf.0","typeLabel":"object"},{"type":"null","description":"The request payload sent by the Spark platform to the integrator's configured `StartSession` endpoint to initiate a transaction session.\n","properties":{"HwSerial":{"type":"string","nullable":false,"description":"The serial number of the payment terminal hardware.\n"},"MachineId":{"type":"integer","format":"int64","description":"The unique identifier for the Nayax machine.\n"},"TokenId":{"type":"integer","format":"int32","description":"A unique token provided by Nayax for secure authentication.\n"},"Random":{"type":"string","nullable":false,"description":"A 27-character random alphanumeric string that Nayax creates for this session. Put it after the `=` in the cipher plaintext.\n"}},"example":{"HwSerial":"0434334921100366","MachineId":71234996,"TokenId":116383,"Random":"123456789qwertyuioasdfghjkl"},"uniqueKey":"oneOf.1","typeLabel":"null"}],"uniqueKey":"","typeLabel":"object | null"},"examples":{"Example":{"title":"Example","value":{"HwSerial":"0434334921100366","MachineId":71234996,"TokenId":116383,"Random":"123456789qwertyuioasdfghjkl"}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"cf725aff-4c6a-4270-8b45-b039c7febbb5":{"description":"Success. A new session has been successfully initiated.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","description":"The response payload from the `StartSession` endpoint, containing encrypted data and the session status.\n","properties":{"Cipher":{"type":"string","nullable":false,"description":"The Base64 result of encrypting `SparkTransactionId=Random` with AES-256 in ECB mode and PKCS7 padding, using the 32 rightmost characters of the Secret Token as the key. The result is 108 characters.\n","uniqueKey":"oneOf.0.Cipher","typeLabel":"string"},"SparkTransactionId":{"oneOf":[{"type":"string","description":"A unique GUID with hyphens (36 characters) that you generate for this transaction. Nayax and you send it in all later calls of the transaction.\n","uniqueKey":"oneOf.0.SparkTransactionId.oneOf.0","typeLabel":"string"},{"type":"null","description":"A unique GUID with hyphens (36 characters) that you generate for this transaction. Nayax and you send it in all later calls of the transaction.\n","uniqueKey":"oneOf.0.SparkTransactionId.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.SparkTransactionId","typeLabel":"string | null"},"Status":{"type":"object","nullable":false,"description":"Transaction Status Details","properties":{"Verdict":{"type":"string","nullable":false,"description":"Status of the request (Approved / Declined)","uniqueKey":"oneOf.0.Status.Verdict","typeLabel":"string"},"ErrorCode":{"oneOf":[{"type":"integer","format":"int16","description":"- Conditional\n- Reason for declined request\n","uniqueKey":"oneOf.0.Status.ErrorCode.oneOf.0","typeLabel":"integer\u003cint16>"},{"type":"null","format":"int16","description":"- Conditional\n- Reason for declined request\n","uniqueKey":"oneOf.0.Status.ErrorCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.Status.ErrorCode","typeLabel":"integer\u003cint16> | null"},"ErrorDescription":{"oneOf":[{"type":"string","description":"- Conditional\n- Length: 255\n- Error description\n","uniqueKey":"oneOf.0.Status.ErrorDescription.oneOf.0","typeLabel":"string"},{"type":"null","description":"- Conditional\n- Length: 255\n- Error description\n","uniqueKey":"oneOf.0.Status.ErrorDescription.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.Status.ErrorDescription","typeLabel":"string | null"},"StatusMessage":{"oneOf":[{"type":"string","description":"- Optional\n- Length: 255\n- Transaction status message as free text field\n","uniqueKey":"oneOf.0.Status.StatusMessage.oneOf.0","typeLabel":"string"},{"type":"null","description":"- Optional\n- Length: 255\n- Transaction status message as free text field\n","uniqueKey":"oneOf.0.Status.StatusMessage.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.Status.StatusMessage","typeLabel":"string | null"}},"uniqueKey":"oneOf.0.Status","typeLabel":"object"}},"example":{"Cipher":"X305dITNTAw2vHsxE+taVcn6UvgBC3fdI6QbqeABgHbo8CKsoZhqISJfslehCiA+E6/0o9N4MFuYA7CTAxAnphuNJwBEjgBzKhhgpJ5ggnw=","SparkTransactionId":"12c7cec2-c690-4425-9a1f-db0db60e2d8c","Status":{"Verdict":"Approved"}},"uniqueKey":"oneOf.0","typeLabel":"object"},{"type":"null","description":"The response payload from the `StartSession` endpoint, containing encrypted data and the session status.\n","properties":{"Cipher":{"type":"string","nullable":false,"description":"The Base64 result of encrypting `SparkTransactionId=Random` with AES-256 in ECB mode and PKCS7 padding, using the 32 rightmost characters of the Secret Token as the key. The result is 108 characters.\n"},"SparkTransactionId":{"oneOf":[{"type":"string","description":"A unique GUID with hyphens (36 characters) that you generate for this transaction. Nayax and you send it in all later calls of the transaction.\n"},{"type":"null","description":"A unique GUID with hyphens (36 characters) that you generate for this transaction. Nayax and you send it in all later calls of the transaction.\n"}]},"Status":{"type":"object","nullable":false,"description":"Transaction Status Details","properties":{"Verdict":{"type":"string","nullable":false,"description":"Status of the request (Approved / Declined)"},"ErrorCode":{"oneOf":[{"type":"integer","format":"int16","description":"- Conditional\n- Reason for declined request\n"},{"type":"null","format":"int16","description":"- Conditional\n- Reason for declined request\n"}]},"ErrorDescription":{"oneOf":[{"type":"string","description":"- Conditional\n- Length: 255\n- Error description\n"},{"type":"null","description":"- Conditional\n- Length: 255\n- Error description\n"}]},"StatusMessage":{"oneOf":[{"type":"string","description":"- Optional\n- Length: 255\n- Transaction status message as free text field\n"},{"type":"null","description":"- Optional\n- Length: 255\n- Transaction status message as free text field\n"}]}}}},"example":{"Cipher":"X305dITNTAw2vHsxE+taVcn6UvgBC3fdI6QbqeABgHbo8CKsoZhqISJfslehCiA+E6/0o9N4MFuYA7CTAxAnphuNJwBEjgBzKhhgpJ5ggnw=","SparkTransactionId":"12c7cec2-c690-4425-9a1f-db0db60e2d8c","Status":{"Verdict":"Approved"}},"uniqueKey":"oneOf.1","typeLabel":"null"}],"uniqueKey":"","typeLabel":"object | null"},"examples":{"Example":{"title":"Example","value":{"Cipher":"X305dITNTAw2vHsxE+taVcn6UvgBC3fdI6QbqeABgHbo8CKsoZhqISJfslehCiA+E6/0o9N4MFuYA7CTAxAnphuNJwBEjgBzKhhgpJ5ggnw=","SparkTransactionId":"12c7cec2-c690-4425-9a1f-db0db60e2d8c","Status":{"Verdict":"Approved"}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{},"servers":{"7cb04a79-56d6-49f3-ac5c-35bc3aaf1f52":{"url":"https://{domain}/api","variables":{"domain":{"default":"nayax-spark-dmz.nayax.com","description":"The Integrator hosts this endpoint. Nayax sends the call to the callback URL configured during onboarding."}}}}},"originalFileLocation":"openapi/spark.yaml"},"subdomain":"nayax-44d6e37b","siteName":"Nayax Developer Portal","title":"StartSession - Nayax Developer Portal","contextualStarterQuestions":[{"_id":"6aa1a3c2370ee193ba7f63b5","deploymentId":"69981f91cf2ae4e6561a0441","questionText":"What is SparkTransactionId?","status":"active","generatedBy":"contextual","path":"reference/spark/transactions/startsession","createdAt":"2026-09-09T18:21:54.525Z","updatedAt":"2026-09-09T18:21:54.525Z","__v":0},{"_id":"6aa1a3c2370ee193ba7f63b4","deploymentId":"69981f91cf2ae4e6561a0441","questionText":"How do I authenticate with Nayax?","status":"active","generatedBy":"contextual","path":"reference/spark/transactions/startsession","createdAt":"2026-09-09T18:21:54.525Z","updatedAt":"2026-09-09T18:21:54.525Z","__v":0},{"_id":"6aa1a3c2370ee193ba7f63b3","deploymentId":"69981f91cf2ae4e6561a0441","questionText":"What does StartSession do?","status":"active","generatedBy":"contextual","path":"reference/spark/transactions/startsession","createdAt":"2026-09-09T18:21:54.525Z","updatedAt":"2026-09-09T18:21:54.525Z","__v":0}],"navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"en":{"href":"/reference/spark/transactions/startsession","matchLevel":0},"zh":{"href":"/reference/zh/spark/transactions/startsession","matchLevel":1}}},"lastModified":"2026-11-09T11:55:21.959Z","originalFileLocation":"reference/spark/transactions/startsession.mdx","locale":"en"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"application-name\" content=\"Nayax Developer Portal\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/nayax-44d6e37b/IDkKyIWxcB2-beJ3/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/nayax-44d6e37b/IDkKyIWxcB2-beJ3/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/nayax-44d6e37b/IDkKyIWxcB2-beJ3/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/nayax-44d6e37b/IDkKyIWxcB2-beJ3/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/nayax-44d6e37b/IDkKyIWxcB2-beJ3/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/nayax-44d6e37b/IDkKyIWxcB2-beJ3/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/nayax-44d6e37b/IDkKyIWxcB2-beJ3/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/nayax-44d6e37b/IDkKyIWxcB2-beJ3/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/nayax-44d6e37b/IDkKyIWxcB2-beJ3/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"StartSession - Nayax Developer Portal\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Nayax Developer Portal\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://devzone.nayax.com/reference/spark/transactions/startsession\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://nayax-44d6e37b.mintlify.site/_mintlify/api/og/v2?division=Transactions\u0026amp;title=StartSession\u0026amp;theme=42406d98d632f71b622c3323\u0026amp;signature=ba0f002ec8b83a6bc062dc635724ae746e67a44cb17ab222cdd84b92a73422a1\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"StartSession - Nayax Developer Portal\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://nayax-44d6e37b.mintlify.site/_mintlify/api/og/v2?division=Transactions\u0026amp;title=StartSession\u0026amp;theme=42406d98d632f71b622c3323\u0026amp;signature=ba0f002ec8b83a6bc062dc635724ae746e67a44cb17ab222cdd84b92a73422a1\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/nayax-44d6e37b/IDkKyIWxcB2-beJ3/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Nayax Developer Portal\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#6352E0\">\u003clink data-mint-head rel=\"canonical\" href=\"https://devzone.nayax.com/reference/spark/transactions/startsession\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/reference/spark/transactions/startsession.md\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"en\" href=\"https://devzone.nayax.com/reference/spark/transactions/startsession\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"zh\" href=\"https://devzone.nayax.com/reference/zh/spark/transactions/startsession\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"x-default\" href=\"https://devzone.nayax.com/reference/spark/transactions/startsession\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://devzone.nayax.com/#organization\",\"name\":\"Nayax Developer Portal\",\"url\":\"https://devzone.nayax.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/nayax-44d6e37b/ag7p0QchXLJNEuNE/images/home/logo_light.svg?fit=max\u0026auto=format\u0026n=ag7p0QchXLJNEuNE\u0026q=85\u0026s=b71aa1a61014633be60cee745d3e978c\"}},{\"@type\":\"WebSite\",\"@id\":\"https://devzone.nayax.com#website\",\"name\":\"Nayax Developer Portal\",\"url\":\"https://devzone.nayax.com\",\"publisher\":{\"@id\":\"https://devzone.nayax.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://devzone.nayax.com/reference/spark/transactions/startsession#webpage\",\"url\":\"https://devzone.nayax.com/reference/spark/transactions/startsession\",\"name\":\"StartSession\",\"dateModified\":\"2026-11-09T11:55:21.959Z\",\"isPartOf\":{\"@id\":\"https://devzone.nayax.com#website\"},\"breadcrumb\":{\"@id\":\"https://devzone.nayax.com/reference/spark/transactions/startsession#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://devzone.nayax.com/reference/spark/transactions/startsession#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API Reference\",\"item\":\"https://devzone.nayax.com/reference/spark/transactions/get-version\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Transactions\",\"item\":\"https://devzone.nayax.com/reference/spark/transactions/get-version\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"StartSession\",\"item\":\"https://devzone.nayax.com/reference/spark/transactions/startsession\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://devzone.nayax.com/reference/spark/transactions/startsession#apireference\",\"headline\":\"StartSession\",\"name\":\"StartSession\",\"url\":\"https://devzone.nayax.com/reference/spark/transactions/startsession\",\"mainEntityOfPage\":{\"@id\":\"https://devzone.nayax.com/reference/spark/transactions/startsession#webpage\"},\"dateModified\":\"2026-11-09T11:55:21.959Z\",\"publisher\":{\"@id\":\"https://devzone.nayax.com/#organization\"},\"isPartOf\":{\"@id\":\"https://devzone.nayax.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Nayax Developer Portal\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Nayax Developer Portal\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/reference/spark/transactions/startsession.md","siteName":"Nayax Developer Portal","nav":{"global":null,"languages":[{"language":"en","default":true,"tabs":[{"tab":"Docs Home","icon":"home","pages":[{"title":"Docs Home","href":""}]},{"tab":"Terminal SDKs","menu":[{"item":"Marshall","pages":[{"title":"Marshall","href":"/docs/integrate-pos-device/marshall/marshall-sdk"}]},{"item":"Marshall Pro (Fuel)","pages":[{"title":"Marshall Pro (Fuel)","href":"/docs/integrate-pos-device/marshall-pro/getting-started"}]},{"item":"TweezerComm","pages":[{"title":"TweezerComm","href":"/docs/integrate-pos-device/tweezercomm/overview-tweezer"}]},{"item":"EMV Core","pages":[{"title":"EMV Core","href":"/docs/integrate-pos-device/emv-core/overview"}]},{"item":"Spark","groups":[{"group":"Spark Guides","pages":[{"title":"Overview","href":"/docs/integrate-pos-device/spark/spark"},{"title":"Integration Process","href":"/docs/integrate-pos-device/spark/spark-integration-process"},{"title":"Spark Network Requirements","sidebarTitle":"Network Requirements","href":"/docs/integrate-pos-device/spark/spark-network-requirement"},{"group":"Security \u0026 Authentication","root":{"title":"Security \u0026 Authentication","href":"/docs/integrate-pos-device/spark/security-authentication/index"},"pages":[{"title":"Authentication","href":"/docs/integrate-pos-device/spark/security-authentication/spark-authentication"},{"title":"Legacy Authentication","href":"/docs/integrate-pos-device/spark/security-authentication/spark-legacy-authentication"},{"title":"Interactive Authentication Tool","href":"/docs/integrate-pos-device/spark/security-authentication/spark-auth-tool"}]},{"group":"Payment Flows","root":{"mode":"wide","title":"Payment Flows","href":"/docs/integrate-pos-device/spark/payment-flows/transaction-flows-spark"},"pages":[{"title":"Device Start","href":"/docs/integrate-pos-device/spark/payment-flows/spark-device-start"},{"title":"Remote Start","href":"/docs/integrate-pos-device/spark/payment-flows/spark-remote-start"},{"title":"Device Stop","href":"/docs/integrate-pos-device/spark/payment-flows/spark-device-stop"},{"title":"External Settlement","href":"/docs/integrate-pos-device/spark/payment-flows/external-settlement"},{"title":"External Cancel","href":"/docs/integrate-pos-device/spark/payment-flows/external-cancel"}]},{"group":"Machine Configuration","root":{"title":"Machine Configuration Overview","href":"/docs/integrate-pos-device/spark/machine-configuration/index"},"pages":[{"title":"Remote Start Configuration","href":"/docs/integrate-pos-device/spark/machine-configuration/spark-remote-start-configuration"},{"title":"Device Start Configuration","href":"/docs/integrate-pos-device/spark/machine-configuration/spark-device-start-configuration"},{"title":"Device Stop Configuration","href":"/docs/integrate-pos-device/spark/machine-configuration/spark-device-stop-configuration"},{"title":"External Settlement Configuration","href":"/docs/integrate-pos-device/spark/machine-configuration/spark-external-settlement-configuration"},{"title":"Additional Features","href":"/docs/integrate-pos-device/spark/machine-configuration/additional-features"}]},{"group":"Webhook Callbacks","root":{"title":"Webhook Callbacks","href":"/docs/integrate-pos-device/spark/webhook-callbacks/index"},"pages":[{"title":"TransactionCallback","href":"/docs/integrate-pos-device/spark/webhook-callbacks/transactioncallback"},{"title":"StopCallback","href":"/docs/integrate-pos-device/spark/webhook-callbacks/stopcallback"},{"title":"TimeoutCallback","href":"/docs/integrate-pos-device/spark/webhook-callbacks/timeoutcallback"},{"title":"DeclineCallback","href":"/docs/integrate-pos-device/spark/webhook-callbacks/declinecallback"}]},{"group":"Additional Resources","root":{"title":"Additional Resources","href":"/docs/integrate-pos-device/spark/additional-resources/index"},"pages":[{"title":"Closed Loop Card Support","href":"/docs/integrate-pos-device/spark/additional-resources/smc-support"},{"title":"PosDisplay Format","href":"/docs/integrate-pos-device/spark/additional-resources/spark-posdisplay-format"},{"title":"eReceiptData Format","href":"/docs/integrate-pos-device/spark/additional-resources/spark-ereceiptdata-format"},{"title":"Response Codes","href":"/docs/integrate-pos-device/spark/additional-resources/spark-response-codes"}]},{"group":"Sample Codes","pages":[{"title":"Authentication Code Sample","href":"/docs/integrate-pos-device/spark/sample-codes/spark-authentication-code-sample"}]}]},{"group":"API Reference","pages":[{"group":"Transactions","pages":[{"title":"Get Version","deprecated":null,"version":null,"openapi":"/openapi/spark.yaml get /Version","href":"/reference/spark/transactions/get-version"},{"title":"ExternalCancel","deprecated":null,"version":null,"openapi":"/openapi/spark.yaml post /ExternalCancel","href":"/reference/spark/transactions/externalcancel"},{"title":"ExternalSettlement","deprecated":null,"version":null,"openapi":"/openapi/spark.yaml post /ExternalSettlement","href":"/reference/spark/transactions/externalsettlement"},{"title":"StartAuthentication","description":null,"deprecated":null,"version":null,"openapi":"/openapi/spark.yaml post /StartAuthentication","href":"/reference/spark/transactions/startauthentication"},{"title":"StartSession","deprecated":null,"version":null,"openapi":"/openapi/spark.yaml post /StartSession","href":"/reference/spark/transactions/startsession"},{"title":"TriggerTransaction","description":null,"deprecated":null,"version":null,"openapi":"/openapi/spark.yaml post /TriggerTransaction","href":"/reference/spark/transactions/triggertransaction"},{"title":"TransactionCallback","deprecated":null,"version":null,"openapi":"/openapi/spark.yaml post /TransactionCallback","href":"/reference/spark/transactions/transactioncallback"},{"title":"TransactionNotify","deprecated":null,"version":null,"openapi":"/openapi/spark.yaml post /TransactionNotify","href":"/reference/spark/transactions/transactionnotify"},{"title":"Settlement","deprecated":null,"version":null,"openapi":"/openapi/spark.yaml post /Settlement","href":"/reference/spark/transactions/settlement"},{"title":"TimeoutCallback","deprecated":null,"version":null,"openapi":"/openapi/spark.yaml post /TimeoutCallback","href":"/reference/spark/transactions/timeoutcallback"},{"title":"CancelTransaction","deprecated":null,"version":null,"openapi":"/openapi/spark.yaml post /CancelTransaction","href":"/reference/spark/transactions/canceltransaction"},{"title":"StopNotify","deprecated":null,"version":null,"openapi":"/openapi/spark.yaml post /StopNotify","href":"/reference/spark/transactions/stopnotify"},{"title":"AvailabilityCheck","deprecated":null,"version":null,"openapi":"/openapi/spark.yaml post /AvailabilityCheck","href":"/reference/spark/transactions/availabilitycheck"},{"title":"StopCallback","deprecated":null,"version":null,"openapi":"/openapi/spark.yaml post /StopCallback","href":"/reference/spark/transactions/stopcallback"},{"title":"DeclineCallback","deprecated":null,"version":null,"openapi":"/openapi/spark.yaml post /DeclineCallback","href":"/reference/spark/transactions/declinecallback"},{"title":"InfoQuery","deprecated":null,"version":null,"openapi":"/openapi/spark.yaml post /InfoQuery","href":"/reference/spark/transactions/infoquery"}]}]}]}]},{"tab":"Platform Management","menu":[{"item":"Transaction Reporting","pages":[{"title":"Transaction Reporting","href":"/docs/manage-data-operations/amazon-sqs/overview"}]},{"item":"Lynx API","pages":[{"title":"Lynx API","href":"/docs/manage-data-operations/lynx-api/lynx-overview"}]}],"pages":[{"title":"Platform Management","href":"/docs/manage-data-operations/amazon-sqs/overview"}]},{"tab":"Core Extension","pages":[{"title":"Core Extension","href":"/docs/core-extension/overview"}]},{"tab":"Cortina","pages":[{"title":"Cortina","href":"/docs/cortina/overview-cortina"}]},{"tab":"Build with AI","pages":[{"title":"Build with AI","href":"/docs/get-started/build-with-ai"}]},{"tab":"Release Notes","href":"https://www.nayax.com/product-updates/integrated-pos/integrated-vpos-touch-onyx/"},{"tab":"Support \u0026 Trust","menu":[{"item":"Help Center","href":"https://nayax-u.nayax.com/"},{"item":"Certifications","pages":[{"title":"Certifications","href":"/docs/get-started/certifications"}]},{"item":"Integration FAQ","pages":[{"title":"Integration FAQ","href":"/docs/get-started/integration-faq"}]}],"pages":[{"title":"Support \u0026 Trust","href":"/docs/get-started/certifications"}]}]},{"language":"zh","pages":[{"title":"zh","href":"/reference/zh/spark/transactions/startsession"}]}]},"basePath":"","title":"StartSession - Nayax Developer Portal","buildId":"dpl_596ePT575z4qnAFksq1biRW97aLY","deploymentId":"dpl_596ePT575z4qnAFksq1biRW97aLY","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-C9Wu0MeN.js","utils-jWgu-6Qf.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DBD8f9qn.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-BGuX1ui5.js","snippetPresets-Evy63nQB.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BQHO1lnV.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-B6C8m-t_.js","shallow-BG4cT0fH.js","getApiPlaygroundDisplay-CgEPrE-D.js","CodeSnippet-CU8JyZ9N.js","CodeSnippets-BnxHU32T.js","Page-D6S0Yh6q.js","getPastedJson-CwiYOonh.js","icon-DYDpWmDf.js","MethodPill-C-J-l7_c.js","DuplicateIcon-B6ARwg9w.js","createIcon-Dsv4MtDq.js","DynamicMarkdown-CtasenyM.js","SectionHeading-YNcgYwjB.js","axios-vUo_bRtp.js","Markdown-CwLx6PAg.js","clsx-C3kuh_dz.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CmKHfscc.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-U3mI6Ljh.js"]}