Returns a full or partial refund for a completed QR payment. This endpoint sends money back to the customer after a transaction completes successfully. It is typically triggered by a customer complaint (via the Nayax web system) and allows for specific refund reasons to be recorded.
Identifies transaction information and references. Included in all response messages for payment calls.
When used in requests (e.g. /Settlement, /Void, /Refund, /Inquiry), this object should match the PaymentInfo returned in a previous call.
Identifies transaction information and references. Included in all response messages for payment calls.
When used in requests (e.g. /Settlement, /Void, /Refund, /Inquiry), this object should match the PaymentInfo returned in a previous call.
{"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"}]}]},"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":"6adb8db7e6de455b2093eb50","collectionId":"f90d1c1f-7ef4-4868-b7db-cc847f757cc5","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6adb8db7e6de455b2093eb50"},"feedback":{"thumbs":true,"agentFeedback":false},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6adb8db7e6de455b2093eb50","clientVersion":"0.0.3971","searchFilterCounts":[{"language":"en","tag":"Terminal SDKs","count":204},{"language":"zh","tag":"Terminal SDKs","count":203},{"language":"default","tag":"API Reference","count":182},{"language":"default","tag":"Endpoints","count":166},{"language":"default","tag":"Platform Management","count":138},{"language":"default","tag":"Lynx API","count":138},{"language":"en","tag":"TweezerComm","count":69},{"language":"en","tag":"TweezerComm Guides","count":69},{"language":"zh","tag":"TweezerComm","count":68},{"language":"zh","tag":"TweezerComm Guides","count":68},{"language":"en","tag":"Platform Management","count":47},{"language":"zh","tag":"Platform Management","count":47},{"language":"en","tag":"Marshall","count":44},{"language":"zh","tag":"Marshall","count":44},{"language":"en","tag":"Cortina","count":42},{"language":"en","tag":"Cortina Guides","count":42},{"language":"en","tag":"Marshall Guides","count":41},{"language":"zh","tag":"Cortina","count":41},{"language":"zh","tag":"Cortina Guides","count":41},{"language":"zh","tag":"Marshall 指南","count":41},{"language":"en","tag":"Lynx API","count":39},{"language":"en","tag":"Lynx API Guides","count":39},{"language":"zh","tag":"Lynx API","count":39},{"language":"zh","tag":"Lynx API Guides","count":39},{"language":"default","tag":"Cortina","count":36},{"language":"default","tag":"Cards","count":21},{"language":"default","tag":"Actors","count":19},{"language":"default","tag":"Lookups","count":18},{"language":"default","tag":"Machines","count":16},{"language":"default","tag":"Scheduling","count":16}]},"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":"editor-v7-file-tree","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":"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":"pause-universal-search-reconcile","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":"per-site-search-delta","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":"editor-private-page-search","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":"editor-nav-generations","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":"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":"byok-sep-25","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":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","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":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":".card_content{font-feature-settings:\"clig\" off,\"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;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,0 1px 0 #0d8d67,1px 0 0 #0d8d67}.card_content span.post{background:#0171c2;text-shadow:1px 1px 0 #0168b3,0 1px 0 #0168b3,1px 0 0 #0168b3}.card_content span.patch{background:#df7d03;text-shadow:1px 1px 0 #d07503,0 1px 0 #d07503,1px 0 0 #d07503}.card_content span.put{background:#674ead;text-shadow:1px 1px 0 #604aa2,0 1px 0 #604aa2,1px 0 0 #604aa2}footer .dark\\:hidden,footer .hidden.dark\\:block,footer h2{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}.nav-tabs{width:100%}.nav-tabs .nav-tabs-item:nth-last-child(3 of .nav-tabs-item){margin-left:auto}pre.bash{background-color:#000;color:#fff;font-size:medium;font-family:Consolas,Monaco,Lucida Console,Liberation Mono,DejaVu Sans Mono,Bitstream Vera Sans Mono,Courier New,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:-.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/cortina/dynamicqr/cortina-dynamicqr-refund","slug":"/reference/cortina/dynamicqr/cortina-dynamicqr-refund","pageMetadata":{"title":"Cortina DynamicQR Refund","description":null,"deprecated":null,"version":null,"hideFooterPagination":true,"openapi":"/openapi/cortina.yaml post /Cortina/DynamicQR/Refund","href":"/reference/cortina/dynamicqr/cortina-dynamicqr-refund","autogeneratedByOpenApi":true},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={p:`p`,..._provideComponents(),...props.components};return _jsx(_components.p,{children:`Returns a full or partial refund for a completed QR payment. This endpoint sends money back to the customer after a transaction completes successfully. It is typically triggered by a customer complaint (via the Nayax web system) and allows for specific refund reasons to be recorded.`})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Cortina DynamicQR Refund","description":null,"deprecated":null,"version":null,"hideFooterPagination":true,"openapi":"/openapi/cortina.yaml post /Cortina/DynamicQR/Refund","href":"/reference/cortina/dynamicqr/cortina-dynamicqr-refund","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/nayax-44d6e37b/c0d908800bae3e5a/wcBadge.js"],"openApiReferenceData":{"operation":{"x-mint":{"content":"Returns a full or partial refund for a completed QR payment. This endpoint sends money back to the customer after a transaction completes successfully. It is typically triggered by a customer complaint (via the Nayax web system) and allows for specific refund reasons to be recorded.","metadata":{"hideFooterPagination":true}},"requestBody":"06601bd4-bbb8-4234-a982-ebc080f4038a","responses":{"200":"fc9891a9-bffd-40e9-b2a5-e35c7f030690"},"summary":"Cortina DynamicQR Refund","tags":["DynamicQR"],"method":"post","type":"path","servers":["ed3c12c7-8b55-4dd2-a341-f8b83db93e68"],"security":[],"path":"/Cortina/DynamicQR/Refund","baseUrlOptions":["https://{domain}:{port}"],"title":"Cortina DynamicQR Refund","description":"","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"content":{"application/*+json":{"schema":{"additionalProperties":false,"properties":{"ActorInfo":{"additionalProperties":false,"description":"Merchant (Actor) details.","properties":{"Country":{"additionalProperties":false,"description":"Actor and Machine Country information\n","properties":{"Alpha2Code":{"description":"String(2)\nMandatory\nISO-3166-1 format: Alpha-2 code\n","example":"US","type":"string","uniqueKey":"ActorInfo.Country.Alpha2Code","typeLabel":"string"},"Alpha3Code":{"description":"String(3)\nMandatory\nISO-3166-1 format: Alpha-3 code\n","example":"USA","type":"string","uniqueKey":"ActorInfo.Country.Alpha3Code","typeLabel":"string"},"Intra":{"description":"String\nMandatory\nAn Intra Region refers to a geographical diversification across countries within a single 'Intra region'.\nE.g. 'France' is country within the 'European Union' Intra Region.\n","example":"Europe","type":"string","uniqueKey":"ActorInfo.Country.Intra","typeLabel":"string"},"Name":{"description":"String\nMandatory\nCountry Full Name\n","example":"UNITED STATES","type":"string","uniqueKey":"ActorInfo.Country.Name","typeLabel":"string"},"NumericCode":{"description":"String(3)\nMandatory\nISO-3166-1 format: Numeric-3 code\n","example":"840","type":"string","uniqueKey":"ActorInfo.Country.NumericCode","typeLabel":"string"}},"type":"object","uniqueKey":"ActorInfo.Country","typeLabel":"object"},"DynamicURL":{"description":"Optional URL configuration at the actor level. Supports dynamic URLs. \n- Max length: 255.\n","example":"https://www.nayax.com/alternativeURL","type":"string","uniqueKey":"ActorInfo.DynamicURL","typeLabel":"string"},"GeoLocation":{"additionalProperties":false,"description":"Actor and Machine Geo location information","properties":{"Address":{"description":"String(255)\nOptional\nAddress as defined in the Nayax backoffice\n","example":"River","type":"string","uniqueKey":"ActorInfo.GeoLocation.Address","typeLabel":"string"},"City":{"description":"- String(255)\n- Optional\n- City as defined in the Nayax backoffice\n","example":"Zambezi","type":"string","uniqueKey":"ActorInfo.GeoLocation.City","typeLabel":"string"},"CountryCode":{"description":"String\nOptional\nCountry code (ISO3) as defined in the Nayax backoffice\n","example":"ZM","type":"string","uniqueKey":"ActorInfo.GeoLocation.CountryCode","typeLabel":"string"},"Latitude":{"description":"- Machine Location Latitude as defined in the Nayax backoffice\n","example":51.0003431,"format":"double","type":"number","uniqueKey":"ActorInfo.GeoLocation.Latitude","typeLabel":"number\u003cdouble>"},"Longitude":{"description":"- Machine Location Longitude as defined in the Nayax backoffice\n","example":23.745245,"format":"double","type":"number","uniqueKey":"ActorInfo.GeoLocation.Longitude","typeLabel":"number\u003cdouble>"},"State":{"description":"- String\n- Optional\n- Actor geo state code as defined in the Nayax backoffice\n","example":"Alabama","type":"string","uniqueKey":"ActorInfo.GeoLocation.State","typeLabel":"string"},"ZipCode":{"description":"String(255)\nOptional\nZip code defined in the Nayax backoffice\n","example":"234234","type":"string","uniqueKey":"ActorInfo.GeoLocation.ZipCode","typeLabel":"string"}},"type":"object","uniqueKey":"ActorInfo.GeoLocation","typeLabel":"object"},"Id":{"description":"Unique ID of the actor (merchant) as defined in the Nayax backoffice.\n","example":2001537302,"format":"int64","type":"integer","uniqueKey":"ActorInfo.Id","typeLabel":"integer\u003cint64>"},"MCC":{"description":"Merchant Category Code (MCC), classifies businesses by type of goods or services provided.\n","example":455,"format":"int32","type":"integer","uniqueKey":"ActorInfo.MCC","typeLabel":"integer\u003cint32>"},"MerchantId":{"description":"Merchant identifier as defined in the Nayax backoffice. Contact Nayax to configure. \n- Max length: 255.\n","example":999999888885,"type":"string","uniqueKey":"ActorInfo.MerchantId","typeLabel":"string"},"Name":{"description":"Merchant name as registered in the Nayax backoffice. Max length: 255.\n","example":"TestPayCC V2 OP","type":"string","uniqueKey":"ActorInfo.Name","typeLabel":"string"},"OperatorId":{"description":"ID of the operator associated with the merchant. Max length: 255.\n","example":2001537302,"format":"int64","type":"integer","uniqueKey":"ActorInfo.OperatorId","typeLabel":"integer\u003cint64>"},"OperatorName":{"description":"Name of the operator associated with the merchant. Max length: 255.\n","example":"TestPayCC V2 OP _ Sub Merchant","type":"string","uniqueKey":"ActorInfo.OperatorName","typeLabel":"string"},"SubMerchantId":{"description":"Identifier for a sub-merchant under the main merchant. Contact Nayax to configure. Max length: 255.\n","example":999999888886,"type":"string","uniqueKey":"ActorInfo.SubMerchantId","typeLabel":"string"}},"type":"object","uniqueKey":"ActorInfo","typeLabel":"object"},"BasicInfo":{"additionalProperties":false,"description":"Basic transaction information.","properties":{"Amount":{"description":"Transaction amount. Use decimal format (e.g. 0.01 for 1 cent). Currencies without decimal places should also be expressed as a double (e.g. 234.0).\n","example":5,"format":"double","type":"number","isRequired":true,"uniqueKey":"BasicInfo.Amount","typeLabel":"number\u003cdouble>"},"CurrencyCode":{"description":"ISO 4217 currency code in Alpha-3 format (e.g. USD, EUR, ILS).\n","example":"ILS","type":"string","isRequired":true,"uniqueKey":"BasicInfo.CurrencyCode","typeLabel":"string"},"CurrencyNumeric":{"description":"ISO 4217 currency code in Numeric-3 format.\n","example":"376","type":"string","isRequired":true,"uniqueKey":"BasicInfo.CurrencyNumeric","typeLabel":"string"},"TransactionId":{"description":"Unique identifier for the transaction.\n- If `/StartSession` was used, this echoes the encrypted transaction ID (`TranIDCipher`).\n- If not, the Nayax engine generates this value.\n","example":"N99O4XURDQYJZIK4OTCAWF1RHHA40TZWVCRB","type":"string","isRequired":true,"uniqueKey":"BasicInfo.TransactionId","typeLabel":"string"},"AgeLimitation":{"description":"Minimum age required for transaction approval.\n","example":18,"format":"int16","type":"integer","uniqueKey":"BasicInfo.AgeLimitation","typeLabel":"integer\u003cint16>"},"AuditNumber":{"description":"For internal Nayax use.\n","example":342,"format":"int64","type":"integer","uniqueKey":"BasicInfo.AuditNumber","typeLabel":"integer\u003cint64>"},"BillingProviderId":{"description":"ID of the billing provider (assigned by Nayax).\n","example":1,"format":"int32","type":"integer","uniqueKey":"BasicInfo.BillingProviderId","typeLabel":"integer\u003cint32>"},"IsDeferredAuthorization":{"description":"Indicates whether the authorization is deferred.\n","type":"boolean","uniqueKey":"BasicInfo.IsDeferredAuthorization","typeLabel":"boolean"},"IsProductSelected":{"description":"Indicates whether a product was pre-selected before payment.\n","example":true,"type":"boolean","uniqueKey":"BasicInfo.IsProductSelected","typeLabel":"boolean"},"IsSoftDeclineCompletion":{"description":"Indicates whether the transaction was completed after a soft decline.\n","type":"boolean","uniqueKey":"BasicInfo.IsSoftDeclineCompletion","typeLabel":"boolean"},"MachineAuTime":{"description":"Timestamp of machine authorization (DDMMYYHHMMSS).\n","example":71221132914,"type":"string","uniqueKey":"BasicInfo.MachineAuTime","typeLabel":"string"},"NayaxRRN":{"description":"Reference number for external identification. Should be visible to the end-user or external parties (e.g. card issuer, app provider). Echoed in `/Inquiry` requests.\n","example":"111111","type":"string","uniqueKey":"BasicInfo.NayaxRRN","typeLabel":"string"},"NayaxTransactionId":{"description":"Internal Nayax ID used to track the transaction in future requests.\n","example":3584697384,"format":"int64","type":"integer","uniqueKey":"BasicInfo.NayaxTransactionId","typeLabel":"integer\u003cint64>"},"PaymentMethodID":{"description":"ID of the payment method provider (assigned by Nayax).\n","example":1,"format":"int32","type":"integer","uniqueKey":"BasicInfo.PaymentMethodID","typeLabel":"integer\u003cint32>"},"SiteId":{"description":"Region identifier for the Nayax server.\n","example":1,"format":"int16","type":"integer","uniqueKey":"BasicInfo.SiteId","typeLabel":"integer\u003cint16>"},"TimeoutMS":{"description":"Server timeout in milliseconds.\n","example":15000,"format":"int32","type":"integer","uniqueKey":"BasicInfo.TimeoutMS","typeLabel":"integer\u003cint32>"},"TransitElement":{"description":"Transit Element Information","properties":{"DenyListIndication":{"description":"* 0 - unknown/ no effect\n* 1 - Decline will cause consumer to be added to the deny list\n* 2 - Approval shall cause the consumer to be removed from deny list.\n","enum":[0,1,2],"format":"int32","type":"integer","uniqueKey":"BasicInfo.TransitElement.DenyListIndication","typeLabel":"enum\u003cinteger>"},"TransitTransactionType":{"description":"* 1 - Prefunded\n* 2 - Realtime Authorization\n* 3 - Post-Authorization Aggregated Transaction\n* 7 - Debt Recovery\n","enum":[1,2,3,7],"format":"int32","type":"integer","uniqueKey":"BasicInfo.TransitElement.TransitTransactionType","typeLabel":"enum\u003cinteger>"}},"type":"object","uniqueKey":"BasicInfo.TransitElement","typeLabel":"object"}},"required":["TransactionId","Amount","CurrencyCode","CurrencyNumeric"],"type":"object","uniqueKey":"BasicInfo","typeLabel":"object"},"CustomData":{"additionalProperties":false,"description":"Custom Fields Information, Contact Nayax TPOC to define.","properties":{"Actor":{"description":"Actor custom data (String in json format)\n","example":"String","type":"string","uniqueKey":"CustomData.Actor","typeLabel":"string"},"DirectActor":{"description":"Direct actor custom data (String in json format)\n","example":"String","type":"string","uniqueKey":"CustomData.DirectActor","typeLabel":"string"},"Distributor":{"description":"Distributor custom data (String in json format)\n","example":"String","type":"string","uniqueKey":"CustomData.Distributor","typeLabel":"string"},"Machine":{"description":"Machine custom data (String in json format)\n","example":"String","type":"string","uniqueKey":"CustomData.Machine","typeLabel":"string"},"Operator":{"description":"Operator custom data (String in json format)\n","example":"String","type":"string","uniqueKey":"CustomData.Operator","typeLabel":"string"},"SoftDecline":{"description":"Soft Decline custom data (String in json format)\n","example":"String","type":"string","uniqueKey":"CustomData.SoftDecline","typeLabel":"string"}},"type":"object","uniqueKey":"CustomData","typeLabel":"object"},"DeviceInfo":{"additionalProperties":false,"description":"Hardware and firmware information of the Nayax device.","properties":{"FWVersion":{"description":"Firmware version installed on the device.\n","example":"4.0.0.22-RC01 - Aug 25 2021","type":"string","uniqueKey":"DeviceInfo.FWVersion","typeLabel":"string"},"HwSerial":{"description":"Hardware serial number of the Nayax device.\n","example":434324119376526,"type":"string","uniqueKey":"DeviceInfo.HwSerial","typeLabel":"string"},"Type":{"description":"Device type as defined in the Nayax system.\n","example":"Onyx","type":"string","uniqueKey":"DeviceInfo.Type","typeLabel":"string"}},"type":"object","uniqueKey":"DeviceInfo","typeLabel":"object"},"MachineInfo":{"description":"Information about the machine involved in the transaction.","properties":{"City":{"description":"City where the machine is located, as defined in the Nayax backoffice. Maximum length: 255 characters.\n","example":"Abbeville","type":"string","uniqueKey":"MachineInfo.City","typeLabel":"string"},"Country":{"additionalProperties":false,"description":"Actor and Machine Country information\n","properties":{"Alpha2Code":{"description":"String(2)\nMandatory\nISO-3166-1 format: Alpha-2 code\n","example":"US","type":"string","uniqueKey":"MachineInfo.Country.Alpha2Code","typeLabel":"string"},"Alpha3Code":{"description":"String(3)\nMandatory\nISO-3166-1 format: Alpha-3 code\n","example":"USA","type":"string","uniqueKey":"MachineInfo.Country.Alpha3Code","typeLabel":"string"},"Intra":{"description":"String\nMandatory\nAn Intra Region refers to a geographical diversification across countries within a single 'Intra region'.\nE.g. 'France' is country within the 'European Union' Intra Region.\n","example":"Europe","type":"string","uniqueKey":"MachineInfo.Country.Intra","typeLabel":"string"},"Name":{"description":"String\nMandatory\nCountry Full Name\n","example":"UNITED STATES","type":"string","uniqueKey":"MachineInfo.Country.Name","typeLabel":"string"},"NumericCode":{"description":"String(3)\nMandatory\nISO-3166-1 format: Numeric-3 code\n","example":"840","type":"string","uniqueKey":"MachineInfo.Country.NumericCode","typeLabel":"string"}},"type":"object","uniqueKey":"MachineInfo.Country","typeLabel":"object"},"DecimalPlace":{"description":"Number of decimal places for transaction amounts.\n- For example, `2` means values like 123.45. - A value of `0` means 12345 (no decimal).\n","example":2,"format":"int64","type":"integer","uniqueKey":"MachineInfo.DecimalPlace","typeLabel":"integer\u003cint64>"},"ExternalId":{"description":"External machine ID as provided by the operator in the Nayax backoffice. Maximum length: 200 characters.\n","example":"OperatorExternalID","type":"string","uniqueKey":"MachineInfo.ExternalId","typeLabel":"string"},"GeoLocation":{"additionalProperties":false,"description":"Actor and Machine Geo location information","properties":{"Address":{"description":"String(255)\nOptional\nAddress as defined in the Nayax backoffice\n","example":"River","type":"string","uniqueKey":"MachineInfo.GeoLocation.Address","typeLabel":"string"},"City":{"description":"- String(255)\n- Optional\n- City as defined in the Nayax backoffice\n","example":"Zambezi","type":"string","uniqueKey":"MachineInfo.GeoLocation.City","typeLabel":"string"},"CountryCode":{"description":"String\nOptional\nCountry code (ISO3) as defined in the Nayax backoffice\n","example":"ZM","type":"string","uniqueKey":"MachineInfo.GeoLocation.CountryCode","typeLabel":"string"},"Latitude":{"description":"- Machine Location Latitude as defined in the Nayax backoffice\n","example":51.0003431,"format":"double","type":"number","uniqueKey":"MachineInfo.GeoLocation.Latitude","typeLabel":"number\u003cdouble>"},"Longitude":{"description":"- Machine Location Longitude as defined in the Nayax backoffice\n","example":23.745245,"format":"double","type":"number","uniqueKey":"MachineInfo.GeoLocation.Longitude","typeLabel":"number\u003cdouble>"},"State":{"description":"- String\n- Optional\n- Actor geo state code as defined in the Nayax backoffice\n","example":"Alabama","type":"string","uniqueKey":"MachineInfo.GeoLocation.State","typeLabel":"string"},"ZipCode":{"description":"String(255)\nOptional\nZip code defined in the Nayax backoffice\n","example":"234234","type":"string","uniqueKey":"MachineInfo.GeoLocation.ZipCode","typeLabel":"string"}},"type":"object","uniqueKey":"MachineInfo.GeoLocation","typeLabel":"object"},"GroupId":{"description":"Internal Nayax group ID.\n","example":"String","type":"string","uniqueKey":"MachineInfo.GroupId","typeLabel":"string"},"Id":{"description":"Unique machine ID as allocated in the Nayax backoffice.\n","example":106791869,"format":"int64","type":"integer","uniqueKey":"MachineInfo.Id","typeLabel":"integer\u003cint64>"},"Name":{"description":"Machine name as defined in the Nayax backoffice. Maximum length: 255 characters.\n","example":"Itai_TestPayCC V2","type":"string","uniqueKey":"MachineInfo.Name","typeLabel":"string"},"Offset":{"description":"UTC timezone offset. Maximum length: 255 characters.\n","example":"3.00","type":"string","uniqueKey":"MachineInfo.Offset","typeLabel":"string"},"OperatorId":{"description":"Merchant ID as defined in the Nayax backoffice. Maximum length: 255 characters.\n","example":2001537302,"type":"string","uniqueKey":"MachineInfo.OperatorId","typeLabel":"string"},"Region":{"description":"Region assigned to the machine in the Nayax backoffice. Maximum length: 255 characters.\n","example":"EU","type":"string","uniqueKey":"MachineInfo.Region","typeLabel":"string"},"TerminalId":{"description":"Optional terminal identifier defined in the Nayax backoffice. Contact Nayax TPOC to configure. Maximum length: 255 characters.\n","example":"8888888844","type":"string","uniqueKey":"MachineInfo.TerminalId","typeLabel":"string"},"Type":{"description":"Machine type as defined in the Nayax backoffice. Maximum length: 50 characters.\n","example":"machine type","type":"string","uniqueKey":"MachineInfo.Type","typeLabel":"string"},"ZipCode":{"description":"Zip or postal code for the machine location. Maximum length: 255 characters.\n","example":"22448Z","type":"string","uniqueKey":"MachineInfo.ZipCode","typeLabel":"string"}},"type":"object","uniqueKey":"MachineInfo","typeLabel":"object"},"PaymentInfo":{"type":"object","additionalProperties":false,"description":"Identifies transaction information and references. Included in all response messages for payment calls.\nWhen used in requests (e.g. `/Settlement`, `/Void`, `/Refund`, `/Inquiry`), this object should match the `PaymentInfo` returned in a previous call.\n","properties":{"SrvTranId":{"type":"string","description":"Integrator's internal transaction ID. Use only if `/StartSession` was not used. If `/StartSession` was used, this should be empty or echo the transaction ID from the request.\n","example":"3584697388","uniqueKey":"PaymentInfo.SrvTranId","typeLabel":"string"},"AuthCode":{"type":"string","description":"External authorization code (usually from the card issuer). In dynamic QR, the approval code from the `/Inquiry` response overrides previous values.\n","example":"333333","uniqueKey":"PaymentInfo.AuthCode","typeLabel":"string"},"AuthAmount":{"type":"number","format":"double","description":"Original amount requested in `/Authorization` or `/Sale`. Optional in other cases.\n","example":5.5,"uniqueKey":"PaymentInfo.AuthAmount","typeLabel":"number\u003cdouble>"},"SettAmount":{"type":"number","format":"double","description":"Final settled amount, used in `/Settlement`, `/Inquiry`, or `/Sale`. In Cortina External Prepaid, this may reflect a discounted amount and is used for reporting only.\n","example":5.5,"uniqueKey":"PaymentInfo.SettAmount","typeLabel":"number\u003cdouble>"},"RRN":{"type":"string","description":"Reference Retrieval Number. Should be visible to the cardholder and match the one in the `/GenerateQR` response.\n","example":"111111","uniqueKey":"PaymentInfo.RRN","typeLabel":"string"},"Token":{"type":"string","description":"Unique token for the transaction. For internal Nayax use only.\n","example":"string","uniqueKey":"PaymentInfo.Token","typeLabel":"string"},"AuthDateTime":{"type":"string","description":"Date and time of the `/Authorization` or `/Sale`. Format: `ddMMyyHHmmss`\n","example":"071221133300","uniqueKey":"PaymentInfo.AuthDateTime","typeLabel":"string"},"SettDateTime":{"type":"string","description":"Date and time of the `/Settlement` or `/Sale`. Format: `ddMMyyHHmmss`\n","example":"071221133330","uniqueKey":"PaymentInfo.SettDateTime","typeLabel":"string"},"TraceNumber":{"type":"string","description":"Trace number. For internal Nayax use only.\n","example":"4444","uniqueKey":"PaymentInfo.TraceNumber","typeLabel":"string"},"AdditionalData":{"type":"string","description":"Optional custom data in JSON format. Contact Nayax to configure.\n","example":"string","uniqueKey":"PaymentInfo.AdditionalData","typeLabel":"string"},"IsGatewayTimeout":{"type":"boolean","description":"Indicates whether there was a gateway timeout.\n","example":false,"uniqueKey":"PaymentInfo.IsGatewayTimeout","typeLabel":"boolean"},"ProviderExternalData":{"type":"string","description":"External data from provider in JSON format.\n","example":"string","uniqueKey":"PaymentInfo.ProviderExternalData","typeLabel":"string"},"InitiateTranReference":{"type":"integer","format":"int64","description":"References the original Nayax transaction ID when reattempting a prepaid loyalty card transaction.\n","example":11223344,"uniqueKey":"PaymentInfo.InitiateTranReference","typeLabel":"integer\u003cint64>"},"IsRevalueCard":{"type":"boolean","description":"Indicates whether the card supports revalue.\n","example":false,"uniqueKey":"PaymentInfo.IsRevalueCard","typeLabel":"boolean"}},"uniqueKey":"PaymentInfo","typeLabel":"object"},"ReasonCode":{"description":"- Optional\n- length: Short integer (16)\n- Refund reason code as saved in Nayax system\n","format":"int16","type":"integer","uniqueKey":"ReasonCode","typeLabel":"integer\u003cint16>"},"ReasonText":{"description":"- Optional\n- length: 64\n- Refund description as saved in Nayax system\n","type":"string","uniqueKey":"ReasonText","typeLabel":"string"}},"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"ActorInfo":{"Country":{"Alpha2Code":"US","Alpha3Code":"USA","Intra":"Europe","Name":"UNITED STATES","NumericCode":"840"},"DynamicURL":"https://www.nayax.com/alternativeURL","GeoLocation":{"Address":"River","City":"Zambezi","CountryCode":"ZM","Latitude":51.0003431,"Longitude":23.745245,"State":"Alabama","ZipCode":"234234"},"Id":2001537302,"MCC":455,"MerchantId":999999888885,"Name":"TestPayCC V2 OP","OperatorId":2001537302,"OperatorName":"TestPayCC V2 OP _ Sub Merchant","SubMerchantId":999999888886},"CustomData":{"Actor":"String","DirectActor":"String","Distributor":"String","Machine":"String","Operator":"String","SoftDecline":"String"},"DeviceInfo":{"FWVersion":"4.0.0.22-RC01 - Aug 25 2021","HwSerial":434324119376526,"Type":"Onyx"},"MachineInfo":{"City":"Abbeville","Country":{"Alpha2Code":"US","Alpha3Code":"USA","Intra":"Europe","Name":"UNITED STATES","NumericCode":"840"},"DecimalPlace":2,"ExternalId":"OperatorExternalID","GeoLocation":{"Address":"River","City":"Zambezi","CountryCode":"ZM","Latitude":51.0003431,"Longitude":23.745245,"State":"Alabama","ZipCode":"234234"},"GroupId":"String","Id":106791869,"Name":"Itai_TestPayCC V2","Offset":"3.00","OperatorId":2001537302,"Region":"EU","TerminalId":"8888888844","Type":"machine type","ZipCode":"22448Z"},"PaymentInfo":{"SrvTranId":"3584697388","AuthCode":"333333","AuthAmount":5.5,"SettAmount":5.5,"RRN":"111111","Token":"string","AuthDateTime":"071221133300","SettDateTime":"071221133330","TraceNumber":"4444","AdditionalData":"string","IsGatewayTimeout":false,"ProviderExternalData":"string","InitiateTranReference":11223344,"IsRevalueCard":false},"ReasonCode":123,"ReasonText":"\u003cstring>"}}},"exampleType":"generated"},"application/json":{"schema":{"additionalProperties":false,"properties":{"ActorInfo":{"additionalProperties":false,"description":"Merchant (Actor) details.","properties":{"Country":{"additionalProperties":false,"description":"Actor and Machine Country information\n","properties":{"Alpha2Code":{"description":"String(2)\nMandatory\nISO-3166-1 format: Alpha-2 code\n","example":"US","type":"string","uniqueKey":"ActorInfo.Country.Alpha2Code","typeLabel":"string"},"Alpha3Code":{"description":"String(3)\nMandatory\nISO-3166-1 format: Alpha-3 code\n","example":"USA","type":"string","uniqueKey":"ActorInfo.Country.Alpha3Code","typeLabel":"string"},"Intra":{"description":"String\nMandatory\nAn Intra Region refers to a geographical diversification across countries within a single 'Intra region'.\nE.g. 'France' is country within the 'European Union' Intra Region.\n","example":"Europe","type":"string","uniqueKey":"ActorInfo.Country.Intra","typeLabel":"string"},"Name":{"description":"String\nMandatory\nCountry Full Name\n","example":"UNITED STATES","type":"string","uniqueKey":"ActorInfo.Country.Name","typeLabel":"string"},"NumericCode":{"description":"String(3)\nMandatory\nISO-3166-1 format: Numeric-3 code\n","example":"840","type":"string","uniqueKey":"ActorInfo.Country.NumericCode","typeLabel":"string"}},"type":"object","uniqueKey":"ActorInfo.Country","typeLabel":"object"},"DynamicURL":{"description":"Optional URL configuration at the actor level. Supports dynamic URLs. \n- Max length: 255.\n","example":"https://www.nayax.com/alternativeURL","type":"string","uniqueKey":"ActorInfo.DynamicURL","typeLabel":"string"},"GeoLocation":{"additionalProperties":false,"description":"Actor and Machine Geo location information","properties":{"Address":{"description":"String(255)\nOptional\nAddress as defined in the Nayax backoffice\n","example":"River","type":"string","uniqueKey":"ActorInfo.GeoLocation.Address","typeLabel":"string"},"City":{"description":"- String(255)\n- Optional\n- City as defined in the Nayax backoffice\n","example":"Zambezi","type":"string","uniqueKey":"ActorInfo.GeoLocation.City","typeLabel":"string"},"CountryCode":{"description":"String\nOptional\nCountry code (ISO3) as defined in the Nayax backoffice\n","example":"ZM","type":"string","uniqueKey":"ActorInfo.GeoLocation.CountryCode","typeLabel":"string"},"Latitude":{"description":"- Machine Location Latitude as defined in the Nayax backoffice\n","example":51.0003431,"format":"double","type":"number","uniqueKey":"ActorInfo.GeoLocation.Latitude","typeLabel":"number\u003cdouble>"},"Longitude":{"description":"- Machine Location Longitude as defined in the Nayax backoffice\n","example":23.745245,"format":"double","type":"number","uniqueKey":"ActorInfo.GeoLocation.Longitude","typeLabel":"number\u003cdouble>"},"State":{"description":"- String\n- Optional\n- Actor geo state code as defined in the Nayax backoffice\n","example":"Alabama","type":"string","uniqueKey":"ActorInfo.GeoLocation.State","typeLabel":"string"},"ZipCode":{"description":"String(255)\nOptional\nZip code defined in the Nayax backoffice\n","example":"234234","type":"string","uniqueKey":"ActorInfo.GeoLocation.ZipCode","typeLabel":"string"}},"type":"object","uniqueKey":"ActorInfo.GeoLocation","typeLabel":"object"},"Id":{"description":"Unique ID of the actor (merchant) as defined in the Nayax backoffice.\n","example":2001537302,"format":"int64","type":"integer","uniqueKey":"ActorInfo.Id","typeLabel":"integer\u003cint64>"},"MCC":{"description":"Merchant Category Code (MCC), classifies businesses by type of goods or services provided.\n","example":455,"format":"int32","type":"integer","uniqueKey":"ActorInfo.MCC","typeLabel":"integer\u003cint32>"},"MerchantId":{"description":"Merchant identifier as defined in the Nayax backoffice. Contact Nayax to configure. \n- Max length: 255.\n","example":999999888885,"type":"string","uniqueKey":"ActorInfo.MerchantId","typeLabel":"string"},"Name":{"description":"Merchant name as registered in the Nayax backoffice. Max length: 255.\n","example":"TestPayCC V2 OP","type":"string","uniqueKey":"ActorInfo.Name","typeLabel":"string"},"OperatorId":{"description":"ID of the operator associated with the merchant. Max length: 255.\n","example":2001537302,"format":"int64","type":"integer","uniqueKey":"ActorInfo.OperatorId","typeLabel":"integer\u003cint64>"},"OperatorName":{"description":"Name of the operator associated with the merchant. Max length: 255.\n","example":"TestPayCC V2 OP _ Sub Merchant","type":"string","uniqueKey":"ActorInfo.OperatorName","typeLabel":"string"},"SubMerchantId":{"description":"Identifier for a sub-merchant under the main merchant. Contact Nayax to configure. Max length: 255.\n","example":999999888886,"type":"string","uniqueKey":"ActorInfo.SubMerchantId","typeLabel":"string"}},"type":"object","uniqueKey":"ActorInfo","typeLabel":"object"},"BasicInfo":{"additionalProperties":false,"description":"Basic transaction information.","properties":{"Amount":{"description":"Transaction amount. Use decimal format (e.g. 0.01 for 1 cent). Currencies without decimal places should also be expressed as a double (e.g. 234.0).\n","example":5,"format":"double","type":"number","isRequired":true,"uniqueKey":"BasicInfo.Amount","typeLabel":"number\u003cdouble>"},"CurrencyCode":{"description":"ISO 4217 currency code in Alpha-3 format (e.g. USD, EUR, ILS).\n","example":"ILS","type":"string","isRequired":true,"uniqueKey":"BasicInfo.CurrencyCode","typeLabel":"string"},"CurrencyNumeric":{"description":"ISO 4217 currency code in Numeric-3 format.\n","example":"376","type":"string","isRequired":true,"uniqueKey":"BasicInfo.CurrencyNumeric","typeLabel":"string"},"TransactionId":{"description":"Unique identifier for the transaction.\n- If `/StartSession` was used, this echoes the encrypted transaction ID (`TranIDCipher`).\n- If not, the Nayax engine generates this value.\n","example":"N99O4XURDQYJZIK4OTCAWF1RHHA40TZWVCRB","type":"string","isRequired":true,"uniqueKey":"BasicInfo.TransactionId","typeLabel":"string"},"AgeLimitation":{"description":"Minimum age required for transaction approval.\n","example":18,"format":"int16","type":"integer","uniqueKey":"BasicInfo.AgeLimitation","typeLabel":"integer\u003cint16>"},"AuditNumber":{"description":"For internal Nayax use.\n","example":342,"format":"int64","type":"integer","uniqueKey":"BasicInfo.AuditNumber","typeLabel":"integer\u003cint64>"},"BillingProviderId":{"description":"ID of the billing provider (assigned by Nayax).\n","example":1,"format":"int32","type":"integer","uniqueKey":"BasicInfo.BillingProviderId","typeLabel":"integer\u003cint32>"},"IsDeferredAuthorization":{"description":"Indicates whether the authorization is deferred.\n","type":"boolean","uniqueKey":"BasicInfo.IsDeferredAuthorization","typeLabel":"boolean"},"IsProductSelected":{"description":"Indicates whether a product was pre-selected before payment.\n","example":true,"type":"boolean","uniqueKey":"BasicInfo.IsProductSelected","typeLabel":"boolean"},"IsSoftDeclineCompletion":{"description":"Indicates whether the transaction was completed after a soft decline.\n","type":"boolean","uniqueKey":"BasicInfo.IsSoftDeclineCompletion","typeLabel":"boolean"},"MachineAuTime":{"description":"Timestamp of machine authorization (DDMMYYHHMMSS).\n","example":71221132914,"type":"string","uniqueKey":"BasicInfo.MachineAuTime","typeLabel":"string"},"NayaxRRN":{"description":"Reference number for external identification. Should be visible to the end-user or external parties (e.g. card issuer, app provider). Echoed in `/Inquiry` requests.\n","example":"111111","type":"string","uniqueKey":"BasicInfo.NayaxRRN","typeLabel":"string"},"NayaxTransactionId":{"description":"Internal Nayax ID used to track the transaction in future requests.\n","example":3584697384,"format":"int64","type":"integer","uniqueKey":"BasicInfo.NayaxTransactionId","typeLabel":"integer\u003cint64>"},"PaymentMethodID":{"description":"ID of the payment method provider (assigned by Nayax).\n","example":1,"format":"int32","type":"integer","uniqueKey":"BasicInfo.PaymentMethodID","typeLabel":"integer\u003cint32>"},"SiteId":{"description":"Region identifier for the Nayax server.\n","example":1,"format":"int16","type":"integer","uniqueKey":"BasicInfo.SiteId","typeLabel":"integer\u003cint16>"},"TimeoutMS":{"description":"Server timeout in milliseconds.\n","example":15000,"format":"int32","type":"integer","uniqueKey":"BasicInfo.TimeoutMS","typeLabel":"integer\u003cint32>"},"TransitElement":{"description":"Transit Element Information","properties":{"DenyListIndication":{"description":"* 0 - unknown/ no effect\n* 1 - Decline will cause consumer to be added to the deny list\n* 2 - Approval shall cause the consumer to be removed from deny list.\n","enum":[0,1,2],"format":"int32","type":"integer","uniqueKey":"BasicInfo.TransitElement.DenyListIndication","typeLabel":"enum\u003cinteger>"},"TransitTransactionType":{"description":"* 1 - Prefunded\n* 2 - Realtime Authorization\n* 3 - Post-Authorization Aggregated Transaction\n* 7 - Debt Recovery\n","enum":[1,2,3,7],"format":"int32","type":"integer","uniqueKey":"BasicInfo.TransitElement.TransitTransactionType","typeLabel":"enum\u003cinteger>"}},"type":"object","uniqueKey":"BasicInfo.TransitElement","typeLabel":"object"}},"required":["TransactionId","Amount","CurrencyCode","CurrencyNumeric"],"type":"object","uniqueKey":"BasicInfo","typeLabel":"object"},"CustomData":{"additionalProperties":false,"description":"Custom Fields Information, Contact Nayax TPOC to define.","properties":{"Actor":{"description":"Actor custom data (String in json format)\n","example":"String","type":"string","uniqueKey":"CustomData.Actor","typeLabel":"string"},"DirectActor":{"description":"Direct actor custom data (String in json format)\n","example":"String","type":"string","uniqueKey":"CustomData.DirectActor","typeLabel":"string"},"Distributor":{"description":"Distributor custom data (String in json format)\n","example":"String","type":"string","uniqueKey":"CustomData.Distributor","typeLabel":"string"},"Machine":{"description":"Machine custom data (String in json format)\n","example":"String","type":"string","uniqueKey":"CustomData.Machine","typeLabel":"string"},"Operator":{"description":"Operator custom data (String in json format)\n","example":"String","type":"string","uniqueKey":"CustomData.Operator","typeLabel":"string"},"SoftDecline":{"description":"Soft Decline custom data (String in json format)\n","example":"String","type":"string","uniqueKey":"CustomData.SoftDecline","typeLabel":"string"}},"type":"object","uniqueKey":"CustomData","typeLabel":"object"},"DeviceInfo":{"additionalProperties":false,"description":"Hardware and firmware information of the Nayax device.","properties":{"FWVersion":{"description":"Firmware version installed on the device.\n","example":"4.0.0.22-RC01 - Aug 25 2021","type":"string","uniqueKey":"DeviceInfo.FWVersion","typeLabel":"string"},"HwSerial":{"description":"Hardware serial number of the Nayax device.\n","example":434324119376526,"type":"string","uniqueKey":"DeviceInfo.HwSerial","typeLabel":"string"},"Type":{"description":"Device type as defined in the Nayax system.\n","example":"Onyx","type":"string","uniqueKey":"DeviceInfo.Type","typeLabel":"string"}},"type":"object","uniqueKey":"DeviceInfo","typeLabel":"object"},"MachineInfo":{"description":"Information about the machine involved in the transaction.","properties":{"City":{"description":"City where the machine is located, as defined in the Nayax backoffice. Maximum length: 255 characters.\n","example":"Abbeville","type":"string","uniqueKey":"MachineInfo.City","typeLabel":"string"},"Country":{"additionalProperties":false,"description":"Actor and Machine Country information\n","properties":{"Alpha2Code":{"description":"String(2)\nMandatory\nISO-3166-1 format: Alpha-2 code\n","example":"US","type":"string","uniqueKey":"MachineInfo.Country.Alpha2Code","typeLabel":"string"},"Alpha3Code":{"description":"String(3)\nMandatory\nISO-3166-1 format: Alpha-3 code\n","example":"USA","type":"string","uniqueKey":"MachineInfo.Country.Alpha3Code","typeLabel":"string"},"Intra":{"description":"String\nMandatory\nAn Intra Region refers to a geographical diversification across countries within a single 'Intra region'.\nE.g. 'France' is country within the 'European Union' Intra Region.\n","example":"Europe","type":"string","uniqueKey":"MachineInfo.Country.Intra","typeLabel":"string"},"Name":{"description":"String\nMandatory\nCountry Full Name\n","example":"UNITED STATES","type":"string","uniqueKey":"MachineInfo.Country.Name","typeLabel":"string"},"NumericCode":{"description":"String(3)\nMandatory\nISO-3166-1 format: Numeric-3 code\n","example":"840","type":"string","uniqueKey":"MachineInfo.Country.NumericCode","typeLabel":"string"}},"type":"object","uniqueKey":"MachineInfo.Country","typeLabel":"object"},"DecimalPlace":{"description":"Number of decimal places for transaction amounts.\n- For example, `2` means values like 123.45. - A value of `0` means 12345 (no decimal).\n","example":2,"format":"int64","type":"integer","uniqueKey":"MachineInfo.DecimalPlace","typeLabel":"integer\u003cint64>"},"ExternalId":{"description":"External machine ID as provided by the operator in the Nayax backoffice. Maximum length: 200 characters.\n","example":"OperatorExternalID","type":"string","uniqueKey":"MachineInfo.ExternalId","typeLabel":"string"},"GeoLocation":{"additionalProperties":false,"description":"Actor and Machine Geo location information","properties":{"Address":{"description":"String(255)\nOptional\nAddress as defined in the Nayax backoffice\n","example":"River","type":"string","uniqueKey":"MachineInfo.GeoLocation.Address","typeLabel":"string"},"City":{"description":"- String(255)\n- Optional\n- City as defined in the Nayax backoffice\n","example":"Zambezi","type":"string","uniqueKey":"MachineInfo.GeoLocation.City","typeLabel":"string"},"CountryCode":{"description":"String\nOptional\nCountry code (ISO3) as defined in the Nayax backoffice\n","example":"ZM","type":"string","uniqueKey":"MachineInfo.GeoLocation.CountryCode","typeLabel":"string"},"Latitude":{"description":"- Machine Location Latitude as defined in the Nayax backoffice\n","example":51.0003431,"format":"double","type":"number","uniqueKey":"MachineInfo.GeoLocation.Latitude","typeLabel":"number\u003cdouble>"},"Longitude":{"description":"- Machine Location Longitude as defined in the Nayax backoffice\n","example":23.745245,"format":"double","type":"number","uniqueKey":"MachineInfo.GeoLocation.Longitude","typeLabel":"number\u003cdouble>"},"State":{"description":"- String\n- Optional\n- Actor geo state code as defined in the Nayax backoffice\n","example":"Alabama","type":"string","uniqueKey":"MachineInfo.GeoLocation.State","typeLabel":"string"},"ZipCode":{"description":"String(255)\nOptional\nZip code defined in the Nayax backoffice\n","example":"234234","type":"string","uniqueKey":"MachineInfo.GeoLocation.ZipCode","typeLabel":"string"}},"type":"object","uniqueKey":"MachineInfo.GeoLocation","typeLabel":"object"},"GroupId":{"description":"Internal Nayax group ID.\n","example":"String","type":"string","uniqueKey":"MachineInfo.GroupId","typeLabel":"string"},"Id":{"description":"Unique machine ID as allocated in the Nayax backoffice.\n","example":106791869,"format":"int64","type":"integer","uniqueKey":"MachineInfo.Id","typeLabel":"integer\u003cint64>"},"Name":{"description":"Machine name as defined in the Nayax backoffice. Maximum length: 255 characters.\n","example":"Itai_TestPayCC V2","type":"string","uniqueKey":"MachineInfo.Name","typeLabel":"string"},"Offset":{"description":"UTC timezone offset. Maximum length: 255 characters.\n","example":"3.00","type":"string","uniqueKey":"MachineInfo.Offset","typeLabel":"string"},"OperatorId":{"description":"Merchant ID as defined in the Nayax backoffice. Maximum length: 255 characters.\n","example":2001537302,"type":"string","uniqueKey":"MachineInfo.OperatorId","typeLabel":"string"},"Region":{"description":"Region assigned to the machine in the Nayax backoffice. Maximum length: 255 characters.\n","example":"EU","type":"string","uniqueKey":"MachineInfo.Region","typeLabel":"string"},"TerminalId":{"description":"Optional terminal identifier defined in the Nayax backoffice. Contact Nayax TPOC to configure. Maximum length: 255 characters.\n","example":"8888888844","type":"string","uniqueKey":"MachineInfo.TerminalId","typeLabel":"string"},"Type":{"description":"Machine type as defined in the Nayax backoffice. Maximum length: 50 characters.\n","example":"machine type","type":"string","uniqueKey":"MachineInfo.Type","typeLabel":"string"},"ZipCode":{"description":"Zip or postal code for the machine location. Maximum length: 255 characters.\n","example":"22448Z","type":"string","uniqueKey":"MachineInfo.ZipCode","typeLabel":"string"}},"type":"object","uniqueKey":"MachineInfo","typeLabel":"object"},"PaymentInfo":{"type":"object","additionalProperties":false,"description":"Identifies transaction information and references. Included in all response messages for payment calls.\nWhen used in requests (e.g. `/Settlement`, `/Void`, `/Refund`, `/Inquiry`), this object should match the `PaymentInfo` returned in a previous call.\n","properties":{"SrvTranId":{"type":"string","description":"Integrator's internal transaction ID. Use only if `/StartSession` was not used. If `/StartSession` was used, this should be empty or echo the transaction ID from the request.\n","example":"3584697388","uniqueKey":"PaymentInfo.SrvTranId","typeLabel":"string"},"AuthCode":{"type":"string","description":"External authorization code (usually from the card issuer). In dynamic QR, the approval code from the `/Inquiry` response overrides previous values.\n","example":"333333","uniqueKey":"PaymentInfo.AuthCode","typeLabel":"string"},"AuthAmount":{"type":"number","format":"double","description":"Original amount requested in `/Authorization` or `/Sale`. Optional in other cases.\n","example":5.5,"uniqueKey":"PaymentInfo.AuthAmount","typeLabel":"number\u003cdouble>"},"SettAmount":{"type":"number","format":"double","description":"Final settled amount, used in `/Settlement`, `/Inquiry`, or `/Sale`. In Cortina External Prepaid, this may reflect a discounted amount and is used for reporting only.\n","example":5.5,"uniqueKey":"PaymentInfo.SettAmount","typeLabel":"number\u003cdouble>"},"RRN":{"type":"string","description":"Reference Retrieval Number. Should be visible to the cardholder and match the one in the `/GenerateQR` response.\n","example":"111111","uniqueKey":"PaymentInfo.RRN","typeLabel":"string"},"Token":{"type":"string","description":"Unique token for the transaction. For internal Nayax use only.\n","example":"string","uniqueKey":"PaymentInfo.Token","typeLabel":"string"},"AuthDateTime":{"type":"string","description":"Date and time of the `/Authorization` or `/Sale`. Format: `ddMMyyHHmmss`\n","example":"071221133300","uniqueKey":"PaymentInfo.AuthDateTime","typeLabel":"string"},"SettDateTime":{"type":"string","description":"Date and time of the `/Settlement` or `/Sale`. Format: `ddMMyyHHmmss`\n","example":"071221133330","uniqueKey":"PaymentInfo.SettDateTime","typeLabel":"string"},"TraceNumber":{"type":"string","description":"Trace number. For internal Nayax use only.\n","example":"4444","uniqueKey":"PaymentInfo.TraceNumber","typeLabel":"string"},"AdditionalData":{"type":"string","description":"Optional custom data in JSON format. Contact Nayax to configure.\n","example":"string","uniqueKey":"PaymentInfo.AdditionalData","typeLabel":"string"},"IsGatewayTimeout":{"type":"boolean","description":"Indicates whether there was a gateway timeout.\n","example":false,"uniqueKey":"PaymentInfo.IsGatewayTimeout","typeLabel":"boolean"},"ProviderExternalData":{"type":"string","description":"External data from provider in JSON format.\n","example":"string","uniqueKey":"PaymentInfo.ProviderExternalData","typeLabel":"string"},"InitiateTranReference":{"type":"integer","format":"int64","description":"References the original Nayax transaction ID when reattempting a prepaid loyalty card transaction.\n","example":11223344,"uniqueKey":"PaymentInfo.InitiateTranReference","typeLabel":"integer\u003cint64>"},"IsRevalueCard":{"type":"boolean","description":"Indicates whether the card supports revalue.\n","example":false,"uniqueKey":"PaymentInfo.IsRevalueCard","typeLabel":"boolean"}},"uniqueKey":"PaymentInfo","typeLabel":"object"},"ReasonCode":{"description":"- Optional\n- length: Short integer (16)\n- Refund reason code as saved in Nayax system\n","format":"int16","type":"integer","uniqueKey":"ReasonCode","typeLabel":"integer\u003cint16>"},"ReasonText":{"description":"- Optional\n- length: 64\n- Refund description as saved in Nayax system\n","type":"string","uniqueKey":"ReasonText","typeLabel":"string"}},"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"ActorInfo":{"Country":{"Alpha2Code":"US","Alpha3Code":"USA","Intra":"Europe","Name":"UNITED STATES","NumericCode":"840"},"DynamicURL":"https://www.nayax.com/alternativeURL","GeoLocation":{"Address":"River","City":"Zambezi","CountryCode":"ZM","Latitude":51.0003431,"Longitude":23.745245,"State":"Alabama","ZipCode":"234234"},"Id":2001537302,"MCC":455,"MerchantId":999999888885,"Name":"TestPayCC V2 OP","OperatorId":2001537302,"OperatorName":"TestPayCC V2 OP _ Sub Merchant","SubMerchantId":999999888886},"CustomData":{"Actor":"String","DirectActor":"String","Distributor":"String","Machine":"String","Operator":"String","SoftDecline":"String"},"DeviceInfo":{"FWVersion":"4.0.0.22-RC01 - Aug 25 2021","HwSerial":434324119376526,"Type":"Onyx"},"MachineInfo":{"City":"Abbeville","Country":{"Alpha2Code":"US","Alpha3Code":"USA","Intra":"Europe","Name":"UNITED STATES","NumericCode":"840"},"DecimalPlace":2,"ExternalId":"OperatorExternalID","GeoLocation":{"Address":"River","City":"Zambezi","CountryCode":"ZM","Latitude":51.0003431,"Longitude":23.745245,"State":"Alabama","ZipCode":"234234"},"GroupId":"String","Id":106791869,"Name":"Itai_TestPayCC V2","Offset":"3.00","OperatorId":2001537302,"Region":"EU","TerminalId":"8888888844","Type":"machine type","ZipCode":"22448Z"},"PaymentInfo":{"SrvTranId":"3584697388","AuthCode":"333333","AuthAmount":5.5,"SettAmount":5.5,"RRN":"111111","Token":"string","AuthDateTime":"071221133300","SettDateTime":"071221133330","TraceNumber":"4444","AdditionalData":"string","IsGatewayTimeout":false,"ProviderExternalData":"string","InitiateTranReference":11223344,"IsRevalueCard":false},"ReasonCode":123,"ReasonText":"\u003cstring>"}}},"exampleType":"generated"},"text/json":{"schema":{"additionalProperties":false,"properties":{"ActorInfo":{"additionalProperties":false,"description":"Merchant (Actor) details.","properties":{"Country":{"additionalProperties":false,"description":"Actor and Machine Country information\n","properties":{"Alpha2Code":{"description":"String(2)\nMandatory\nISO-3166-1 format: Alpha-2 code\n","example":"US","type":"string","uniqueKey":"ActorInfo.Country.Alpha2Code","typeLabel":"string"},"Alpha3Code":{"description":"String(3)\nMandatory\nISO-3166-1 format: Alpha-3 code\n","example":"USA","type":"string","uniqueKey":"ActorInfo.Country.Alpha3Code","typeLabel":"string"},"Intra":{"description":"String\nMandatory\nAn Intra Region refers to a geographical diversification across countries within a single 'Intra region'.\nE.g. 'France' is country within the 'European Union' Intra Region.\n","example":"Europe","type":"string","uniqueKey":"ActorInfo.Country.Intra","typeLabel":"string"},"Name":{"description":"String\nMandatory\nCountry Full Name\n","example":"UNITED STATES","type":"string","uniqueKey":"ActorInfo.Country.Name","typeLabel":"string"},"NumericCode":{"description":"String(3)\nMandatory\nISO-3166-1 format: Numeric-3 code\n","example":"840","type":"string","uniqueKey":"ActorInfo.Country.NumericCode","typeLabel":"string"}},"type":"object","uniqueKey":"ActorInfo.Country","typeLabel":"object"},"DynamicURL":{"description":"Optional URL configuration at the actor level. Supports dynamic URLs. \n- Max length: 255.\n","example":"https://www.nayax.com/alternativeURL","type":"string","uniqueKey":"ActorInfo.DynamicURL","typeLabel":"string"},"GeoLocation":{"additionalProperties":false,"description":"Actor and Machine Geo location information","properties":{"Address":{"description":"String(255)\nOptional\nAddress as defined in the Nayax backoffice\n","example":"River","type":"string","uniqueKey":"ActorInfo.GeoLocation.Address","typeLabel":"string"},"City":{"description":"- String(255)\n- Optional\n- City as defined in the Nayax backoffice\n","example":"Zambezi","type":"string","uniqueKey":"ActorInfo.GeoLocation.City","typeLabel":"string"},"CountryCode":{"description":"String\nOptional\nCountry code (ISO3) as defined in the Nayax backoffice\n","example":"ZM","type":"string","uniqueKey":"ActorInfo.GeoLocation.CountryCode","typeLabel":"string"},"Latitude":{"description":"- Machine Location Latitude as defined in the Nayax backoffice\n","example":51.0003431,"format":"double","type":"number","uniqueKey":"ActorInfo.GeoLocation.Latitude","typeLabel":"number\u003cdouble>"},"Longitude":{"description":"- Machine Location Longitude as defined in the Nayax backoffice\n","example":23.745245,"format":"double","type":"number","uniqueKey":"ActorInfo.GeoLocation.Longitude","typeLabel":"number\u003cdouble>"},"State":{"description":"- String\n- Optional\n- Actor geo state code as defined in the Nayax backoffice\n","example":"Alabama","type":"string","uniqueKey":"ActorInfo.GeoLocation.State","typeLabel":"string"},"ZipCode":{"description":"String(255)\nOptional\nZip code defined in the Nayax backoffice\n","example":"234234","type":"string","uniqueKey":"ActorInfo.GeoLocation.ZipCode","typeLabel":"string"}},"type":"object","uniqueKey":"ActorInfo.GeoLocation","typeLabel":"object"},"Id":{"description":"Unique ID of the actor (merchant) as defined in the Nayax backoffice.\n","example":2001537302,"format":"int64","type":"integer","uniqueKey":"ActorInfo.Id","typeLabel":"integer\u003cint64>"},"MCC":{"description":"Merchant Category Code (MCC), classifies businesses by type of goods or services provided.\n","example":455,"format":"int32","type":"integer","uniqueKey":"ActorInfo.MCC","typeLabel":"integer\u003cint32>"},"MerchantId":{"description":"Merchant identifier as defined in the Nayax backoffice. Contact Nayax to configure. \n- Max length: 255.\n","example":999999888885,"type":"string","uniqueKey":"ActorInfo.MerchantId","typeLabel":"string"},"Name":{"description":"Merchant name as registered in the Nayax backoffice. Max length: 255.\n","example":"TestPayCC V2 OP","type":"string","uniqueKey":"ActorInfo.Name","typeLabel":"string"},"OperatorId":{"description":"ID of the operator associated with the merchant. Max length: 255.\n","example":2001537302,"format":"int64","type":"integer","uniqueKey":"ActorInfo.OperatorId","typeLabel":"integer\u003cint64>"},"OperatorName":{"description":"Name of the operator associated with the merchant. Max length: 255.\n","example":"TestPayCC V2 OP _ Sub Merchant","type":"string","uniqueKey":"ActorInfo.OperatorName","typeLabel":"string"},"SubMerchantId":{"description":"Identifier for a sub-merchant under the main merchant. Contact Nayax to configure. Max length: 255.\n","example":999999888886,"type":"string","uniqueKey":"ActorInfo.SubMerchantId","typeLabel":"string"}},"type":"object","uniqueKey":"ActorInfo","typeLabel":"object"},"BasicInfo":{"additionalProperties":false,"description":"Basic transaction information.","properties":{"Amount":{"description":"Transaction amount. Use decimal format (e.g. 0.01 for 1 cent). Currencies without decimal places should also be expressed as a double (e.g. 234.0).\n","example":5,"format":"double","type":"number","isRequired":true,"uniqueKey":"BasicInfo.Amount","typeLabel":"number\u003cdouble>"},"CurrencyCode":{"description":"ISO 4217 currency code in Alpha-3 format (e.g. USD, EUR, ILS).\n","example":"ILS","type":"string","isRequired":true,"uniqueKey":"BasicInfo.CurrencyCode","typeLabel":"string"},"CurrencyNumeric":{"description":"ISO 4217 currency code in Numeric-3 format.\n","example":"376","type":"string","isRequired":true,"uniqueKey":"BasicInfo.CurrencyNumeric","typeLabel":"string"},"TransactionId":{"description":"Unique identifier for the transaction.\n- If `/StartSession` was used, this echoes the encrypted transaction ID (`TranIDCipher`).\n- If not, the Nayax engine generates this value.\n","example":"N99O4XURDQYJZIK4OTCAWF1RHHA40TZWVCRB","type":"string","isRequired":true,"uniqueKey":"BasicInfo.TransactionId","typeLabel":"string"},"AgeLimitation":{"description":"Minimum age required for transaction approval.\n","example":18,"format":"int16","type":"integer","uniqueKey":"BasicInfo.AgeLimitation","typeLabel":"integer\u003cint16>"},"AuditNumber":{"description":"For internal Nayax use.\n","example":342,"format":"int64","type":"integer","uniqueKey":"BasicInfo.AuditNumber","typeLabel":"integer\u003cint64>"},"BillingProviderId":{"description":"ID of the billing provider (assigned by Nayax).\n","example":1,"format":"int32","type":"integer","uniqueKey":"BasicInfo.BillingProviderId","typeLabel":"integer\u003cint32>"},"IsDeferredAuthorization":{"description":"Indicates whether the authorization is deferred.\n","type":"boolean","uniqueKey":"BasicInfo.IsDeferredAuthorization","typeLabel":"boolean"},"IsProductSelected":{"description":"Indicates whether a product was pre-selected before payment.\n","example":true,"type":"boolean","uniqueKey":"BasicInfo.IsProductSelected","typeLabel":"boolean"},"IsSoftDeclineCompletion":{"description":"Indicates whether the transaction was completed after a soft decline.\n","type":"boolean","uniqueKey":"BasicInfo.IsSoftDeclineCompletion","typeLabel":"boolean"},"MachineAuTime":{"description":"Timestamp of machine authorization (DDMMYYHHMMSS).\n","example":71221132914,"type":"string","uniqueKey":"BasicInfo.MachineAuTime","typeLabel":"string"},"NayaxRRN":{"description":"Reference number for external identification. Should be visible to the end-user or external parties (e.g. card issuer, app provider). Echoed in `/Inquiry` requests.\n","example":"111111","type":"string","uniqueKey":"BasicInfo.NayaxRRN","typeLabel":"string"},"NayaxTransactionId":{"description":"Internal Nayax ID used to track the transaction in future requests.\n","example":3584697384,"format":"int64","type":"integer","uniqueKey":"BasicInfo.NayaxTransactionId","typeLabel":"integer\u003cint64>"},"PaymentMethodID":{"description":"ID of the payment method provider (assigned by Nayax).\n","example":1,"format":"int32","type":"integer","uniqueKey":"BasicInfo.PaymentMethodID","typeLabel":"integer\u003cint32>"},"SiteId":{"description":"Region identifier for the Nayax server.\n","example":1,"format":"int16","type":"integer","uniqueKey":"BasicInfo.SiteId","typeLabel":"integer\u003cint16>"},"TimeoutMS":{"description":"Server timeout in milliseconds.\n","example":15000,"format":"int32","type":"integer","uniqueKey":"BasicInfo.TimeoutMS","typeLabel":"integer\u003cint32>"},"TransitElement":{"description":"Transit Element Information","properties":{"DenyListIndication":{"description":"* 0 - unknown/ no effect\n* 1 - Decline will cause consumer to be added to the deny list\n* 2 - Approval shall cause the consumer to be removed from deny list.\n","enum":[0,1,2],"format":"int32","type":"integer","uniqueKey":"BasicInfo.TransitElement.DenyListIndication","typeLabel":"enum\u003cinteger>"},"TransitTransactionType":{"description":"* 1 - Prefunded\n* 2 - Realtime Authorization\n* 3 - Post-Authorization Aggregated Transaction\n* 7 - Debt Recovery\n","enum":[1,2,3,7],"format":"int32","type":"integer","uniqueKey":"BasicInfo.TransitElement.TransitTransactionType","typeLabel":"enum\u003cinteger>"}},"type":"object","uniqueKey":"BasicInfo.TransitElement","typeLabel":"object"}},"required":["TransactionId","Amount","CurrencyCode","CurrencyNumeric"],"type":"object","uniqueKey":"BasicInfo","typeLabel":"object"},"CustomData":{"additionalProperties":false,"description":"Custom Fields Information, Contact Nayax TPOC to define.","properties":{"Actor":{"description":"Actor custom data (String in json format)\n","example":"String","type":"string","uniqueKey":"CustomData.Actor","typeLabel":"string"},"DirectActor":{"description":"Direct actor custom data (String in json format)\n","example":"String","type":"string","uniqueKey":"CustomData.DirectActor","typeLabel":"string"},"Distributor":{"description":"Distributor custom data (String in json format)\n","example":"String","type":"string","uniqueKey":"CustomData.Distributor","typeLabel":"string"},"Machine":{"description":"Machine custom data (String in json format)\n","example":"String","type":"string","uniqueKey":"CustomData.Machine","typeLabel":"string"},"Operator":{"description":"Operator custom data (String in json format)\n","example":"String","type":"string","uniqueKey":"CustomData.Operator","typeLabel":"string"},"SoftDecline":{"description":"Soft Decline custom data (String in json format)\n","example":"String","type":"string","uniqueKey":"CustomData.SoftDecline","typeLabel":"string"}},"type":"object","uniqueKey":"CustomData","typeLabel":"object"},"DeviceInfo":{"additionalProperties":false,"description":"Hardware and firmware information of the Nayax device.","properties":{"FWVersion":{"description":"Firmware version installed on the device.\n","example":"4.0.0.22-RC01 - Aug 25 2021","type":"string","uniqueKey":"DeviceInfo.FWVersion","typeLabel":"string"},"HwSerial":{"description":"Hardware serial number of the Nayax device.\n","example":434324119376526,"type":"string","uniqueKey":"DeviceInfo.HwSerial","typeLabel":"string"},"Type":{"description":"Device type as defined in the Nayax system.\n","example":"Onyx","type":"string","uniqueKey":"DeviceInfo.Type","typeLabel":"string"}},"type":"object","uniqueKey":"DeviceInfo","typeLabel":"object"},"MachineInfo":{"description":"Information about the machine involved in the transaction.","properties":{"City":{"description":"City where the machine is located, as defined in the Nayax backoffice. Maximum length: 255 characters.\n","example":"Abbeville","type":"string","uniqueKey":"MachineInfo.City","typeLabel":"string"},"Country":{"additionalProperties":false,"description":"Actor and Machine Country information\n","properties":{"Alpha2Code":{"description":"String(2)\nMandatory\nISO-3166-1 format: Alpha-2 code\n","example":"US","type":"string","uniqueKey":"MachineInfo.Country.Alpha2Code","typeLabel":"string"},"Alpha3Code":{"description":"String(3)\nMandatory\nISO-3166-1 format: Alpha-3 code\n","example":"USA","type":"string","uniqueKey":"MachineInfo.Country.Alpha3Code","typeLabel":"string"},"Intra":{"description":"String\nMandatory\nAn Intra Region refers to a geographical diversification across countries within a single 'Intra region'.\nE.g. 'France' is country within the 'European Union' Intra Region.\n","example":"Europe","type":"string","uniqueKey":"MachineInfo.Country.Intra","typeLabel":"string"},"Name":{"description":"String\nMandatory\nCountry Full Name\n","example":"UNITED STATES","type":"string","uniqueKey":"MachineInfo.Country.Name","typeLabel":"string"},"NumericCode":{"description":"String(3)\nMandatory\nISO-3166-1 format: Numeric-3 code\n","example":"840","type":"string","uniqueKey":"MachineInfo.Country.NumericCode","typeLabel":"string"}},"type":"object","uniqueKey":"MachineInfo.Country","typeLabel":"object"},"DecimalPlace":{"description":"Number of decimal places for transaction amounts.\n- For example, `2` means values like 123.45. - A value of `0` means 12345 (no decimal).\n","example":2,"format":"int64","type":"integer","uniqueKey":"MachineInfo.DecimalPlace","typeLabel":"integer\u003cint64>"},"ExternalId":{"description":"External machine ID as provided by the operator in the Nayax backoffice. Maximum length: 200 characters.\n","example":"OperatorExternalID","type":"string","uniqueKey":"MachineInfo.ExternalId","typeLabel":"string"},"GeoLocation":{"additionalProperties":false,"description":"Actor and Machine Geo location information","properties":{"Address":{"description":"String(255)\nOptional\nAddress as defined in the Nayax backoffice\n","example":"River","type":"string","uniqueKey":"MachineInfo.GeoLocation.Address","typeLabel":"string"},"City":{"description":"- String(255)\n- Optional\n- City as defined in the Nayax backoffice\n","example":"Zambezi","type":"string","uniqueKey":"MachineInfo.GeoLocation.City","typeLabel":"string"},"CountryCode":{"description":"String\nOptional\nCountry code (ISO3) as defined in the Nayax backoffice\n","example":"ZM","type":"string","uniqueKey":"MachineInfo.GeoLocation.CountryCode","typeLabel":"string"},"Latitude":{"description":"- Machine Location Latitude as defined in the Nayax backoffice\n","example":51.0003431,"format":"double","type":"number","uniqueKey":"MachineInfo.GeoLocation.Latitude","typeLabel":"number\u003cdouble>"},"Longitude":{"description":"- Machine Location Longitude as defined in the Nayax backoffice\n","example":23.745245,"format":"double","type":"number","uniqueKey":"MachineInfo.GeoLocation.Longitude","typeLabel":"number\u003cdouble>"},"State":{"description":"- String\n- Optional\n- Actor geo state code as defined in the Nayax backoffice\n","example":"Alabama","type":"string","uniqueKey":"MachineInfo.GeoLocation.State","typeLabel":"string"},"ZipCode":{"description":"String(255)\nOptional\nZip code defined in the Nayax backoffice\n","example":"234234","type":"string","uniqueKey":"MachineInfo.GeoLocation.ZipCode","typeLabel":"string"}},"type":"object","uniqueKey":"MachineInfo.GeoLocation","typeLabel":"object"},"GroupId":{"description":"Internal Nayax group ID.\n","example":"String","type":"string","uniqueKey":"MachineInfo.GroupId","typeLabel":"string"},"Id":{"description":"Unique machine ID as allocated in the Nayax backoffice.\n","example":106791869,"format":"int64","type":"integer","uniqueKey":"MachineInfo.Id","typeLabel":"integer\u003cint64>"},"Name":{"description":"Machine name as defined in the Nayax backoffice. Maximum length: 255 characters.\n","example":"Itai_TestPayCC V2","type":"string","uniqueKey":"MachineInfo.Name","typeLabel":"string"},"Offset":{"description":"UTC timezone offset. Maximum length: 255 characters.\n","example":"3.00","type":"string","uniqueKey":"MachineInfo.Offset","typeLabel":"string"},"OperatorId":{"description":"Merchant ID as defined in the Nayax backoffice. Maximum length: 255 characters.\n","example":2001537302,"type":"string","uniqueKey":"MachineInfo.OperatorId","typeLabel":"string"},"Region":{"description":"Region assigned to the machine in the Nayax backoffice. Maximum length: 255 characters.\n","example":"EU","type":"string","uniqueKey":"MachineInfo.Region","typeLabel":"string"},"TerminalId":{"description":"Optional terminal identifier defined in the Nayax backoffice. Contact Nayax TPOC to configure. Maximum length: 255 characters.\n","example":"8888888844","type":"string","uniqueKey":"MachineInfo.TerminalId","typeLabel":"string"},"Type":{"description":"Machine type as defined in the Nayax backoffice. Maximum length: 50 characters.\n","example":"machine type","type":"string","uniqueKey":"MachineInfo.Type","typeLabel":"string"},"ZipCode":{"description":"Zip or postal code for the machine location. Maximum length: 255 characters.\n","example":"22448Z","type":"string","uniqueKey":"MachineInfo.ZipCode","typeLabel":"string"}},"type":"object","uniqueKey":"MachineInfo","typeLabel":"object"},"PaymentInfo":{"type":"object","additionalProperties":false,"description":"Identifies transaction information and references. Included in all response messages for payment calls.\nWhen used in requests (e.g. `/Settlement`, `/Void`, `/Refund`, `/Inquiry`), this object should match the `PaymentInfo` returned in a previous call.\n","properties":{"SrvTranId":{"type":"string","description":"Integrator's internal transaction ID. Use only if `/StartSession` was not used. If `/StartSession` was used, this should be empty or echo the transaction ID from the request.\n","example":"3584697388","uniqueKey":"PaymentInfo.SrvTranId","typeLabel":"string"},"AuthCode":{"type":"string","description":"External authorization code (usually from the card issuer). In dynamic QR, the approval code from the `/Inquiry` response overrides previous values.\n","example":"333333","uniqueKey":"PaymentInfo.AuthCode","typeLabel":"string"},"AuthAmount":{"type":"number","format":"double","description":"Original amount requested in `/Authorization` or `/Sale`. Optional in other cases.\n","example":5.5,"uniqueKey":"PaymentInfo.AuthAmount","typeLabel":"number\u003cdouble>"},"SettAmount":{"type":"number","format":"double","description":"Final settled amount, used in `/Settlement`, `/Inquiry`, or `/Sale`. In Cortina External Prepaid, this may reflect a discounted amount and is used for reporting only.\n","example":5.5,"uniqueKey":"PaymentInfo.SettAmount","typeLabel":"number\u003cdouble>"},"RRN":{"type":"string","description":"Reference Retrieval Number. Should be visible to the cardholder and match the one in the `/GenerateQR` response.\n","example":"111111","uniqueKey":"PaymentInfo.RRN","typeLabel":"string"},"Token":{"type":"string","description":"Unique token for the transaction. For internal Nayax use only.\n","example":"string","uniqueKey":"PaymentInfo.Token","typeLabel":"string"},"AuthDateTime":{"type":"string","description":"Date and time of the `/Authorization` or `/Sale`. Format: `ddMMyyHHmmss`\n","example":"071221133300","uniqueKey":"PaymentInfo.AuthDateTime","typeLabel":"string"},"SettDateTime":{"type":"string","description":"Date and time of the `/Settlement` or `/Sale`. Format: `ddMMyyHHmmss`\n","example":"071221133330","uniqueKey":"PaymentInfo.SettDateTime","typeLabel":"string"},"TraceNumber":{"type":"string","description":"Trace number. For internal Nayax use only.\n","example":"4444","uniqueKey":"PaymentInfo.TraceNumber","typeLabel":"string"},"AdditionalData":{"type":"string","description":"Optional custom data in JSON format. Contact Nayax to configure.\n","example":"string","uniqueKey":"PaymentInfo.AdditionalData","typeLabel":"string"},"IsGatewayTimeout":{"type":"boolean","description":"Indicates whether there was a gateway timeout.\n","example":false,"uniqueKey":"PaymentInfo.IsGatewayTimeout","typeLabel":"boolean"},"ProviderExternalData":{"type":"string","description":"External data from provider in JSON format.\n","example":"string","uniqueKey":"PaymentInfo.ProviderExternalData","typeLabel":"string"},"InitiateTranReference":{"type":"integer","format":"int64","description":"References the original Nayax transaction ID when reattempting a prepaid loyalty card transaction.\n","example":11223344,"uniqueKey":"PaymentInfo.InitiateTranReference","typeLabel":"integer\u003cint64>"},"IsRevalueCard":{"type":"boolean","description":"Indicates whether the card supports revalue.\n","example":false,"uniqueKey":"PaymentInfo.IsRevalueCard","typeLabel":"boolean"}},"uniqueKey":"PaymentInfo","typeLabel":"object"},"ReasonCode":{"description":"- Optional\n- length: Short integer (16)\n- Refund reason code as saved in Nayax system\n","format":"int16","type":"integer","uniqueKey":"ReasonCode","typeLabel":"integer\u003cint16>"},"ReasonText":{"description":"- Optional\n- length: 64\n- Refund description as saved in Nayax system\n","type":"string","uniqueKey":"ReasonText","typeLabel":"string"}},"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"ActorInfo":{"Country":{"Alpha2Code":"US","Alpha3Code":"USA","Intra":"Europe","Name":"UNITED STATES","NumericCode":"840"},"DynamicURL":"https://www.nayax.com/alternativeURL","GeoLocation":{"Address":"River","City":"Zambezi","CountryCode":"ZM","Latitude":51.0003431,"Longitude":23.745245,"State":"Alabama","ZipCode":"234234"},"Id":2001537302,"MCC":455,"MerchantId":999999888885,"Name":"TestPayCC V2 OP","OperatorId":2001537302,"OperatorName":"TestPayCC V2 OP _ Sub Merchant","SubMerchantId":999999888886},"CustomData":{"Actor":"String","DirectActor":"String","Distributor":"String","Machine":"String","Operator":"String","SoftDecline":"String"},"DeviceInfo":{"FWVersion":"4.0.0.22-RC01 - Aug 25 2021","HwSerial":434324119376526,"Type":"Onyx"},"MachineInfo":{"City":"Abbeville","Country":{"Alpha2Code":"US","Alpha3Code":"USA","Intra":"Europe","Name":"UNITED STATES","NumericCode":"840"},"DecimalPlace":2,"ExternalId":"OperatorExternalID","GeoLocation":{"Address":"River","City":"Zambezi","CountryCode":"ZM","Latitude":51.0003431,"Longitude":23.745245,"State":"Alabama","ZipCode":"234234"},"GroupId":"String","Id":106791869,"Name":"Itai_TestPayCC V2","Offset":"3.00","OperatorId":2001537302,"Region":"EU","TerminalId":"8888888844","Type":"machine type","ZipCode":"22448Z"},"PaymentInfo":{"SrvTranId":"3584697388","AuthCode":"333333","AuthAmount":5.5,"SettAmount":5.5,"RRN":"111111","Token":"string","AuthDateTime":"071221133300","SettDateTime":"071221133330","TraceNumber":"4444","AdditionalData":"string","IsGatewayTimeout":false,"ProviderExternalData":"string","InitiateTranReference":11223344,"IsRevalueCard":false},"ReasonCode":123,"ReasonText":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"fc9891a9-bffd-40e9-b2a5-e35c7f030690":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"PaymentInfo":{"type":"object","additionalProperties":false,"description":"Identifies transaction information and references. Included in all response messages for payment calls.\nWhen used in requests (e.g. `/Settlement`, `/Void`, `/Refund`, `/Inquiry`), this object should match the `PaymentInfo` returned in a previous call.\n","properties":{"SrvTranId":{"type":"string","description":"Integrator's internal transaction ID. Use only if `/StartSession` was not used. If `/StartSession` was used, this should be empty or echo the transaction ID from the request.\n","example":"3584697388","uniqueKey":"PaymentInfo.SrvTranId","typeLabel":"string"},"AuthCode":{"type":"string","description":"External authorization code (usually from the card issuer). In dynamic QR, the approval code from the `/Inquiry` response overrides previous values.\n","example":"333333","uniqueKey":"PaymentInfo.AuthCode","typeLabel":"string"},"AuthAmount":{"type":"number","format":"double","description":"Original amount requested in `/Authorization` or `/Sale`. Optional in other cases.\n","example":5.5,"uniqueKey":"PaymentInfo.AuthAmount","typeLabel":"number\u003cdouble>"},"SettAmount":{"type":"number","format":"double","description":"Final settled amount, used in `/Settlement`, `/Inquiry`, or `/Sale`. In Cortina External Prepaid, this may reflect a discounted amount and is used for reporting only.\n","example":5.5,"uniqueKey":"PaymentInfo.SettAmount","typeLabel":"number\u003cdouble>"},"RRN":{"type":"string","description":"Reference Retrieval Number. Should be visible to the cardholder and match the one in the `/GenerateQR` response.\n","example":"111111","uniqueKey":"PaymentInfo.RRN","typeLabel":"string"},"Token":{"type":"string","description":"Unique token for the transaction. For internal Nayax use only.\n","example":"string","uniqueKey":"PaymentInfo.Token","typeLabel":"string"},"AuthDateTime":{"type":"string","description":"Date and time of the `/Authorization` or `/Sale`. Format: `ddMMyyHHmmss`\n","example":"071221133300","uniqueKey":"PaymentInfo.AuthDateTime","typeLabel":"string"},"SettDateTime":{"type":"string","description":"Date and time of the `/Settlement` or `/Sale`. Format: `ddMMyyHHmmss`\n","example":"071221133330","uniqueKey":"PaymentInfo.SettDateTime","typeLabel":"string"},"TraceNumber":{"type":"string","description":"Trace number. For internal Nayax use only.\n","example":"4444","uniqueKey":"PaymentInfo.TraceNumber","typeLabel":"string"},"AdditionalData":{"type":"string","description":"Optional custom data in JSON format. Contact Nayax to configure.\n","example":"string","uniqueKey":"PaymentInfo.AdditionalData","typeLabel":"string"},"IsGatewayTimeout":{"type":"boolean","description":"Indicates whether there was a gateway timeout.\n","example":false,"uniqueKey":"PaymentInfo.IsGatewayTimeout","typeLabel":"boolean"},"ProviderExternalData":{"type":"string","description":"External data from provider in JSON format.\n","example":"string","uniqueKey":"PaymentInfo.ProviderExternalData","typeLabel":"string"},"InitiateTranReference":{"type":"integer","format":"int64","description":"References the original Nayax transaction ID when reattempting a prepaid loyalty card transaction.\n","example":11223344,"uniqueKey":"PaymentInfo.InitiateTranReference","typeLabel":"integer\u003cint64>"},"IsRevalueCard":{"type":"boolean","description":"Indicates whether the card supports revalue.\n","example":false,"uniqueKey":"PaymentInfo.IsRevalueCard","typeLabel":"boolean"}},"uniqueKey":"PaymentInfo","typeLabel":"object"},"Status":{"additionalProperties":false,"description":"Transaction status","properties":{"Code":{"description":"- Conditional - Only if verdict value is declined\n- Please refer to the Decline Reasons Code List in the relevant Overview section for full list of allowed decline codes\n","format":"int32","type":"integer","uniqueKey":"Status.Code","typeLabel":"integer\u003cint32>"},"CustomDeclineCode":{"description":"- Always mirrors the value of the Code field when Code is present, regardless of Verdict.\n- Included in all responses (Approved or Declined) whenever Code is present.\n","format":"int32","type":"integer","uniqueKey":"Status.CustomDeclineCode","typeLabel":"integer\u003cint32>"},"StatusMessage":{"description":"- Optional\n- Length: 255\n- Transaction status message free text field / additional varying data\n","type":"string","uniqueKey":"Status.StatusMessage","typeLabel":"string"},"Verdict":{"description":"- Mandatory\n- Const string values:\n- Status of the request ('Approved'/'Declined')\n","type":"string","uniqueKey":"Status.Verdict","typeLabel":"string"}},"type":"object","uniqueKey":"Status","typeLabel":"object"}},"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"PaymentInfo":{"SrvTranId":"3584697388","AuthCode":"333333","AuthAmount":5.5,"SettAmount":5.5,"RRN":"111111","Token":"string","AuthDateTime":"071221133300","SettDateTime":"071221133330","TraceNumber":"4444","AdditionalData":"string","IsGatewayTimeout":false,"ProviderExternalData":"string","InitiateTranReference":11223344,"IsRevalueCard":false},"Status":{"Code":123,"CustomDeclineCode":123,"StatusMessage":"\u003cstring>","Verdict":"\u003cstring>"}}}},"exampleType":"generated"},"text/json":{"schema":{"additionalProperties":false,"properties":{"PaymentInfo":{"type":"object","additionalProperties":false,"description":"Identifies transaction information and references. Included in all response messages for payment calls.\nWhen used in requests (e.g. `/Settlement`, `/Void`, `/Refund`, `/Inquiry`), this object should match the `PaymentInfo` returned in a previous call.\n","properties":{"SrvTranId":{"type":"string","description":"Integrator's internal transaction ID. Use only if `/StartSession` was not used. If `/StartSession` was used, this should be empty or echo the transaction ID from the request.\n","example":"3584697388","uniqueKey":"PaymentInfo.SrvTranId","typeLabel":"string"},"AuthCode":{"type":"string","description":"External authorization code (usually from the card issuer). In dynamic QR, the approval code from the `/Inquiry` response overrides previous values.\n","example":"333333","uniqueKey":"PaymentInfo.AuthCode","typeLabel":"string"},"AuthAmount":{"type":"number","format":"double","description":"Original amount requested in `/Authorization` or `/Sale`. Optional in other cases.\n","example":5.5,"uniqueKey":"PaymentInfo.AuthAmount","typeLabel":"number\u003cdouble>"},"SettAmount":{"type":"number","format":"double","description":"Final settled amount, used in `/Settlement`, `/Inquiry`, or `/Sale`. In Cortina External Prepaid, this may reflect a discounted amount and is used for reporting only.\n","example":5.5,"uniqueKey":"PaymentInfo.SettAmount","typeLabel":"number\u003cdouble>"},"RRN":{"type":"string","description":"Reference Retrieval Number. Should be visible to the cardholder and match the one in the `/GenerateQR` response.\n","example":"111111","uniqueKey":"PaymentInfo.RRN","typeLabel":"string"},"Token":{"type":"string","description":"Unique token for the transaction. For internal Nayax use only.\n","example":"string","uniqueKey":"PaymentInfo.Token","typeLabel":"string"},"AuthDateTime":{"type":"string","description":"Date and time of the `/Authorization` or `/Sale`. Format: `ddMMyyHHmmss`\n","example":"071221133300","uniqueKey":"PaymentInfo.AuthDateTime","typeLabel":"string"},"SettDateTime":{"type":"string","description":"Date and time of the `/Settlement` or `/Sale`. Format: `ddMMyyHHmmss`\n","example":"071221133330","uniqueKey":"PaymentInfo.SettDateTime","typeLabel":"string"},"TraceNumber":{"type":"string","description":"Trace number. For internal Nayax use only.\n","example":"4444","uniqueKey":"PaymentInfo.TraceNumber","typeLabel":"string"},"AdditionalData":{"type":"string","description":"Optional custom data in JSON format. Contact Nayax to configure.\n","example":"string","uniqueKey":"PaymentInfo.AdditionalData","typeLabel":"string"},"IsGatewayTimeout":{"type":"boolean","description":"Indicates whether there was a gateway timeout.\n","example":false,"uniqueKey":"PaymentInfo.IsGatewayTimeout","typeLabel":"boolean"},"ProviderExternalData":{"type":"string","description":"External data from provider in JSON format.\n","example":"string","uniqueKey":"PaymentInfo.ProviderExternalData","typeLabel":"string"},"InitiateTranReference":{"type":"integer","format":"int64","description":"References the original Nayax transaction ID when reattempting a prepaid loyalty card transaction.\n","example":11223344,"uniqueKey":"PaymentInfo.InitiateTranReference","typeLabel":"integer\u003cint64>"},"IsRevalueCard":{"type":"boolean","description":"Indicates whether the card supports revalue.\n","example":false,"uniqueKey":"PaymentInfo.IsRevalueCard","typeLabel":"boolean"}},"uniqueKey":"PaymentInfo","typeLabel":"object"},"Status":{"additionalProperties":false,"description":"Transaction status","properties":{"Code":{"description":"- Conditional - Only if verdict value is declined\n- Please refer to the Decline Reasons Code List in the relevant Overview section for full list of allowed decline codes\n","format":"int32","type":"integer","uniqueKey":"Status.Code","typeLabel":"integer\u003cint32>"},"CustomDeclineCode":{"description":"- Always mirrors the value of the Code field when Code is present, regardless of Verdict.\n- Included in all responses (Approved or Declined) whenever Code is present.\n","format":"int32","type":"integer","uniqueKey":"Status.CustomDeclineCode","typeLabel":"integer\u003cint32>"},"StatusMessage":{"description":"- Optional\n- Length: 255\n- Transaction status message free text field / additional varying data\n","type":"string","uniqueKey":"Status.StatusMessage","typeLabel":"string"},"Verdict":{"description":"- Mandatory\n- Const string values:\n- Status of the request ('Approved'/'Declined')\n","type":"string","uniqueKey":"Status.Verdict","typeLabel":"string"}},"type":"object","uniqueKey":"Status","typeLabel":"object"}},"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"PaymentInfo":{"SrvTranId":"3584697388","AuthCode":"333333","AuthAmount":5.5,"SettAmount":5.5,"RRN":"111111","Token":"string","AuthDateTime":"071221133300","SettDateTime":"071221133330","TraceNumber":"4444","AdditionalData":"string","IsGatewayTimeout":false,"ProviderExternalData":"string","InitiateTranReference":11223344,"IsRevalueCard":false},"Status":{"Code":123,"CustomDeclineCode":123,"StatusMessage":"\u003cstring>","Verdict":"\u003cstring>"}}}},"exampleType":"generated"}},"description":"Success","exampleType":"generated"}},"security":{},"servers":{"ed3c12c7-8b55-4dd2-a341-f8b83db93e68":{"url":"https://{domain}:{port}","variables":{"domain":{"default":"example.com","description":"Customer ID assigned by the service provider"},"port":{"default":"443","enum":["443","8443"]}}}}},"originalFileLocation":"openapi/cortina.yaml"},"subdomain":"nayax-44d6e37b","siteName":"Nayax Developer Portal","title":"Cortina DynamicQR Refund - Nayax Developer Portal","contextualStarterQuestions":[{"_id":"6aa1a3ae370ee193ba7f5e5f","deploymentId":"69981f91cf2ae4e6561a0441","questionText":"What refund reasons are available?","status":"active","generatedBy":"contextual","path":"reference/cortina/dynamicqr/cortina-dynamicqr-refund","createdAt":"2026-09-09T18:21:34.997Z","updatedAt":"2026-09-09T18:21:34.997Z","__v":0},{"_id":"6aa1a3ae370ee193ba7f5e60","deploymentId":"69981f91cf2ae4e6561a0441","questionText":"Can I refund partial payments?","status":"active","generatedBy":"contextual","path":"reference/cortina/dynamicqr/cortina-dynamicqr-refund","createdAt":"2026-09-09T18:21:34.997Z","updatedAt":"2026-09-09T18:21:34.997Z","__v":0},{"_id":"6aa1a3ae370ee193ba7f5e5e","deploymentId":"69981f91cf2ae4e6561a0441","questionText":"How do I process a refund?","status":"active","generatedBy":"contextual","path":"reference/cortina/dynamicqr/cortina-dynamicqr-refund","createdAt":"2026-09-09T18:21:34.997Z","updatedAt":"2026-09-09T18:21:34.997Z","__v":0}],"navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"en":{"href":"/reference/cortina/dynamicqr/cortina-dynamicqr-refund","matchLevel":0},"zh":{"href":"/reference/cortina/dynamicqr/cortina-dynamicqr-refund","matchLevel":0}}},"lastModified":"2026-10-23T16:39:30.872Z","originalFileLocation":"reference/cortina/dynamicqr/cortina-dynamicqr-refund.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=\"Cortina DynamicQR Refund - 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/cortina/dynamicqr/cortina-dynamicqr-refund\">\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=DynamicQR\u0026amp;title=Cortina+DynamicQR+Refund\u0026amp;theme=09b4e344a36ca47397141e43\u0026amp;signature=9fe50ca4c4e8654c48eb3ba917586e6cb46f674d986bae3cb4c7c127757aef00\">\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=\"Cortina DynamicQR Refund - Nayax Developer Portal\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://nayax-44d6e37b.mintlify.app/_mintlify/api/og/v2?division=DynamicQR\u0026amp;title=Cortina+DynamicQR+Refund\u0026amp;theme=09b4e344a36ca47397141e43\u0026amp;signature=9fe50ca4c4e8654c48eb3ba917586e6cb46f674d986bae3cb4c7c127757aef00\">\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/cortina/dynamicqr/cortina-dynamicqr-refund\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/reference/cortina/dynamicqr/cortina-dynamicqr-refund.md\">\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/cortina/dynamicqr/cortina-dynamicqr-refund#webpage\",\"url\":\"https://devzone.nayax.com/reference/cortina/dynamicqr/cortina-dynamicqr-refund\",\"name\":\"Cortina DynamicQR Refund\",\"dateModified\":\"2026-10-23T16:39:30.872Z\",\"isPartOf\":{\"@id\":\"https://devzone.nayax.com#website\"},\"breadcrumb\":{\"@id\":\"https://devzone.nayax.com/reference/cortina/dynamicqr/cortina-dynamicqr-refund#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://devzone.nayax.com/reference/cortina/dynamicqr/cortina-dynamicqr-refund#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API Reference\",\"item\":\"https://devzone.nayax.com/reference/cortina/cortina/cortina-age-verification\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Endpoints\",\"item\":\"https://devzone.nayax.com/reference/cortina/cortina/cortina-age-verification\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"DynamicQR\",\"item\":\"https://devzone.nayax.com/reference/cortina/dynamicqr/cortina-dynamicqr-generateqr\"},{\"@type\":\"ListItem\",\"position\":4,\"name\":\"Cortina DynamicQR Refund\",\"item\":\"https://devzone.nayax.com/reference/cortina/dynamicqr/cortina-dynamicqr-refund\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://devzone.nayax.com/reference/cortina/dynamicqr/cortina-dynamicqr-refund#apireference\",\"headline\":\"Cortina DynamicQR Refund\",\"name\":\"Cortina DynamicQR Refund\",\"url\":\"https://devzone.nayax.com/reference/cortina/dynamicqr/cortina-dynamicqr-refund\",\"mainEntityOfPage\":{\"@id\":\"https://devzone.nayax.com/reference/cortina/dynamicqr/cortina-dynamicqr-refund#webpage\"},\"dateModified\":\"2026-10-23T16:39:30.872Z\",\"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,"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","pages":[{"title":"Spark","href":"/docs/integrate-pos-device/spark/spark"}]}],"pages":[{"title":"Terminal SDKs","href":"/docs/integrate-pos-device/marshall/marshall-sdk"}]},{"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","groups":[{"group":"Cortina Guides","pages":[{"title":"Overview","href":"/docs/cortina/overview-cortina"},{"title":"Integration Process","href":"/docs/cortina/cortina-integration"},{"title":"Cortina Network Requirements","sidebarTitle":"Network Requirements","href":"/docs/cortina/network-requirements"},{"group":"Start Session","root":{"title":"Start Session","href":"/docs/cortina/start-session/index"},"pages":[{"title":"Authentication Process","href":"/docs/cortina/start-session/cortina-auth"}]},{"title":"Sale End Notification","href":"/docs/cortina/sale-end-notification"},{"group":"Prepaid Card","root":{"title":"Prepaid Card","href":"/docs/cortina/prepaid-card/prepaid-card-flows"},"pages":[{"title":"Authorization","href":"/docs/cortina/prepaid-card/prepaid-card-authorization"},{"title":"Settlement","href":"/docs/cortina/prepaid-card/prepaid-card-settlement"},{"title":"Cancel","href":"/docs/cortina/prepaid-card/prepaid-card-cancel"},{"title":"Sale","href":"/docs/cortina/prepaid-card/prepaid-card-sale"},{"title":"Void","href":"/docs/cortina/prepaid-card/prepaid-card-void"},{"title":"Refund","href":"/docs/cortina/prepaid-card/prepaid-card-refund"},{"title":"Decline Reasons","href":"/docs/cortina/prepaid-card/prepaid-card-decline-reasons"},{"title":"Remaining Prepaid Balance","href":"/docs/cortina/prepaid-card/check-balance"},{"title":"Partial Approval in Authorization","href":"/docs/cortina/prepaid-card/partial-approval-for-prepaid"},{"title":"Discounts","href":"/docs/cortina/prepaid-card/discount"}]},{"group":"StaticQR","root":{"title":"StaticQR","href":"/docs/cortina/staticqr/staticqr-flows"},"pages":[{"title":"Start","href":"/docs/cortina/staticqr/static-qr-start"},{"title":"Authorization","href":"/docs/cortina/staticqr/static-qr-authorization"},{"title":"Settlement","href":"/docs/cortina/staticqr/static-qr-settlement"},{"title":"Cancel","href":"/docs/cortina/staticqr/static-qr-cancel"},{"title":"Sale","href":"/docs/cortina/staticqr/static-qr-sale"},{"title":"Void","href":"/docs/cortina/staticqr/static-qr-void"},{"title":"Refund","href":"/docs/cortina/staticqr/static-qr-refund"},{"title":"StaticQR Decline Reasons","href":"/docs/cortina/staticqr/staticqr-decline-reasons"},{"title":"On Screen QR Display","href":"/docs/cortina/staticqr/on-screen-qr-display"},{"title":"Product Remote Vend","href":"/docs/cortina/staticqr/remote-vend"}]},{"group":"DynamicQR","root":{"title":"DynamicQR","href":"/docs/cortina/dynamicqr/cortina-dynamicqr"},"pages":[{"title":"DynamicQR Decline Reasons","href":"/docs/cortina/dynamicqr/dynamicqr-decline-reasons"},{"title":"GenerateQR","href":"/docs/cortina/dynamicqr/dynamicqr-generateqr"},{"title":"Inquiry","href":"/docs/cortina/dynamicqr/dynamicqr-inquiry"},{"title":"Void","href":"/docs/cortina/dynamicqr/dynamicqr-void"},{"title":"Refund","href":"/docs/cortina/dynamicqr/dynamicqr-refund"}]},{"group":"Credit Card","root":{"title":"Credit Card","href":"/docs/cortina/credit-card/cortina-credit-card-flows"},"pages":[{"title":"Credit Card Decline Reasons","href":"/docs/cortina/credit-card/credit-card-decline-reasons"},{"title":"Partial Approval in Authorization","href":"/docs/cortina/credit-card/partial-approval"},{"title":"Incremental Authorization","href":"/docs/cortina/credit-card/incremental-authorization-1"},{"title":"EMV Response Tags","href":"/docs/cortina/credit-card/emv-response-tags"},{"group":"PIN Processing","root":{"title":"PIN Processing","href":"/docs/cortina/credit-card/pin-processing/index"},"pages":[{"title":"Receive the PIN Block","href":"/docs/cortina/credit-card/pin-processing/receiving-the-pin-block"},{"title":"Dynamic Key Exchange","href":"/docs/cortina/credit-card/pin-processing/dynamic-key-exchange"},{"title":"Strong Customer Authentication (SCA)","href":"/docs/cortina/credit-card/pin-processing/strong-customer-authentication-sca"}]}]},{"title":"Refunds","href":"/docs/cortina/refunds"},{"title":"Cancel Type Codes","href":"/docs/cortina/cancel-types"},{"group":"Cortina FAQs","root":{"title":"Cortina FAQs","href":"/docs/cortina/cortina-faqs/index"},"pages":[{"title":"Prepaid Card","href":"/docs/cortina/cortina-faqs/cortina-prepaid-faq"},{"title":"StaticQR","href":"/docs/cortina/cortina-faqs/faq-2"},{"title":"DynamicQR","href":"/docs/cortina/cortina-faqs/faq-3"}]}]},{"group":"API Reference","pages":[{"group":"Endpoints","pages":[{"group":"Cortina","pages":[{"title":"Cortina Age Verification","deprecated":null,"version":null,"openapi":"/openapi/cortina.yaml post /Cortina/AgeVerification","href":"/reference/cortina/cortina/cortina-age-verification"},{"title":"Post Renew Key","deprecated":null,"version":null,"openapi":"/openapi/cortina.yaml post /Cortina/RenewKey","href":"/reference/cortina/cortina/post-renew-key"},{"title":"Post Sale End Notification","deprecated":null,"version":null,"openapi":"/openapi/cortina.yaml post /Cortina/SaleEndNotification","href":"/reference/cortina/cortina/post-sale-end-notification"},{"title":"Post Start Session","deprecated":null,"version":null,"openapi":"/openapi/cortina.yaml post /Cortina/StartSession","href":"/reference/cortina/cortina/post-start-session"}]},{"group":"Cortina Credit Card","pages":[{"title":"Cortina Credit Card Authorization","deprecated":null,"version":null,"openapi":"/openapi/cortina.yaml post /Cortina/CreditCard/Authorization","href":"/reference/cortina/cortina-credit-card/cortina-credit-card-authorization"},{"title":"Cortina Credit Card Cancel","deprecated":null,"version":null,"openapi":"/openapi/cortina.yaml post /Cortina/CreditCard/Cancel","href":"/reference/cortina/cortina-credit-card/cortina-credit-card-cancel"},{"title":"Cortina Credit Card Incremental Auth","deprecated":null,"version":null,"openapi":"/openapi/cortina.yaml post /Cortina/CreditCard/IncrementalAuth","href":"/reference/cortina/cortina-credit-card/cortina-credit-card-incremental-auth"},{"title":"Cortina Credit Card Inquiry3DS","deprecated":null,"version":null,"openapi":"/openapi/cortina.yaml post /Cortina/CreditCard/Inquiry3DS","href":"/reference/cortina/cortina-credit-card/cortina-credit-card-inquiry3ds"},{"title":"Cortina Credit Card Refund","deprecated":null,"version":null,"openapi":"/openapi/cortina.yaml post /Cortina/CreditCard/Refund","href":"/reference/cortina/cortina-credit-card/cortina-credit-card-refund"},{"title":"Cortina Credit Card Sale","deprecated":null,"version":null,"openapi":"/openapi/cortina.yaml post /Cortina/CreditCard/Sale","href":"/reference/cortina/cortina-credit-card/cortina-credit-card-sale"},{"title":"Cortina Credit Card Settlement","deprecated":null,"version":null,"openapi":"/openapi/cortina.yaml post /Cortina/CreditCard/Settlement","href":"/reference/cortina/cortina-credit-card/cortina-credit-card-settlement"},{"title":"Cortina Credit Card Void","deprecated":null,"version":null,"openapi":"/openapi/cortina.yaml post /Cortina/CreditCard/Void","href":"/reference/cortina/cortina-credit-card/cortina-credit-card-void"}]},{"group":"DynamicQR","pages":[{"title":"Cortina DynamicQR GenerateQR","deprecated":null,"version":null,"openapi":"/openapi/cortina.yaml post /Cortina/DynamicQR/GenerateQR","href":"/reference/cortina/dynamicqr/cortina-dynamicqr-generateqr"},{"title":"Cortina DynamicQR Inquiry","description":null,"deprecated":null,"version":null,"openapi":"/openapi/cortina.yaml post /Cortina/DynamicQR/Inquiry","href":"/reference/cortina/dynamicqr/cortina-dynamicqr-inquiry"},{"title":"Cortina DynamicQR Refund","deprecated":null,"version":null,"openapi":"/openapi/cortina.yaml post /Cortina/DynamicQR/Refund","href":"/reference/cortina/dynamicqr/cortina-dynamicqr-refund"},{"title":"Cortina DynamicQR Void","description":null,"deprecated":null,"version":null,"openapi":"/openapi/cortina.yaml post /Cortina/DynamicQR/Void","href":"/reference/cortina/dynamicqr/cortina-dynamicqr-void"}]},{"group":"Cortina Prepaid","pages":[{"title":"Cortina Prepaid Authorization","deprecated":null,"version":null,"openapi":"/openapi/cortina.yaml post /Cortina/Prepaid/Authorization","href":"/reference/cortina/cortina-prepaid/cortina-prepaid-authorization"},{"title":"Cortina Prepaid Cancel","deprecated":null,"version":null,"openapi":"/openapi/cortina.yaml post /Cortina/Prepaid/Cancel","href":"/reference/cortina/cortina-prepaid/cortina-prepaid-cancel"},{"title":"Cortina Prepaid Refund","deprecated":null,"version":null,"openapi":"/openapi/cortina.yaml post /Cortina/Prepaid/Refund","href":"/reference/cortina/cortina-prepaid/cortina-prepaid-refund"},{"title":"Cortina Prepaid Sale","deprecated":null,"version":null,"openapi":"/openapi/cortina.yaml post /Cortina/Prepaid/Sale","href":"/reference/cortina/cortina-prepaid/cortina-prepaid-sale"},{"title":"Cortina Prepaid Settlement","deprecated":null,"version":null,"openapi":"/openapi/cortina.yaml post /Cortina/Prepaid/Settlement","href":"/reference/cortina/cortina-prepaid/cortina-prepaid-settlement"},{"title":"Cortina Prepaid Void","deprecated":null,"version":null,"openapi":"/openapi/cortina.yaml post /Cortina/Prepaid/Void","href":"/reference/cortina/cortina-prepaid/cortina-prepaid-void"}]},{"group":"StaticQR","pages":[{"title":"Cortina StaticQR Authorization","deprecated":null,"version":null,"openapi":"/openapi/cortina.yaml post /Cortina/StaticQR/Authorization","href":"/reference/cortina/staticqr/cortina-staticqr-authorization"},{"title":"Cortina StaticQR Cancel","deprecated":null,"version":null,"openapi":"/openapi/cortina.yaml post /Cortina/StaticQR/Cancel","href":"/reference/cortina/staticqr/cortina-staticqr-cancel"},{"title":"Cortina StaticQR Refund","deprecated":null,"version":null,"openapi":"/openapi/cortina.yaml post /Cortina/StaticQR/Refund","href":"/reference/cortina/staticqr/cortina-staticqr-refund"},{"title":"Cortina StaticQR Sale","deprecated":null,"version":null,"openapi":"/openapi/cortina.yaml post /Cortina/StaticQR/Sale","href":"/reference/cortina/staticqr/cortina-staticqr-sale"},{"title":"Cortina StaticQR Settlement","deprecated":null,"version":null,"openapi":"/openapi/cortina.yaml post /Cortina/StaticQR/Settlement","href":"/reference/cortina/staticqr/cortina-staticqr-settlement"},{"title":"Cortina StaticQR Void","deprecated":null,"version":null,"openapi":"/openapi/cortina.yaml post /Cortina/StaticQR/Void","href":"/reference/cortina/staticqr/cortina-staticqr-void"},{"title":"Cortina StaticQR Start","deprecated":null,"version":null,"openapi":"/openapi/cortina.yaml post /Cortina/{integratorName}/start","href":"/reference/cortina/staticqr/cortina-staticqr-start"}]},{"group":"Cortina Onboarding","pages":[{"title":"Onboard Actor","deprecated":null,"version":null,"openapi":"/openapi/cortina.yaml post /OnboardActor","href":"/reference/cortina/cortina-onboarding/onboard-actor"},{"title":"Onboard Machine","deprecated":null,"version":null,"openapi":"/openapi/cortina.yaml post /OnboardMachine","href":"/reference/cortina/cortina-onboarding/onboard-machine"},{"title":"Get Version","deprecated":null,"version":null,"openapi":"/openapi/cortina.yaml get /Version","href":"/reference/cortina/cortina-onboarding/get-version"}]}]}]}]},{"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","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","pages":[{"title":"Spark","href":"/docs/zh/integrate-pos-device/spark/spark"}]}],"pages":[{"title":"Terminal SDKs","href":"/docs/zh/integrate-pos-device/marshall/marshall-sdk"}]},{"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","groups":[{"group":"Cortina Guides","pages":[{"title":"概述","href":"/docs/zh/cortina/overview-cortina"},{"title":"集成过程","href":"/docs/zh/cortina/cortina-integration"},{"title":"网络要求","href":"/docs/zh/cortina/network-requirements"},{"group":"Start Session","root":{"title":"开始会话","href":"/docs/zh/cortina/start-session/index"},"pages":[{"title":"身份验证流程","href":"/docs/zh/cortina/start-session/cortina-auth"}]},{"title":"销售结束通知","href":"/docs/zh/cortina/sale-end-notification"},{"group":"Prepaid Card","root":{"title":"预付卡","href":"/docs/zh/cortina/prepaid-card/prepaid-card-flows"},"pages":[{"title":"授权","href":"/docs/zh/cortina/prepaid-card/prepaid-card-authorization"},{"title":"沉降","href":"/docs/zh/cortina/prepaid-card/prepaid-card-settlement"},{"title":"取消","href":"/docs/zh/cortina/prepaid-card/prepaid-card-cancel"},{"title":"销售","href":"/docs/zh/cortina/prepaid-card/prepaid-card-sale"},{"title":"Void","href":"/docs/zh/cortina/prepaid-card/prepaid-card-void"},{"title":"退款","href":"/docs/zh/cortina/prepaid-card/prepaid-card-refund"},{"title":"下降原因","href":"/docs/zh/cortina/prepaid-card/prepaid-card-decline-reasons"},{"title":"剩余预付余额","href":"/docs/zh/cortina/prepaid-card/check-balance"},{"title":"部分批准授权","href":"/docs/zh/cortina/prepaid-card/partial-approval-for-prepaid"},{"title":"折扣","href":"/docs/zh/cortina/prepaid-card/discount"}]},{"group":"StaticQR","root":{"title":"静态二维码","href":"/docs/zh/cortina/staticqr/staticqr-flows"},"pages":[{"title":"开始","href":"/docs/zh/cortina/staticqr/static-qr-start"},{"title":"授权","href":"/docs/zh/cortina/staticqr/static-qr-authorization"},{"title":"沉降","href":"/docs/zh/cortina/staticqr/static-qr-settlement"},{"title":"取消","href":"/docs/zh/cortina/staticqr/static-qr-cancel"},{"title":"销售","href":"/docs/zh/cortina/staticqr/static-qr-sale"},{"title":"Void","href":"/docs/zh/cortina/staticqr/static-qr-void"},{"title":"退款","href":"/docs/zh/cortina/staticqr/static-qr-refund"},{"title":"静态二维码被拒原因","href":"/docs/zh/cortina/staticqr/staticqr-decline-reasons"},{"title":"屏幕二维码显示","href":"/docs/zh/cortina/staticqr/on-screen-qr-display"},{"title":"产品远程销售","href":"/docs/zh/cortina/staticqr/remote-vend"}]},{"group":"DynamicQR","root":{"title":"动态二维码","href":"/docs/zh/cortina/dynamicqr/cortina-dynamicqr"},"pages":[{"title":"DynamicQR 拒绝原因","href":"/docs/zh/cortina/dynamicqr/dynamicqr-decline-reasons"},{"title":"生成二维码","href":"/docs/zh/cortina/dynamicqr/dynamicqr-generateqr"},{"title":"询问","href":"/docs/zh/cortina/dynamicqr/dynamicqr-inquiry"},{"title":"Void","href":"/docs/zh/cortina/dynamicqr/dynamicqr-void"},{"title":"退款","href":"/docs/zh/cortina/dynamicqr/dynamicqr-refund"}]},{"group":"Credit Card","root":{"title":"信用卡","href":"/docs/zh/cortina/credit-card/cortina-credit-card-flows"},"pages":[{"title":"信用卡被拒的原因","href":"/docs/zh/cortina/credit-card/credit-card-decline-reasons"},{"title":"部分批准授权","href":"/docs/zh/cortina/credit-card/partial-approval"},{"title":"增量授权","href":"/docs/zh/cortina/credit-card/incremental-authorization-1"},{"title":"EMV响应标签","href":"/docs/zh/cortina/credit-card/emv-response-tags"},{"group":"PIN Processing","root":{"title":"PIN 码处理","href":"/docs/zh/cortina/credit-card/pin-processing/index"},"pages":[{"title":"接收 PIN Block","href":"/docs/zh/cortina/credit-card/pin-processing/receiving-the-pin-block"},{"title":"动态密钥交换","href":"/docs/zh/cortina/credit-card/pin-processing/dynamic-key-exchange"},{"title":"强客户身份验证 (SCA)","href":"/docs/zh/cortina/credit-card/pin-processing/strong-customer-authentication-sca"}]}]},{"title":"退款","href":"/docs/zh/cortina/refunds"},{"group":"Cortina FAQs","root":{"title":"Cortina常见问题解答","href":"/docs/zh/cortina/cortina-faqs/index"},"pages":[{"title":"预付卡","href":"/docs/zh/cortina/cortina-faqs/cortina-prepaid-faq"},{"title":"静态二维码","href":"/docs/zh/cortina/cortina-faqs/faq-2"},{"title":"动态二维码","href":"/docs/zh/cortina/cortina-faqs/faq-3"}]}]},{"group":"API Reference","pages":[{"group":"Endpoints","pages":[{"group":"Cortina","pages":[{"title":"Cortina Age Verification","deprecated":null,"version":null,"openapi":"/openapi/cortina.yaml post /Cortina/AgeVerification","href":"/reference/cortina/cortina/cortina-age-verification"},{"title":"Post Renew Key","deprecated":null,"version":null,"openapi":"/openapi/cortina.yaml post /Cortina/RenewKey","href":"/reference/cortina/cortina/post-renew-key"},{"title":"Post Sale End Notification","deprecated":null,"version":null,"openapi":"/openapi/cortina.yaml post /Cortina/SaleEndNotification","href":"/reference/cortina/cortina/post-sale-end-notification"},{"title":"Post Start Session","deprecated":null,"version":null,"openapi":"/openapi/cortina.yaml post /Cortina/StartSession","href":"/reference/cortina/cortina/post-start-session"}]},{"group":"Cortina Credit Card","pages":[{"title":"Cortina Credit Card Authorization","deprecated":null,"version":null,"openapi":"/openapi/cortina.yaml post /Cortina/CreditCard/Authorization","href":"/reference/cortina/cortina-credit-card/cortina-credit-card-authorization"},{"title":"Cortina Credit Card Cancel","deprecated":null,"version":null,"openapi":"/openapi/cortina.yaml post /Cortina/CreditCard/Cancel","href":"/reference/cortina/cortina-credit-card/cortina-credit-card-cancel"},{"title":"Cortina Credit Card Incremental Auth","deprecated":null,"version":null,"openapi":"/openapi/cortina.yaml post /Cortina/CreditCard/IncrementalAuth","href":"/reference/cortina/cortina-credit-card/cortina-credit-card-incremental-auth"},{"title":"Cortina Credit Card Inquiry3DS","deprecated":null,"version":null,"openapi":"/openapi/cortina.yaml post /Cortina/CreditCard/Inquiry3DS","href":"/reference/cortina/cortina-credit-card/cortina-credit-card-inquiry3ds"},{"title":"Cortina Credit Card Refund","deprecated":null,"version":null,"openapi":"/openapi/cortina.yaml post /Cortina/CreditCard/Refund","href":"/reference/cortina/cortina-credit-card/cortina-credit-card-refund"},{"title":"Cortina Credit Card Sale","deprecated":null,"version":null,"openapi":"/openapi/cortina.yaml post /Cortina/CreditCard/Sale","href":"/reference/cortina/cortina-credit-card/cortina-credit-card-sale"},{"title":"Cortina Credit Card Settlement","deprecated":null,"version":null,"openapi":"/openapi/cortina.yaml post /Cortina/CreditCard/Settlement","href":"/reference/cortina/cortina-credit-card/cortina-credit-card-settlement"},{"title":"Cortina Credit Card Void","deprecated":null,"version":null,"openapi":"/openapi/cortina.yaml post /Cortina/CreditCard/Void","href":"/reference/cortina/cortina-credit-card/cortina-credit-card-void"}]},{"group":"DynamicQR","pages":[{"title":"Cortina DynamicQR GenerateQR","deprecated":null,"version":null,"openapi":"/openapi/cortina.yaml post /Cortina/DynamicQR/GenerateQR","href":"/reference/cortina/dynamicqr/cortina-dynamicqr-generateqr"},{"title":"Cortina DynamicQR Inquiry","description":null,"deprecated":null,"version":null,"openapi":"/openapi/cortina.yaml post /Cortina/DynamicQR/Inquiry","href":"/reference/cortina/dynamicqr/cortina-dynamicqr-inquiry"},{"title":"Cortina DynamicQR Refund","deprecated":null,"version":null,"openapi":"/openapi/cortina.yaml post /Cortina/DynamicQR/Refund","href":"/reference/cortina/dynamicqr/cortina-dynamicqr-refund"},{"title":"Cortina DynamicQR Void","description":null,"deprecated":null,"version":null,"openapi":"/openapi/cortina.yaml post /Cortina/DynamicQR/Void","href":"/reference/cortina/dynamicqr/cortina-dynamicqr-void"}]},{"group":"Cortina Prepaid","pages":[{"title":"Cortina Prepaid Authorization","deprecated":null,"version":null,"openapi":"/openapi/cortina.yaml post /Cortina/Prepaid/Authorization","href":"/reference/cortina/cortina-prepaid/cortina-prepaid-authorization"},{"title":"Cortina Prepaid Cancel","deprecated":null,"version":null,"openapi":"/openapi/cortina.yaml post /Cortina/Prepaid/Cancel","href":"/reference/cortina/cortina-prepaid/cortina-prepaid-cancel"},{"title":"Cortina Prepaid Refund","deprecated":null,"version":null,"openapi":"/openapi/cortina.yaml post /Cortina/Prepaid/Refund","href":"/reference/cortina/cortina-prepaid/cortina-prepaid-refund"},{"title":"Cortina Prepaid Sale","deprecated":null,"version":null,"openapi":"/openapi/cortina.yaml post /Cortina/Prepaid/Sale","href":"/reference/cortina/cortina-prepaid/cortina-prepaid-sale"},{"title":"Cortina Prepaid Settlement","deprecated":null,"version":null,"openapi":"/openapi/cortina.yaml post /Cortina/Prepaid/Settlement","href":"/reference/cortina/cortina-prepaid/cortina-prepaid-settlement"},{"title":"Cortina Prepaid Void","deprecated":null,"version":null,"openapi":"/openapi/cortina.yaml post /Cortina/Prepaid/Void","href":"/reference/cortina/cortina-prepaid/cortina-prepaid-void"}]},{"group":"StaticQR","pages":[{"title":"Cortina StaticQR Authorization","deprecated":null,"version":null,"openapi":"/openapi/cortina.yaml post /Cortina/StaticQR/Authorization","href":"/reference/cortina/staticqr/cortina-staticqr-authorization"},{"title":"Cortina StaticQR Cancel","deprecated":null,"version":null,"openapi":"/openapi/cortina.yaml post /Cortina/StaticQR/Cancel","href":"/reference/cortina/staticqr/cortina-staticqr-cancel"},{"title":"Cortina StaticQR Refund","deprecated":null,"version":null,"openapi":"/openapi/cortina.yaml post /Cortina/StaticQR/Refund","href":"/reference/cortina/staticqr/cortina-staticqr-refund"},{"title":"Cortina StaticQR Sale","deprecated":null,"version":null,"openapi":"/openapi/cortina.yaml post /Cortina/StaticQR/Sale","href":"/reference/cortina/staticqr/cortina-staticqr-sale"},{"title":"Cortina StaticQR Settlement","deprecated":null,"version":null,"openapi":"/openapi/cortina.yaml post /Cortina/StaticQR/Settlement","href":"/reference/cortina/staticqr/cortina-staticqr-settlement"},{"title":"Cortina StaticQR Void","deprecated":null,"version":null,"openapi":"/openapi/cortina.yaml post /Cortina/StaticQR/Void","href":"/reference/cortina/staticqr/cortina-staticqr-void"},{"title":"Cortina StaticQR Start","deprecated":null,"version":null,"openapi":"/openapi/cortina.yaml post /Cortina/{integratorName}/start","href":"/reference/cortina/staticqr/cortina-staticqr-start"}]},{"group":"Cortina Onboarding","pages":[{"title":"Onboard Actor","deprecated":null,"version":null,"openapi":"/openapi/cortina.yaml post /OnboardActor","href":"/reference/cortina/cortina-onboarding/onboard-actor"},{"title":"Onboard Machine","deprecated":null,"version":null,"openapi":"/openapi/cortina.yaml post /OnboardMachine","href":"/reference/cortina/cortina-onboarding/onboard-machine"},{"title":"Get Version","deprecated":null,"version":null,"openapi":"/openapi/cortina.yaml get /Version","href":"/reference/cortina/cortina-onboarding/get-version"}]}]}]}]},{"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/"}]}]},"title":"Cortina DynamicQR Refund - Nayax Developer Portal","buildId":"dpl_DFJrtvUi8HS5F9nkooKuDJsuD5BM","deploymentId":"dpl_DFJrtvUi8HS5F9nkooKuDJsuD5BM","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-rfhihCWU.js","utils-BmH1XFxk.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-BcNsxPKB.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-BAES3tkd.js","snippetPresets-DCMQBKLP.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-D6l_bzE9.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BOktbnNh.js","shallow-BCs8SgM7.js","getApiPlaygroundDisplay-DEmW5bJB.js","CodeSnippet-CpZOpB9C.js","CodeSnippets-BOBDqibl.js","Page-D5fEM6aW.js","getPastedJson-DH2JBvmr.js","icon-BBJH-kKh.js","MethodPill-D2Sd5NLC.js","DuplicateIcon-CGgfL2qN.js","createIcon-BKudBBzi.js","DynamicMarkdown-85clUA0i.js","SectionHeading-D0JiMgDx.js","axios-vUo_bRtp.js","Markdown-Cfiy0xZO.js","clsx-rL8ZCCw4.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-aeztFa9U.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BywkCr5C.js"]}