The /ExternalCancel method is used by the third-party server to cancel a transaction that has been authorized but not yet settled. Cancellation is necessary if a failure occurs during the interaction or on the third-party server. This process is vital for releasing any funds captured on the consumer’s payment card.While the API method is always /ExternalCancel, the financial terminology depends on the machine flow type:
Pre-Authorization Flow: This method is called to as a “Cancel”.
Pre-Selection Flow: This the method is referred a “Void”.
The request must specify the required cancellation type.
To successfully cancel a transaction, your request must include the three required identifiers that exactly match the original transaction data.
NayaxTransactionID: The unique ID generated during authorization.
SiteID: The identifier for the machine’s location.
MachineAuTime: The exact authorization timestamp. Optional field but recommended
MachineAUTime is currently not available for Marshall machines due to Transfer Data not providing this information to the machine (hence the 3rd party servers would not have this information when trying to send the ExternalCancel)
If any of these fields are missing or mismatched, the system will return a “Transaction not found” error.
Automatic Retries (AutoCancel):In case the request fails, Nayax provides an AutoCancel feature, which means Nayax will automatically attempt to retry the cancellation later. The prerequisite is that the AutoCancel feature must be enabled for the specific operator.
Conditional. Detailed description or text of the cancel reason. Either ReasonCode or ReasonText must be provided. ExternalCancel request without both will cause failure.
The date time string of when the /Authorization or /Sale took place, in local (machine) time.
Example:
"20251212110000500"
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Nayax Developer Portal","colors":{"primary":"#6352E0","light":"#FCC705","dark":"#6352E0"},"logo":{"light":"https://mintcdn.com/nayax-44d6e37b/ag7p0QchXLJNEuNE/images/home/logo_light.svg?fit=max\u0026auto=format\u0026n=ag7p0QchXLJNEuNE\u0026q=85\u0026s=b71aa1a61014633be60cee745d3e978c","dark":"https://mintcdn.com/nayax-44d6e37b/ag7p0QchXLJNEuNE/images/home/logo_dark.svg?fit=max\u0026auto=format\u0026n=ag7p0QchXLJNEuNE\u0026q=85\u0026s=26e496c2ba485bfe41389f473135944e"},"favicon":"https://mintcdn.com/nayax-44d6e37b/th_G6l3xpaCQbV-V/images/favicon.ico?fit=max\u0026auto=format\u0026n=th_G6l3xpaCQbV-V\u0026q=85\u0026s=96a64c93cc563f757e95a29a7ad6637d","api":{"playground":{"display":"none"}},"footer":{"links":[{"header":"Legal \u0026 Policies","items":[{"label":"Privacy Policy","href":"https://www.nayax.com/legal/nayax-general-privacy-policy"},{"label":"Cookie Policy","href":"https://www.nayax.com/cookie-policy"},{"label":"Terms of Use","href":"/docs/get-started/terms-of-service"},{"label":"Code of Ethics","href":"https://www.nayax.com/code-of-ethics"},{"label":"Whistleblowing","href":"https://www.nayax.com/whistleblowing-reporting-form"}]}]},"integrations":{"posthog":{"apiKey":"phc_trwjDEqjYgYGbwbd3aiMU6r4R5qcHqXt7pNzJCoVDtgg","sessionRecording":true}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":true},"navigation":{"languages":[{"language":"en","default":true,"href":""},{"language":"zh","href":"docs/zh"}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"nayax-44d6e37b","hasAudioNarration":false,"actualSubdomain":"nayax-44d6e37b","customDomains":["devzone.nayax.com"],"gitSource":{"type":"github","owner":"writechoiceorg","repo":"nayax-mintlify","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true,"agentFeedback":false},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6af1b49d0da5396f9632f099","clientVersion":"0.0.4102","searchFilterCounts":[{"language":"en","tag":"Terminal SDKs","count":220},{"language":"zh","tag":"Terminal SDKs","count":220},{"language":"en","tag":"API Reference","count":185},{"language":"zh","tag":"API Reference","count":185},{"language":"en","tag":"Platform Management","count":181},{"language":"zh","tag":"Platform Management","count":181},{"language":"en","tag":"Lynx API","count":173},{"language":"zh","tag":"Lynx API","count":173},{"language":"en","tag":"Endpoints","count":166},{"language":"zh","tag":"Endpoints","count":166},{"language":"en","tag":"Cortina","count":78},{"language":"zh","tag":"Cortina","count":78},{"language":"en","tag":"TweezerComm","count":69},{"language":"en","tag":"TweezerComm Guides","count":69},{"language":"zh","tag":"TweezerComm","count":69},{"language":"zh","tag":"TweezerComm Guides","count":69},{"language":"en","tag":"Marshall","count":44},{"language":"zh","tag":"Marshall","count":44},{"language":"en","tag":"Cortina Guides","count":42},{"language":"zh","tag":"Cortina Guides","count":42},{"language":"default","tag":"Platform Management","count":4},{"language":"default","tag":"Lynx API","count":4},{"language":"default","tag":"Lynx API Guides","count":4},{"language":"default","tag":"Operator","count":1},{"language":"default","tag":"Cards","count":1},{"language":"default","tag":"Machines","count":1}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":true,"enableAskAiSearchBar":true,"deflection":{"enabled":false,"type":"link"}},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":".card_content{font-feature-settings:\"clig\" off,\r\n \"liga\" off;font-family:Inter;font-style:normal;line-height:18px}.card_content span{position:absolute;top:10px;right:-5px;display:flex;align-items:center;justify-content:center;flex-shrink:0;color:#fff!important;text-align:center;font-size:8px;font-weight:700;text-transform:uppercase;width:40px;height:16px;flex-shrink:0;border-radius:10px;margin:0 15px 0 0}.card_content span.get{background:#0e9b71;text-shadow:1px 1px 0 #0d8d67,\r\n 0 1px 0 #0d8d67,\r\n 1px 0 0 #0d8d67}.card_content span.post{background:#0171c2;text-shadow:1px 1px 0 #0168b3,\r\n 0 1px 0 #0168b3,\r\n 1px 0 0 #0168b3}.card_content span.patch{background:#df7d03;text-shadow:1px 1px 0 #d07503,\r\n 0 1px 0 #d07503,\r\n 1px 0 0 #d07503}.card_content span.put{background:#674ead;text-shadow:1px 1px 0 #604aa2,\r\n 0 1px 0 #604aa2,\r\n 1px 0 0 #604aa2}footer .dark\\:hidden,footer .hidden.dark\\:block{display:none!important}footer .block.dark\\:hidden,footer .hidden.dark\\:block.active{display:block!important}footer .max-w-7xl>.flex{flex-direction:row!important;justify-content:space-between!important;align-items:center!important;flex-wrap:nowrap!important;width:100%!important}footer div:has(>a.md\\:truncate){display:flex!important;flex-direction:row!important;flex-wrap:nowrap!important;gap:1.5rem!important;margin-left:auto!important}footer a.md\\:truncate{max-width:none!important;white-space:nowrap!important;flex-shrink:0!important}footer h2{display:none!important}.nav-tabs{width:100%}.nav-tabs .nav-tabs-item:nth-last-child(3 of.nav-tabs-item){margin-left:auto}pre.bash{background-color:black;color:white;font-size:medium;font-family:Consolas,\r\n Monaco,\r\n Lucida Console,\r\n Liberation Mono,\r\n DejaVu Sans Mono,\r\n Bitstream Vera Sans Mono,\r\n Courier New,\r\n monospace;width:100%;display:inline-block}table{display:block;overflow-x:auto;white-space:normal}.nav-tabs>a:first-child::after{content:\"|\";position:absolute;right:-0.875rem;top:50%;transform:translateY(-50%);color:#d1d5db;font-weight:300;pointer-events:none;user-select:none}.dark .nav-tabs>a:first-child::after{color:#4b5563}[data-component-part=\"search-ask-ai-button\"]{display:none!important}#pagination{display:grid!important;grid-template-columns:1fr 1fr;gap:12px;align-items:stretch;margin-top:2rem}@media (max-width: 640px){#pagination{grid-template-columns:1fr}}#pagination>a{position:relative;display:flex;flex-direction:column;justify-content:center;gap:2px;width:100%;box-sizing:border-box;margin:0!important;padding:14px 16px;border-width:1px;border-style:solid;border-color:var(--pagination-border);border-radius:12px;background-color:rgb(var(--gray-50));text-decoration:none;transition:border-color 150ms ease;--pagination-accent: rgb(var(--primary-dark));--pagination-border: rgb(var(--gray-300))}.dark #pagination>a{background-color:rgb(var(--gray-900));--pagination-accent: rgb(var(--primary-light));--pagination-border: rgb(var(--default-border-color))}#pagination>a:hover{border-color:var(--pagination-accent)}#pagination>a:focus-visible{outline:2px solid var(--pagination-accent);outline-offset:2px}#pagination>a:not(.ml-auto){align-items:flex-start;text-align:left;padding-left:52px}#pagination>a.ml-auto{align-items:flex-end;text-align:right;padding-right:52px}#pagination>a::before{font-size:12px;font-weight:600;line-height:1.2;color:rgb(var(--gray-500))}.dark #pagination>a::before{color:rgb(var(--gray-400))}#pagination>a:not(.ml-auto)::before{content:\"Previous\"}#pagination>a.ml-auto::before{content:\"Next\"}#pagination>a span{font-size:15px;font-weight:600;line-height:1.3;color:#374151!important;margin:0!important}.dark #pagination>a span{color:#d1d5db!important}#pagination a svg{display:none}#pagination>a:not(.ml-auto){--arrow: url(\"data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24' fill='none' stroke='black' stroke-width='1.5' stroke-linecap='round' stroke-linejoin='round'%3E%3Cpath d='M19 12H5M11 5l-7 7 7 7'/%3E%3C/svg%3E\")}#pagination>a.ml-auto{--arrow: url(\"data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24' fill='none' stroke='black' stroke-width='1.5' stroke-linecap='round' stroke-linejoin='round'%3E%3Cpath d='M5 12h14M13 5l7 7-7 7'/%3E%3C/svg%3E\")}#pagination>a::after{content:\"\";position:absolute;top:50%;display:block;width:20px;height:20px;background:currentColor;-webkit-mask:var(--arrow) center / 20px 20px no-repeat;mask:var(--arrow) center / 20px 20px no-repeat;transform:translateY(-50%);color:#374151;transition:background-color 150ms ease}.dark #pagination>a::after{color:#d1d5db}#pagination>a:not(.ml-auto)::after{left:16px}#pagination>a.ml-auto::after{right:16px}#pagination>a:hover::after{color:var(--pagination-accent)}@media (prefers-reduced-motion: no-preference){#pagination>a::after{transition:background-color 150ms ease, transform 150ms ease}#pagination>a:not(.ml-auto):hover::after{transform:translate(-3px, -50%)}#pagination>a.ml-auto:hover::after{transform:translate(3px, -50%)}}"}],"page":{"pagePath":"reference/spark/transactions/externalcancel","slug":"/reference/spark/transactions/externalcancel","pageMetadata":{"title":"ExternalCancel","description":null,"deprecated":null,"version":null,"hideFooterPagination":true,"openapi":"/openapi/spark.yaml post /ExternalCancel","href":"/reference/spark/transactions/externalcancel","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`,ul:`ul`,..._provideComponents(),...props.components},{Heading,Note}=_components;if(!Heading)_missingMdxReference(`Heading`,true);if(!Note)_missingMdxReference(`Note`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`The `,_jsx(_components.code,{children:`/ExternalCancel`}),` method is used by the third-party server to cancel a transaction that has been authorized but not yet settled. Cancellation is necessary if a failure occurs during the interaction or on the third-party server. This process is vital for releasing any funds captured on the consumer’s payment card.`]}),`\n`,_jsxs(_components.p,{children:[`While the API method is always `,_jsx(_components.code,{children:`/ExternalCancel`}),`, the financial terminology depends on the machine flow type:`]}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Pre-Authorization Flow`}),`: This method is called to as a `,_jsx(_components.strong,{children:`“Cancel”`}),`.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Pre-Selection Flow`}),`: This the method is referred a `,_jsx(_components.strong,{children:`“Void”`}),`.`]}),`\n`]}),`\n`,_jsx(_components.p,{children:`The request must specify the required cancellation type.`}),`\n`,_jsx(Heading,{level:`2`,id:`identifying-the-transaction`,children:`Identifying the Transaction`}),`\n`,_jsx(_components.p,{children:`To successfully cancel a transaction, your request must include the three required identifiers that exactly match the original transaction data.`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`NayaxTransactionID`}),`: The unique ID generated during authorization.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`SiteID`}),`: The identifier for the machine’s location.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`MachineAuTime`}),`: The exact authorization timestamp. Optional field but recommended`,`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`MachineAUTime is currently not available for Marshall machines due to Transfer Data not providing this information to the machine (hence the 3rd party servers would not have this information when trying to send the ExternalCancel)`}),`\n`]}),`\n`]}),`\n`]}),`\n`,_jsx(_components.p,{children:`If any of these fields are missing or mismatched, the system will return a “Transaction not found” error.`}),`\n`,_jsxs(Note,{children:[_jsx(_components.p,{children:_jsx(_components.strong,{children:`Automatic Retries (AutoCancel):`})}),_jsxs(_components.p,{children:[`In case the request fails, Nayax provides an `,_jsx(_components.strong,{children:`AutoCancel`}),` feature, which means Nayax will automatically attempt to retry the cancellation later. The prerequisite is that the `,_jsx(_components.strong,{children:`AutoCancel`}),` feature must be enabled for the specific operator.`]})]}),`\n`,_jsx(Heading,{level:`2`,id:`troubleshooting-declined-cancellations`,children:`Troubleshooting Declined Cancellations`}),`\n`,_jsxs(_components.p,{children:[`If a cancellation request is declined, the response will return `,_jsx(_components.strong,{children:`ErrorCode 51`}),`: “External Cancel Failed”.`]}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Mandatory Use`}),`: You must send an `,_jsx(_components.code,{children:`ExternalCancel`}),` immediately if you know no product or service will be provided.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Consumer Impact`}),`: If not canceled, consumer funds will remain captured, leading to a poor user experience and potential disputes.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Audit Trail`}),`: It is recommended to include a `,_jsx(_components.code,{children:`ReasonCode`}),` and `,_jsx(_components.code,{children:`ReasonText`}),` (e.g., “75 - Service not provided”) to document why the transaction was voided.`]}),`\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":"ExternalCancel","description":null,"deprecated":null,"version":null,"hideFooterPagination":true,"openapi":"/openapi/spark.yaml post /ExternalCancel","href":"/reference/spark/transactions/externalcancel","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Identifying the Transaction","slug":"identifying-the-transaction","depth":2,"children":[]},{"title":"Troubleshooting Declined Cancellations","slug":"troubleshooting-declined-cancellations","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":["/_mintlify/custom/nayax-44d6e37b/c0d908800bae3e5a/wcBadge.js"],"openApiReferenceData":{"operation":{"summary":"ExternalCancel","tags":["Transactions"],"x-mint":{"content":"The `/ExternalCancel` method is used by the third-party server to cancel a transaction that has been authorized but not yet settled. Cancellation is necessary if a failure occurs during the interaction or on the third-party server. This process is vital for releasing any funds captured on the consumer's payment card.\n\nWhile the API method is always `/ExternalCancel`, the financial terminology depends on the machine flow type:\n\n* **Pre-Authorization Flow**: This method is called to as a **\"Cancel\"**.\n* **Pre-Selection Flow**: This the method is referred a **\"Void\"**.\n\nThe request must specify the required cancellation type.\n\n## Identifying the Transaction\n\nTo successfully cancel a transaction, your request must include the three required identifiers that exactly match the original transaction data.\n\n* **NayaxTransactionID**: The unique ID generated during authorization.\n* **SiteID**: The identifier for the machine's location.\n* **MachineAuTime**: The exact authorization timestamp. Optional field but recommended\n * MachineAUTime is currently not available for Marshall machines due to Transfer Data not providing this information to the machine (hence the 3rd party servers would not have this information when trying to send the ExternalCancel)\n\nIf any of these fields are missing or mismatched, the system will return a \"Transaction not found\" error.\n\n\u003cNote>\n**Automatic Retries (AutoCancel):**\n\nIn case the request fails, Nayax provides an **AutoCancel** feature, which means Nayax will automatically attempt to retry the cancellation later. The prerequisite is that the **AutoCancel** feature must be enabled for the specific operator.\n\u003c/Note>\n\n## Troubleshooting Declined Cancellations\n\nIf a cancellation request is declined, the response will return **ErrorCode 51**: \"External Cancel Failed\".\n\n* **Mandatory Use**: You must send an `ExternalCancel` immediately if you know no product or service will be provided.\n* **Consumer Impact**: If not canceled, consumer funds will remain captured, leading to a poor user experience and potential disputes.\n* **Audit Trail**: It is recommended to include a `ReasonCode` and `ReasonText` (e.g., \"75 - Service not provided\") to document why the transaction was voided.\n","metadata":{"hideFooterPagination":true}},"requestBody":"24f01f9a-3a48-4656-9e0e-073f9399d4bd","responses":{"200":"27558251-3d27-4b92-8bc0-ebe27b349668"},"method":"post","type":"path","servers":["c8ac8999-db88-417b-af04-ab5e9e4589ec"],"security":[],"path":"/ExternalCancel","baseUrlOptions":["https://nayax-spark-dmz.nayax.com/api"],"title":"ExternalCancel","description":"","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"type":"object","description":"Request details for canceling an external payment transaction (e.g., voiding a pre-authorization).","properties":{"NayaxTransactionId":{"type":"integer","format":"int64","description":"Nayax Internal Unique identifier for the transaction being cancelled.","example":987654321,"uniqueKey":"oneOf.0.NayaxTransactionId","typeLabel":"integer\u003cint64>"},"SparkTransactionId":{"oneOf":[{"type":"string","description":"Spark Unique identifier for this transaction.","example":"f8e7d6c5-b4a3-2109-fedc-ba9876543210","uniqueKey":"oneOf.0.SparkTransactionId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Spark Unique identifier for this transaction.","example":"f8e7d6c5-b4a3-2109-fedc-ba9876543210","uniqueKey":"oneOf.0.SparkTransactionId.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.SparkTransactionId","typeLabel":"string | null"},"SiteId":{"oneOf":[{"type":"integer","format":"int16","description":"Optional. Indication for the Nayax Engine in which Site the transaction originated. Echo value from Authorization Callback.","example":2,"uniqueKey":"oneOf.0.SiteId.oneOf.0","typeLabel":"integer\u003cint16>"},{"type":"null","format":"int16","description":"Optional. Indication for the Nayax Engine in which Site the transaction originated. Echo value from Authorization Callback.","example":2,"uniqueKey":"oneOf.0.SiteId.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.SiteId","typeLabel":"integer\u003cint16> | 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":"20251212110000500","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":"20251212110000500","uniqueKey":"oneOf.0.MachineAuTime.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.MachineAuTime","typeLabel":"string\u003cyyyyMMddHHmmssfff.> | null"},"TerminalId":{"type":"string","nullable":false,"description":"Unique Identifier for the Nayax Terminal.","maxLength":255,"example":"NX0087654321","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"},"CancellationType":{"type":"integer","format":"int32","description":"Indicates which cancellation flow is implemented. 1 - Pre-Authorization Cancel, 2 - Pre-Selection Void","enum":[1,2],"example":1,"uniqueKey":"oneOf.0.CancellationType","typeLabel":"enum\u003cinteger>"},"ReasonCode":{"oneOf":[{"type":"string","format":"int16","description":"Conditional. Cancel reason code. See [Cancel Type Codes](/docs/cortina/cancel-types).","example":"01","uniqueKey":"oneOf.0.ReasonCode.oneOf.0","typeLabel":"string\u003cint16>"},{"type":"null","format":"int16","description":"Conditional. Cancel reason code. See [Cancel Type Codes](/docs/cortina/cancel-types).","example":"01","uniqueKey":"oneOf.0.ReasonCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.ReasonCode","typeLabel":"string\u003cint16> | null"},"ReasonText":{"oneOf":[{"type":"string","description":"Conditional. Detailed description or text of the cancel reason. Either ReasonCode or ReasonText must be provided. ExternalCancel request without both will cause failure.","example":"User requested cancellation","uniqueKey":"oneOf.0.ReasonText.oneOf.0","typeLabel":"string"},{"type":"null","description":"Conditional. Detailed description or text of the cancel reason. Either ReasonCode or ReasonText must be provided. ExternalCancel request without both will cause failure.","example":"User requested cancellation","uniqueKey":"oneOf.0.ReasonText.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.ReasonText","typeLabel":"string | null"},"CancelAmount":{"oneOf":[{"type":"number","format":"double","description":"Always mandatory. Amount to be cancelled. Can’t be higher than the authorized amount.","example":5,"uniqueKey":"oneOf.0.CancelAmount.oneOf.0","typeLabel":"number\u003cdouble>"},{"type":"null","format":"double","description":"Always mandatory. Amount to be cancelled. Can’t be higher than the authorized amount.","example":5,"uniqueKey":"oneOf.0.CancelAmount.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.CancelAmount","typeLabel":"number\u003cdouble> | null"}},"uniqueKey":"oneOf.0","typeLabel":"object"},{"type":"null","description":"Request details for canceling an external payment transaction (e.g., voiding a pre-authorization).","properties":{"NayaxTransactionId":{"type":"integer","format":"int64","description":"Nayax Internal Unique identifier for the transaction being cancelled.","example":987654321},"SparkTransactionId":{"oneOf":[{"type":"string","description":"Spark Unique identifier for this transaction.","example":"f8e7d6c5-b4a3-2109-fedc-ba9876543210"},{"type":"null","description":"Spark Unique identifier for this transaction.","example":"f8e7d6c5-b4a3-2109-fedc-ba9876543210"}]},"SiteId":{"oneOf":[{"type":"integer","format":"int16","description":"Optional. Indication for the Nayax Engine in which Site the transaction originated. Echo value from Authorization Callback.","example":2},{"type":"null","format":"int16","description":"Optional. Indication for the Nayax Engine in which Site the transaction originated. Echo value from Authorization Callback.","example":2}]},"MachineAuTime":{"oneOf":[{"type":"string","description":"The date time string of when the `/Authorization` or `/Sale` took place, in local (machine) time.","format":"yyyyMMddHHmmssfff.","example":"20251212110000500"},{"type":"null","description":"The date time string of when the `/Authorization` or `/Sale` took place, in local (machine) time.","format":"yyyyMMddHHmmssfff.","example":"20251212110000500"}]},"TerminalId":{"type":"string","nullable":false,"description":"Unique Identifier for the Nayax Terminal.","maxLength":255,"example":"NX0087654321"},"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}]},"CancellationType":{"type":"integer","format":"int32","description":"Indicates which cancellation flow is implemented. 1 - Pre-Authorization Cancel, 2 - Pre-Selection Void","enum":[1,2],"example":1},"ReasonCode":{"oneOf":[{"type":"string","format":"int16","description":"Conditional. Cancel reason code. See [Cancel Type Codes](/docs/cortina/cancel-types).","example":"01"},{"type":"null","format":"int16","description":"Conditional. Cancel reason code. See [Cancel Type Codes](/docs/cortina/cancel-types).","example":"01"}]},"ReasonText":{"oneOf":[{"type":"string","description":"Conditional. Detailed description or text of the cancel reason. Either ReasonCode or ReasonText must be provided. ExternalCancel request without both will cause failure.","example":"User requested cancellation"},{"type":"null","description":"Conditional. Detailed description or text of the cancel reason. Either ReasonCode or ReasonText must be provided. ExternalCancel request without both will cause failure.","example":"User requested cancellation"}]},"CancelAmount":{"oneOf":[{"type":"number","format":"double","description":"Always mandatory. Amount to be cancelled. Can’t be higher than the authorized amount.","example":5},{"type":"null","format":"double","description":"Always mandatory. Amount to be cancelled. Can’t be higher than the authorized amount.","example":5}]}},"uniqueKey":"oneOf.1","typeLabel":"null"}],"uniqueKey":"","typeLabel":"object | null"},"examples":{"Example":{"title":"Example","value":{"NayaxTransactionId":987654321,"SparkTransactionId":"f8e7d6c5-b4a3-2109-fedc-ba9876543210","SiteId":2,"MachineAuTime":"20251212110000500","TerminalId":"NX0087654321","TerminalIdType":1,"CancellationType":1,"ReasonCode":"01","ReasonText":"User requested cancellation","CancelAmount":5}}},"exampleType":"generated"},"text/json":{"schema":{"oneOf":[{"type":"object","description":"Request details for canceling an external payment transaction (e.g., voiding a pre-authorization).","properties":{"NayaxTransactionId":{"type":"integer","format":"int64","description":"Nayax Internal Unique identifier for the transaction being cancelled.","example":987654321,"uniqueKey":"oneOf.0.NayaxTransactionId","typeLabel":"integer\u003cint64>"},"SparkTransactionId":{"oneOf":[{"type":"string","description":"Spark Unique identifier for this transaction.","example":"f8e7d6c5-b4a3-2109-fedc-ba9876543210","uniqueKey":"oneOf.0.SparkTransactionId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Spark Unique identifier for this transaction.","example":"f8e7d6c5-b4a3-2109-fedc-ba9876543210","uniqueKey":"oneOf.0.SparkTransactionId.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.SparkTransactionId","typeLabel":"string | null"},"SiteId":{"oneOf":[{"type":"integer","format":"int16","description":"Optional. Indication for the Nayax Engine in which Site the transaction originated. Echo value from Authorization Callback.","example":2,"uniqueKey":"oneOf.0.SiteId.oneOf.0","typeLabel":"integer\u003cint16>"},{"type":"null","format":"int16","description":"Optional. Indication for the Nayax Engine in which Site the transaction originated. Echo value from Authorization Callback.","example":2,"uniqueKey":"oneOf.0.SiteId.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.SiteId","typeLabel":"integer\u003cint16> | 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":"20251212110000500","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":"20251212110000500","uniqueKey":"oneOf.0.MachineAuTime.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.MachineAuTime","typeLabel":"string\u003cyyyyMMddHHmmssfff.> | null"},"TerminalId":{"type":"string","nullable":false,"description":"Unique Identifier for the Nayax Terminal.","maxLength":255,"example":"NX0087654321","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"},"CancellationType":{"type":"integer","format":"int32","description":"Indicates which cancellation flow is implemented. 1 - Pre-Authorization Cancel, 2 - Pre-Selection Void","enum":[1,2],"example":1,"uniqueKey":"oneOf.0.CancellationType","typeLabel":"enum\u003cinteger>"},"ReasonCode":{"oneOf":[{"type":"string","format":"int16","description":"Conditional. Cancel reason code. See [Cancel Type Codes](/docs/cortina/cancel-types).","example":"01","uniqueKey":"oneOf.0.ReasonCode.oneOf.0","typeLabel":"string\u003cint16>"},{"type":"null","format":"int16","description":"Conditional. Cancel reason code. See [Cancel Type Codes](/docs/cortina/cancel-types).","example":"01","uniqueKey":"oneOf.0.ReasonCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.ReasonCode","typeLabel":"string\u003cint16> | null"},"ReasonText":{"oneOf":[{"type":"string","description":"Conditional. Detailed description or text of the cancel reason. Either ReasonCode or ReasonText must be provided. ExternalCancel request without both will cause failure.","example":"User requested cancellation","uniqueKey":"oneOf.0.ReasonText.oneOf.0","typeLabel":"string"},{"type":"null","description":"Conditional. Detailed description or text of the cancel reason. Either ReasonCode or ReasonText must be provided. ExternalCancel request without both will cause failure.","example":"User requested cancellation","uniqueKey":"oneOf.0.ReasonText.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.ReasonText","typeLabel":"string | null"},"CancelAmount":{"oneOf":[{"type":"number","format":"double","description":"Always mandatory. Amount to be cancelled. Can’t be higher than the authorized amount.","example":5,"uniqueKey":"oneOf.0.CancelAmount.oneOf.0","typeLabel":"number\u003cdouble>"},{"type":"null","format":"double","description":"Always mandatory. Amount to be cancelled. Can’t be higher than the authorized amount.","example":5,"uniqueKey":"oneOf.0.CancelAmount.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.CancelAmount","typeLabel":"number\u003cdouble> | null"}},"uniqueKey":"oneOf.0","typeLabel":"object"},{"type":"null","description":"Request details for canceling an external payment transaction (e.g., voiding a pre-authorization).","properties":{"NayaxTransactionId":{"type":"integer","format":"int64","description":"Nayax Internal Unique identifier for the transaction being cancelled.","example":987654321},"SparkTransactionId":{"oneOf":[{"type":"string","description":"Spark Unique identifier for this transaction.","example":"f8e7d6c5-b4a3-2109-fedc-ba9876543210"},{"type":"null","description":"Spark Unique identifier for this transaction.","example":"f8e7d6c5-b4a3-2109-fedc-ba9876543210"}]},"SiteId":{"oneOf":[{"type":"integer","format":"int16","description":"Optional. Indication for the Nayax Engine in which Site the transaction originated. Echo value from Authorization Callback.","example":2},{"type":"null","format":"int16","description":"Optional. Indication for the Nayax Engine in which Site the transaction originated. Echo value from Authorization Callback.","example":2}]},"MachineAuTime":{"oneOf":[{"type":"string","description":"The date time string of when the `/Authorization` or `/Sale` took place, in local (machine) time.","format":"yyyyMMddHHmmssfff.","example":"20251212110000500"},{"type":"null","description":"The date time string of when the `/Authorization` or `/Sale` took place, in local (machine) time.","format":"yyyyMMddHHmmssfff.","example":"20251212110000500"}]},"TerminalId":{"type":"string","nullable":false,"description":"Unique Identifier for the Nayax Terminal.","maxLength":255,"example":"NX0087654321"},"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}]},"CancellationType":{"type":"integer","format":"int32","description":"Indicates which cancellation flow is implemented. 1 - Pre-Authorization Cancel, 2 - Pre-Selection Void","enum":[1,2],"example":1},"ReasonCode":{"oneOf":[{"type":"string","format":"int16","description":"Conditional. Cancel reason code. See [Cancel Type Codes](/docs/cortina/cancel-types).","example":"01"},{"type":"null","format":"int16","description":"Conditional. Cancel reason code. See [Cancel Type Codes](/docs/cortina/cancel-types).","example":"01"}]},"ReasonText":{"oneOf":[{"type":"string","description":"Conditional. Detailed description or text of the cancel reason. Either ReasonCode or ReasonText must be provided. ExternalCancel request without both will cause failure.","example":"User requested cancellation"},{"type":"null","description":"Conditional. Detailed description or text of the cancel reason. Either ReasonCode or ReasonText must be provided. ExternalCancel request without both will cause failure.","example":"User requested cancellation"}]},"CancelAmount":{"oneOf":[{"type":"number","format":"double","description":"Always mandatory. Amount to be cancelled. Can’t be higher than the authorized amount.","example":5},{"type":"null","format":"double","description":"Always mandatory. Amount to be cancelled. Can’t be higher than the authorized amount.","example":5}]}},"uniqueKey":"oneOf.1","typeLabel":"null"}],"uniqueKey":"","typeLabel":"object | null"},"examples":{"Example":{"title":"Example","value":{"NayaxTransactionId":987654321,"SparkTransactionId":"f8e7d6c5-b4a3-2109-fedc-ba9876543210","SiteId":2,"MachineAuTime":"20251212110000500","TerminalId":"NX0087654321","TerminalIdType":1,"CancellationType":1,"ReasonCode":"01","ReasonText":"User requested cancellation","CancelAmount":5}}},"exampleType":"generated"},"application/*+json":{"schema":{"oneOf":[{"type":"object","description":"Request details for canceling an external payment transaction (e.g., voiding a pre-authorization).","properties":{"NayaxTransactionId":{"type":"integer","format":"int64","description":"Nayax Internal Unique identifier for the transaction being cancelled.","example":987654321,"uniqueKey":"oneOf.0.NayaxTransactionId","typeLabel":"integer\u003cint64>"},"SparkTransactionId":{"oneOf":[{"type":"string","description":"Spark Unique identifier for this transaction.","example":"f8e7d6c5-b4a3-2109-fedc-ba9876543210","uniqueKey":"oneOf.0.SparkTransactionId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Spark Unique identifier for this transaction.","example":"f8e7d6c5-b4a3-2109-fedc-ba9876543210","uniqueKey":"oneOf.0.SparkTransactionId.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.SparkTransactionId","typeLabel":"string | null"},"SiteId":{"oneOf":[{"type":"integer","format":"int16","description":"Optional. Indication for the Nayax Engine in which Site the transaction originated. Echo value from Authorization Callback.","example":2,"uniqueKey":"oneOf.0.SiteId.oneOf.0","typeLabel":"integer\u003cint16>"},{"type":"null","format":"int16","description":"Optional. Indication for the Nayax Engine in which Site the transaction originated. Echo value from Authorization Callback.","example":2,"uniqueKey":"oneOf.0.SiteId.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.SiteId","typeLabel":"integer\u003cint16> | 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":"20251212110000500","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":"20251212110000500","uniqueKey":"oneOf.0.MachineAuTime.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.MachineAuTime","typeLabel":"string\u003cyyyyMMddHHmmssfff.> | null"},"TerminalId":{"type":"string","nullable":false,"description":"Unique Identifier for the Nayax Terminal.","maxLength":255,"example":"NX0087654321","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"},"CancellationType":{"type":"integer","format":"int32","description":"Indicates which cancellation flow is implemented. 1 - Pre-Authorization Cancel, 2 - Pre-Selection Void","enum":[1,2],"example":1,"uniqueKey":"oneOf.0.CancellationType","typeLabel":"enum\u003cinteger>"},"ReasonCode":{"oneOf":[{"type":"string","format":"int16","description":"Conditional. Cancel reason code. See [Cancel Type Codes](/docs/cortina/cancel-types).","example":"01","uniqueKey":"oneOf.0.ReasonCode.oneOf.0","typeLabel":"string\u003cint16>"},{"type":"null","format":"int16","description":"Conditional. Cancel reason code. See [Cancel Type Codes](/docs/cortina/cancel-types).","example":"01","uniqueKey":"oneOf.0.ReasonCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.ReasonCode","typeLabel":"string\u003cint16> | null"},"ReasonText":{"oneOf":[{"type":"string","description":"Conditional. Detailed description or text of the cancel reason. Either ReasonCode or ReasonText must be provided. ExternalCancel request without both will cause failure.","example":"User requested cancellation","uniqueKey":"oneOf.0.ReasonText.oneOf.0","typeLabel":"string"},{"type":"null","description":"Conditional. Detailed description or text of the cancel reason. Either ReasonCode or ReasonText must be provided. ExternalCancel request without both will cause failure.","example":"User requested cancellation","uniqueKey":"oneOf.0.ReasonText.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.ReasonText","typeLabel":"string | null"},"CancelAmount":{"oneOf":[{"type":"number","format":"double","description":"Always mandatory. Amount to be cancelled. Can’t be higher than the authorized amount.","example":5,"uniqueKey":"oneOf.0.CancelAmount.oneOf.0","typeLabel":"number\u003cdouble>"},{"type":"null","format":"double","description":"Always mandatory. Amount to be cancelled. Can’t be higher than the authorized amount.","example":5,"uniqueKey":"oneOf.0.CancelAmount.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.CancelAmount","typeLabel":"number\u003cdouble> | null"}},"uniqueKey":"oneOf.0","typeLabel":"object"},{"type":"null","description":"Request details for canceling an external payment transaction (e.g., voiding a pre-authorization).","properties":{"NayaxTransactionId":{"type":"integer","format":"int64","description":"Nayax Internal Unique identifier for the transaction being cancelled.","example":987654321},"SparkTransactionId":{"oneOf":[{"type":"string","description":"Spark Unique identifier for this transaction.","example":"f8e7d6c5-b4a3-2109-fedc-ba9876543210"},{"type":"null","description":"Spark Unique identifier for this transaction.","example":"f8e7d6c5-b4a3-2109-fedc-ba9876543210"}]},"SiteId":{"oneOf":[{"type":"integer","format":"int16","description":"Optional. Indication for the Nayax Engine in which Site the transaction originated. Echo value from Authorization Callback.","example":2},{"type":"null","format":"int16","description":"Optional. Indication for the Nayax Engine in which Site the transaction originated. Echo value from Authorization Callback.","example":2}]},"MachineAuTime":{"oneOf":[{"type":"string","description":"The date time string of when the `/Authorization` or `/Sale` took place, in local (machine) time.","format":"yyyyMMddHHmmssfff.","example":"20251212110000500"},{"type":"null","description":"The date time string of when the `/Authorization` or `/Sale` took place, in local (machine) time.","format":"yyyyMMddHHmmssfff.","example":"20251212110000500"}]},"TerminalId":{"type":"string","nullable":false,"description":"Unique Identifier for the Nayax Terminal.","maxLength":255,"example":"NX0087654321"},"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}]},"CancellationType":{"type":"integer","format":"int32","description":"Indicates which cancellation flow is implemented. 1 - Pre-Authorization Cancel, 2 - Pre-Selection Void","enum":[1,2],"example":1},"ReasonCode":{"oneOf":[{"type":"string","format":"int16","description":"Conditional. Cancel reason code. See [Cancel Type Codes](/docs/cortina/cancel-types).","example":"01"},{"type":"null","format":"int16","description":"Conditional. Cancel reason code. See [Cancel Type Codes](/docs/cortina/cancel-types).","example":"01"}]},"ReasonText":{"oneOf":[{"type":"string","description":"Conditional. Detailed description or text of the cancel reason. Either ReasonCode or ReasonText must be provided. ExternalCancel request without both will cause failure.","example":"User requested cancellation"},{"type":"null","description":"Conditional. Detailed description or text of the cancel reason. Either ReasonCode or ReasonText must be provided. ExternalCancel request without both will cause failure.","example":"User requested cancellation"}]},"CancelAmount":{"oneOf":[{"type":"number","format":"double","description":"Always mandatory. Amount to be cancelled. Can’t be higher than the authorized amount.","example":5},{"type":"null","format":"double","description":"Always mandatory. Amount to be cancelled. Can’t be higher than the authorized amount.","example":5}]}},"uniqueKey":"oneOf.1","typeLabel":"null"}],"uniqueKey":"","typeLabel":"object | null"},"examples":{"Example":{"title":"Example","value":{"NayaxTransactionId":987654321,"SparkTransactionId":"f8e7d6c5-b4a3-2109-fedc-ba9876543210","SiteId":2,"MachineAuTime":"20251212110000500","TerminalId":"NX0087654321","TerminalIdType":1,"CancellationType":1,"ReasonCode":"01","ReasonText":"User requested cancellation","CancelAmount":5}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"27558251-3d27-4b92-8bc0-ebe27b349668":{"description":"Success","content":{"text/plain":{"schema":{"oneOf":[{"type":"object","description":"Response details for an external transaction cancellation request.","properties":{"SparkTransactionId":{"oneOf":[{"type":"string","description":"The Spark unique identifier for this transaction.","example":"f8e7d6c5-b4a3-2109-fedc-ba9876543210","uniqueKey":"oneOf.0.SparkTransactionId.oneOf.0","typeLabel":"string"},{"type":"null","description":"The Spark unique identifier for this transaction.","example":"f8e7d6c5-b4a3-2109-fedc-ba9876543210","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 cancellation request.","properties":{"Verdict":{"type":"string","nullable":false,"description":"Status of the request (Approved / Declined)","uniqueKey":"oneOf.0.Status.Verdict","typeLabel":"string"},"ErrorCode":{"oneOf":[{"type":"integer","format":"int16","description":"- Conditional\n- Reason for declined request\n","uniqueKey":"oneOf.0.Status.ErrorCode.oneOf.0","typeLabel":"integer\u003cint16>"},{"type":"null","format":"int16","description":"- Conditional\n- Reason for declined request\n","uniqueKey":"oneOf.0.Status.ErrorCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.Status.ErrorCode","typeLabel":"integer\u003cint16> | null"},"ErrorDescription":{"oneOf":[{"type":"string","description":"- Conditional\n- Length: 255\n- Error description\n","uniqueKey":"oneOf.0.Status.ErrorDescription.oneOf.0","typeLabel":"string"},{"type":"null","description":"- Conditional\n- Length: 255\n- Error description\n","uniqueKey":"oneOf.0.Status.ErrorDescription.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.Status.ErrorDescription","typeLabel":"string | null"},"StatusMessage":{"oneOf":[{"type":"string","description":"- Optional\n- Length: 255\n- Transaction status message as free text field\n","uniqueKey":"oneOf.0.Status.StatusMessage.oneOf.0","typeLabel":"string"},{"type":"null","description":"- Optional\n- Length: 255\n- Transaction status message as free text field\n","uniqueKey":"oneOf.0.Status.StatusMessage.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.Status.StatusMessage","typeLabel":"string | null"}},"uniqueKey":"oneOf.0.Status","typeLabel":"object"},"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":"D4E5F6","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":"D4E5F6","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. \n","format":"yyyyMMddHHmmssfff","example":"20251212110000500","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. \n","format":"yyyyMMddHHmmssfff","example":"20251212110000500","uniqueKey":"oneOf.0.MachineAuTime.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.MachineAuTime","typeLabel":"string\u003cyyyyMMddHHmmssfff> | null"}},"uniqueKey":"oneOf.0","typeLabel":"object"},{"type":"null","description":"Response details for an external transaction cancellation request.","properties":{"SparkTransactionId":{"oneOf":[{"type":"string","description":"The Spark unique identifier for this transaction.","example":"f8e7d6c5-b4a3-2109-fedc-ba9876543210"},{"type":"null","description":"The Spark unique identifier for this transaction.","example":"f8e7d6c5-b4a3-2109-fedc-ba9876543210"}]},"Status":{"type":"object","nullable":false,"description":"The status of the cancellation request.","properties":{"Verdict":{"type":"string","nullable":false,"description":"Status of the request (Approved / Declined)"},"ErrorCode":{"oneOf":[{"type":"integer","format":"int16","description":"- Conditional\n- Reason for declined request\n"},{"type":"null","format":"int16","description":"- Conditional\n- Reason for declined request\n"}]},"ErrorDescription":{"oneOf":[{"type":"string","description":"- Conditional\n- Length: 255\n- Error description\n"},{"type":"null","description":"- Conditional\n- Length: 255\n- Error description\n"}]},"StatusMessage":{"oneOf":[{"type":"string","description":"- Optional\n- Length: 255\n- Transaction status message as free text field\n"},{"type":"null","description":"- Optional\n- Length: 255\n- Transaction status message as free text field\n"}]}}},"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":"D4E5F6"},{"type":"null","description":"For Credit card implementation, when the transaction is approved, this is the External (usually Card issuer's) Authorization Code.","example":"D4E5F6"}]},"MachineAuTime":{"oneOf":[{"type":"string","description":"The date time string of when the `/Authorization` or `/Sale` took place, in local (machine) time. \n","format":"yyyyMMddHHmmssfff","example":"20251212110000500"},{"type":"null","description":"The date time string of when the `/Authorization` or `/Sale` took place, in local (machine) time. \n","format":"yyyyMMddHHmmssfff","example":"20251212110000500"}]}},"uniqueKey":"oneOf.1","typeLabel":"null"}],"uniqueKey":"","typeLabel":"object | null"},"examples":{"Example":{"title":"Example","value":{"SparkTransactionId":"f8e7d6c5-b4a3-2109-fedc-ba9876543210","Status":{"Verdict":"\u003cstring>","ErrorCode":123,"ErrorDescription":"\u003cstring>","StatusMessage":"\u003cstring>"},"AuthCode":"D4E5F6","MachineAuTime":"20251212110000500"}}},"exampleType":"generated"},"application/json":{"schema":{"oneOf":[{"type":"object","description":"Response details for an external transaction cancellation request.","properties":{"SparkTransactionId":{"oneOf":[{"type":"string","description":"The Spark unique identifier for this transaction.","example":"f8e7d6c5-b4a3-2109-fedc-ba9876543210","uniqueKey":"oneOf.0.SparkTransactionId.oneOf.0","typeLabel":"string"},{"type":"null","description":"The Spark unique identifier for this transaction.","example":"f8e7d6c5-b4a3-2109-fedc-ba9876543210","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 cancellation request.","properties":{"Verdict":{"type":"string","nullable":false,"description":"Status of the request (Approved / Declined)","uniqueKey":"oneOf.0.Status.Verdict","typeLabel":"string"},"ErrorCode":{"oneOf":[{"type":"integer","format":"int16","description":"- Conditional\n- Reason for declined request\n","uniqueKey":"oneOf.0.Status.ErrorCode.oneOf.0","typeLabel":"integer\u003cint16>"},{"type":"null","format":"int16","description":"- Conditional\n- Reason for declined request\n","uniqueKey":"oneOf.0.Status.ErrorCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.Status.ErrorCode","typeLabel":"integer\u003cint16> | null"},"ErrorDescription":{"oneOf":[{"type":"string","description":"- Conditional\n- Length: 255\n- Error description\n","uniqueKey":"oneOf.0.Status.ErrorDescription.oneOf.0","typeLabel":"string"},{"type":"null","description":"- Conditional\n- Length: 255\n- Error description\n","uniqueKey":"oneOf.0.Status.ErrorDescription.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.Status.ErrorDescription","typeLabel":"string | null"},"StatusMessage":{"oneOf":[{"type":"string","description":"- Optional\n- Length: 255\n- Transaction status message as free text field\n","uniqueKey":"oneOf.0.Status.StatusMessage.oneOf.0","typeLabel":"string"},{"type":"null","description":"- Optional\n- Length: 255\n- Transaction status message as free text field\n","uniqueKey":"oneOf.0.Status.StatusMessage.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.Status.StatusMessage","typeLabel":"string | null"}},"uniqueKey":"oneOf.0.Status","typeLabel":"object"},"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":"D4E5F6","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":"D4E5F6","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. \n","format":"yyyyMMddHHmmssfff","example":"20251212110000500","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. \n","format":"yyyyMMddHHmmssfff","example":"20251212110000500","uniqueKey":"oneOf.0.MachineAuTime.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.MachineAuTime","typeLabel":"string\u003cyyyyMMddHHmmssfff> | null"}},"uniqueKey":"oneOf.0","typeLabel":"object"},{"type":"null","description":"Response details for an external transaction cancellation request.","properties":{"SparkTransactionId":{"oneOf":[{"type":"string","description":"The Spark unique identifier for this transaction.","example":"f8e7d6c5-b4a3-2109-fedc-ba9876543210"},{"type":"null","description":"The Spark unique identifier for this transaction.","example":"f8e7d6c5-b4a3-2109-fedc-ba9876543210"}]},"Status":{"type":"object","nullable":false,"description":"The status of the cancellation request.","properties":{"Verdict":{"type":"string","nullable":false,"description":"Status of the request (Approved / Declined)"},"ErrorCode":{"oneOf":[{"type":"integer","format":"int16","description":"- Conditional\n- Reason for declined request\n"},{"type":"null","format":"int16","description":"- Conditional\n- Reason for declined request\n"}]},"ErrorDescription":{"oneOf":[{"type":"string","description":"- Conditional\n- Length: 255\n- Error description\n"},{"type":"null","description":"- Conditional\n- Length: 255\n- Error description\n"}]},"StatusMessage":{"oneOf":[{"type":"string","description":"- Optional\n- Length: 255\n- Transaction status message as free text field\n"},{"type":"null","description":"- Optional\n- Length: 255\n- Transaction status message as free text field\n"}]}}},"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":"D4E5F6"},{"type":"null","description":"For Credit card implementation, when the transaction is approved, this is the External (usually Card issuer's) Authorization Code.","example":"D4E5F6"}]},"MachineAuTime":{"oneOf":[{"type":"string","description":"The date time string of when the `/Authorization` or `/Sale` took place, in local (machine) time. \n","format":"yyyyMMddHHmmssfff","example":"20251212110000500"},{"type":"null","description":"The date time string of when the `/Authorization` or `/Sale` took place, in local (machine) time. \n","format":"yyyyMMddHHmmssfff","example":"20251212110000500"}]}},"uniqueKey":"oneOf.1","typeLabel":"null"}],"uniqueKey":"","typeLabel":"object | null"},"examples":{"Example":{"title":"Example","value":{"SparkTransactionId":"f8e7d6c5-b4a3-2109-fedc-ba9876543210","Status":{"Verdict":"\u003cstring>","ErrorCode":123,"ErrorDescription":"\u003cstring>","StatusMessage":"\u003cstring>"},"AuthCode":"D4E5F6","MachineAuTime":"20251212110000500"}}},"exampleType":"generated"},"text/json":{"schema":{"oneOf":[{"type":"object","description":"Response details for an external transaction cancellation request.","properties":{"SparkTransactionId":{"oneOf":[{"type":"string","description":"The Spark unique identifier for this transaction.","example":"f8e7d6c5-b4a3-2109-fedc-ba9876543210","uniqueKey":"oneOf.0.SparkTransactionId.oneOf.0","typeLabel":"string"},{"type":"null","description":"The Spark unique identifier for this transaction.","example":"f8e7d6c5-b4a3-2109-fedc-ba9876543210","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 cancellation request.","properties":{"Verdict":{"type":"string","nullable":false,"description":"Status of the request (Approved / Declined)","uniqueKey":"oneOf.0.Status.Verdict","typeLabel":"string"},"ErrorCode":{"oneOf":[{"type":"integer","format":"int16","description":"- Conditional\n- Reason for declined request\n","uniqueKey":"oneOf.0.Status.ErrorCode.oneOf.0","typeLabel":"integer\u003cint16>"},{"type":"null","format":"int16","description":"- Conditional\n- Reason for declined request\n","uniqueKey":"oneOf.0.Status.ErrorCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.Status.ErrorCode","typeLabel":"integer\u003cint16> | null"},"ErrorDescription":{"oneOf":[{"type":"string","description":"- Conditional\n- Length: 255\n- Error description\n","uniqueKey":"oneOf.0.Status.ErrorDescription.oneOf.0","typeLabel":"string"},{"type":"null","description":"- Conditional\n- Length: 255\n- Error description\n","uniqueKey":"oneOf.0.Status.ErrorDescription.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.Status.ErrorDescription","typeLabel":"string | null"},"StatusMessage":{"oneOf":[{"type":"string","description":"- Optional\n- Length: 255\n- Transaction status message as free text field\n","uniqueKey":"oneOf.0.Status.StatusMessage.oneOf.0","typeLabel":"string"},{"type":"null","description":"- Optional\n- Length: 255\n- Transaction status message as free text field\n","uniqueKey":"oneOf.0.Status.StatusMessage.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.Status.StatusMessage","typeLabel":"string | null"}},"uniqueKey":"oneOf.0.Status","typeLabel":"object"},"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":"D4E5F6","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":"D4E5F6","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. \n","format":"yyyyMMddHHmmssfff","example":"20251212110000500","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. \n","format":"yyyyMMddHHmmssfff","example":"20251212110000500","uniqueKey":"oneOf.0.MachineAuTime.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.MachineAuTime","typeLabel":"string\u003cyyyyMMddHHmmssfff> | null"}},"uniqueKey":"oneOf.0","typeLabel":"object"},{"type":"null","description":"Response details for an external transaction cancellation request.","properties":{"SparkTransactionId":{"oneOf":[{"type":"string","description":"The Spark unique identifier for this transaction.","example":"f8e7d6c5-b4a3-2109-fedc-ba9876543210"},{"type":"null","description":"The Spark unique identifier for this transaction.","example":"f8e7d6c5-b4a3-2109-fedc-ba9876543210"}]},"Status":{"type":"object","nullable":false,"description":"The status of the cancellation request.","properties":{"Verdict":{"type":"string","nullable":false,"description":"Status of the request (Approved / Declined)"},"ErrorCode":{"oneOf":[{"type":"integer","format":"int16","description":"- Conditional\n- Reason for declined request\n"},{"type":"null","format":"int16","description":"- Conditional\n- Reason for declined request\n"}]},"ErrorDescription":{"oneOf":[{"type":"string","description":"- Conditional\n- Length: 255\n- Error description\n"},{"type":"null","description":"- Conditional\n- Length: 255\n- Error description\n"}]},"StatusMessage":{"oneOf":[{"type":"string","description":"- Optional\n- Length: 255\n- Transaction status message as free text field\n"},{"type":"null","description":"- Optional\n- Length: 255\n- Transaction status message as free text field\n"}]}}},"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":"D4E5F6"},{"type":"null","description":"For Credit card implementation, when the transaction is approved, this is the External (usually Card issuer's) Authorization Code.","example":"D4E5F6"}]},"MachineAuTime":{"oneOf":[{"type":"string","description":"The date time string of when the `/Authorization` or `/Sale` took place, in local (machine) time. \n","format":"yyyyMMddHHmmssfff","example":"20251212110000500"},{"type":"null","description":"The date time string of when the `/Authorization` or `/Sale` took place, in local (machine) time. \n","format":"yyyyMMddHHmmssfff","example":"20251212110000500"}]}},"uniqueKey":"oneOf.1","typeLabel":"null"}],"uniqueKey":"","typeLabel":"object | null"},"examples":{"Example":{"title":"Example","value":{"SparkTransactionId":"f8e7d6c5-b4a3-2109-fedc-ba9876543210","Status":{"Verdict":"\u003cstring>","ErrorCode":123,"ErrorDescription":"\u003cstring>","StatusMessage":"\u003cstring>"},"AuthCode":"D4E5F6","MachineAuTime":"20251212110000500"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{},"servers":{"c8ac8999-db88-417b-af04-ab5e9e4589ec":{"url":"https://nayax-spark-dmz.nayax.com/api","description":"The same host serves the integration and production environments."}}},"originalFileLocation":"openapi/spark.yaml"},"subdomain":"nayax-44d6e37b","siteName":"Nayax Developer Portal","title":"ExternalCancel - Nayax Developer Portal","contextualStarterQuestions":[{"_id":"6aa1a3c1370ee193ba7f6386","deploymentId":"69981f91cf2ae4e6561a0441","questionText":"What does error code 51 mean?","status":"active","generatedBy":"contextual","path":"reference/spark/transactions/externalcancel","createdAt":"2026-09-09T18:21:53.875Z","updatedAt":"2026-09-09T18:21:53.875Z","__v":0},{"_id":"6aa1a3c1370ee193ba7f6385","deploymentId":"69981f91cf2ae4e6561a0441","questionText":"What identifiers do I need?","status":"active","generatedBy":"contextual","path":"reference/spark/transactions/externalcancel","createdAt":"2026-09-09T18:21:53.875Z","updatedAt":"2026-09-09T18:21:53.875Z","__v":0},{"_id":"6aa1a3c1370ee193ba7f6384","deploymentId":"69981f91cf2ae4e6561a0441","questionText":"When should I cancel a transaction?","status":"active","generatedBy":"contextual","path":"reference/spark/transactions/externalcancel","createdAt":"2026-09-09T18:21:53.875Z","updatedAt":"2026-09-09T18:21:53.875Z","__v":0}],"navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"en":{"href":"/reference/spark/transactions/externalcancel","matchLevel":0},"zh":{"href":"/reference/zh/spark/transactions/externalcancel","matchLevel":1}}},"lastModified":"2026-11-09T11:55:21.917Z","originalFileLocation":"reference/spark/transactions/externalcancel.mdx","locale":"en"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"application-name\" content=\"Nayax Developer Portal\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/nayax-44d6e37b/IDkKyIWxcB2-beJ3/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/nayax-44d6e37b/IDkKyIWxcB2-beJ3/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/nayax-44d6e37b/IDkKyIWxcB2-beJ3/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/nayax-44d6e37b/IDkKyIWxcB2-beJ3/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/nayax-44d6e37b/IDkKyIWxcB2-beJ3/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/nayax-44d6e37b/IDkKyIWxcB2-beJ3/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/nayax-44d6e37b/IDkKyIWxcB2-beJ3/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/nayax-44d6e37b/IDkKyIWxcB2-beJ3/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/nayax-44d6e37b/IDkKyIWxcB2-beJ3/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"ExternalCancel - Nayax Developer Portal\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Nayax Developer Portal\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://devzone.nayax.com/reference/spark/transactions/externalcancel\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://nayax-44d6e37b.mintlify.site/_mintlify/api/og/v2?division=Transactions\u0026amp;title=ExternalCancel\u0026amp;theme=42406d98d632f71b622c3323\u0026amp;signature=965afeff8a8daad2d85950fb21212e777cc5f189056b7b0c0bce5a422ba1a11c\">\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=\"ExternalCancel - Nayax Developer Portal\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://nayax-44d6e37b.mintlify.site/_mintlify/api/og/v2?division=Transactions\u0026amp;title=ExternalCancel\u0026amp;theme=42406d98d632f71b622c3323\u0026amp;signature=965afeff8a8daad2d85950fb21212e777cc5f189056b7b0c0bce5a422ba1a11c\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/nayax-44d6e37b/IDkKyIWxcB2-beJ3/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Nayax Developer Portal\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#6352E0\">\u003clink data-mint-head rel=\"canonical\" href=\"https://devzone.nayax.com/reference/spark/transactions/externalcancel\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/reference/spark/transactions/externalcancel.md\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"en\" href=\"https://devzone.nayax.com/reference/spark/transactions/externalcancel\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"zh\" href=\"https://devzone.nayax.com/reference/zh/spark/transactions/externalcancel\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"x-default\" href=\"https://devzone.nayax.com/reference/spark/transactions/externalcancel\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://devzone.nayax.com/#organization\",\"name\":\"Nayax Developer Portal\",\"url\":\"https://devzone.nayax.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/nayax-44d6e37b/ag7p0QchXLJNEuNE/images/home/logo_light.svg?fit=max\u0026auto=format\u0026n=ag7p0QchXLJNEuNE\u0026q=85\u0026s=b71aa1a61014633be60cee745d3e978c\"}},{\"@type\":\"WebSite\",\"@id\":\"https://devzone.nayax.com#website\",\"name\":\"Nayax Developer Portal\",\"url\":\"https://devzone.nayax.com\",\"publisher\":{\"@id\":\"https://devzone.nayax.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://devzone.nayax.com/reference/spark/transactions/externalcancel#webpage\",\"url\":\"https://devzone.nayax.com/reference/spark/transactions/externalcancel\",\"name\":\"ExternalCancel\",\"dateModified\":\"2026-11-09T11:55:21.917Z\",\"isPartOf\":{\"@id\":\"https://devzone.nayax.com#website\"},\"breadcrumb\":{\"@id\":\"https://devzone.nayax.com/reference/spark/transactions/externalcancel#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://devzone.nayax.com/reference/spark/transactions/externalcancel#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API Reference\",\"item\":\"https://devzone.nayax.com/reference/spark/transactions/get-version\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Transactions\",\"item\":\"https://devzone.nayax.com/reference/spark/transactions/get-version\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"ExternalCancel\",\"item\":\"https://devzone.nayax.com/reference/spark/transactions/externalcancel\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://devzone.nayax.com/reference/spark/transactions/externalcancel#apireference\",\"headline\":\"ExternalCancel\",\"name\":\"ExternalCancel\",\"url\":\"https://devzone.nayax.com/reference/spark/transactions/externalcancel\",\"mainEntityOfPage\":{\"@id\":\"https://devzone.nayax.com/reference/spark/transactions/externalcancel#webpage\"},\"dateModified\":\"2026-11-09T11:55:21.917Z\",\"publisher\":{\"@id\":\"https://devzone.nayax.com/#organization\"},\"isPartOf\":{\"@id\":\"https://devzone.nayax.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Nayax Developer Portal\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Nayax Developer Portal\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/reference/spark/transactions/externalcancel.md","siteName":"Nayax Developer Portal","nav":{"global":null,"languages":[{"language":"en","default":true,"tabs":[{"tab":"Docs Home","icon":"home","pages":[{"title":"Docs Home","href":""}]},{"tab":"Terminal SDKs","menu":[{"item":"Marshall","pages":[{"title":"Marshall","href":"/docs/integrate-pos-device/marshall/marshall-sdk"}]},{"item":"Marshall Pro (Fuel)","pages":[{"title":"Marshall Pro (Fuel)","href":"/docs/integrate-pos-device/marshall-pro/getting-started"}]},{"item":"TweezerComm","pages":[{"title":"TweezerComm","href":"/docs/integrate-pos-device/tweezercomm/overview-tweezer"}]},{"item":"EMV Core","pages":[{"title":"EMV Core","href":"/docs/integrate-pos-device/emv-core/overview"}]},{"item":"Spark","groups":[{"group":"Spark Guides","pages":[{"title":"Overview","href":"/docs/integrate-pos-device/spark/spark"},{"title":"Integration Process","href":"/docs/integrate-pos-device/spark/spark-integration-process"},{"title":"Spark Network Requirements","sidebarTitle":"Network Requirements","href":"/docs/integrate-pos-device/spark/spark-network-requirement"},{"group":"Security \u0026 Authentication","root":{"title":"Security \u0026 Authentication","href":"/docs/integrate-pos-device/spark/security-authentication/index"},"pages":[{"title":"Authentication","href":"/docs/integrate-pos-device/spark/security-authentication/spark-authentication"},{"title":"Legacy Authentication","href":"/docs/integrate-pos-device/spark/security-authentication/spark-legacy-authentication"},{"title":"Interactive Authentication Tool","href":"/docs/integrate-pos-device/spark/security-authentication/spark-auth-tool"}]},{"group":"Payment Flows","root":{"mode":"wide","title":"Payment Flows","href":"/docs/integrate-pos-device/spark/payment-flows/transaction-flows-spark"},"pages":[{"title":"Device Start","href":"/docs/integrate-pos-device/spark/payment-flows/spark-device-start"},{"title":"Remote Start","href":"/docs/integrate-pos-device/spark/payment-flows/spark-remote-start"},{"title":"Device Stop","href":"/docs/integrate-pos-device/spark/payment-flows/spark-device-stop"},{"title":"External Settlement","href":"/docs/integrate-pos-device/spark/payment-flows/external-settlement"},{"title":"External Cancel","href":"/docs/integrate-pos-device/spark/payment-flows/external-cancel"}]},{"group":"Machine Configuration","root":{"title":"Machine Configuration Overview","href":"/docs/integrate-pos-device/spark/machine-configuration/index"},"pages":[{"title":"Remote Start Configuration","href":"/docs/integrate-pos-device/spark/machine-configuration/spark-remote-start-configuration"},{"title":"Device Start Configuration","href":"/docs/integrate-pos-device/spark/machine-configuration/spark-device-start-configuration"},{"title":"Device Stop Configuration","href":"/docs/integrate-pos-device/spark/machine-configuration/spark-device-stop-configuration"},{"title":"External Settlement Configuration","href":"/docs/integrate-pos-device/spark/machine-configuration/spark-external-settlement-configuration"},{"title":"Additional Features","href":"/docs/integrate-pos-device/spark/machine-configuration/additional-features"}]},{"group":"Webhook Callbacks","root":{"title":"Webhook Callbacks","href":"/docs/integrate-pos-device/spark/webhook-callbacks/index"},"pages":[{"title":"TransactionCallback","href":"/docs/integrate-pos-device/spark/webhook-callbacks/transactioncallback"},{"title":"StopCallback","href":"/docs/integrate-pos-device/spark/webhook-callbacks/stopcallback"},{"title":"TimeoutCallback","href":"/docs/integrate-pos-device/spark/webhook-callbacks/timeoutcallback"},{"title":"DeclineCallback","href":"/docs/integrate-pos-device/spark/webhook-callbacks/declinecallback"}]},{"group":"Additional Resources","root":{"title":"Additional Resources","href":"/docs/integrate-pos-device/spark/additional-resources/index"},"pages":[{"title":"Closed Loop Card Support","href":"/docs/integrate-pos-device/spark/additional-resources/smc-support"},{"title":"PosDisplay Format","href":"/docs/integrate-pos-device/spark/additional-resources/spark-posdisplay-format"},{"title":"eReceiptData Format","href":"/docs/integrate-pos-device/spark/additional-resources/spark-ereceiptdata-format"},{"title":"Response Codes","href":"/docs/integrate-pos-device/spark/additional-resources/spark-response-codes"}]},{"group":"Sample Codes","pages":[{"title":"Authentication Code Sample","href":"/docs/integrate-pos-device/spark/sample-codes/spark-authentication-code-sample"}]}]},{"group":"API Reference","pages":[{"group":"Transactions","pages":[{"title":"Get Version","description":null,"deprecated":null,"version":null,"openapi":"/openapi/spark.yaml get /Version","href":"/reference/spark/transactions/get-version"},{"title":"ExternalCancel","deprecated":null,"version":null,"openapi":"/openapi/spark.yaml post /ExternalCancel","href":"/reference/spark/transactions/externalcancel"},{"title":"ExternalSettlement","description":null,"deprecated":null,"version":null,"openapi":"/openapi/spark.yaml post /ExternalSettlement","href":"/reference/spark/transactions/externalsettlement"},{"title":"StartAuthentication","deprecated":null,"version":null,"openapi":"/openapi/spark.yaml post /StartAuthentication","href":"/reference/spark/transactions/startauthentication"},{"title":"StartSession","deprecated":null,"version":null,"openapi":"/openapi/spark.yaml post /StartSession","href":"/reference/spark/transactions/startsession"},{"title":"TriggerTransaction","deprecated":null,"version":null,"openapi":"/openapi/spark.yaml post /TriggerTransaction","href":"/reference/spark/transactions/triggertransaction"},{"title":"TransactionCallback","deprecated":null,"version":null,"openapi":"/openapi/spark.yaml post /TransactionCallback","href":"/reference/spark/transactions/transactioncallback"},{"title":"TransactionNotify","deprecated":null,"version":null,"openapi":"/openapi/spark.yaml post /TransactionNotify","href":"/reference/spark/transactions/transactionnotify"},{"title":"Settlement","deprecated":null,"version":null,"openapi":"/openapi/spark.yaml post /Settlement","href":"/reference/spark/transactions/settlement"},{"title":"TimeoutCallback","deprecated":null,"version":null,"openapi":"/openapi/spark.yaml post /TimeoutCallback","href":"/reference/spark/transactions/timeoutcallback"},{"title":"CancelTransaction","deprecated":null,"version":null,"openapi":"/openapi/spark.yaml post /CancelTransaction","href":"/reference/spark/transactions/canceltransaction"},{"title":"StopNotify","deprecated":null,"version":null,"openapi":"/openapi/spark.yaml post /StopNotify","href":"/reference/spark/transactions/stopnotify"},{"title":"AvailabilityCheck","deprecated":null,"version":null,"openapi":"/openapi/spark.yaml post /AvailabilityCheck","href":"/reference/spark/transactions/availabilitycheck"},{"title":"StopCallback","deprecated":null,"version":null,"openapi":"/openapi/spark.yaml post /StopCallback","href":"/reference/spark/transactions/stopcallback"},{"title":"DeclineCallback","deprecated":null,"version":null,"openapi":"/openapi/spark.yaml post /DeclineCallback","href":"/reference/spark/transactions/declinecallback"},{"title":"InfoQuery","deprecated":null,"version":null,"openapi":"/openapi/spark.yaml post /InfoQuery","href":"/reference/spark/transactions/infoquery"}]}]}]}]},{"tab":"Platform Management","menu":[{"item":"Transaction Reporting","pages":[{"title":"Transaction Reporting","href":"/docs/manage-data-operations/amazon-sqs/overview"}]},{"item":"Lynx API","pages":[{"title":"Lynx API","href":"/docs/manage-data-operations/lynx-api/lynx-overview"}]}],"pages":[{"title":"Platform Management","href":"/docs/manage-data-operations/amazon-sqs/overview"}]},{"tab":"Core Extension","pages":[{"title":"Core Extension","href":"/docs/core-extension/overview"}]},{"tab":"Cortina","pages":[{"title":"Cortina","href":"/docs/cortina/overview-cortina"}]},{"tab":"Build with AI","pages":[{"title":"Build with AI","href":"/docs/get-started/build-with-ai"}]},{"tab":"Release Notes","href":"https://www.nayax.com/product-updates/integrated-pos/integrated-vpos-touch-onyx/"},{"tab":"Support \u0026 Trust","menu":[{"item":"Help Center","href":"https://nayax-u.nayax.com/"},{"item":"Certifications","pages":[{"title":"Certifications","href":"/docs/get-started/certifications"}]},{"item":"Integration FAQ","pages":[{"title":"Integration FAQ","href":"/docs/get-started/integration-faq"}]}],"pages":[{"title":"Support \u0026 Trust","href":"/docs/get-started/certifications"}]}]},{"language":"zh","pages":[{"title":"zh","href":"/reference/zh/spark/transactions/externalcancel"}]}]},"basePath":"","title":"ExternalCancel - Nayax Developer Portal","buildId":"dpl_596ePT575z4qnAFksq1biRW97aLY","deploymentId":"dpl_596ePT575z4qnAFksq1biRW97aLY","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-C9Wu0MeN.js","utils-jWgu-6Qf.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DBD8f9qn.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-BGuX1ui5.js","snippetPresets-Evy63nQB.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BQHO1lnV.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-B6C8m-t_.js","shallow-BG4cT0fH.js","getApiPlaygroundDisplay-CgEPrE-D.js","CodeSnippet-CU8JyZ9N.js","CodeSnippets-BnxHU32T.js","Page-D6S0Yh6q.js","getPastedJson-CwiYOonh.js","icon-DYDpWmDf.js","MethodPill-C-J-l7_c.js","DuplicateIcon-B6ARwg9w.js","createIcon-Dsv4MtDq.js","DynamicMarkdown-CtasenyM.js","SectionHeading-YNcgYwjB.js","axios-vUo_bRtp.js","Markdown-CwLx6PAg.js","clsx-C3kuh_dz.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CmKHfscc.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-U3mI6Ljh.js"]}