The Settlement endpoint is used to finalize an approved transaction.
After the session ends and the total amount is known, the integrator
sends the final amount along with optional e-receipt information. This
method is only relevant for transactions with Pre-Authorization.
Body
application/json
The request payload containing the final transaction amount and optional e-receipt data.
The request payload to finalize a pre-authorized transaction after the session ends and the final amount is known. This method is only relevant for transactions using the Pre-Authorization flow.
An optional JSON-formatted string containing additional e-receipt details. This data can be used to provide digital receipts to consumers via the Nayax eReceipt platform.
Response
200 - application/json
object | null
Success. The transaction has been successfully settled.
The response payload returned by Spark upon a successful Settlement request. This payload includes final transaction details such as the settled amount, card information, and timestamps.
The final settled amount, approved by the Payment Provider.
Was this page helpful?
{"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":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"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/settlement","slug":"/reference/spark/transactions/settlement","pageMetadata":{"title":"Settlement","description":null,"deprecated":null,"version":null,"hideFooterPagination":true,"openapi":"/openapi/spark.yaml post /Settlement","href":"/reference/spark/transactions/settlement","autogeneratedByOpenApi":true},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={code:`code`,p:`p`,..._provideComponents(),...props.components};return _jsxs(_components.p,{children:[`The `,_jsx(_components.code,{children:`Settlement`}),` endpoint is used to finalize an approved transaction.\nAfter the session ends and the total amount is known, the integrator\nsends the final amount along with optional e-receipt information. This\nmethod is only relevant for transactions with Pre-Authorization.`]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Settlement","description":null,"deprecated":null,"version":null,"hideFooterPagination":true,"openapi":"/openapi/spark.yaml post /Settlement","href":"/reference/spark/transactions/settlement","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/nayax-44d6e37b/c0d908800bae3e5a/wcBadge.js"],"openApiReferenceData":{"operation":{"summary":"Settlement","tags":["Transactions"],"x-mint":{"content":"The `Settlement` endpoint is used to finalize an approved transaction.\nAfter the session ends and the total amount is known, the integrator\nsends the final amount along with optional e-receipt information. This\nmethod is only relevant for transactions with Pre-Authorization.\n","metadata":{"hideFooterPagination":true}},"requestBody":"2f9598ff-8d0e-4a71-a88c-9e63cc675868","responses":{"200":"1eadebe3-4be5-4892-8a5d-15e3e3edb871"},"method":"post","type":"path","servers":["c8ac8999-db88-417b-af04-ab5e9e4589ec"],"security":[],"path":"/Settlement","baseUrlOptions":["https://nayax-spark-dmz.nayax.com/api"],"title":"Settlement","description":"","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"description":"The request payload containing the final transaction amount and optional e-receipt data.","required":true,"content":{"application/json":{"schema":{"oneOf":[{"type":"object","description":"The request payload to finalize a pre-authorized transaction after the session ends and the final amount is known. This method is only relevant for transactions using the Pre-Authorization flow.\n","properties":{"NayaxTransactionId":{"type":"integer","format":"int64","description":"The unique transaction ID assigned by Nayax for the transaction being settled.\n","uniqueKey":"oneOf.0.NayaxTransactionId","typeLabel":"integer\u003cint64>"},"SparkTransactionId":{"oneOf":[{"type":"string","description":"The unique session ID from the initial `/StartAuthentication` request. This ID links the settlement to the original transaction.\n","uniqueKey":"oneOf.0.SparkTransactionId.oneOf.0","typeLabel":"string"},{"type":"null","description":"The unique session ID from the initial `/StartAuthentication` request. This ID links the settlement to the original transaction.\n","uniqueKey":"oneOf.0.SparkTransactionId.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.SparkTransactionId","typeLabel":"string | null"},"SiteId":{"oneOf":[{"type":"integer","format":"int16","description":"The identifier of the site where the transaction occurred. This value is an echo from the initial authorization callback.\n","uniqueKey":"oneOf.0.SiteId.oneOf.0","typeLabel":"integer\u003cint16>"},{"type":"null","format":"int16","description":"The identifier of the site where the transaction occurred. This value is an echo from the initial authorization callback.\n","uniqueKey":"oneOf.0.SiteId.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.SiteId","typeLabel":"integer\u003cint16> | null"},"TerminalId":{"type":"string","nullable":false,"description":"The serial or external ID of the terminal used for the transaction.\n","uniqueKey":"oneOf.0.TerminalId","typeLabel":"string"},"TerminalIdType":{"oneOf":[{"type":"integer","format":"int32","description":"Defines the ID type used for the `TerminalId`. Use `1` for the HW Serial and `2` for the Nayax Machine ID.\n","uniqueKey":"oneOf.0.TerminalIdType.oneOf.0","typeLabel":"integer\u003cint32>"},{"type":"null","format":"int32","description":"Defines the ID type used for the `TerminalId`. Use `1` for the HW Serial and `2` for the Nayax Machine ID.\n","uniqueKey":"oneOf.0.TerminalIdType.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.TerminalIdType","typeLabel":"integer\u003cint32> | null"},"Amount":{"type":"number","format":"double","description":"The final transaction amount to be settled, specified in major currency units (e.g., dollars or euros).\n","uniqueKey":"oneOf.0.Amount","typeLabel":"number\u003cdouble>"},"EReceiptData":{"oneOf":[{"type":"string","description":"An optional JSON-formatted string containing additional e-receipt details. This data can be used to provide digital receipts to consumers via the Nayax eReceipt platform.\n","uniqueKey":"oneOf.0.EReceiptData.oneOf.0","typeLabel":"string"},{"type":"null","description":"An optional JSON-formatted string containing additional e-receipt details. This data can be used to provide digital receipts to consumers via the Nayax eReceipt platform.\n","uniqueKey":"oneOf.0.EReceiptData.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.EReceiptData","typeLabel":"string | null"}},"example":{"NayaxTransactionId":2004545072,"SparkTransactionId":"12c7cec2-c690-4425-9a1f-db0db60e2d8c","SiteId":2,"TerminalId":"0434334921100366","TerminalIdType":1,"Amount":12.25,"EReceiptData":"{\"General\":[{\"Company\":\"Your Payments - Our Solutions\",\"Station Name\":\"B12\"}],\"Service\":[{\"Product\":\"Something Yummy\",\"Price Per Unit\":\"$2.45\",\"Number of Units\":2}]}"},"uniqueKey":"oneOf.0","typeLabel":"object"},{"type":"null","description":"The request payload to finalize a pre-authorized transaction after the session ends and the final amount is known. This method is only relevant for transactions using the Pre-Authorization flow.\n","properties":{"NayaxTransactionId":{"type":"integer","format":"int64","description":"The unique transaction ID assigned by Nayax for the transaction being settled.\n"},"SparkTransactionId":{"oneOf":[{"type":"string","description":"The unique session ID from the initial `/StartAuthentication` request. This ID links the settlement to the original transaction.\n"},{"type":"null","description":"The unique session ID from the initial `/StartAuthentication` request. This ID links the settlement to the original transaction.\n"}]},"SiteId":{"oneOf":[{"type":"integer","format":"int16","description":"The identifier of the site where the transaction occurred. This value is an echo from the initial authorization callback.\n"},{"type":"null","format":"int16","description":"The identifier of the site where the transaction occurred. This value is an echo from the initial authorization callback.\n"}]},"TerminalId":{"type":"string","nullable":false,"description":"The serial or external ID of the terminal used for the transaction.\n"},"TerminalIdType":{"oneOf":[{"type":"integer","format":"int32","description":"Defines the ID type used for the `TerminalId`. Use `1` for the HW Serial and `2` for the Nayax Machine ID.\n"},{"type":"null","format":"int32","description":"Defines the ID type used for the `TerminalId`. Use `1` for the HW Serial and `2` for the Nayax Machine ID.\n"}]},"Amount":{"type":"number","format":"double","description":"The final transaction amount to be settled, specified in major currency units (e.g., dollars or euros).\n"},"EReceiptData":{"oneOf":[{"type":"string","description":"An optional JSON-formatted string containing additional e-receipt details. This data can be used to provide digital receipts to consumers via the Nayax eReceipt platform.\n"},{"type":"null","description":"An optional JSON-formatted string containing additional e-receipt details. This data can be used to provide digital receipts to consumers via the Nayax eReceipt platform.\n"}]}},"example":{"NayaxTransactionId":2004545072,"SparkTransactionId":"12c7cec2-c690-4425-9a1f-db0db60e2d8c","SiteId":2,"TerminalId":"0434334921100366","TerminalIdType":1,"Amount":12.25,"EReceiptData":"{\"General\":[{\"Company\":\"Your Payments - Our Solutions\",\"Station Name\":\"B12\"}],\"Service\":[{\"Product\":\"Something Yummy\",\"Price Per Unit\":\"$2.45\",\"Number of Units\":2}]}"},"uniqueKey":"oneOf.1","typeLabel":"null"}],"uniqueKey":"","typeLabel":"object | null"},"examples":{"Example":{"title":"Example","value":{"NayaxTransactionId":2004545072,"SparkTransactionId":"12c7cec2-c690-4425-9a1f-db0db60e2d8c","SiteId":2,"TerminalId":"0434334921100366","TerminalIdType":1,"Amount":12.25,"EReceiptData":"{\"General\":[{\"Company\":\"Your Payments - Our Solutions\",\"Station Name\":\"B12\"}],\"Service\":[{\"Product\":\"Something Yummy\",\"Price Per Unit\":\"$2.45\",\"Number of Units\":2}]}"}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"1eadebe3-4be5-4892-8a5d-15e3e3edb871":{"description":"Success. The transaction has been successfully settled.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","description":"The response payload returned by Spark upon a successful `Settlement` request. This payload includes final transaction details such as the settled amount, card information, and timestamps.\n","properties":{"SparkTransactionId":{"oneOf":[{"type":"string","description":"The unique ID used for this transaction session, which is an echo of the value sent in the request.\n","uniqueKey":"oneOf.0.SparkTransactionId.oneOf.0","typeLabel":"string"},{"type":"null","description":"The unique ID used for this transaction session, which is an echo of the value sent in the request.\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"},"CardBrand":{"oneOf":[{"type":"string","description":"The brand of the card used for the transaction, such as `Visa` or `MasterCard`.\n","uniqueKey":"oneOf.0.CardBrand.oneOf.0","typeLabel":"string"},{"type":"null","description":"The brand of the card used for the transaction, such as `Visa` or `MasterCard`.\n","uniqueKey":"oneOf.0.CardBrand.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.CardBrand","typeLabel":"string | null"},"CardLast4Digits":{"oneOf":[{"type":"string","description":"The last four digits of the payment card used.\n","uniqueKey":"oneOf.0.CardLast4Digits.oneOf.0","typeLabel":"string"},{"type":"null","description":"The last four digits of the payment card used.\n","uniqueKey":"oneOf.0.CardLast4Digits.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.CardLast4Digits","typeLabel":"string | null"},"AuthCode":{"oneOf":[{"type":"string","description":"The authorization code returned by the payment provider for the transaction.\n","uniqueKey":"oneOf.0.AuthCode.oneOf.0","typeLabel":"string"},{"type":"null","description":"The authorization code returned by the payment provider for the transaction.\n","uniqueKey":"oneOf.0.AuthCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.AuthCode","typeLabel":"string | null"},"MachineAuTime":{"oneOf":[{"type":"string","description":"The device timestamp at the moment of authorization, formatted as `yyyyMMddHHmmssSSS`.\n","uniqueKey":"oneOf.0.MachineAuTime.oneOf.0","typeLabel":"string"},{"type":"null","description":"The device timestamp at the moment of authorization, formatted as `yyyyMMddHHmmssSSS`.\n","uniqueKey":"oneOf.0.MachineAuTime.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.MachineAuTime","typeLabel":"string | null"},"AuTime":{"oneOf":[{"type":"string","description":"The authorization server's timestamp.\n","uniqueKey":"oneOf.0.AuTime.oneOf.0","typeLabel":"string"},{"type":"null","description":"The authorization server's timestamp.\n","uniqueKey":"oneOf.0.AuTime.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.AuTime","typeLabel":"string | null"},"SeTime":{"oneOf":[{"type":"string","description":"The timestamp from the settlement server, formatted as `yyyyMMddHHmmssSSS`.\n","uniqueKey":"oneOf.0.SeTime.oneOf.0","typeLabel":"string"},{"type":"null","description":"The timestamp from the settlement server, formatted as `yyyyMMddHHmmssSSS`.\n","uniqueKey":"oneOf.0.SeTime.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.SeTime","typeLabel":"string | null"},"CurrencyCode":{"oneOf":[{"type":"string","description":"The ISO currency code for the transaction, such as `EUR`.\n","uniqueKey":"oneOf.0.CurrencyCode.oneOf.0","typeLabel":"string"},{"type":"null","description":"The ISO currency code for the transaction, such as `EUR`.\n","uniqueKey":"oneOf.0.CurrencyCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.CurrencyCode","typeLabel":"string | null"},"CurrencyNumeric":{"oneOf":[{"type":"string","description":"The ISO 4217 numeric currency code, such as `978` for EUR.\n","uniqueKey":"oneOf.0.CurrencyNumeric.oneOf.0","typeLabel":"string"},{"type":"null","description":"The ISO 4217 numeric currency code, such as `978` for EUR.\n","uniqueKey":"oneOf.0.CurrencyNumeric.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.CurrencyNumeric","typeLabel":"string | null"},"FiscalRrn":{"oneOf":[{"type":"string","description":"The fiscal reference number for the transaction, used for receipt and audit purposes.\n","uniqueKey":"oneOf.0.FiscalRrn.oneOf.0","typeLabel":"string"},{"type":"null","description":"The fiscal reference number for the transaction, used for receipt and audit purposes.\n","uniqueKey":"oneOf.0.FiscalRrn.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.FiscalRrn","typeLabel":"string | null"},"NayaxRRN":{"oneOf":[{"type":"string","description":"The internal Nayax settlement reference number.\n","uniqueKey":"oneOf.0.NayaxRRN.oneOf.0","typeLabel":"string"},{"type":"null","description":"The internal Nayax settlement reference number.\n","uniqueKey":"oneOf.0.NayaxRRN.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.NayaxRRN","typeLabel":"string | null"},"Amount":{"type":"number","format":"double","description":"The final settled amount, approved by the Payment Provider.\n","uniqueKey":"oneOf.0.Amount","typeLabel":"number\u003cdouble>"}},"example":{"SparkTransactionId":"12c7cec2-c690-4425-9a1f-db0db60e2d8c","Status":{"Verdict":"Approved","ErrorDescription":"No Errors"},"CardBrand":"Visa","CardLast4Digits":"1234","AuthCode":"333333","MachineAuTime":"20240205194122328","AuTime":"20240205174122328","SeTime":"20240205192215572","CurrencyCode":"EUR","CurrencyNumeric":"978","FiscalRrn":"1A2b3C4d5E6f7g8H9i","NayaxRRN":"111111","Amount":12.25},"uniqueKey":"oneOf.0","typeLabel":"object"},{"type":"null","description":"The response payload returned by Spark upon a successful `Settlement` request. This payload includes final transaction details such as the settled amount, card information, and timestamps.\n","properties":{"SparkTransactionId":{"oneOf":[{"type":"string","description":"The unique ID used for this transaction session, which is an echo of the value sent in the request.\n"},{"type":"null","description":"The unique ID used for this transaction session, which is an echo of the value sent in the request.\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"}]}}},"CardBrand":{"oneOf":[{"type":"string","description":"The brand of the card used for the transaction, such as `Visa` or `MasterCard`.\n"},{"type":"null","description":"The brand of the card used for the transaction, such as `Visa` or `MasterCard`.\n"}]},"CardLast4Digits":{"oneOf":[{"type":"string","description":"The last four digits of the payment card used.\n"},{"type":"null","description":"The last four digits of the payment card used.\n"}]},"AuthCode":{"oneOf":[{"type":"string","description":"The authorization code returned by the payment provider for the transaction.\n"},{"type":"null","description":"The authorization code returned by the payment provider for the transaction.\n"}]},"MachineAuTime":{"oneOf":[{"type":"string","description":"The device timestamp at the moment of authorization, formatted as `yyyyMMddHHmmssSSS`.\n"},{"type":"null","description":"The device timestamp at the moment of authorization, formatted as `yyyyMMddHHmmssSSS`.\n"}]},"AuTime":{"oneOf":[{"type":"string","description":"The authorization server's timestamp.\n"},{"type":"null","description":"The authorization server's timestamp.\n"}]},"SeTime":{"oneOf":[{"type":"string","description":"The timestamp from the settlement server, formatted as `yyyyMMddHHmmssSSS`.\n"},{"type":"null","description":"The timestamp from the settlement server, formatted as `yyyyMMddHHmmssSSS`.\n"}]},"CurrencyCode":{"oneOf":[{"type":"string","description":"The ISO currency code for the transaction, such as `EUR`.\n"},{"type":"null","description":"The ISO currency code for the transaction, such as `EUR`.\n"}]},"CurrencyNumeric":{"oneOf":[{"type":"string","description":"The ISO 4217 numeric currency code, such as `978` for EUR.\n"},{"type":"null","description":"The ISO 4217 numeric currency code, such as `978` for EUR.\n"}]},"FiscalRrn":{"oneOf":[{"type":"string","description":"The fiscal reference number for the transaction, used for receipt and audit purposes.\n"},{"type":"null","description":"The fiscal reference number for the transaction, used for receipt and audit purposes.\n"}]},"NayaxRRN":{"oneOf":[{"type":"string","description":"The internal Nayax settlement reference number.\n"},{"type":"null","description":"The internal Nayax settlement reference number.\n"}]},"Amount":{"type":"number","format":"double","description":"The final settled amount, approved by the Payment Provider.\n"}},"example":{"SparkTransactionId":"12c7cec2-c690-4425-9a1f-db0db60e2d8c","Status":{"Verdict":"Approved","ErrorDescription":"No Errors"},"CardBrand":"Visa","CardLast4Digits":"1234","AuthCode":"333333","MachineAuTime":"20240205194122328","AuTime":"20240205174122328","SeTime":"20240205192215572","CurrencyCode":"EUR","CurrencyNumeric":"978","FiscalRrn":"1A2b3C4d5E6f7g8H9i","NayaxRRN":"111111","Amount":12.25},"uniqueKey":"oneOf.1","typeLabel":"null"}],"uniqueKey":"","typeLabel":"object | null"},"examples":{"Example":{"title":"Example","value":{"SparkTransactionId":"12c7cec2-c690-4425-9a1f-db0db60e2d8c","Status":{"Verdict":"Approved","ErrorDescription":"No Errors"},"CardBrand":"Visa","CardLast4Digits":"1234","AuthCode":"333333","MachineAuTime":"20240205194122328","AuTime":"20240205174122328","SeTime":"20240205192215572","CurrencyCode":"EUR","CurrencyNumeric":"978","FiscalRrn":"1A2b3C4d5E6f7g8H9i","NayaxRRN":"111111","Amount":12.25}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{},"servers":{"c8ac8999-db88-417b-af04-ab5e9e4589ec":{"url":"https://nayax-spark-dmz.nayax.com/api","description":"The same host serves the integration and production environments."}}},"originalFileLocation":"openapi/spark.yaml"},"subdomain":"nayax-44d6e37b","siteName":"Nayax Developer Portal","title":"Settlement - Nayax Developer Portal","contextualStarterQuestions":[{"_id":"6aa1a3c2370ee193ba7f63a6","deploymentId":"69981f91cf2ae4e6561a0441","questionText":"Can I add e-receipt to settlement?","status":"active","generatedBy":"contextual","path":"reference/spark/transactions/settlement","createdAt":"2026-09-09T18:21:54.319Z","updatedAt":"2026-09-09T18:21:54.319Z","__v":0},{"_id":"6aa1a3c2370ee193ba7f63a4","deploymentId":"69981f91cf2ae4e6561a0441","questionText":"How do I settle a transaction?","status":"active","generatedBy":"contextual","path":"reference/spark/transactions/settlement","createdAt":"2026-09-09T18:21:54.319Z","updatedAt":"2026-09-09T18:21:54.319Z","__v":0},{"_id":"6aa1a3c2370ee193ba7f63a5","deploymentId":"69981f91cf2ae4e6561a0441","questionText":"What is pre-authorization settlement?","status":"active","generatedBy":"contextual","path":"reference/spark/transactions/settlement","createdAt":"2026-09-09T18:21:54.319Z","updatedAt":"2026-09-09T18:21:54.319Z","__v":0}],"navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"en":{"href":"/reference/spark/transactions/settlement","matchLevel":0},"zh":{"href":"/reference/zh/spark/transactions/settlement","matchLevel":1}}},"lastModified":"2026-11-09T11:55:22.011Z","originalFileLocation":"reference/spark/transactions/settlement.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=\"Settlement - 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/settlement\">\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=Settlement\u0026amp;theme=42406d98d632f71b622c3323\u0026amp;signature=032bf27dea407109f42c2c6e56d22fc7b1b337ac355a0af2d702c98f8083bde4\">\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=\"Settlement - Nayax Developer Portal\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://nayax-44d6e37b.mintlify.site/_mintlify/api/og/v2?division=Transactions\u0026amp;title=Settlement\u0026amp;theme=42406d98d632f71b622c3323\u0026amp;signature=032bf27dea407109f42c2c6e56d22fc7b1b337ac355a0af2d702c98f8083bde4\">\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/settlement\">\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/settlement.md\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"en\" href=\"https://devzone.nayax.com/reference/spark/transactions/settlement\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"zh\" href=\"https://devzone.nayax.com/reference/zh/spark/transactions/settlement\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"x-default\" href=\"https://devzone.nayax.com/reference/spark/transactions/settlement\">\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/settlement#webpage\",\"url\":\"https://devzone.nayax.com/reference/spark/transactions/settlement\",\"name\":\"Settlement\",\"dateModified\":\"2026-11-09T11:55:22.011Z\",\"isPartOf\":{\"@id\":\"https://devzone.nayax.com#website\"},\"breadcrumb\":{\"@id\":\"https://devzone.nayax.com/reference/spark/transactions/settlement#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://devzone.nayax.com/reference/spark/transactions/settlement#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\":\"Settlement\",\"item\":\"https://devzone.nayax.com/reference/spark/transactions/settlement\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://devzone.nayax.com/reference/spark/transactions/settlement#apireference\",\"headline\":\"Settlement\",\"name\":\"Settlement\",\"url\":\"https://devzone.nayax.com/reference/spark/transactions/settlement\",\"mainEntityOfPage\":{\"@id\":\"https://devzone.nayax.com/reference/spark/transactions/settlement#webpage\"},\"dateModified\":\"2026-11-09T11:55:22.011Z\",\"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/settlement.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","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","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","description":null,"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","description":null,"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/settlement"}]}]},"basePath":"","title":"Settlement - 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"]}