The /ExternalSettlement method is called by the 3rd-party server to finalize a transaction after the payment provider has authorized the initial amount and the service or products have been provided to the consumer. This request must contain the final amount to be charged.To successfully settle a transaction, you must provide three mandatory identifiers that match the original authorization data exactly:
NayaxTransactionID: The unique identifier for the transaction in the Nayax system.
SiteID: The ID of the site where the machine is located.
MachineAUTime: The authorization timestamp from the terminal. Optional field but recommended.
MachineAUTime is not available for Marshall machines. However, as this field is optional, you can still use ExternalSettlement without it.
If you use the Nayax eReceipt platform, you can use the EReceiptData field to add custom information to the digital receipt that isn’t stored in the Nayax Backoffice.
Any information shared in this field will be visible to the consumer on their receipt. Avoid sharing sensitive data that is not relevant to the transaction.
The data must be sent as a JSON string containing:
Section Naming: To display fields without a section header, use a blank space for the section name: {" ":[...]}.
Order: Fields appear on the receipt in the exact order they are listed in the string.
Characters: Use escape characters (e.g., \") for internal quotes within the JSON string.
For operators who manage a Products Map in Nayax Core, the ProductInfo object allows you to report exactly which items were sold.This is an array of objects where each item requires:
Field
Type
Description
Value
Decimal
The price of a single unit of the product.
* The value is taken as is (Decimal place of 0), meaning if you send value of 6.50 the value that the consumer would be charged for is 6.50, and if you send 65 the value would be 65.00)
Code
Integer
The Product Code as defined in your Nayax Products Map.
* The value is taken as is (Decimal place of 0)
Quantity
Integer
The number of units of this product provided.
* The value is taken as is (Decimal place of 0)
Example Format: [{"Value": 6.50, "Code": 12, "Quantity": 3}]
The value Settled by the card issuer during the Settlement phase.
示例:
15.75
此页面对您有帮助吗?
{"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":""},"chroma":{"liveDeploymentHistoryId":"6aea16c5eceed668c0276682","collectionId":"171145e5-03e4-4182-9d14-4cc6b965d3b5","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6aea16c5eceed668c0276682"},"feedback":{"thumbs":true,"agentFeedback":false},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6aea16c5eceed668c0276682","clientVersion":"0.0.4067","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":"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":"vite-origin","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":"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}],"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/zh/spark/transactions/externalsettlement","slug":"/reference/zh/spark/transactions/externalsettlement","pageMetadata":{"title":"ExternalSettlement","description":null,"deprecated":null,"version":null,"hideFooterPagination":true,"openapi":"/openapi/zh/spark.yaml post /ExternalSettlement","href":"/reference/zh/spark/transactions/externalsettlement","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},{Danger,Heading,Table}=_components;if(!Danger)_missingMdxReference(`Danger`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Table)_missingMdxReference(`Table`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`The `,_jsx(_components.code,{children:`/ExternalSettlement`}),` method is called by the 3rd-party server to finalize a transaction after the payment provider has authorized the initial amount and the service or products have been provided to the consumer. This request must contain the final amount to be charged.`]}),`\n`,_jsx(_components.p,{children:`To successfully settle a transaction, you must provide three mandatory identifiers that match the original authorization data exactly:`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`NayaxTransactionID`}),`: The unique identifier for the transaction in the Nayax system.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`SiteID`}),`: The ID of the site where the machine is located.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`MachineAUTime`}),`: The authorization timestamp from the terminal. Optional field but recommended.`,`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`MachineAUTime is not available for Marshall machines. However, as this field is optional, you can still use ExternalSettlement without it.`}),`\n`]}),`\n`]}),`\n`]}),`\n`,_jsx(Heading,{level:`2`,id:`where-to-find-this-information`,children:`Where to Find this Information`}),`\n`,_jsx(_components.p,{children:`Depending on your hardware, these identifiers are retrieved through different channels:`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[`\n`,_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`OTI Devices`}),`: Information is sent via the `,_jsx(_components.strong,{children:`CommerceAPI`}),`.`]}),`\n`]}),`\n`,_jsxs(_components.li,{children:[`\n`,_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Marshall Devices`}),`: Information is sent via `,_jsx(_components.strong,{children:`Transfer Data`})]}),`\n`]}),`\n`,_jsxs(_components.li,{children:[`\n`,_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Alternative`}),`: All integrators can retrieve this data via `,_jsx(_components.strong,{children:`Amazon SQS`}),`.`]}),`\n`]}),`\n`]}),`\n`,_jsxs(Heading,{level:`2`,id:`adding-digital-receipts-ereceiptdata`,children:[`Adding Digital Receipts (`,_jsx(_components.code,{children:`EReceiptData`}),`)`]}),`\n`,_jsxs(_components.p,{children:[`If you use the Nayax eReceipt platform, you can use the `,_jsx(_components.code,{children:`EReceiptData`}),` field to add custom information to the digital receipt that isn’t stored in the Nayax Backoffice.`]}),`\n`,_jsx(Danger,{children:_jsx(_components.p,{children:`Any information shared in this field will be visible to the consumer on their receipt. Avoid sharing sensitive data that is not relevant to the transaction.`})}),`\n`,_jsx(_components.p,{children:`The data must be sent as a JSON string containing:`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Section Naming`}),`: To display fields without a section header, use a blank space for the section name: `,_jsx(_components.code,{children:`{\" \":[...]}`}),`.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Order`}),`: Fields appear on the receipt in the exact order they are listed in the string.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Characters`}),`: Use escape characters (e.g., `,_jsx(_components.code,{children:`\\\\\"`}),`) for internal quotes within the JSON string.`]}),`\n`]}),`\n`,_jsxs(Heading,{level:`2`,id:`reporting-products-productinfo`,children:[`Reporting Products (`,_jsx(_components.code,{children:`ProductInfo`}),`)`]}),`\n`,_jsxs(_components.p,{children:[`For operators who manage a `,_jsx(_components.strong,{children:`Products Map`}),` in Nayax Core, the `,_jsx(_components.code,{children:`ProductInfo`}),` object allows you to report exactly which items were sold.`]}),`\n`,_jsx(_components.p,{children:`This is an array of objects where each item requires:`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Field`}),_jsx(_components.th,{children:`Type`}),_jsx(_components.th,{children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.strong,{children:`Value`})}),_jsx(_components.td,{children:`Decimal`}),_jsxs(_components.td,{children:[`The price of a single unit of the product.`,_jsx(`br`,{}),_jsx(`br`,{}),`* The value is taken as is (Decimal place of 0), meaning if you send value of 6.50 the value that the consumer would be charged for is 6.50, and if you send 65 the value would be 65.00)`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.strong,{children:`Code`})}),_jsx(_components.td,{children:`Integer`}),_jsxs(_components.td,{children:[`The Product Code as defined in your Nayax Products Map.`,_jsx(`br`,{}),_jsx(`br`,{}),`* The value is taken as is (Decimal place of 0)`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.strong,{children:`Quantity`})}),_jsx(_components.td,{children:`Integer`}),_jsxs(_components.td,{children:[`The number of units of this product provided.`,_jsx(`br`,{}),_jsx(`br`,{}),`* The value is taken as is (Decimal place of 0)`]})]})]})]}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Example Format`}),`: `,_jsx(_components.code,{children:`[{\"Value\": 6.50, \"Code\": 12, \"Quantity\": 3}]`})]}),`\n`,_jsx(Heading,{level:`2`,id:`troubleshooting-declined-settlements`,children:`Troubleshooting Declined Settlements`}),`\n`,_jsxs(_components.p,{children:[`If a settlement request is declined, the response will include an `,_jsx(_components.strong,{children:`ErrorCode 50`}),`: “External Settlement Failed”.`]}),`\n`,_jsx(_components.p,{children:`Common reasons for failure include:`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Missing Identifiers`}),`: Mandatory fields like `,_jsx(_components.code,{children:`SiteId`}),` were missing from the request.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Data Mismatch`}),`: The IDs provided do not match the original authorization record.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Time Limit`}),`: The request was sent more than 48 hours after the transaction started.`]}),`\n`]})]})}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":"ExternalSettlement","description":null,"deprecated":null,"version":null,"hideFooterPagination":true,"openapi":"/openapi/zh/spark.yaml post /ExternalSettlement","href":"/reference/zh/spark/transactions/externalsettlement","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Where to Find this Information","slug":"where-to-find-this-information","depth":2,"children":[]},{"title":"Adding Digital Receipts (EReceiptData)","slug":"adding-digital-receipts-ereceiptdata","depth":2,"children":[]},{"title":"Reporting Products (ProductInfo)","slug":"reporting-products-productinfo","depth":2,"children":[]},{"title":"Troubleshooting Declined Settlements","slug":"troubleshooting-declined-settlements","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":["/_mintlify/custom/nayax-44d6e37b/c0d908800bae3e5a/wcBadge.js"],"openApiReferenceData":{"operation":{"tags":["Transactions"],"summary":"ExternalSettlement","x-mint":{"content":"The `/ExternalSettlement` method is called by the 3rd-party server to finalize a transaction after the payment provider has authorized the initial amount and the service or products have been provided to the consumer. This request must contain the final amount to be charged.\n\nTo successfully settle a transaction, you must provide three mandatory identifiers that match the original authorization data exactly:\n\n* **NayaxTransactionID**: The unique identifier for the transaction in the Nayax system.\n* **SiteID**: The ID of the site where the machine is located.\n* **MachineAUTime**: The authorization timestamp from the terminal. Optional field but recommended.\n * MachineAUTime is not available for Marshall machines. However, as this field is optional, you can still use ExternalSettlement without it.\n\n## Where to Find this Information\n\nDepending on your hardware, these identifiers are retrieved through different channels:\n\n* **OTI Devices**: Information is sent via the **CommerceAPI**.\n* **Marshall Devices**: Information is sent via **Transfer Data**\n\n* **Alternative**: All integrators can retrieve this data via **Amazon SQS**.\n\n## Adding Digital Receipts (`EReceiptData`)\n\nIf you use the Nayax eReceipt platform, you can use the `EReceiptData` field to add custom information to the digital receipt that isn't stored in the Nayax Backoffice.\n\n\u003cDanger>\nAny information shared in this field will be visible to the consumer on their receipt. Avoid sharing sensitive data that is not relevant to the transaction.\n\u003c/Danger>\n\nThe data must be sent as a JSON string containing:\n\n* **Section Naming**: To display fields without a section header, use a blank space for the section name: `{\" \":[...]}`.\n* **Order**: Fields appear on the receipt in the exact order they are listed in the string.\n* **Characters**: Use escape characters (e.g., `\\\"`) for internal quotes within the JSON string.\n\n## Reporting Products (`ProductInfo`)\n\nFor operators who manage a **Products Map** in Nayax Core, the `ProductInfo` object allows you to report exactly which items were sold.\n\nThis is an array of objects where each item requires:\n\n| Field | Type | Description |\n| --- | --- | --- |\n| **Value** | Decimal | The price of a single unit of the product.\u003cbr/>\u003cbr/>* The value is taken as is (Decimal place of 0), meaning if you send value of 6.50 the value that the consumer would be charged for is 6.50, and if you send 65 the value would be 65.00) |\n| **Code** | Integer | The Product Code as defined in your Nayax Products Map.\u003cbr/>\u003cbr/>* The value is taken as is (Decimal place of 0) |\n| **Quantity** | Integer | The number of units of this product provided.\u003cbr/>\u003cbr/>* The value is taken as is (Decimal place of 0) |\n\n**Example Format**: `[{\"Value\": 6.50, \"Code\": 12, \"Quantity\": 3}]`\n\n## Troubleshooting Declined Settlements\n\nIf a settlement request is declined, the response will include an **ErrorCode 50**: \"External Settlement Failed\".\n\nCommon reasons for failure include:\n\n* **Missing Identifiers**: Mandatory fields like `SiteId` were missing from the request.\n* **Data Mismatch**: The IDs provided do not match the original authorization record.\n* **Time Limit**: The request was sent more than 48 hours after the transaction started.\n","metadata":{"hideFooterPagination":true}},"requestBody":"6e3d8cf6-2c47-4028-8e0f-464694d4a253","responses":{"200":"3f3abdb5-3ac3-4223-a6a9-0c4592a3c23e"},"method":"post","type":"path","servers":["c095f17e-3d4b-47a3-a6df-9cb8a41bd4e1"],"security":[],"path":"/ExternalSettlement","baseUrlOptions":["https://nayax-spark-dmz.nayax.com/api"],"title":"ExternalSettlement","description":"","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"type":"object","description":"Settlement request details for an external transaction.","properties":{"NayaxTransactionId":{"type":"integer","format":"int64","description":"Nayax Internal Unique identifier for the transaction.","example":1234567890,"uniqueKey":"oneOf.0.NayaxTransactionId","typeLabel":"integer\u003cint64>"},"SparkTransactionId":{"oneOf":[{"type":"string","description":"Unique identifier for this transaction, used by Spark.","maxLength":36,"example":"a1b2c3d4-e5f6-7890-1234-567890abcdef","uniqueKey":"oneOf.0.SparkTransactionId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Unique identifier for this transaction, used by Spark.","maxLength":36,"example":"a1b2c3d4-e5f6-7890-1234-567890abcdef","uniqueKey":"oneOf.0.SparkTransactionId.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.SparkTransactionId","typeLabel":"string | null"},"MachineAuTime":{"oneOf":[{"type":"string","description":"The date time string of when the `/Authorization` took place, in local (machine) time. \n","format":"yyyyMMddHHmmssfff.","example":"20251212104530123","uniqueKey":"oneOf.0.MachineAuTime.oneOf.0","typeLabel":"string\u003cyyyyMMddHHmmssfff.>"},{"type":"null","description":"The date time string of when the `/Authorization` took place, in local (machine) time. \n","format":"yyyyMMddHHmmssfff.","example":"20251212104530123","uniqueKey":"oneOf.0.MachineAuTime.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.MachineAuTime","typeLabel":"string\u003cyyyyMMddHHmmssfff.> | null"},"SiteId":{"oneOf":[{"type":"integer","format":"int16","description":"Optional. Echo value from Authorization Callback. Represents the Site ID.","example":2,"uniqueKey":"oneOf.0.SiteId.oneOf.0","typeLabel":"integer\u003cint16>"},{"type":"null","format":"int16","description":"Optional. Echo value from Authorization Callback. Represents the Site ID.","example":2,"uniqueKey":"oneOf.0.SiteId.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.SiteId","typeLabel":"integer\u003cint16> | null"},"TerminalId":{"type":"string","nullable":false,"description":"Unique Identifier for the Nayax Terminal.","example":"0434334921100366","uniqueKey":"oneOf.0.TerminalId","typeLabel":"string"},"TerminalIdType":{"oneOf":[{"type":"integer","format":"int32","description":"Indicates the type of TerminalId. 1 - Nayax HW serial, 2 - Nayax Machine ID","enum":[1,2],"example":1,"uniqueKey":"oneOf.0.TerminalIdType.oneOf.0","typeLabel":"enum\u003cinteger>"},{"type":"null","format":"int32","description":"Indicates the type of TerminalId. 1 - Nayax HW serial, 2 - Nayax Machine ID","enum":[1,2],"example":1,"uniqueKey":"oneOf.0.TerminalIdType.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.TerminalIdType","typeLabel":"enum\u003cinteger> | null"},"Amount":{"type":"number","format":"double","description":"The value to be provided to the Terminal for transaction initiation. Decimal (max 2 digits for cents)","example":15.75,"uniqueKey":"oneOf.0.Amount","typeLabel":"number\u003cdouble>"},"EReceiptData":{"oneOf":[{"type":"string","description":"Optional. Transaction's 3rd party data for receipt generation.","uniqueKey":"oneOf.0.EReceiptData.oneOf.0","typeLabel":"string"},{"type":"null","description":"Optional. Transaction's 3rd party data for receipt generation.","uniqueKey":"oneOf.0.EReceiptData.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.EReceiptData","typeLabel":"string | null"},"ProductInfo":{"oneOf":[{"type":"array","description":"Array of products associated with the settlement.","items":{"type":"object","description":"Information about a single product in the transaction.","properties":{"Value":{"type":"number","format":"decimal","example":15.75,"nullable":false,"description":"Mandatory. The monetary amount of the product.","uniqueKey":"oneOf.0.ProductInfo.oneOf.0.items.[INDEX].Value","typeLabel":"number\u003cdecimal>"},"Code":{"oneOf":[{"type":"integer","format":"int64","example":0,"description":"Represents the product code in the product's map.","uniqueKey":"oneOf.0.ProductInfo.oneOf.0.items.[INDEX].Code.oneOf.0","typeLabel":"integer\u003cint64>"},{"type":"null","format":"int64","example":0,"description":"Represents the product code in the product's map.","uniqueKey":"oneOf.0.ProductInfo.oneOf.0.items.[INDEX].Code.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.ProductInfo.oneOf.0.items.[INDEX].Code","typeLabel":"integer\u003cint64> | null"},"Quantity":{"oneOf":[{"type":"integer","format":"int64","example":1,"description":"Quantity of the product purchased.","uniqueKey":"oneOf.0.ProductInfo.oneOf.0.items.[INDEX].Quantity.oneOf.0","typeLabel":"integer\u003cint64>"},{"type":"null","format":"int64","example":1,"description":"Quantity of the product purchased.","uniqueKey":"oneOf.0.ProductInfo.oneOf.0.items.[INDEX].Quantity.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.ProductInfo.oneOf.0.items.[INDEX].Quantity","typeLabel":"integer\u003cint64> | null"}},"uniqueKey":"oneOf.0.ProductInfo.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.0.ProductInfo.oneOf.0","typeLabel":"object[]"},{"type":"null","description":"Array of products associated with the settlement.","items":{"type":"object","description":"Information about a single product in the transaction.","properties":{"Value":{"type":"number","format":"decimal","example":15.75,"nullable":false,"description":"Mandatory. The monetary amount of the product."},"Code":{"oneOf":[{"type":"integer","format":"int64","example":0,"description":"Represents the product code in the product's map."},{"type":"null","format":"int64","example":0,"description":"Represents the product code in the product's map."}]},"Quantity":{"oneOf":[{"type":"integer","format":"int64","example":1,"description":"Quantity of the product purchased."},{"type":"null","format":"int64","example":1,"description":"Quantity of the product purchased."}]}}},"uniqueKey":"oneOf.0.ProductInfo.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.ProductInfo","typeLabel":"object[] | null"}},"uniqueKey":"oneOf.0","typeLabel":"object"},{"type":"null","description":"Settlement request details for an external transaction.","properties":{"NayaxTransactionId":{"type":"integer","format":"int64","description":"Nayax Internal Unique identifier for the transaction.","example":1234567890},"SparkTransactionId":{"oneOf":[{"type":"string","description":"Unique identifier for this transaction, used by Spark.","maxLength":36,"example":"a1b2c3d4-e5f6-7890-1234-567890abcdef"},{"type":"null","description":"Unique identifier for this transaction, used by Spark.","maxLength":36,"example":"a1b2c3d4-e5f6-7890-1234-567890abcdef"}]},"MachineAuTime":{"oneOf":[{"type":"string","description":"The date time string of when the `/Authorization` took place, in local (machine) time. \n","format":"yyyyMMddHHmmssfff.","example":"20251212104530123"},{"type":"null","description":"The date time string of when the `/Authorization` took place, in local (machine) time. \n","format":"yyyyMMddHHmmssfff.","example":"20251212104530123"}]},"SiteId":{"oneOf":[{"type":"integer","format":"int16","description":"Optional. Echo value from Authorization Callback. Represents the Site ID.","example":2},{"type":"null","format":"int16","description":"Optional. Echo value from Authorization Callback. Represents the Site ID.","example":2}]},"TerminalId":{"type":"string","nullable":false,"description":"Unique Identifier for the Nayax Terminal.","example":"0434334921100366"},"TerminalIdType":{"oneOf":[{"type":"integer","format":"int32","description":"Indicates the type of TerminalId. 1 - Nayax HW serial, 2 - Nayax Machine ID","enum":[1,2],"example":1},{"type":"null","format":"int32","description":"Indicates the type of TerminalId. 1 - Nayax HW serial, 2 - Nayax Machine ID","enum":[1,2],"example":1}]},"Amount":{"type":"number","format":"double","description":"The value to be provided to the Terminal for transaction initiation. Decimal (max 2 digits for cents)","example":15.75},"EReceiptData":{"oneOf":[{"type":"string","description":"Optional. Transaction's 3rd party data for receipt generation."},{"type":"null","description":"Optional. Transaction's 3rd party data for receipt generation."}]},"ProductInfo":{"oneOf":[{"type":"array","description":"Array of products associated with the settlement.","items":{"type":"object","description":"Information about a single product in the transaction.","properties":{"Value":{"type":"number","format":"decimal","example":15.75,"nullable":false,"description":"Mandatory. The monetary amount of the product."},"Code":{"oneOf":[{"type":"integer","format":"int64","example":0,"description":"Represents the product code in the product's map."},{"type":"null","format":"int64","example":0,"description":"Represents the product code in the product's map."}]},"Quantity":{"oneOf":[{"type":"integer","format":"int64","example":1,"description":"Quantity of the product purchased."},{"type":"null","format":"int64","example":1,"description":"Quantity of the product purchased."}]}}}},{"type":"null","description":"Array of products associated with the settlement.","items":{"type":"object","description":"Information about a single product in the transaction.","properties":{"Value":{"type":"number","format":"decimal","example":15.75,"nullable":false,"description":"Mandatory. The monetary amount of the product."},"Code":{"oneOf":[{"type":"integer","format":"int64","example":0,"description":"Represents the product code in the product's map."},{"type":"null","format":"int64","example":0,"description":"Represents the product code in the product's map."}]},"Quantity":{"oneOf":[{"type":"integer","format":"int64","example":1,"description":"Quantity of the product purchased."},{"type":"null","format":"int64","example":1,"description":"Quantity of the product purchased."}]}}}}]}},"uniqueKey":"oneOf.1","typeLabel":"null"}],"uniqueKey":"","typeLabel":"object | null"},"examples":{"Example":{"title":"Example","value":{"NayaxTransactionId":1234567890,"SparkTransactionId":"a1b2c3d4-e5f6-7890-1234-567890abcdef","MachineAuTime":"20251212104530123","SiteId":2,"TerminalId":"0434334921100366","TerminalIdType":1,"Amount":15.75,"EReceiptData":"\u003cstring>","ProductInfo":[{"Value":15.75,"Code":0,"Quantity":1}]}}},"exampleType":"generated"},"text/json":{"schema":{"oneOf":[{"type":"object","description":"Settlement request details for an external transaction.","properties":{"NayaxTransactionId":{"type":"integer","format":"int64","description":"Nayax Internal Unique identifier for the transaction.","example":1234567890,"uniqueKey":"oneOf.0.NayaxTransactionId","typeLabel":"integer\u003cint64>"},"SparkTransactionId":{"oneOf":[{"type":"string","description":"Unique identifier for this transaction, used by Spark.","maxLength":36,"example":"a1b2c3d4-e5f6-7890-1234-567890abcdef","uniqueKey":"oneOf.0.SparkTransactionId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Unique identifier for this transaction, used by Spark.","maxLength":36,"example":"a1b2c3d4-e5f6-7890-1234-567890abcdef","uniqueKey":"oneOf.0.SparkTransactionId.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.SparkTransactionId","typeLabel":"string | null"},"MachineAuTime":{"oneOf":[{"type":"string","description":"The date time string of when the `/Authorization` took place, in local (machine) time. \n","format":"yyyyMMddHHmmssfff.","example":"20251212104530123","uniqueKey":"oneOf.0.MachineAuTime.oneOf.0","typeLabel":"string\u003cyyyyMMddHHmmssfff.>"},{"type":"null","description":"The date time string of when the `/Authorization` took place, in local (machine) time. \n","format":"yyyyMMddHHmmssfff.","example":"20251212104530123","uniqueKey":"oneOf.0.MachineAuTime.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.MachineAuTime","typeLabel":"string\u003cyyyyMMddHHmmssfff.> | null"},"SiteId":{"oneOf":[{"type":"integer","format":"int16","description":"Optional. Echo value from Authorization Callback. Represents the Site ID.","example":2,"uniqueKey":"oneOf.0.SiteId.oneOf.0","typeLabel":"integer\u003cint16>"},{"type":"null","format":"int16","description":"Optional. Echo value from Authorization Callback. Represents the Site ID.","example":2,"uniqueKey":"oneOf.0.SiteId.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.SiteId","typeLabel":"integer\u003cint16> | null"},"TerminalId":{"type":"string","nullable":false,"description":"Unique Identifier for the Nayax Terminal.","example":"0434334921100366","uniqueKey":"oneOf.0.TerminalId","typeLabel":"string"},"TerminalIdType":{"oneOf":[{"type":"integer","format":"int32","description":"Indicates the type of TerminalId. 1 - Nayax HW serial, 2 - Nayax Machine ID","enum":[1,2],"example":1,"uniqueKey":"oneOf.0.TerminalIdType.oneOf.0","typeLabel":"enum\u003cinteger>"},{"type":"null","format":"int32","description":"Indicates the type of TerminalId. 1 - Nayax HW serial, 2 - Nayax Machine ID","enum":[1,2],"example":1,"uniqueKey":"oneOf.0.TerminalIdType.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.TerminalIdType","typeLabel":"enum\u003cinteger> | null"},"Amount":{"type":"number","format":"double","description":"The value to be provided to the Terminal for transaction initiation. Decimal (max 2 digits for cents)","example":15.75,"uniqueKey":"oneOf.0.Amount","typeLabel":"number\u003cdouble>"},"EReceiptData":{"oneOf":[{"type":"string","description":"Optional. Transaction's 3rd party data for receipt generation.","uniqueKey":"oneOf.0.EReceiptData.oneOf.0","typeLabel":"string"},{"type":"null","description":"Optional. Transaction's 3rd party data for receipt generation.","uniqueKey":"oneOf.0.EReceiptData.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.EReceiptData","typeLabel":"string | null"},"ProductInfo":{"oneOf":[{"type":"array","description":"Array of products associated with the settlement.","items":{"type":"object","description":"Information about a single product in the transaction.","properties":{"Value":{"type":"number","format":"decimal","example":15.75,"nullable":false,"description":"Mandatory. The monetary amount of the product.","uniqueKey":"oneOf.0.ProductInfo.oneOf.0.items.[INDEX].Value","typeLabel":"number\u003cdecimal>"},"Code":{"oneOf":[{"type":"integer","format":"int64","example":0,"description":"Represents the product code in the product's map.","uniqueKey":"oneOf.0.ProductInfo.oneOf.0.items.[INDEX].Code.oneOf.0","typeLabel":"integer\u003cint64>"},{"type":"null","format":"int64","example":0,"description":"Represents the product code in the product's map.","uniqueKey":"oneOf.0.ProductInfo.oneOf.0.items.[INDEX].Code.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.ProductInfo.oneOf.0.items.[INDEX].Code","typeLabel":"integer\u003cint64> | null"},"Quantity":{"oneOf":[{"type":"integer","format":"int64","example":1,"description":"Quantity of the product purchased.","uniqueKey":"oneOf.0.ProductInfo.oneOf.0.items.[INDEX].Quantity.oneOf.0","typeLabel":"integer\u003cint64>"},{"type":"null","format":"int64","example":1,"description":"Quantity of the product purchased.","uniqueKey":"oneOf.0.ProductInfo.oneOf.0.items.[INDEX].Quantity.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.ProductInfo.oneOf.0.items.[INDEX].Quantity","typeLabel":"integer\u003cint64> | null"}},"uniqueKey":"oneOf.0.ProductInfo.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.0.ProductInfo.oneOf.0","typeLabel":"object[]"},{"type":"null","description":"Array of products associated with the settlement.","items":{"type":"object","description":"Information about a single product in the transaction.","properties":{"Value":{"type":"number","format":"decimal","example":15.75,"nullable":false,"description":"Mandatory. The monetary amount of the product."},"Code":{"oneOf":[{"type":"integer","format":"int64","example":0,"description":"Represents the product code in the product's map."},{"type":"null","format":"int64","example":0,"description":"Represents the product code in the product's map."}]},"Quantity":{"oneOf":[{"type":"integer","format":"int64","example":1,"description":"Quantity of the product purchased."},{"type":"null","format":"int64","example":1,"description":"Quantity of the product purchased."}]}}},"uniqueKey":"oneOf.0.ProductInfo.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.ProductInfo","typeLabel":"object[] | null"}},"uniqueKey":"oneOf.0","typeLabel":"object"},{"type":"null","description":"Settlement request details for an external transaction.","properties":{"NayaxTransactionId":{"type":"integer","format":"int64","description":"Nayax Internal Unique identifier for the transaction.","example":1234567890},"SparkTransactionId":{"oneOf":[{"type":"string","description":"Unique identifier for this transaction, used by Spark.","maxLength":36,"example":"a1b2c3d4-e5f6-7890-1234-567890abcdef"},{"type":"null","description":"Unique identifier for this transaction, used by Spark.","maxLength":36,"example":"a1b2c3d4-e5f6-7890-1234-567890abcdef"}]},"MachineAuTime":{"oneOf":[{"type":"string","description":"The date time string of when the `/Authorization` took place, in local (machine) time. \n","format":"yyyyMMddHHmmssfff.","example":"20251212104530123"},{"type":"null","description":"The date time string of when the `/Authorization` took place, in local (machine) time. \n","format":"yyyyMMddHHmmssfff.","example":"20251212104530123"}]},"SiteId":{"oneOf":[{"type":"integer","format":"int16","description":"Optional. Echo value from Authorization Callback. Represents the Site ID.","example":2},{"type":"null","format":"int16","description":"Optional. Echo value from Authorization Callback. Represents the Site ID.","example":2}]},"TerminalId":{"type":"string","nullable":false,"description":"Unique Identifier for the Nayax Terminal.","example":"0434334921100366"},"TerminalIdType":{"oneOf":[{"type":"integer","format":"int32","description":"Indicates the type of TerminalId. 1 - Nayax HW serial, 2 - Nayax Machine ID","enum":[1,2],"example":1},{"type":"null","format":"int32","description":"Indicates the type of TerminalId. 1 - Nayax HW serial, 2 - Nayax Machine ID","enum":[1,2],"example":1}]},"Amount":{"type":"number","format":"double","description":"The value to be provided to the Terminal for transaction initiation. Decimal (max 2 digits for cents)","example":15.75},"EReceiptData":{"oneOf":[{"type":"string","description":"Optional. Transaction's 3rd party data for receipt generation."},{"type":"null","description":"Optional. Transaction's 3rd party data for receipt generation."}]},"ProductInfo":{"oneOf":[{"type":"array","description":"Array of products associated with the settlement.","items":{"type":"object","description":"Information about a single product in the transaction.","properties":{"Value":{"type":"number","format":"decimal","example":15.75,"nullable":false,"description":"Mandatory. The monetary amount of the product."},"Code":{"oneOf":[{"type":"integer","format":"int64","example":0,"description":"Represents the product code in the product's map."},{"type":"null","format":"int64","example":0,"description":"Represents the product code in the product's map."}]},"Quantity":{"oneOf":[{"type":"integer","format":"int64","example":1,"description":"Quantity of the product purchased."},{"type":"null","format":"int64","example":1,"description":"Quantity of the product purchased."}]}}}},{"type":"null","description":"Array of products associated with the settlement.","items":{"type":"object","description":"Information about a single product in the transaction.","properties":{"Value":{"type":"number","format":"decimal","example":15.75,"nullable":false,"description":"Mandatory. The monetary amount of the product."},"Code":{"oneOf":[{"type":"integer","format":"int64","example":0,"description":"Represents the product code in the product's map."},{"type":"null","format":"int64","example":0,"description":"Represents the product code in the product's map."}]},"Quantity":{"oneOf":[{"type":"integer","format":"int64","example":1,"description":"Quantity of the product purchased."},{"type":"null","format":"int64","example":1,"description":"Quantity of the product purchased."}]}}}}]}},"uniqueKey":"oneOf.1","typeLabel":"null"}],"uniqueKey":"","typeLabel":"object | null"},"examples":{"Example":{"title":"Example","value":{"NayaxTransactionId":1234567890,"SparkTransactionId":"a1b2c3d4-e5f6-7890-1234-567890abcdef","MachineAuTime":"20251212104530123","SiteId":2,"TerminalId":"0434334921100366","TerminalIdType":1,"Amount":15.75,"EReceiptData":"\u003cstring>","ProductInfo":[{"Value":15.75,"Code":0,"Quantity":1}]}}},"exampleType":"generated"},"application/*+json":{"schema":{"oneOf":[{"type":"object","description":"Settlement request details for an external transaction.","properties":{"NayaxTransactionId":{"type":"integer","format":"int64","description":"Nayax Internal Unique identifier for the transaction.","example":1234567890,"uniqueKey":"oneOf.0.NayaxTransactionId","typeLabel":"integer\u003cint64>"},"SparkTransactionId":{"oneOf":[{"type":"string","description":"Unique identifier for this transaction, used by Spark.","maxLength":36,"example":"a1b2c3d4-e5f6-7890-1234-567890abcdef","uniqueKey":"oneOf.0.SparkTransactionId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Unique identifier for this transaction, used by Spark.","maxLength":36,"example":"a1b2c3d4-e5f6-7890-1234-567890abcdef","uniqueKey":"oneOf.0.SparkTransactionId.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.SparkTransactionId","typeLabel":"string | null"},"MachineAuTime":{"oneOf":[{"type":"string","description":"The date time string of when the `/Authorization` took place, in local (machine) time. \n","format":"yyyyMMddHHmmssfff.","example":"20251212104530123","uniqueKey":"oneOf.0.MachineAuTime.oneOf.0","typeLabel":"string\u003cyyyyMMddHHmmssfff.>"},{"type":"null","description":"The date time string of when the `/Authorization` took place, in local (machine) time. \n","format":"yyyyMMddHHmmssfff.","example":"20251212104530123","uniqueKey":"oneOf.0.MachineAuTime.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.MachineAuTime","typeLabel":"string\u003cyyyyMMddHHmmssfff.> | null"},"SiteId":{"oneOf":[{"type":"integer","format":"int16","description":"Optional. Echo value from Authorization Callback. Represents the Site ID.","example":2,"uniqueKey":"oneOf.0.SiteId.oneOf.0","typeLabel":"integer\u003cint16>"},{"type":"null","format":"int16","description":"Optional. Echo value from Authorization Callback. Represents the Site ID.","example":2,"uniqueKey":"oneOf.0.SiteId.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.SiteId","typeLabel":"integer\u003cint16> | null"},"TerminalId":{"type":"string","nullable":false,"description":"Unique Identifier for the Nayax Terminal.","example":"0434334921100366","uniqueKey":"oneOf.0.TerminalId","typeLabel":"string"},"TerminalIdType":{"oneOf":[{"type":"integer","format":"int32","description":"Indicates the type of TerminalId. 1 - Nayax HW serial, 2 - Nayax Machine ID","enum":[1,2],"example":1,"uniqueKey":"oneOf.0.TerminalIdType.oneOf.0","typeLabel":"enum\u003cinteger>"},{"type":"null","format":"int32","description":"Indicates the type of TerminalId. 1 - Nayax HW serial, 2 - Nayax Machine ID","enum":[1,2],"example":1,"uniqueKey":"oneOf.0.TerminalIdType.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.TerminalIdType","typeLabel":"enum\u003cinteger> | null"},"Amount":{"type":"number","format":"double","description":"The value to be provided to the Terminal for transaction initiation. Decimal (max 2 digits for cents)","example":15.75,"uniqueKey":"oneOf.0.Amount","typeLabel":"number\u003cdouble>"},"EReceiptData":{"oneOf":[{"type":"string","description":"Optional. Transaction's 3rd party data for receipt generation.","uniqueKey":"oneOf.0.EReceiptData.oneOf.0","typeLabel":"string"},{"type":"null","description":"Optional. Transaction's 3rd party data for receipt generation.","uniqueKey":"oneOf.0.EReceiptData.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.EReceiptData","typeLabel":"string | null"},"ProductInfo":{"oneOf":[{"type":"array","description":"Array of products associated with the settlement.","items":{"type":"object","description":"Information about a single product in the transaction.","properties":{"Value":{"type":"number","format":"decimal","example":15.75,"nullable":false,"description":"Mandatory. The monetary amount of the product.","uniqueKey":"oneOf.0.ProductInfo.oneOf.0.items.[INDEX].Value","typeLabel":"number\u003cdecimal>"},"Code":{"oneOf":[{"type":"integer","format":"int64","example":0,"description":"Represents the product code in the product's map.","uniqueKey":"oneOf.0.ProductInfo.oneOf.0.items.[INDEX].Code.oneOf.0","typeLabel":"integer\u003cint64>"},{"type":"null","format":"int64","example":0,"description":"Represents the product code in the product's map.","uniqueKey":"oneOf.0.ProductInfo.oneOf.0.items.[INDEX].Code.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.ProductInfo.oneOf.0.items.[INDEX].Code","typeLabel":"integer\u003cint64> | null"},"Quantity":{"oneOf":[{"type":"integer","format":"int64","example":1,"description":"Quantity of the product purchased.","uniqueKey":"oneOf.0.ProductInfo.oneOf.0.items.[INDEX].Quantity.oneOf.0","typeLabel":"integer\u003cint64>"},{"type":"null","format":"int64","example":1,"description":"Quantity of the product purchased.","uniqueKey":"oneOf.0.ProductInfo.oneOf.0.items.[INDEX].Quantity.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.ProductInfo.oneOf.0.items.[INDEX].Quantity","typeLabel":"integer\u003cint64> | null"}},"uniqueKey":"oneOf.0.ProductInfo.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.0.ProductInfo.oneOf.0","typeLabel":"object[]"},{"type":"null","description":"Array of products associated with the settlement.","items":{"type":"object","description":"Information about a single product in the transaction.","properties":{"Value":{"type":"number","format":"decimal","example":15.75,"nullable":false,"description":"Mandatory. The monetary amount of the product."},"Code":{"oneOf":[{"type":"integer","format":"int64","example":0,"description":"Represents the product code in the product's map."},{"type":"null","format":"int64","example":0,"description":"Represents the product code in the product's map."}]},"Quantity":{"oneOf":[{"type":"integer","format":"int64","example":1,"description":"Quantity of the product purchased."},{"type":"null","format":"int64","example":1,"description":"Quantity of the product purchased."}]}}},"uniqueKey":"oneOf.0.ProductInfo.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.ProductInfo","typeLabel":"object[] | null"}},"uniqueKey":"oneOf.0","typeLabel":"object"},{"type":"null","description":"Settlement request details for an external transaction.","properties":{"NayaxTransactionId":{"type":"integer","format":"int64","description":"Nayax Internal Unique identifier for the transaction.","example":1234567890},"SparkTransactionId":{"oneOf":[{"type":"string","description":"Unique identifier for this transaction, used by Spark.","maxLength":36,"example":"a1b2c3d4-e5f6-7890-1234-567890abcdef"},{"type":"null","description":"Unique identifier for this transaction, used by Spark.","maxLength":36,"example":"a1b2c3d4-e5f6-7890-1234-567890abcdef"}]},"MachineAuTime":{"oneOf":[{"type":"string","description":"The date time string of when the `/Authorization` took place, in local (machine) time. \n","format":"yyyyMMddHHmmssfff.","example":"20251212104530123"},{"type":"null","description":"The date time string of when the `/Authorization` took place, in local (machine) time. \n","format":"yyyyMMddHHmmssfff.","example":"20251212104530123"}]},"SiteId":{"oneOf":[{"type":"integer","format":"int16","description":"Optional. Echo value from Authorization Callback. Represents the Site ID.","example":2},{"type":"null","format":"int16","description":"Optional. Echo value from Authorization Callback. Represents the Site ID.","example":2}]},"TerminalId":{"type":"string","nullable":false,"description":"Unique Identifier for the Nayax Terminal.","example":"0434334921100366"},"TerminalIdType":{"oneOf":[{"type":"integer","format":"int32","description":"Indicates the type of TerminalId. 1 - Nayax HW serial, 2 - Nayax Machine ID","enum":[1,2],"example":1},{"type":"null","format":"int32","description":"Indicates the type of TerminalId. 1 - Nayax HW serial, 2 - Nayax Machine ID","enum":[1,2],"example":1}]},"Amount":{"type":"number","format":"double","description":"The value to be provided to the Terminal for transaction initiation. Decimal (max 2 digits for cents)","example":15.75},"EReceiptData":{"oneOf":[{"type":"string","description":"Optional. Transaction's 3rd party data for receipt generation."},{"type":"null","description":"Optional. Transaction's 3rd party data for receipt generation."}]},"ProductInfo":{"oneOf":[{"type":"array","description":"Array of products associated with the settlement.","items":{"type":"object","description":"Information about a single product in the transaction.","properties":{"Value":{"type":"number","format":"decimal","example":15.75,"nullable":false,"description":"Mandatory. The monetary amount of the product."},"Code":{"oneOf":[{"type":"integer","format":"int64","example":0,"description":"Represents the product code in the product's map."},{"type":"null","format":"int64","example":0,"description":"Represents the product code in the product's map."}]},"Quantity":{"oneOf":[{"type":"integer","format":"int64","example":1,"description":"Quantity of the product purchased."},{"type":"null","format":"int64","example":1,"description":"Quantity of the product purchased."}]}}}},{"type":"null","description":"Array of products associated with the settlement.","items":{"type":"object","description":"Information about a single product in the transaction.","properties":{"Value":{"type":"number","format":"decimal","example":15.75,"nullable":false,"description":"Mandatory. The monetary amount of the product."},"Code":{"oneOf":[{"type":"integer","format":"int64","example":0,"description":"Represents the product code in the product's map."},{"type":"null","format":"int64","example":0,"description":"Represents the product code in the product's map."}]},"Quantity":{"oneOf":[{"type":"integer","format":"int64","example":1,"description":"Quantity of the product purchased."},{"type":"null","format":"int64","example":1,"description":"Quantity of the product purchased."}]}}}}]}},"uniqueKey":"oneOf.1","typeLabel":"null"}],"uniqueKey":"","typeLabel":"object | null"},"examples":{"Example":{"title":"Example","value":{"NayaxTransactionId":1234567890,"SparkTransactionId":"a1b2c3d4-e5f6-7890-1234-567890abcdef","MachineAuTime":"20251212104530123","SiteId":2,"TerminalId":"0434334921100366","TerminalIdType":1,"Amount":15.75,"EReceiptData":"\u003cstring>","ProductInfo":[{"Value":15.75,"Code":0,"Quantity":1}]}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"3f3abdb5-3ac3-4223-a6a9-0c4592a3c23e":{"description":"Success","content":{"text/plain":{"schema":{"oneOf":[{"type":"object","description":"Response details for an external settlement request.","properties":{"SparkTransactionId":{"oneOf":[{"type":"string","description":"The Spark unique identifier for this transaction.","example":"a1b2c3d4-e5f6-7890-1234-567890abcdef","uniqueKey":"oneOf.0.SparkTransactionId.oneOf.0","typeLabel":"string"},{"type":"null","description":"The Spark unique identifier for this transaction.","example":"a1b2c3d4-e5f6-7890-1234-567890abcdef","uniqueKey":"oneOf.0.SparkTransactionId.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.SparkTransactionId","typeLabel":"string | null"},"Status":{"type":"object","nullable":false,"description":"The status of the settlement request.","properties":{"Verdict":{"type":"string","nullable":false,"description":"请求的状态(Approved / Declined)","uniqueKey":"oneOf.0.Status.Verdict","typeLabel":"string"},"ErrorCode":{"oneOf":[{"type":"integer","format":"int16","description":"- 条件必填\n- 请求被拒绝的原因\n","uniqueKey":"oneOf.0.Status.ErrorCode.oneOf.0","typeLabel":"integer\u003cint16>"},{"type":"null","format":"int16","description":"- 条件必填\n- 请求被拒绝的原因\n","uniqueKey":"oneOf.0.Status.ErrorCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.Status.ErrorCode","typeLabel":"integer\u003cint16> | null"},"ErrorDescription":{"oneOf":[{"type":"string","description":"- 条件必填\n- 长度:255\n- 错误描述\n","uniqueKey":"oneOf.0.Status.ErrorDescription.oneOf.0","typeLabel":"string"},{"type":"null","description":"- 条件必填\n- 长度:255\n- 错误描述\n","uniqueKey":"oneOf.0.Status.ErrorDescription.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.Status.ErrorDescription","typeLabel":"string | null"},"StatusMessage":{"oneOf":[{"type":"string","description":"- 可选\n- 长度:255\n- 交易状态消息,自由文本字段\n","uniqueKey":"oneOf.0.Status.StatusMessage.oneOf.0","typeLabel":"string"},{"type":"null","description":"- 可选\n- 长度:255\n- 交易状态消息,自由文本字段\n","uniqueKey":"oneOf.0.Status.StatusMessage.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.Status.StatusMessage","typeLabel":"string | null"}},"uniqueKey":"oneOf.0.Status","typeLabel":"object"},"AuthCode":{"oneOf":[{"type":"string","description":"For Credit card implementation, when the transaction is approved, this is the External (usually Card issuer's) Authorization Code.","example":"A1B2C3","uniqueKey":"oneOf.0.AuthCode.oneOf.0","typeLabel":"string"},{"type":"null","description":"For Credit card implementation, when the transaction is approved, this is the External (usually Card issuer's) Authorization Code.","example":"A1B2C3","uniqueKey":"oneOf.0.AuthCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.AuthCode","typeLabel":"string | null"},"MachineAuTime":{"oneOf":[{"type":"string","description":"The date time string of when the `/Authorization` or `/Sale` took place, in local (machine) time.","format":"yyyyMMddHHmmssfff","example":"20251212104530123","uniqueKey":"oneOf.0.MachineAuTime.oneOf.0","typeLabel":"string\u003cyyyyMMddHHmmssfff>"},{"type":"null","description":"The date time string of when the `/Authorization` or `/Sale` took place, in local (machine) time.","format":"yyyyMMddHHmmssfff","example":"20251212104530123","uniqueKey":"oneOf.0.MachineAuTime.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.MachineAuTime","typeLabel":"string\u003cyyyyMMddHHmmssfff> | null"},"Amount":{"type":"number","format":"double","description":"The value Settled by the card issuer during the Settlement phase.","example":15.75,"uniqueKey":"oneOf.0.Amount","typeLabel":"number\u003cdouble>"}},"uniqueKey":"oneOf.0","typeLabel":"object"},{"type":"null","description":"Response details for an external settlement request.","properties":{"SparkTransactionId":{"oneOf":[{"type":"string","description":"The Spark unique identifier for this transaction.","example":"a1b2c3d4-e5f6-7890-1234-567890abcdef"},{"type":"null","description":"The Spark unique identifier for this transaction.","example":"a1b2c3d4-e5f6-7890-1234-567890abcdef"}]},"Status":{"type":"object","nullable":false,"description":"The status of the settlement request.","properties":{"Verdict":{"type":"string","nullable":false,"description":"请求的状态(Approved / Declined)"},"ErrorCode":{"oneOf":[{"type":"integer","format":"int16","description":"- 条件必填\n- 请求被拒绝的原因\n"},{"type":"null","format":"int16","description":"- 条件必填\n- 请求被拒绝的原因\n"}]},"ErrorDescription":{"oneOf":[{"type":"string","description":"- 条件必填\n- 长度:255\n- 错误描述\n"},{"type":"null","description":"- 条件必填\n- 长度:255\n- 错误描述\n"}]},"StatusMessage":{"oneOf":[{"type":"string","description":"- 可选\n- 长度:255\n- 交易状态消息,自由文本字段\n"},{"type":"null","description":"- 可选\n- 长度:255\n- 交易状态消息,自由文本字段\n"}]}}},"AuthCode":{"oneOf":[{"type":"string","description":"For Credit card implementation, when the transaction is approved, this is the External (usually Card issuer's) Authorization Code.","example":"A1B2C3"},{"type":"null","description":"For Credit card implementation, when the transaction is approved, this is the External (usually Card issuer's) Authorization Code.","example":"A1B2C3"}]},"MachineAuTime":{"oneOf":[{"type":"string","description":"The date time string of when the `/Authorization` or `/Sale` took place, in local (machine) time.","format":"yyyyMMddHHmmssfff","example":"20251212104530123"},{"type":"null","description":"The date time string of when the `/Authorization` or `/Sale` took place, in local (machine) time.","format":"yyyyMMddHHmmssfff","example":"20251212104530123"}]},"Amount":{"type":"number","format":"double","description":"The value Settled by the card issuer during the Settlement phase.","example":15.75}},"uniqueKey":"oneOf.1","typeLabel":"null"}],"uniqueKey":"","typeLabel":"object | null"},"examples":{"Example":{"title":"Example","value":{"SparkTransactionId":"a1b2c3d4-e5f6-7890-1234-567890abcdef","Status":{"Verdict":"\u003cstring>","ErrorCode":123,"ErrorDescription":"\u003cstring>","StatusMessage":"\u003cstring>"},"AuthCode":"A1B2C3","MachineAuTime":"20251212104530123","Amount":15.75}}},"exampleType":"generated"},"application/json":{"schema":{"oneOf":[{"type":"object","description":"Response details for an external settlement request.","properties":{"SparkTransactionId":{"oneOf":[{"type":"string","description":"The Spark unique identifier for this transaction.","example":"a1b2c3d4-e5f6-7890-1234-567890abcdef","uniqueKey":"oneOf.0.SparkTransactionId.oneOf.0","typeLabel":"string"},{"type":"null","description":"The Spark unique identifier for this transaction.","example":"a1b2c3d4-e5f6-7890-1234-567890abcdef","uniqueKey":"oneOf.0.SparkTransactionId.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.SparkTransactionId","typeLabel":"string | null"},"Status":{"type":"object","nullable":false,"description":"The status of the settlement request.","properties":{"Verdict":{"type":"string","nullable":false,"description":"请求的状态(Approved / Declined)","uniqueKey":"oneOf.0.Status.Verdict","typeLabel":"string"},"ErrorCode":{"oneOf":[{"type":"integer","format":"int16","description":"- 条件必填\n- 请求被拒绝的原因\n","uniqueKey":"oneOf.0.Status.ErrorCode.oneOf.0","typeLabel":"integer\u003cint16>"},{"type":"null","format":"int16","description":"- 条件必填\n- 请求被拒绝的原因\n","uniqueKey":"oneOf.0.Status.ErrorCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.Status.ErrorCode","typeLabel":"integer\u003cint16> | null"},"ErrorDescription":{"oneOf":[{"type":"string","description":"- 条件必填\n- 长度:255\n- 错误描述\n","uniqueKey":"oneOf.0.Status.ErrorDescription.oneOf.0","typeLabel":"string"},{"type":"null","description":"- 条件必填\n- 长度:255\n- 错误描述\n","uniqueKey":"oneOf.0.Status.ErrorDescription.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.Status.ErrorDescription","typeLabel":"string | null"},"StatusMessage":{"oneOf":[{"type":"string","description":"- 可选\n- 长度:255\n- 交易状态消息,自由文本字段\n","uniqueKey":"oneOf.0.Status.StatusMessage.oneOf.0","typeLabel":"string"},{"type":"null","description":"- 可选\n- 长度:255\n- 交易状态消息,自由文本字段\n","uniqueKey":"oneOf.0.Status.StatusMessage.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.Status.StatusMessage","typeLabel":"string | null"}},"uniqueKey":"oneOf.0.Status","typeLabel":"object"},"AuthCode":{"oneOf":[{"type":"string","description":"For Credit card implementation, when the transaction is approved, this is the External (usually Card issuer's) Authorization Code.","example":"A1B2C3","uniqueKey":"oneOf.0.AuthCode.oneOf.0","typeLabel":"string"},{"type":"null","description":"For Credit card implementation, when the transaction is approved, this is the External (usually Card issuer's) Authorization Code.","example":"A1B2C3","uniqueKey":"oneOf.0.AuthCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.AuthCode","typeLabel":"string | null"},"MachineAuTime":{"oneOf":[{"type":"string","description":"The date time string of when the `/Authorization` or `/Sale` took place, in local (machine) time.","format":"yyyyMMddHHmmssfff","example":"20251212104530123","uniqueKey":"oneOf.0.MachineAuTime.oneOf.0","typeLabel":"string\u003cyyyyMMddHHmmssfff>"},{"type":"null","description":"The date time string of when the `/Authorization` or `/Sale` took place, in local (machine) time.","format":"yyyyMMddHHmmssfff","example":"20251212104530123","uniqueKey":"oneOf.0.MachineAuTime.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.MachineAuTime","typeLabel":"string\u003cyyyyMMddHHmmssfff> | null"},"Amount":{"type":"number","format":"double","description":"The value Settled by the card issuer during the Settlement phase.","example":15.75,"uniqueKey":"oneOf.0.Amount","typeLabel":"number\u003cdouble>"}},"uniqueKey":"oneOf.0","typeLabel":"object"},{"type":"null","description":"Response details for an external settlement request.","properties":{"SparkTransactionId":{"oneOf":[{"type":"string","description":"The Spark unique identifier for this transaction.","example":"a1b2c3d4-e5f6-7890-1234-567890abcdef"},{"type":"null","description":"The Spark unique identifier for this transaction.","example":"a1b2c3d4-e5f6-7890-1234-567890abcdef"}]},"Status":{"type":"object","nullable":false,"description":"The status of the settlement request.","properties":{"Verdict":{"type":"string","nullable":false,"description":"请求的状态(Approved / Declined)"},"ErrorCode":{"oneOf":[{"type":"integer","format":"int16","description":"- 条件必填\n- 请求被拒绝的原因\n"},{"type":"null","format":"int16","description":"- 条件必填\n- 请求被拒绝的原因\n"}]},"ErrorDescription":{"oneOf":[{"type":"string","description":"- 条件必填\n- 长度:255\n- 错误描述\n"},{"type":"null","description":"- 条件必填\n- 长度:255\n- 错误描述\n"}]},"StatusMessage":{"oneOf":[{"type":"string","description":"- 可选\n- 长度:255\n- 交易状态消息,自由文本字段\n"},{"type":"null","description":"- 可选\n- 长度:255\n- 交易状态消息,自由文本字段\n"}]}}},"AuthCode":{"oneOf":[{"type":"string","description":"For Credit card implementation, when the transaction is approved, this is the External (usually Card issuer's) Authorization Code.","example":"A1B2C3"},{"type":"null","description":"For Credit card implementation, when the transaction is approved, this is the External (usually Card issuer's) Authorization Code.","example":"A1B2C3"}]},"MachineAuTime":{"oneOf":[{"type":"string","description":"The date time string of when the `/Authorization` or `/Sale` took place, in local (machine) time.","format":"yyyyMMddHHmmssfff","example":"20251212104530123"},{"type":"null","description":"The date time string of when the `/Authorization` or `/Sale` took place, in local (machine) time.","format":"yyyyMMddHHmmssfff","example":"20251212104530123"}]},"Amount":{"type":"number","format":"double","description":"The value Settled by the card issuer during the Settlement phase.","example":15.75}},"uniqueKey":"oneOf.1","typeLabel":"null"}],"uniqueKey":"","typeLabel":"object | null"},"examples":{"Example":{"title":"Example","value":{"SparkTransactionId":"a1b2c3d4-e5f6-7890-1234-567890abcdef","Status":{"Verdict":"\u003cstring>","ErrorCode":123,"ErrorDescription":"\u003cstring>","StatusMessage":"\u003cstring>"},"AuthCode":"A1B2C3","MachineAuTime":"20251212104530123","Amount":15.75}}},"exampleType":"generated"},"text/json":{"schema":{"oneOf":[{"type":"object","description":"Response details for an external settlement request.","properties":{"SparkTransactionId":{"oneOf":[{"type":"string","description":"The Spark unique identifier for this transaction.","example":"a1b2c3d4-e5f6-7890-1234-567890abcdef","uniqueKey":"oneOf.0.SparkTransactionId.oneOf.0","typeLabel":"string"},{"type":"null","description":"The Spark unique identifier for this transaction.","example":"a1b2c3d4-e5f6-7890-1234-567890abcdef","uniqueKey":"oneOf.0.SparkTransactionId.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.SparkTransactionId","typeLabel":"string | null"},"Status":{"type":"object","nullable":false,"description":"The status of the settlement request.","properties":{"Verdict":{"type":"string","nullable":false,"description":"请求的状态(Approved / Declined)","uniqueKey":"oneOf.0.Status.Verdict","typeLabel":"string"},"ErrorCode":{"oneOf":[{"type":"integer","format":"int16","description":"- 条件必填\n- 请求被拒绝的原因\n","uniqueKey":"oneOf.0.Status.ErrorCode.oneOf.0","typeLabel":"integer\u003cint16>"},{"type":"null","format":"int16","description":"- 条件必填\n- 请求被拒绝的原因\n","uniqueKey":"oneOf.0.Status.ErrorCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.Status.ErrorCode","typeLabel":"integer\u003cint16> | null"},"ErrorDescription":{"oneOf":[{"type":"string","description":"- 条件必填\n- 长度:255\n- 错误描述\n","uniqueKey":"oneOf.0.Status.ErrorDescription.oneOf.0","typeLabel":"string"},{"type":"null","description":"- 条件必填\n- 长度:255\n- 错误描述\n","uniqueKey":"oneOf.0.Status.ErrorDescription.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.Status.ErrorDescription","typeLabel":"string | null"},"StatusMessage":{"oneOf":[{"type":"string","description":"- 可选\n- 长度:255\n- 交易状态消息,自由文本字段\n","uniqueKey":"oneOf.0.Status.StatusMessage.oneOf.0","typeLabel":"string"},{"type":"null","description":"- 可选\n- 长度:255\n- 交易状态消息,自由文本字段\n","uniqueKey":"oneOf.0.Status.StatusMessage.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.Status.StatusMessage","typeLabel":"string | null"}},"uniqueKey":"oneOf.0.Status","typeLabel":"object"},"AuthCode":{"oneOf":[{"type":"string","description":"For Credit card implementation, when the transaction is approved, this is the External (usually Card issuer's) Authorization Code.","example":"A1B2C3","uniqueKey":"oneOf.0.AuthCode.oneOf.0","typeLabel":"string"},{"type":"null","description":"For Credit card implementation, when the transaction is approved, this is the External (usually Card issuer's) Authorization Code.","example":"A1B2C3","uniqueKey":"oneOf.0.AuthCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.AuthCode","typeLabel":"string | null"},"MachineAuTime":{"oneOf":[{"type":"string","description":"The date time string of when the `/Authorization` or `/Sale` took place, in local (machine) time.","format":"yyyyMMddHHmmssfff","example":"20251212104530123","uniqueKey":"oneOf.0.MachineAuTime.oneOf.0","typeLabel":"string\u003cyyyyMMddHHmmssfff>"},{"type":"null","description":"The date time string of when the `/Authorization` or `/Sale` took place, in local (machine) time.","format":"yyyyMMddHHmmssfff","example":"20251212104530123","uniqueKey":"oneOf.0.MachineAuTime.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.MachineAuTime","typeLabel":"string\u003cyyyyMMddHHmmssfff> | null"},"Amount":{"type":"number","format":"double","description":"The value Settled by the card issuer during the Settlement phase.","example":15.75,"uniqueKey":"oneOf.0.Amount","typeLabel":"number\u003cdouble>"}},"uniqueKey":"oneOf.0","typeLabel":"object"},{"type":"null","description":"Response details for an external settlement request.","properties":{"SparkTransactionId":{"oneOf":[{"type":"string","description":"The Spark unique identifier for this transaction.","example":"a1b2c3d4-e5f6-7890-1234-567890abcdef"},{"type":"null","description":"The Spark unique identifier for this transaction.","example":"a1b2c3d4-e5f6-7890-1234-567890abcdef"}]},"Status":{"type":"object","nullable":false,"description":"The status of the settlement request.","properties":{"Verdict":{"type":"string","nullable":false,"description":"请求的状态(Approved / Declined)"},"ErrorCode":{"oneOf":[{"type":"integer","format":"int16","description":"- 条件必填\n- 请求被拒绝的原因\n"},{"type":"null","format":"int16","description":"- 条件必填\n- 请求被拒绝的原因\n"}]},"ErrorDescription":{"oneOf":[{"type":"string","description":"- 条件必填\n- 长度:255\n- 错误描述\n"},{"type":"null","description":"- 条件必填\n- 长度:255\n- 错误描述\n"}]},"StatusMessage":{"oneOf":[{"type":"string","description":"- 可选\n- 长度:255\n- 交易状态消息,自由文本字段\n"},{"type":"null","description":"- 可选\n- 长度:255\n- 交易状态消息,自由文本字段\n"}]}}},"AuthCode":{"oneOf":[{"type":"string","description":"For Credit card implementation, when the transaction is approved, this is the External (usually Card issuer's) Authorization Code.","example":"A1B2C3"},{"type":"null","description":"For Credit card implementation, when the transaction is approved, this is the External (usually Card issuer's) Authorization Code.","example":"A1B2C3"}]},"MachineAuTime":{"oneOf":[{"type":"string","description":"The date time string of when the `/Authorization` or `/Sale` took place, in local (machine) time.","format":"yyyyMMddHHmmssfff","example":"20251212104530123"},{"type":"null","description":"The date time string of when the `/Authorization` or `/Sale` took place, in local (machine) time.","format":"yyyyMMddHHmmssfff","example":"20251212104530123"}]},"Amount":{"type":"number","format":"double","description":"The value Settled by the card issuer during the Settlement phase.","example":15.75}},"uniqueKey":"oneOf.1","typeLabel":"null"}],"uniqueKey":"","typeLabel":"object | null"},"examples":{"Example":{"title":"Example","value":{"SparkTransactionId":"a1b2c3d4-e5f6-7890-1234-567890abcdef","Status":{"Verdict":"\u003cstring>","ErrorCode":123,"ErrorDescription":"\u003cstring>","StatusMessage":"\u003cstring>"},"AuthCode":"A1B2C3","MachineAuTime":"20251212104530123","Amount":15.75}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{},"servers":{"c095f17e-3d4b-47a3-a6df-9cb8a41bd4e1":{"url":"https://nayax-spark-dmz.nayax.com/api","description":"The same host serves the integration and production environments."}}},"originalFileLocation":"openapi/zh/spark.yaml"},"subdomain":"nayax-44d6e37b","siteName":"Nayax Developer Portal","title":"ExternalSettlement - Nayax Developer Portal","contextualStarterQuestions":[],"navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"en":{"href":"/reference/spark/transactions/externalsettlement","matchLevel":1},"zh":{"href":"/reference/zh/spark/transactions/externalsettlement","matchLevel":0}}},"lastModified":"2026-11-03T17:16:36.531Z","originalFileLocation":"reference/zh/spark/transactions/externalsettlement.mdx","locale":"zh"},"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=\"ExternalSettlement - 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/zh/spark/transactions/externalsettlement\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://nayax-44d6e37b.mintlify.app/_mintlify/api/og/v2?division=Transactions\u0026amp;title=ExternalSettlement\u0026amp;theme=09b4e344a36ca47397141e43\u0026amp;signature=e67df5f44f63526a1d6b837da7f2a84329facd8900f9e457fec38e4f7ea7264c\">\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=\"ExternalSettlement - Nayax Developer Portal\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://nayax-44d6e37b.mintlify.app/_mintlify/api/og/v2?division=Transactions\u0026amp;title=ExternalSettlement\u0026amp;theme=09b4e344a36ca47397141e43\u0026amp;signature=e67df5f44f63526a1d6b837da7f2a84329facd8900f9e457fec38e4f7ea7264c\">\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/zh/spark/transactions/externalsettlement\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/reference/zh/spark/transactions/externalsettlement.md\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"zh\" href=\"https://devzone.nayax.com/reference/zh/spark/transactions/externalsettlement\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"en\" href=\"https://devzone.nayax.com/reference/spark/transactions/externalsettlement\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"x-default\" href=\"https://devzone.nayax.com/reference/spark/transactions/externalsettlement\">\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/zh/spark/transactions/externalsettlement#webpage\",\"url\":\"https://devzone.nayax.com/reference/zh/spark/transactions/externalsettlement\",\"name\":\"ExternalSettlement\",\"dateModified\":\"2026-11-03T17:16:36.531Z\",\"isPartOf\":{\"@id\":\"https://devzone.nayax.com#website\"},\"breadcrumb\":{\"@id\":\"https://devzone.nayax.com/reference/zh/spark/transactions/externalsettlement#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://devzone.nayax.com/reference/zh/spark/transactions/externalsettlement#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API Reference\",\"item\":\"https://devzone.nayax.com/reference/zh/spark/transactions/get-version\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Transactions\",\"item\":\"https://devzone.nayax.com/reference/zh/spark/transactions/get-version\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"ExternalSettlement\",\"item\":\"https://devzone.nayax.com/reference/zh/spark/transactions/externalsettlement\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://devzone.nayax.com/reference/zh/spark/transactions/externalsettlement#apireference\",\"headline\":\"ExternalSettlement\",\"name\":\"ExternalSettlement\",\"url\":\"https://devzone.nayax.com/reference/zh/spark/transactions/externalsettlement\",\"mainEntityOfPage\":{\"@id\":\"https://devzone.nayax.com/reference/zh/spark/transactions/externalsettlement#webpage\"},\"dateModified\":\"2026-11-03T17:16:36.531Z\",\"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\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Nayax Developer Portal","nav":{"global":null,"languages":[{"language":"en","default":true,"pages":[{"title":"en","href":"/reference/spark/transactions/externalsettlement"}]},{"language":"zh","tabs":[{"tab":"Docs Home","icon":"home","pages":[{"title":"Docs Home","href":"/docs/zh"}]},{"tab":"Terminal SDKs","menu":[{"item":"Marshall","pages":[{"title":"Marshall","href":"/docs/zh/integrate-pos-device/marshall/marshall-sdk"}]},{"item":"Marshall Pro (Fuel)","pages":[{"title":"Marshall Pro (Fuel)","href":"/docs/zh/integrate-pos-device/marshall-pro/getting-started"}]},{"item":"TweezerComm","pages":[{"title":"TweezerComm","href":"/docs/zh/integrate-pos-device/tweezercomm/overview-tweezer"}]},{"item":"EMV Core","pages":[{"title":"EMV Core","href":"/docs/zh/integrate-pos-device/emv-core/overview"}]},{"item":"Spark","groups":[{"group":"Spark Guides","pages":[{"title":"概述","href":"/docs/zh/integrate-pos-device/spark/spark"},{"title":"集成过程","href":"/docs/zh/integrate-pos-device/spark/spark-integration-process"},{"title":"网络要求","href":"/docs/zh/integrate-pos-device/spark/spark-network-requirement"},{"group":"Security \u0026 Authentication","root":{"title":"安全与身份验证","href":"/docs/zh/integrate-pos-device/spark/security-authentication/index"},"pages":[{"title":"验证","href":"/docs/zh/integrate-pos-device/spark/security-authentication/spark-authentication"},{"title":"传统身份验证","href":"/docs/zh/integrate-pos-device/spark/security-authentication/spark-legacy-authentication"},{"title":"交互式身份验证工具","href":"/docs/zh/integrate-pos-device/spark/security-authentication/spark-auth-tool"}]},{"group":"Payment Flows","root":{"mode":"wide","title":"付款流程","href":"/docs/zh/integrate-pos-device/spark/payment-flows/transaction-flows-spark"},"pages":[{"title":"设备启动","href":"/docs/zh/integrate-pos-device/spark/payment-flows/spark-device-start"},{"title":"远程启动","href":"/docs/zh/integrate-pos-device/spark/payment-flows/spark-remote-start"},{"title":"设备停止","href":"/docs/zh/integrate-pos-device/spark/payment-flows/spark-device-stop"},{"title":"外部结算","href":"/docs/zh/integrate-pos-device/spark/payment-flows/external-settlement"},{"title":"外部取消","href":"/docs/zh/integrate-pos-device/spark/payment-flows/external-cancel"}]},{"group":"Machine Configuration","root":{"title":"机器配置概述","href":"/docs/zh/integrate-pos-device/spark/machine-configuration/index"},"pages":[{"title":"远程启动配置","href":"/docs/zh/integrate-pos-device/spark/machine-configuration/spark-remote-start-configuration"},{"title":"设备启动配置","href":"/docs/zh/integrate-pos-device/spark/machine-configuration/spark-device-start-configuration"},{"title":"设备停止配置","href":"/docs/zh/integrate-pos-device/spark/machine-configuration/spark-device-stop-configuration"},{"title":"外部结算配置","href":"/docs/zh/integrate-pos-device/spark/machine-configuration/spark-external-settlement-configuration"},{"title":"附加功能","href":"/docs/zh/integrate-pos-device/spark/machine-configuration/additional-features"}]},{"group":"Webhook Callbacks","root":{"title":"Webhook 回调","href":"/docs/zh/integrate-pos-device/spark/webhook-callbacks/index"},"pages":[{"title":"TransactionCallback","href":"/docs/zh/integrate-pos-device/spark/webhook-callbacks/transactioncallback"},{"title":"停止回调","href":"/docs/zh/integrate-pos-device/spark/webhook-callbacks/stopcallback"},{"title":"超时回调","href":"/docs/zh/integrate-pos-device/spark/webhook-callbacks/timeoutcallback"},{"title":"拒绝回调","href":"/docs/zh/integrate-pos-device/spark/webhook-callbacks/declinecallback"}]},{"group":"Additional Resources","root":{"title":"其他资源","href":"/docs/zh/integrate-pos-device/spark/additional-resources/index"},"pages":[{"title":"闭环卡支持","href":"/docs/zh/integrate-pos-device/spark/additional-resources/smc-support"},{"title":"PosDisplay 格式","href":"/docs/zh/integrate-pos-device/spark/additional-resources/spark-posdisplay-format"},{"title":"电子收据数据格式","href":"/docs/zh/integrate-pos-device/spark/additional-resources/spark-ereceiptdata-format"},{"title":"响应代码","href":"/docs/zh/integrate-pos-device/spark/additional-resources/spark-response-codes"}]},{"group":"Sample Codes","pages":[{"title":"身份验证码示例","href":"/docs/zh/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/zh/spark.yaml get /Version","href":"/reference/zh/spark/transactions/get-version"},{"title":"ExternalCancel","description":null,"deprecated":null,"version":null,"openapi":"/openapi/zh/spark.yaml post /ExternalCancel","href":"/reference/zh/spark/transactions/externalcancel"},{"title":"ExternalSettlement","deprecated":null,"version":null,"openapi":"/openapi/zh/spark.yaml post /ExternalSettlement","href":"/reference/zh/spark/transactions/externalsettlement"},{"title":"StartAuthentication","description":null,"deprecated":null,"version":null,"openapi":"/openapi/zh/spark.yaml post /StartAuthentication","href":"/reference/zh/spark/transactions/startauthentication"},{"title":"StartSession","deprecated":null,"version":null,"openapi":"/openapi/zh/spark.yaml post /StartSession","href":"/reference/zh/spark/transactions/startsession"},{"title":"TriggerTransaction","deprecated":null,"version":null,"openapi":"/openapi/zh/spark.yaml post /TriggerTransaction","href":"/reference/zh/spark/transactions/triggertransaction"},{"title":"TransactionCallback","deprecated":null,"version":null,"openapi":"/openapi/zh/spark.yaml post /TransactionCallback","href":"/reference/zh/spark/transactions/transactioncallback"},{"title":"TransactionNotify","deprecated":null,"version":null,"openapi":"/openapi/zh/spark.yaml post /TransactionNotify","href":"/reference/zh/spark/transactions/transactionnotify"},{"title":"Settlement","deprecated":null,"version":null,"openapi":"/openapi/zh/spark.yaml post /Settlement","href":"/reference/zh/spark/transactions/settlement"},{"title":"TimeoutCallback","deprecated":null,"version":null,"openapi":"/openapi/zh/spark.yaml post /TimeoutCallback","href":"/reference/zh/spark/transactions/timeoutcallback"},{"title":"CancelTransaction","deprecated":null,"version":null,"openapi":"/openapi/zh/spark.yaml post /CancelTransaction","href":"/reference/zh/spark/transactions/canceltransaction"},{"title":"StopNotify","deprecated":null,"version":null,"openapi":"/openapi/zh/spark.yaml post /StopNotify","href":"/reference/zh/spark/transactions/stopnotify"},{"title":"AvailabilityCheck","deprecated":null,"version":null,"openapi":"/openapi/zh/spark.yaml post /AvailabilityCheck","href":"/reference/zh/spark/transactions/availabilitycheck"},{"title":"StopCallback","deprecated":null,"version":null,"openapi":"/openapi/zh/spark.yaml post /StopCallback","href":"/reference/zh/spark/transactions/stopcallback"},{"title":"DeclineCallback","deprecated":null,"version":null,"openapi":"/openapi/zh/spark.yaml post /DeclineCallback","href":"/reference/zh/spark/transactions/declinecallback"},{"title":"InfoQuery","deprecated":null,"version":null,"openapi":"/openapi/zh/spark.yaml post /InfoQuery","href":"/reference/zh/spark/transactions/infoquery"}]}]}]}]},{"tab":"Platform Management","menu":[{"item":"Transaction Reporting","pages":[{"title":"Transaction Reporting","href":"/docs/zh/manage-data-operations/amazon-sqs/overview"}]},{"item":"Lynx API","pages":[{"title":"Lynx API","href":"/docs/zh/manage-data-operations/lynx-api/lynx-overview"}]}],"pages":[{"title":"Platform Management","href":"/docs/zh/manage-data-operations/amazon-sqs/overview"}]},{"tab":"Core Extension","pages":[{"title":"Core Extension","href":"/docs/zh/core-extension/overview"}]},{"tab":"Cortina","pages":[{"title":"Cortina","href":"/docs/zh/cortina/overview-cortina"}]},{"tab":"Build with AI","pages":[{"title":"Build with AI","href":"/docs/zh/get-started/build-with-ai"}]},{"tab":"Release Notes","href":"https://www.nayax.com/product-updates/integrated-pos/integrated-vpos-touch-onyx/"},{"tab":"Help Center","href":"https://nayax-u.nayax.com/"}]}]},"basePath":"","title":"ExternalSettlement - Nayax Developer Portal","buildId":"dpl_9VVk5y1P8k1ATeJguVngy9Q3cmbD","deploymentId":"dpl_9VVk5y1P8k1ATeJguVngy9Q3cmbD","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DX1Meug0.js","utils-B_OMIQVC.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-ChxhRPMa.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-CuKvD8Iv.js","snippetPresets-C5d7p2hp.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CfHcE8m4.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C1zZV314.js","shallow-CmQhqCJn.js","getApiPlaygroundDisplay-YRo9s1O7.js","CodeSnippet-RN1MTdfk.js","CodeSnippets-DKLPHxJA.js","Page-BAvA99GL.js","getPastedJson-bz0M41mU.js","icon-CsmhpPrv.js","MethodPill-CNGsVE77.js","DuplicateIcon-DilfU_Z2.js","createIcon-BdsYzQck.js","DynamicMarkdown-CbqEDjbV.js","SectionHeading-O6hXpFCN.js","axios-vUo_bRtp.js","Markdown-nKm-uidQ.js","clsx-ClVdStUn.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CIQkMg3R.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-ImrFS4Fy.js"]}