JWT RSA token required for authentication. The token should be included in the Authorization header as Bearer <token>.
Nayax will issue tokens to the VAS, signed by a private key, and decrypt them using a public key.
Body
application/json
Request to charge a saved token for a payment.
Request body for processing a transaction (charge token, close transaction).
Payment-related information, including Nayax token ID if applicable.
Show child attributes
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Nayax Developer Portal","colors":{"primary":"#6352E0","light":"#FCC705","dark":"#6352E0"},"logo":{"light":"https://mintcdn.com/nayax-44d6e37b/ag7p0QchXLJNEuNE/images/home/logo_light.svg?fit=max\u0026auto=format\u0026n=ag7p0QchXLJNEuNE\u0026q=85\u0026s=b71aa1a61014633be60cee745d3e978c","dark":"https://mintcdn.com/nayax-44d6e37b/ag7p0QchXLJNEuNE/images/home/logo_dark.svg?fit=max\u0026auto=format\u0026n=ag7p0QchXLJNEuNE\u0026q=85\u0026s=26e496c2ba485bfe41389f473135944e"},"favicon":"https://mintcdn.com/nayax-44d6e37b/th_G6l3xpaCQbV-V/images/favicon.ico?fit=max\u0026auto=format\u0026n=th_G6l3xpaCQbV-V\u0026q=85\u0026s=96a64c93cc563f757e95a29a7ad6637d","api":{"playground":{"display":"none"}},"footer":{"links":[{"header":"Legal \u0026 Policies","items":[{"label":"Privacy Policy","href":"https://www.nayax.com/legal/nayax-general-privacy-policy"},{"label":"Cookie Policy","href":"https://www.nayax.com/cookie-policy"},{"label":"Terms of Use","href":"/docs/get-started/terms-of-service"},{"label":"Code of Ethics","href":"https://www.nayax.com/code-of-ethics"},{"label":"Whistleblowing","href":"https://www.nayax.com/whistleblowing-reporting-form"}]}]},"integrations":{"posthog":{"apiKey":"phc_trwjDEqjYgYGbwbd3aiMU6r4R5qcHqXt7pNzJCoVDtgg","sessionRecording":true}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":true},"navigation":{"languages":[{"language":"en","default":true,"href":""},{"language":"zh","href":"docs/zh"}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"nayax-44d6e37b","hasAudioNarration":false,"actualSubdomain":"nayax-44d6e37b","customDomains":["devzone.nayax.com"],"gitSource":{"type":"github","owner":"writechoiceorg","repo":"nayax-mintlify","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6aea16c5eceed668c0276682","collectionId":"171145e5-03e4-4182-9d14-4cc6b965d3b5","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6aea16c5eceed668c0276682"},"feedback":{"thumbs":true,"agentFeedback":false},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6aea16c5eceed668c0276682","clientVersion":"0.0.4054","searchFilterCounts":[{"language":"en","tag":"Terminal SDKs","count":220},{"language":"zh","tag":"Terminal SDKs","count":220},{"language":"en","tag":"API Reference","count":185},{"language":"zh","tag":"API Reference","count":185},{"language":"en","tag":"Platform Management","count":181},{"language":"zh","tag":"Platform Management","count":181},{"language":"en","tag":"Lynx API","count":173},{"language":"zh","tag":"Lynx API","count":173},{"language":"en","tag":"Endpoints","count":166},{"language":"zh","tag":"Endpoints","count":166},{"language":"en","tag":"Cortina","count":78},{"language":"zh","tag":"Cortina","count":78},{"language":"en","tag":"TweezerComm","count":69},{"language":"en","tag":"TweezerComm Guides","count":69},{"language":"zh","tag":"TweezerComm","count":69},{"language":"zh","tag":"TweezerComm Guides","count":69},{"language":"en","tag":"Marshall","count":44},{"language":"zh","tag":"Marshall","count":44},{"language":"en","tag":"Cortina Guides","count":42},{"language":"zh","tag":"Cortina Guides","count":42},{"language":"default","tag":"Platform Management","count":4},{"language":"default","tag":"Lynx API","count":4},{"language":"default","tag":"Lynx API Guides","count":4},{"language":"default","tag":"Operator","count":1},{"language":"default","tag":"Cards","count":1},{"language":"default","tag":"Machines","count":1}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":true,"enableAskAiSearchBar":true,"deflection":{"enabled":false,"type":"link"}},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"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":"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":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"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/ecom/payments/charge-token","slug":"/reference/ecom/payments/charge-token","pageMetadata":{"openapi":"openapi/ecom.yaml POST /charge-token","title":"Charge Token","description":null,"href":"/reference/ecom/payments/charge-token"},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}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":{"openapi":"openapi/ecom.yaml POST /charge-token","title":"Charge Token","description":null,"href":"/reference/ecom/payments/charge-token"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/nayax-44d6e37b/c0d908800bae3e5a/wcBadge.js"],"openApiReferenceData":{"operation":{"x-mint":{"content":"Processes a payment using a previously saved card token. This endpoint is primarily used for recurring payments (MIT or CIT transactions).\n\n**Important:** This endpoint might be exposed server-to-server for two-step flows, potentially requiring changes in authentication mechanisms. Recurring payment calls will originate from the server only. Fiscalization and eReceipt processes should also be operated during this flow.\n\nProcesses a payment using a previously saved card token. This endpoint is primarily used for recurring payments (MIT or CIT transactions).\n\nThis endpoint may be exposed server-to-server for two-factor authentication flows, potentially requiring changes to authentication mechanisms. Recurring payment calls will originate from the server only. Fiscalization and eReceipt processes should also be operated during this flow.\n\n\u003cNote>\n **Integration URL**\n\n When performing your integration to the API use the stable URL, such as:\n\n * `https: //stable-sdk-api.nayax.com/charge-token`\n\u003c/Note>\n"},"tags":["Payments"],"summary":"Charge Token","requestBody":"16645a01-d2e4-4983-b79d-e070cc13dbad","responses":{"200":"bd25be43-493a-41ee-aeca-7190ea261afb","400":"52857cbe-fe3b-4c05-8d86-fcc0beb1de72","401":"51138d77-7fd6-416f-9d7b-25eaaeba6cdb"},"method":"post","type":"path","servers":["a20cde7d-7e32-499e-bbfd-be4b6df67219"],"security":["b2f180d2-275a-45f1-9630-8d3e7088465a"],"path":"/charge-token","baseUrlOptions":["https://api.nayax.com/sdk"],"title":"Charge Token","description":"","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"description":"Request to charge a saved token for a payment.","required":true,"content":{"application/json":{"schema":{"type":"object","description":"Request body for processing a transaction (charge token, close transaction).","properties":{"basicInfo":{"type":"object","description":"Basic transaction details.","properties":{"sessionExpiration":{"oneOf":[{"type":"string","format":"date-time","description":"Session expiration date and time.","example":"2025-12-31T23:59:59Z","isRequired":true,"uniqueKey":"basicInfo.sessionExpiration.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Session expiration date and time.","example":"2025-12-31T23:59:59Z","isRequired":true,"uniqueKey":"basicInfo.sessionExpiration.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"basicInfo.sessionExpiration","typeLabel":"string\u003cdate-time> | null"},"redirectURL":{"oneOf":[{"type":"string","description":"URL where the shopper should be redirected after a redirection flow.","example":"https://your-merchant.com/callback","isRequired":true,"uniqueKey":"basicInfo.redirectURL.oneOf.0","typeLabel":"string"},{"type":"null","description":"URL where the shopper should be redirected after a redirection flow.","example":"https://your-merchant.com/callback","isRequired":true,"uniqueKey":"basicInfo.redirectURL.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"basicInfo.redirectURL","typeLabel":"string | null"},"amount":{"oneOf":[{"type":"number","format":"double","description":"Transaction amount.","example":15,"isRequired":true,"uniqueKey":"basicInfo.amount.oneOf.0","typeLabel":"number\u003cdouble>"},{"type":"null","format":"double","description":"Transaction amount.","example":15,"isRequired":true,"uniqueKey":"basicInfo.amount.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"basicInfo.amount","typeLabel":"number\u003cdouble> | null"},"countryCode":{"oneOf":[{"type":"string","description":"Country code according to ISO 3166.","example":"US","isRequired":true,"uniqueKey":"basicInfo.countryCode.oneOf.0","typeLabel":"string"},{"type":"null","description":"Country code according to ISO 3166.","example":"US","isRequired":true,"uniqueKey":"basicInfo.countryCode.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"basicInfo.countryCode","typeLabel":"string | null"},"requestType":{"type":"integer","format":"int32","description":"Session transaction type.","enum":[0,1,2,3,4,5,6,7,8,9,10],"x-enum-varnames":["Sale","Auth","Settlement","Void","Refund","PartialRefund","IncrementalAuth","CancelAuth","PartialCapture","AutoCapture","DelayAuth"],"example":0,"isRequired":true,"uniqueKey":"basicInfo.requestType","typeLabel":"enum\u003cinteger>"},"entryMode":{"type":"integer","format":"int32","description":"Indicates the point-of-sale entry mode.\nFor Initialize requests, values may be ECOM, COF or MOTO.\nFor Payment requests, values may be MIT or CIT.","enum":[0,1,2,3,4],"x-enum-varnames":["ECOM","MIT","CIT","COF","MOTO"],"example":0,"isRequired":true,"uniqueKey":"basicInfo.entryMode","typeLabel":"enum\u003cinteger>"},"currency":{"oneOf":[{"type":"string","minLength":3,"maxLength":3,"description":"The three-character ISO currency code according to ISO4217.","example":"USD","uniqueKey":"basicInfo.currency.oneOf.0","typeLabel":"string"},{"type":"null","minLength":3,"maxLength":3,"description":"The three-character ISO currency code according to ISO4217.","example":"USD","uniqueKey":"basicInfo.currency.oneOf.1","typeLabel":"null"}],"uniqueKey":"basicInfo.currency","typeLabel":"string | null"},"tokenModel":{"type":"integer","format":"int32","description":"Conditional (mandatory if EntryMode is COF). Indicates the desired token model. **Note on Token Behaviour**: A token's type (subscription/COF/top-up) is set during its initial creation and stored in our system. If a subsequent [Charge Token](ref:post_charge-token) request includes a different token type parameter, it is ignored. The system always uses the original token type from the initialization request, regardless of what is provided in later charge requests.","enum":[0,1,2],"x-enum-varnames":["StoredCard","Subscription","TopUp"],"example":0,"uniqueKey":"basicInfo.tokenModel","typeLabel":"enum\u003cinteger>"},"platform":{"type":"integer","format":"int32","description":"The platform from which the request originated (e.g., iOS, Android, Web).","enum":[0,1,2],"x-enum-varnames":["iOS","Android","Web"],"example":0,"uniqueKey":"basicInfo.platform","typeLabel":"enum\u003cinteger>"},"isStoredCard":{"oneOf":[{"type":"boolean","description":"Optional. Cardholder approval for card saving.","example":true,"uniqueKey":"basicInfo.isStoredCard.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Optional. Cardholder approval for card saving.","example":true,"uniqueKey":"basicInfo.isStoredCard.oneOf.1","typeLabel":"null"}],"uniqueKey":"basicInfo.isStoredCard","typeLabel":"boolean | null"},"cvc":{"oneOf":[{"type":"integer","format":"int32","description":"Optional (for CIT only). Secure code for transaction verification.","example":123,"uniqueKey":"basicInfo.cvc.oneOf.0","typeLabel":"integer\u003cint32>"},{"type":"null","format":"int32","description":"Optional (for CIT only). Secure code for transaction verification.","example":123,"uniqueKey":"basicInfo.cvc.oneOf.1","typeLabel":"null"}],"uniqueKey":"basicInfo.cvc","typeLabel":"integer\u003cint32> | null"},"token":{"oneOf":[{"type":"string","description":"Conditional (mandatory if EntryMode is MIT or CIT). Saved Card token (Nayax token ID).","example":"NAYAXTOK12345","uniqueKey":"basicInfo.token.oneOf.0","typeLabel":"string"},{"type":"null","description":"Conditional (mandatory if EntryMode is MIT or CIT). Saved Card token (Nayax token ID).","example":"NAYAXTOK12345","uniqueKey":"basicInfo.token.oneOf.1","typeLabel":"null"}],"uniqueKey":"basicInfo.token","typeLabel":"string | null"},"merchantRequestId":{"oneOf":[{"type":"string","description":"The actor's/integrator's transaction ID. Will be passed as \"MerchantTranId\" in the SDK.","example":"MERCHANT_REQ_12345","uniqueKey":"basicInfo.merchantRequestId.oneOf.0","typeLabel":"string"},{"type":"null","description":"The actor's/integrator's transaction ID. Will be passed as \"MerchantTranId\" in the SDK.","example":"MERCHANT_REQ_12345","uniqueKey":"basicInfo.merchantRequestId.oneOf.1","typeLabel":"null"}],"uniqueKey":"basicInfo.merchantRequestId","typeLabel":"string | null"},"transactionId":{"oneOf":[{"type":"string","description":"Conditional Nayax Transaction Identifier, required for second-step transactions (Refund etc.).","example":"NAYAXTRANS98765","uniqueKey":"basicInfo.transactionId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Conditional Nayax Transaction Identifier, required for second-step transactions (Refund etc.).","example":"NAYAXTRANS98765","uniqueKey":"basicInfo.transactionId.oneOf.1","typeLabel":"null"}],"uniqueKey":"basicInfo.transactionId","typeLabel":"string | null"},"transactionTimeUtc":{"oneOf":[{"type":"string","format":"date-time","description":"Conditional. Nayax Transaction Identifier for second-step transactions (Refund etc.).","example":"2025-08-28T10:30:00Z","uniqueKey":"basicInfo.transactionTimeUtc.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Conditional. Nayax Transaction Identifier for second-step transactions (Refund etc.).","example":"2025-08-28T10:30:00Z","uniqueKey":"basicInfo.transactionTimeUtc.oneOf.1","typeLabel":"null"}],"uniqueKey":"basicInfo.transactionTimeUtc","typeLabel":"string\u003cdate-time> | null"},"isSaveTokenWithoutConsent":{"oneOf":[{"type":"boolean","description":"Indicates if the token should be saved without explicit cardholder consent.","example":false,"uniqueKey":"basicInfo.isSaveTokenWithoutConsent.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Indicates if the token should be saved without explicit cardholder consent.","example":false,"uniqueKey":"basicInfo.isSaveTokenWithoutConsent.oneOf.1","typeLabel":"null"}],"uniqueKey":"basicInfo.isSaveTokenWithoutConsent","typeLabel":"boolean | null"}},"additionalProperties":false,"required":["amount","countryCode","requestType","entryMode","sessionExpiration","redirectURL"],"uniqueKey":"basicInfo","typeLabel":"object"},"machineInfo":{"type":"object","description":"Information about the machine/terminal.","properties":{"machineId":{"oneOf":[{"type":"string","description":"Machine entity unique ID allocated in the Nayax Backoffice.","example":"0434334921100366","isRequired":true,"uniqueKey":"machineInfo.machineId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Machine entity unique ID allocated in the Nayax Backoffice.","example":"0434334921100366","isRequired":true,"uniqueKey":"machineInfo.machineId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"machineInfo.machineId","typeLabel":"string | null"}},"additionalProperties":false,"required":["machineId"],"uniqueKey":"machineInfo","typeLabel":"object"},"validationKey":{"oneOf":[{"type":"string","description":"Validation key from the authentication flow.","example":"AUTH_KEY_FROM_VALIDATE","uniqueKey":"validationKey.oneOf.0","typeLabel":"string"},{"type":"null","description":"Validation key from the authentication flow.","example":"AUTH_KEY_FROM_VALIDATE","uniqueKey":"validationKey.oneOf.1","typeLabel":"null"}],"uniqueKey":"validationKey","typeLabel":"string | null"},"cardHolderInfo":{"type":"object","description":"Cardholder details.","properties":{"cardholderCountry":{"oneOf":[{"type":"string","description":"Optional. Country of the cardholder.","example":"US","uniqueKey":"cardHolderInfo.cardholderCountry.oneOf.0","typeLabel":"string"},{"type":"null","description":"Optional. Country of the cardholder.","example":"US","uniqueKey":"cardHolderInfo.cardholderCountry.oneOf.1","typeLabel":"null"}],"uniqueKey":"cardHolderInfo.cardholderCountry","typeLabel":"string | null"},"paymentPageLan":{"oneOf":[{"type":"string","description":"Optional. Language for the payment page.","example":"en","uniqueKey":"cardHolderInfo.paymentPageLan.oneOf.0","typeLabel":"string"},{"type":"null","description":"Optional. Language for the payment page.","example":"en","uniqueKey":"cardHolderInfo.paymentPageLan.oneOf.1","typeLabel":"null"}],"uniqueKey":"cardHolderInfo.paymentPageLan","typeLabel":"string | null"},"cardholderEmail":{"oneOf":[{"type":"string","description":"Optional (conditional - if COF, mandatory). Cardholder's email address. One of `cardholderEmail` or `cardHolderUniqId` needs to be provided.","example":"john.doe@example.com","uniqueKey":"cardHolderInfo.cardholderEmail.oneOf.0","typeLabel":"string"},{"type":"null","description":"Optional (conditional - if COF, mandatory). Cardholder's email address. One of `cardholderEmail` or `cardHolderUniqId` needs to be provided.","example":"john.doe@example.com","uniqueKey":"cardHolderInfo.cardholderEmail.oneOf.1","typeLabel":"null"}],"uniqueKey":"cardHolderInfo.cardholderEmail","typeLabel":"string | null"},"cardHolderUniqId":{"oneOf":[{"type":"string","description":"Optional (conditional - if MIT/CIT, mandatory). Unique identifier for the cardholder. One of `cardholderEmail` or `cardHolderUniqId` needs to be provided.","example":"unique_customer_id_123","uniqueKey":"cardHolderInfo.cardHolderUniqId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Optional (conditional - if MIT/CIT, mandatory). Unique identifier for the cardholder. One of `cardholderEmail` or `cardHolderUniqId` needs to be provided.","example":"unique_customer_id_123","uniqueKey":"cardHolderInfo.cardHolderUniqId.oneOf.1","typeLabel":"null"}],"uniqueKey":"cardHolderInfo.cardHolderUniqId","typeLabel":"string | null"},"brand":{"oneOf":[{"type":"string","description":"The brand of the card (e.g., VISA, MASTERCARD).","example":"VISA","uniqueKey":"cardHolderInfo.brand.oneOf.0","typeLabel":"string"},{"type":"null","description":"The brand of the card (e.g., VISA, MASTERCARD).","example":"VISA","uniqueKey":"cardHolderInfo.brand.oneOf.1","typeLabel":"null"}],"uniqueKey":"cardHolderInfo.brand","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"cardHolderInfo","typeLabel":"object"},"additionalInfo":{"type":"object","description":"Additional information for the transaction and receipt.","properties":{"additionalData":{"oneOf":[{"type":"string","description":"Optional additional data in JSON format for the channel (iOS, Android, Web).","example":"{\"channel\": \"iOS\", \"campaignId\": \"XYZ789\"}","uniqueKey":"additionalInfo.additionalData.oneOf.0","typeLabel":"string"},{"type":"null","description":"Optional additional data in JSON format for the channel (iOS, Android, Web).","example":"{\"channel\": \"iOS\", \"campaignId\": \"XYZ789\"}","uniqueKey":"additionalInfo.additionalData.oneOf.1","typeLabel":"null"}],"uniqueKey":"additionalInfo.additionalData","typeLabel":"string | null"},"additionalReceiptData":{"oneOf":[{"type":"string","description":"Optional additional data that the integrator wishes to be displayed in the eReceipt (new Weezmo eReceipt).","example":"[{\"key\":\"productCode\", \"value\":\"PROD001\"}, {\"key\":\"customerRating\", \"value\":\"5_STARS\"}]","uniqueKey":"additionalInfo.additionalReceiptData.oneOf.0","typeLabel":"string"},{"type":"null","description":"Optional additional data that the integrator wishes to be displayed in the eReceipt (new Weezmo eReceipt).","example":"[{\"key\":\"productCode\", \"value\":\"PROD001\"}, {\"key\":\"customerRating\", \"value\":\"5_STARS\"}]","uniqueKey":"additionalInfo.additionalReceiptData.oneOf.1","typeLabel":"null"}],"uniqueKey":"additionalInfo.additionalReceiptData","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"additionalInfo","typeLabel":"object"},"originalTransactionId":{"type":"integer","format":"int32","description":"Required for second-step transactions (e.g., refund, void). The original Nayax transaction ID.","example":123456,"uniqueKey":"originalTransactionId","typeLabel":"integer\u003cint32>"},"paymentInfo":{"type":"object","description":"Payment-related information.","properties":{"amount":{"oneOf":[{"type":"number","format":"double","description":"Transaction amount.","example":15,"isRequired":true,"uniqueKey":"paymentInfo.amount.oneOf.0","typeLabel":"number\u003cdouble>"},{"type":"null","format":"double","description":"Transaction amount.","example":15,"isRequired":true,"uniqueKey":"paymentInfo.amount.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"paymentInfo.amount","typeLabel":"number\u003cdouble> | null"},"currency":{"oneOf":[{"type":"string","description":"Currency code according to ISO4217.","example":"USD","isRequired":true,"uniqueKey":"paymentInfo.currency.oneOf.0","typeLabel":"string"},{"type":"null","description":"Currency code according to ISO4217.","example":"USD","isRequired":true,"uniqueKey":"paymentInfo.currency.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"paymentInfo.currency","typeLabel":"string | null"},"authAmount":{"oneOf":[{"type":"number","format":"double","description":"Conditional (if requestType is Auth). The authorized amount.","example":15,"uniqueKey":"paymentInfo.authAmount.oneOf.0","typeLabel":"number\u003cdouble>"},{"type":"null","format":"double","description":"Conditional (if requestType is Auth). The authorized amount.","example":15,"uniqueKey":"paymentInfo.authAmount.oneOf.1","typeLabel":"null"}],"uniqueKey":"paymentInfo.authAmount","typeLabel":"number\u003cdouble> | null"},"nayaxTokenId":{"oneOf":[{"type":"string","description":"Conditional (mandatory if COF). Saved Card token (Nayax token ID).","example":"NAYAXTOK12345","uniqueKey":"paymentInfo.nayaxTokenId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Conditional (mandatory if COF). Saved Card token (Nayax token ID).","example":"NAYAXTOK12345","uniqueKey":"paymentInfo.nayaxTokenId.oneOf.1","typeLabel":"null"}],"uniqueKey":"paymentInfo.nayaxTokenId","typeLabel":"string | null"},"siteId":{"oneOf":[{"type":"integer","format":"int32","description":"Site ID, identifying the region where the transaction originated in Nayax Servers.","example":1,"uniqueKey":"paymentInfo.siteId.oneOf.0","typeLabel":"integer\u003cint32>"},{"type":"null","format":"int32","description":"Site ID, identifying the region where the transaction originated in Nayax Servers.","example":1,"uniqueKey":"paymentInfo.siteId.oneOf.1","typeLabel":"null"}],"uniqueKey":"paymentInfo.siteId","typeLabel":"integer\u003cint32> | null"},"providerTransactionId":{"oneOf":[{"type":"string","description":"Transaction ID from the Payment Service Provider (PSP).","example":"PSP_TRANS_ABC","uniqueKey":"paymentInfo.providerTransactionId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Transaction ID from the Payment Service Provider (PSP).","example":"PSP_TRANS_ABC","uniqueKey":"paymentInfo.providerTransactionId.oneOf.1","typeLabel":"null"}],"uniqueKey":"paymentInfo.providerTransactionId","typeLabel":"string | null"},"providerExternalData":{"oneOf":[{"type":"string","description":"Additional data from the PSP.","example":"{\"pspRef\": \"REF123\", \"riskScore\": 10}","uniqueKey":"paymentInfo.providerExternalData.oneOf.0","typeLabel":"string"},{"type":"null","description":"Additional data from the PSP.","example":"{\"pspRef\": \"REF123\", \"riskScore\": 10}","uniqueKey":"paymentInfo.providerExternalData.oneOf.1","typeLabel":"null"}],"uniqueKey":"paymentInfo.providerExternalData","typeLabel":"string | null"},"decimalPlace":{"oneOf":[{"type":"integer","format":"int32","description":"The number of digits after the decimal point (e.g., amount = 100, decimalPlace = 2 --> amount for payment = 1.00).","example":2,"uniqueKey":"paymentInfo.decimalPlace.oneOf.0","typeLabel":"integer\u003cint32>"},{"type":"null","format":"int32","description":"The number of digits after the decimal point (e.g., amount = 100, decimalPlace = 2 --> amount for payment = 1.00).","example":2,"uniqueKey":"paymentInfo.decimalPlace.oneOf.1","typeLabel":"null"}],"uniqueKey":"paymentInfo.decimalPlace","typeLabel":"integer\u003cint32> | null"}},"additionalProperties":false,"required":["amount","currency"],"uniqueKey":"paymentInfo","typeLabel":"object"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"chargeTokenRequestMIT":{"title":"chargeTokenRequestMIT","value":{"basicInfo":{"amount":25.5,"currency":"EUR","countryCode":"DE","requestType":0,"entryMode":1,"tokenModel":1,"cvc":null,"token":"NAYAXTOK12345","merchantRequestId":"MERCHANT_MIT_001","transactionId":null,"transactionTimeUtc":null,"isSaveTokenWithoutConsent":false},"machineInfo":{"machineId":"0434334921100366"},"cardHolderInfo":{"cardholderEmail":"customer@example.com","cardHolderUniqId":"unique_customer_id_123"},"additionalInfo":{"additionalData":"{\"loyaltyPoints\": 100}","additionalReceiptData":"[{\"key\":\"product\", \"value\":\"Premium Service\"}]"},"validationKey":"AUTH_VALID_KEY_XYZ"}},"chargeTokenRequestCIT":{"title":"chargeTokenRequestCIT","value":{"basicInfo":{"amount":10,"currency":"GBP","countryCode":"UK","requestType":0,"entryMode":2,"tokenModel":2,"cvc":123,"token":"NAYAXTOK67890","merchantRequestId":"MERCHANT_CIT_002","transactionId":null,"transactionTimeUtc":null,"isSaveTokenWithoutConsent":false},"machineInfo":{"machineId":"0434334921100367"},"cardHolderInfo":{"cardholderEmail":"customer2@example.com","cardHolderUniqId":"unique_customer_id_456"},"additionalInfo":{"additionalData":"{\"discountCode\": \"SAVE10\"}","additionalReceiptData":"[{\"key\":\"item\", \"value\":\"Book A\"}]"},"validationKey":"AUTH_VALID_KEY_ABC"}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"bd25be43-493a-41ee-aeca-7190ea261afb":{"description":"Success","content":{"application/json":{"schema":{"type":"object","description":"Response body for a transaction (charge token, close transaction).","properties":{"status":{"type":"object","description":"Transaction status.","properties":{"verdict":{"oneOf":[{"type":"string","description":"Const string values 'Approved' or 'Declined'.","example":"Approved","isRequired":true,"uniqueKey":"status.verdict.oneOf.0","typeLabel":"string"},{"type":"null","description":"Const string values 'Approved' or 'Declined'.","example":"Approved","isRequired":true,"uniqueKey":"status.verdict.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"status.verdict","typeLabel":"string | null"},"code":{"type":"integer","format":"int32","description":"Response code. 0 for Approved, relevant decline code for Declined.","example":0,"uniqueKey":"status.code","typeLabel":"integer\u003cint32>"},"statusMessage":{"oneOf":[{"type":"string","maxLength":255,"description":"Optional. Session status message free text field or additional varying data.","example":"Transaction processed successfully.","uniqueKey":"status.statusMessage.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":255,"description":"Optional. Session status message free text field or additional varying data.","example":"Transaction processed successfully.","uniqueKey":"status.statusMessage.oneOf.1","typeLabel":"null"}],"uniqueKey":"status.statusMessage","typeLabel":"string | null"},"customDeclineCode":{"oneOf":[{"type":"string","description":"Custom decline code, can also be used to return the HashedEcomTransactionId for validate-merchant success.","example":"9515af0d6b5c328b6383ff241fa7b03e489d6285a8db6a4f0d8369e3f044e8d7","uniqueKey":"status.customDeclineCode.oneOf.0","typeLabel":"string"},{"type":"null","description":"Custom decline code, can also be used to return the HashedEcomTransactionId for validate-merchant success.","example":"9515af0d6b5c328b6383ff241fa7b03e489d6285a8db6a4f0d8369e3f044e8d7","uniqueKey":"status.customDeclineCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"status.customDeclineCode","typeLabel":"string | null"}},"additionalProperties":false,"required":["verdict"],"uniqueKey":"status","typeLabel":"object"},"basicInfo":{"type":"object","description":"Basic information about the transaction, including amount, currency, and merchant request ID.","properties":{"sessionExpiration":{"oneOf":[{"type":"string","format":"date-time","description":"Session expiration date and time.","example":"2025-12-31T23:59:59Z","isRequired":true,"uniqueKey":"basicInfo.sessionExpiration.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Session expiration date and time.","example":"2025-12-31T23:59:59Z","isRequired":true,"uniqueKey":"basicInfo.sessionExpiration.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"basicInfo.sessionExpiration","typeLabel":"string\u003cdate-time> | null"},"redirectURL":{"oneOf":[{"type":"string","description":"URL where the shopper should be redirected after a redirection flow.","example":"https://your-merchant.com/callback","isRequired":true,"uniqueKey":"basicInfo.redirectURL.oneOf.0","typeLabel":"string"},{"type":"null","description":"URL where the shopper should be redirected after a redirection flow.","example":"https://your-merchant.com/callback","isRequired":true,"uniqueKey":"basicInfo.redirectURL.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"basicInfo.redirectURL","typeLabel":"string | null"},"amount":{"oneOf":[{"type":"number","format":"double","description":"Transaction amount.","example":15,"isRequired":true,"uniqueKey":"basicInfo.amount.oneOf.0","typeLabel":"number\u003cdouble>"},{"type":"null","format":"double","description":"Transaction amount.","example":15,"isRequired":true,"uniqueKey":"basicInfo.amount.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"basicInfo.amount","typeLabel":"number\u003cdouble> | null"},"countryCode":{"oneOf":[{"type":"string","description":"Country code according to ISO 3166.","example":"US","isRequired":true,"uniqueKey":"basicInfo.countryCode.oneOf.0","typeLabel":"string"},{"type":"null","description":"Country code according to ISO 3166.","example":"US","isRequired":true,"uniqueKey":"basicInfo.countryCode.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"basicInfo.countryCode","typeLabel":"string | null"},"requestType":{"type":"integer","format":"int32","description":"Session transaction type.","enum":[0,1,2,3,4,5,6,7,8,9,10],"x-enum-varnames":["Sale","Auth","Settlement","Void","Refund","PartialRefund","IncrementalAuth","CancelAuth","PartialCapture","AutoCapture","DelayAuth"],"example":0,"isRequired":true,"uniqueKey":"basicInfo.requestType","typeLabel":"enum\u003cinteger>"},"entryMode":{"type":"integer","format":"int32","description":"Indicates the point-of-sale entry mode.\nFor Initialize requests, values may be ECOM, COF or MOTO.\nFor Payment requests, values may be MIT or CIT.","enum":[0,1,2,3,4],"x-enum-varnames":["ECOM","MIT","CIT","COF","MOTO"],"example":0,"isRequired":true,"uniqueKey":"basicInfo.entryMode","typeLabel":"enum\u003cinteger>"},"currency":{"oneOf":[{"type":"string","minLength":3,"maxLength":3,"description":"The three-character ISO currency code according to ISO4217.","example":"USD","uniqueKey":"basicInfo.currency.oneOf.0","typeLabel":"string"},{"type":"null","minLength":3,"maxLength":3,"description":"The three-character ISO currency code according to ISO4217.","example":"USD","uniqueKey":"basicInfo.currency.oneOf.1","typeLabel":"null"}],"uniqueKey":"basicInfo.currency","typeLabel":"string | null"},"tokenModel":{"type":"integer","format":"int32","description":"Conditional (mandatory if EntryMode is COF). Indicates the desired token model. **Note on Token Behaviour**: A token's type (subscription/COF/top-up) is set during its initial creation and stored in our system. If a subsequent [Charge Token](ref:post_charge-token) request includes a different token type parameter, it is ignored. The system always uses the original token type from the initialization request, regardless of what is provided in later charge requests.","enum":[0,1,2],"x-enum-varnames":["StoredCard","Subscription","TopUp"],"example":0,"uniqueKey":"basicInfo.tokenModel","typeLabel":"enum\u003cinteger>"},"platform":{"type":"integer","format":"int32","description":"The platform from which the request originated (e.g., iOS, Android, Web).","enum":[0,1,2],"x-enum-varnames":["iOS","Android","Web"],"example":0,"uniqueKey":"basicInfo.platform","typeLabel":"enum\u003cinteger>"},"isStoredCard":{"oneOf":[{"type":"boolean","description":"Optional. Cardholder approval for card saving.","example":true,"uniqueKey":"basicInfo.isStoredCard.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Optional. Cardholder approval for card saving.","example":true,"uniqueKey":"basicInfo.isStoredCard.oneOf.1","typeLabel":"null"}],"uniqueKey":"basicInfo.isStoredCard","typeLabel":"boolean | null"},"cvc":{"oneOf":[{"type":"integer","format":"int32","description":"Optional (for CIT only). Secure code for transaction verification.","example":123,"uniqueKey":"basicInfo.cvc.oneOf.0","typeLabel":"integer\u003cint32>"},{"type":"null","format":"int32","description":"Optional (for CIT only). Secure code for transaction verification.","example":123,"uniqueKey":"basicInfo.cvc.oneOf.1","typeLabel":"null"}],"uniqueKey":"basicInfo.cvc","typeLabel":"integer\u003cint32> | null"},"token":{"oneOf":[{"type":"string","description":"Conditional (mandatory if EntryMode is MIT or CIT). Saved Card token (Nayax token ID).","example":"NAYAXTOK12345","uniqueKey":"basicInfo.token.oneOf.0","typeLabel":"string"},{"type":"null","description":"Conditional (mandatory if EntryMode is MIT or CIT). Saved Card token (Nayax token ID).","example":"NAYAXTOK12345","uniqueKey":"basicInfo.token.oneOf.1","typeLabel":"null"}],"uniqueKey":"basicInfo.token","typeLabel":"string | null"},"merchantRequestId":{"oneOf":[{"type":"string","description":"The actor's/integrator's transaction ID. Will be passed as \"MerchantTranId\" in the SDK.","example":"MERCHANT_REQ_12345","uniqueKey":"basicInfo.merchantRequestId.oneOf.0","typeLabel":"string"},{"type":"null","description":"The actor's/integrator's transaction ID. Will be passed as \"MerchantTranId\" in the SDK.","example":"MERCHANT_REQ_12345","uniqueKey":"basicInfo.merchantRequestId.oneOf.1","typeLabel":"null"}],"uniqueKey":"basicInfo.merchantRequestId","typeLabel":"string | null"},"transactionId":{"oneOf":[{"type":"string","description":"Conditional Nayax Transaction Identifier, required for second-step transactions (Refund etc.).","example":"NAYAXTRANS98765","uniqueKey":"basicInfo.transactionId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Conditional Nayax Transaction Identifier, required for second-step transactions (Refund etc.).","example":"NAYAXTRANS98765","uniqueKey":"basicInfo.transactionId.oneOf.1","typeLabel":"null"}],"uniqueKey":"basicInfo.transactionId","typeLabel":"string | null"},"transactionTimeUtc":{"oneOf":[{"type":"string","format":"date-time","description":"Conditional. Nayax Transaction Identifier for second-step transactions (Refund etc.).","example":"2025-08-28T10:30:00Z","uniqueKey":"basicInfo.transactionTimeUtc.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Conditional. Nayax Transaction Identifier for second-step transactions (Refund etc.).","example":"2025-08-28T10:30:00Z","uniqueKey":"basicInfo.transactionTimeUtc.oneOf.1","typeLabel":"null"}],"uniqueKey":"basicInfo.transactionTimeUtc","typeLabel":"string\u003cdate-time> | null"},"isSaveTokenWithoutConsent":{"oneOf":[{"type":"boolean","description":"Indicates if the token should be saved without explicit cardholder consent.","example":false,"uniqueKey":"basicInfo.isSaveTokenWithoutConsent.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Indicates if the token should be saved without explicit cardholder consent.","example":false,"uniqueKey":"basicInfo.isSaveTokenWithoutConsent.oneOf.1","typeLabel":"null"}],"uniqueKey":"basicInfo.isSaveTokenWithoutConsent","typeLabel":"boolean | null"}},"additionalProperties":false,"required":["amount","countryCode","requestType","entryMode","sessionExpiration","redirectURL"],"uniqueKey":"basicInfo","typeLabel":"object"},"paymentInfo":{"type":"object","description":"Payment-related information, including Nayax token ID if applicable.","properties":{"amount":{"oneOf":[{"type":"number","format":"double","description":"Transaction amount.","example":15,"isRequired":true,"uniqueKey":"paymentInfo.amount.oneOf.0","typeLabel":"number\u003cdouble>"},{"type":"null","format":"double","description":"Transaction amount.","example":15,"isRequired":true,"uniqueKey":"paymentInfo.amount.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"paymentInfo.amount","typeLabel":"number\u003cdouble> | null"},"currency":{"oneOf":[{"type":"string","description":"Currency code according to ISO4217.","example":"USD","isRequired":true,"uniqueKey":"paymentInfo.currency.oneOf.0","typeLabel":"string"},{"type":"null","description":"Currency code according to ISO4217.","example":"USD","isRequired":true,"uniqueKey":"paymentInfo.currency.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"paymentInfo.currency","typeLabel":"string | null"},"authAmount":{"oneOf":[{"type":"number","format":"double","description":"Conditional (if requestType is Auth). The authorized amount.","example":15,"uniqueKey":"paymentInfo.authAmount.oneOf.0","typeLabel":"number\u003cdouble>"},{"type":"null","format":"double","description":"Conditional (if requestType is Auth). The authorized amount.","example":15,"uniqueKey":"paymentInfo.authAmount.oneOf.1","typeLabel":"null"}],"uniqueKey":"paymentInfo.authAmount","typeLabel":"number\u003cdouble> | null"},"nayaxTokenId":{"oneOf":[{"type":"string","description":"Conditional (mandatory if COF). Saved Card token (Nayax token ID).","example":"NAYAXTOK12345","uniqueKey":"paymentInfo.nayaxTokenId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Conditional (mandatory if COF). Saved Card token (Nayax token ID).","example":"NAYAXTOK12345","uniqueKey":"paymentInfo.nayaxTokenId.oneOf.1","typeLabel":"null"}],"uniqueKey":"paymentInfo.nayaxTokenId","typeLabel":"string | null"},"siteId":{"oneOf":[{"type":"integer","format":"int32","description":"Site ID, identifying the region where the transaction originated in Nayax Servers.","example":1,"uniqueKey":"paymentInfo.siteId.oneOf.0","typeLabel":"integer\u003cint32>"},{"type":"null","format":"int32","description":"Site ID, identifying the region where the transaction originated in Nayax Servers.","example":1,"uniqueKey":"paymentInfo.siteId.oneOf.1","typeLabel":"null"}],"uniqueKey":"paymentInfo.siteId","typeLabel":"integer\u003cint32> | null"},"providerTransactionId":{"oneOf":[{"type":"string","description":"Transaction ID from the Payment Service Provider (PSP).","example":"PSP_TRANS_ABC","uniqueKey":"paymentInfo.providerTransactionId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Transaction ID from the Payment Service Provider (PSP).","example":"PSP_TRANS_ABC","uniqueKey":"paymentInfo.providerTransactionId.oneOf.1","typeLabel":"null"}],"uniqueKey":"paymentInfo.providerTransactionId","typeLabel":"string | null"},"providerExternalData":{"oneOf":[{"type":"string","description":"Additional data from the PSP.","example":"{\"pspRef\": \"REF123\", \"riskScore\": 10}","uniqueKey":"paymentInfo.providerExternalData.oneOf.0","typeLabel":"string"},{"type":"null","description":"Additional data from the PSP.","example":"{\"pspRef\": \"REF123\", \"riskScore\": 10}","uniqueKey":"paymentInfo.providerExternalData.oneOf.1","typeLabel":"null"}],"uniqueKey":"paymentInfo.providerExternalData","typeLabel":"string | null"},"decimalPlace":{"oneOf":[{"type":"integer","format":"int32","description":"The number of digits after the decimal point (e.g., amount = 100, decimalPlace = 2 --> amount for payment = 1.00).","example":2,"uniqueKey":"paymentInfo.decimalPlace.oneOf.0","typeLabel":"integer\u003cint32>"},{"type":"null","format":"int32","description":"The number of digits after the decimal point (e.g., amount = 100, decimalPlace = 2 --> amount for payment = 1.00).","example":2,"uniqueKey":"paymentInfo.decimalPlace.oneOf.1","typeLabel":"null"}],"uniqueKey":"paymentInfo.decimalPlace","typeLabel":"integer\u003cint32> | null"}},"additionalProperties":false,"required":["amount","currency"],"uniqueKey":"paymentInfo","typeLabel":"object"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"chargeTokenResponseApproved":{"title":"chargeTokenResponseApproved","value":{"status":{"verdict":"Approved","code":0,"statusMessage":"Payment processed successfully."},"basicInfo":{"amount":25.5,"currency":"EUR","merchantRequestId":"MERCHANT_MIT_001","transactionId":"NAYAXTRANS98765","transactionTimeUtc":"2025-08-28T10:30:00Z"},"paymentInfo":{"amount":25.5,"currency":"EUR","nayaxTokenId":"NAYAXTOK12345","siteId":1,"providerTransactionId":"PSP_TRANS_ABC","decimalPlace":2}}},"chargeTokenResponseDeclined":{"title":"chargeTokenResponseDeclined","value":{"status":{"verdict":"Declined","code":981,"statusMessage":"Unauthorized – Machine is not active."},"basicInfo":{"amount":10,"currency":"GBP","merchantRequestId":"MERCHANT_CIT_002","transactionId":null,"transactionTimeUtc":null},"paymentInfo":{"amount":null,"currency":null,"nayaxTokenId":null,"siteId":null,"providerTransactionId":null,"decimalPlace":null}}}},"exampleType":"examples"}},"exampleType":"examples"},"52857cbe-fe3b-4c05-8d86-fcc0beb1de72":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","description":"General status object for API responses.","properties":{"verdict":{"oneOf":[{"type":"string","description":"Const string values 'Approved' or 'Declined'.","example":"Approved","isRequired":true,"uniqueKey":"verdict.oneOf.0","typeLabel":"string"},{"type":"null","description":"Const string values 'Approved' or 'Declined'.","example":"Approved","isRequired":true,"uniqueKey":"verdict.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"verdict","typeLabel":"string | null"},"code":{"type":"integer","format":"int32","description":"Response code. 0 for Approved, relevant decline code for Declined.","example":0,"uniqueKey":"code","typeLabel":"integer\u003cint32>"},"statusMessage":{"oneOf":[{"type":"string","maxLength":255,"description":"Optional. Session status message free text field or additional varying data.","example":"Transaction processed successfully.","uniqueKey":"statusMessage.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":255,"description":"Optional. Session status message free text field or additional varying data.","example":"Transaction processed successfully.","uniqueKey":"statusMessage.oneOf.1","typeLabel":"null"}],"uniqueKey":"statusMessage","typeLabel":"string | null"},"customDeclineCode":{"oneOf":[{"type":"string","description":"Custom decline code, can also be used to return the HashedEcomTransactionId for validate-merchant success.","example":"9515af0d6b5c328b6383ff241fa7b03e489d6285a8db6a4f0d8369e3f044e8d7","uniqueKey":"customDeclineCode.oneOf.0","typeLabel":"string"},{"type":"null","description":"Custom decline code, can also be used to return the HashedEcomTransactionId for validate-merchant success.","example":"9515af0d6b5c328b6383ff241fa7b03e489d6285a8db6a4f0d8369e3f044e8d7","uniqueKey":"customDeclineCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"customDeclineCode","typeLabel":"string | null"}},"additionalProperties":false,"required":["verdict"],"uniqueKey":"","typeLabel":"object"},"examples":{"badRequest":{"title":"badRequest","value":{"verdict":"Declined","code":997,"statusMessage":"Did not receive mandatory parameters."}}},"exampleType":"examples"}},"exampleType":"examples"},"51138d77-7fd6-416f-9d7b-25eaaeba6cdb":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","description":"General status object for API responses.","properties":{"verdict":{"oneOf":[{"type":"string","description":"Const string values 'Approved' or 'Declined'.","example":"Approved","isRequired":true,"uniqueKey":"verdict.oneOf.0","typeLabel":"string"},{"type":"null","description":"Const string values 'Approved' or 'Declined'.","example":"Approved","isRequired":true,"uniqueKey":"verdict.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"verdict","typeLabel":"string | null"},"code":{"type":"integer","format":"int32","description":"Response code. 0 for Approved, relevant decline code for Declined.","example":0,"uniqueKey":"code","typeLabel":"integer\u003cint32>"},"statusMessage":{"oneOf":[{"type":"string","maxLength":255,"description":"Optional. Session status message free text field or additional varying data.","example":"Transaction processed successfully.","uniqueKey":"statusMessage.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":255,"description":"Optional. Session status message free text field or additional varying data.","example":"Transaction processed successfully.","uniqueKey":"statusMessage.oneOf.1","typeLabel":"null"}],"uniqueKey":"statusMessage","typeLabel":"string | null"},"customDeclineCode":{"oneOf":[{"type":"string","description":"Custom decline code, can also be used to return the HashedEcomTransactionId for validate-merchant success.","example":"9515af0d6b5c328b6383ff241fa7b03e489d6285a8db6a4f0d8369e3f044e8d7","uniqueKey":"customDeclineCode.oneOf.0","typeLabel":"string"},{"type":"null","description":"Custom decline code, can also be used to return the HashedEcomTransactionId for validate-merchant success.","example":"9515af0d6b5c328b6383ff241fa7b03e489d6285a8db6a4f0d8369e3f044e8d7","uniqueKey":"customDeclineCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"customDeclineCode","typeLabel":"string | null"}},"additionalProperties":false,"required":["verdict"],"uniqueKey":"","typeLabel":"object"},"examples":{"unauthorized":{"title":"unauthorized","value":{"verdict":"Declined","code":980,"statusMessage":"Unauthorized - Authentication failed."}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"b2f180d2-275a-45f1-9630-8d3e7088465a":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"JWT RSA token required for authentication. The token should be included in the `Authorization` header as `Bearer \u003ctoken>`.\nNayax will issue tokens to the VAS, signed by a private key, and decrypt them using a public key.","scopes":[]}}},"servers":{"a20cde7d-7e32-499e-bbfd-be4b6df67219":{"url":"https://api.nayax.com/sdk","description":"Production Nayax SDK API"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"JWT RSA token required for authentication. The token should be included in the `Authorization` header as `Bearer \u003ctoken>`.\nNayax will issue tokens to the VAS, signed by a private key, and decrypt them using a public key.","scopes":[]},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"JWT RSA token required for authentication. The token should be included in the `Authorization` header as `Bearer \u003ctoken>`.\nNayax will issue tokens to the VAS, signed by a private key, and decrypt them using a public key.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"BearerAuth","name":"Authorization"}],"title":"BearerAuth"}]},"originalFileLocation":"openapi/ecom.yaml"},"subdomain":"nayax-44d6e37b","siteName":"Nayax Developer Portal","title":"Charge Token - Nayax Developer Portal","contextualStarterQuestions":[{"_id":"6aea170c10288742fe0a8138","deploymentId":"69981f91cf2ae4e6561a0441","questionText":"When should I use tokens?","status":"active","generatedBy":"contextual","path":"reference/ecom/payments/charge-token","createdAt":"2026-11-03T17:17:00.323Z","updatedAt":"2026-11-03T17:17:00.323Z","__v":0},{"_id":"6aea170c10288742fe0a8137","deploymentId":"69981f91cf2ae4e6561a0441","questionText":"What is a charge token?","status":"active","generatedBy":"contextual","path":"reference/ecom/payments/charge-token","createdAt":"2026-11-03T17:17:00.323Z","updatedAt":"2026-11-03T17:17:00.323Z","__v":0},{"_id":"6aea170c10288742fe0a8136","deploymentId":"69981f91cf2ae4e6561a0441","questionText":"How do I charge a token?","status":"active","generatedBy":"contextual","path":"reference/ecom/payments/charge-token","createdAt":"2026-11-03T17:17:00.323Z","updatedAt":"2026-11-03T17:17:00.323Z","__v":0}],"navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"en":{"href":"/reference/ecom/payments/charge-token","matchLevel":0},"zh":{"href":"/docs/zh","matchLevel":4}}},"lastModified":"2026-11-03T17:16:50.004Z","originalFileLocation":"reference/ecom/payments/charge-token.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=\"Charge Token - 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/ecom/payments/charge-token\">\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=Documentation\u0026amp;title=Charge+Token\u0026amp;theme=09b4e344a36ca47397141e43\u0026amp;signature=98ca3c206acaeb9e2975a8940a3a425e9d889c08cfba14d5b763044c1fe3aa1c\">\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=\"Charge Token - Nayax Developer Portal\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://nayax-44d6e37b.mintlify.app/_mintlify/api/og/v2?division=Documentation\u0026amp;title=Charge+Token\u0026amp;theme=09b4e344a36ca47397141e43\u0026amp;signature=98ca3c206acaeb9e2975a8940a3a425e9d889c08cfba14d5b763044c1fe3aa1c\">\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/ecom/payments/charge-token\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/reference/ecom/payments/charge-token.md\">\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":"Home","mode":"custom","href":""}]},{"tab":"Terminal SDKs","menu":[{"item":"Marshall","groups":[{"group":"Marshall Guides","pages":[{"title":"Overview","href":"/docs/integrate-pos-device/marshall/marshall-sdk"},{"title":"Integration Process","href":"/docs/integrate-pos-device/marshall/get-started/marshall-integration-process"},{"group":"Payment Flows","root":{"title":"Payment Flows","href":"/docs/integrate-pos-device/marshall/payment-flows/marshall-payment-flows"},"pages":[{"title":"Single Session with Pre-Selection","href":"/docs/integrate-pos-device/marshall/payment-flows/marshall-single-session-with-pre-sel"},{"title":"Single Session with Pre-Authorization","href":"/docs/integrate-pos-device/marshall/payment-flows/marshall-single-session-with-pre-auth"},{"title":"Multi-Session","href":"/docs/integrate-pos-device/marshall/payment-flows/marshall-multi-session"},{"title":"Multi-Vending with Pre-Selection","href":"/docs/integrate-pos-device/marshall/payment-flows/marshall-multi-vend-with-pre-sel"},{"title":"Multi-Vending with Pre-Authorization","href":"/docs/integrate-pos-device/marshall/payment-flows/marshall-multi-vend-with-pre-auth"},{"title":"Sub Flows \u0026 Features","href":"/docs/integrate-pos-device/marshall/payment-flows/sub-flows-features"},{"title":"Single Session Pre-Authorization with External Settlement","href":"/docs/integrate-pos-device/marshall/payment-flows/external-settlement-marshall"},{"title":"Multi-Session Pre-Authorization with External Settlement","href":"/docs/integrate-pos-device/marshall/payment-flows/multi-session-pre-authorization-with-external-settlement"}]},{"group":"Get Started","root":{"title":"Get Started","href":"/docs/integrate-pos-device/marshall/get-started/marshall-get-started"},"pages":[{"title":"C# \u0026 Java SDK Integration","href":"/docs/integrate-pos-device/marshall/get-started/marshall-csharp-java-integration"},{"title":"C SDK Integration","href":"/docs/integrate-pos-device/marshall/get-started/c-sdk-integration"},{"title":"VMC Configuration Object","href":"/docs/integrate-pos-device/marshall/get-started/vmc-configuration-object"},{"title":"SDK Flags","href":"/docs/integrate-pos-device/marshall/get-started/sdk-flags-descriptions"},{"title":"Certification Process","href":"/docs/integrate-pos-device/marshall/get-started/certification-proccess"}]},{"group":"Simulators \u0026 Sample Codes","root":{"title":"Simulators \u0026 Sample Codes","href":"/docs/integrate-pos-device/marshall/simulators-sample-codes/marshall-sdk-simulators"},"pages":[{"title":"Java SDK Simulator","href":"/docs/integrate-pos-device/marshall/simulators-sample-codes/java-sdk-simulator"},{"title":"C# SDK Simulator","href":"/docs/integrate-pos-device/marshall/simulators-sample-codes/csharp-sdk-simulator"},{"title":"C SDK Simulator","href":"/docs/integrate-pos-device/marshall/simulators-sample-codes/c-sdk-simulator"},{"title":"C SDK Single Session","href":"/docs/integrate-pos-device/marshall/simulators-sample-codes/single-session"},{"title":"C SDK Multi-Session","href":"/docs/integrate-pos-device/marshall/simulators-sample-codes/multi-session"},{"title":"C SDK Multi-Vend","href":"/docs/integrate-pos-device/marshall/simulators-sample-codes/multi-vend"},{"title":"C SDK Always Idle Mode","href":"/docs/integrate-pos-device/marshall/simulators-sample-codes/marshall-c-always-idle"}]},{"title":"Create Payments","href":"/docs/integrate-pos-device/marshall/marshall-create-payments"},{"group":"Methods \u0026 Functions","root":{"title":"Methods \u0026 Functions","href":"/docs/integrate-pos-device/marshall/methods-functions/marshall-methods-and-functions"},"pages":[{"title":"Framework","href":"/docs/integrate-pos-device/marshall/methods-functions/framework"},{"title":"Link and Events Configuration","href":"/docs/integrate-pos-device/marshall/methods-functions/link-and-events-configuration"},{"title":"Vending Events","href":"/docs/integrate-pos-device/marshall/methods-functions/vending-events"},{"title":"Vending Session Management","href":"/docs/integrate-pos-device/marshall/methods-functions/data-structures"},{"title":"General Marshall Events","href":"/docs/integrate-pos-device/marshall/methods-functions/general-marshall-events"}]},{"group":"HW Integration Kit and Setup","root":{"title":"HW Integration Kit and Setup","href":"/docs/integrate-pos-device/marshall/hw-integration-kit-and-setup/vpos-touch-installation"},"pages":[{"title":"Marshall Integration Kit","href":"/docs/integrate-pos-device/marshall/hw-integration-kit-and-setup/sales-kit"},{"title":"Installation Steps","href":"/docs/integrate-pos-device/marshall/hw-integration-kit-and-setup/installation-steps"},{"title":"Set Up Nayax Core for Marshall Integration","href":"/docs/integrate-pos-device/marshall/hw-integration-kit-and-setup/set-up-nayax-core-for-marshall-integration"}]},{"group":"Logs and Diagnostics","root":{"title":"Log Analysis","href":"/docs/integrate-pos-device/marshall/log-analysis/overview"},"pages":[{"title":"SDK Log Generation","href":"/docs/integrate-pos-device/marshall/log-analysis/log-generation"},{"title":"Log Trace Comparator","href":"/docs/integrate-pos-device/marshall/log-analysis/log-trace-comparator"},{"title":"Checkpoints \u0026 Scenario Tags","href":"/docs/integrate-pos-device/marshall/log-analysis/log-trace-comparator-guide"}]},{"group":"Additional Resources","pages":[{"title":"Display Control (Screen Display)","href":"/docs/integrate-pos-device/marshall/additional-resources/marshall-display"},{"title":"Transfer Data","href":"/docs/integrate-pos-device/marshall/additional-resources/marshall-ontransferdata"},{"title":"Stability \u0026 Starvation Issues","href":"/docs/integrate-pos-device/marshall/additional-resources/stablity-issues"},{"title":"Capabilities","href":"/docs/integrate-pos-device/marshall/additional-resources/capabilities"}]},{"group":"Marshall FAQs","root":{"title":"Marshall FAQs","href":"/docs/integrate-pos-device/marshall/marshall-faqs/index"},"pages":[{"title":"General","href":"/docs/integrate-pos-device/marshall/marshall-faqs/faq-general"},{"title":"Device","href":"/docs/integrate-pos-device/marshall/marshall-faqs/faq"},{"title":"Flow \u0026 Configurations","href":"/docs/integrate-pos-device/marshall/marshall-faqs/faq-marshall-flowconfigurations"}]}]},{"group":"Marshall Release Notes","pages":[{"title":"Marshall Java SDK Release Notes","sidebarTitle":"Java","href":"/docs/integrate-pos-device/marshall/marshall-java-release-notes"},{"title":"Marshall C# SDK Release Notes","sidebarTitle":"C#","href":"/docs/integrate-pos-device/marshall/marshall-csharp-release-notes"},{"title":"Marshall C SDK Release Notes","sidebarTitle":"C","href":"/docs/integrate-pos-device/marshall/marshall-c-release-notes"}]}]},{"item":"Marshall Pro (Fuel)","pages":[{"group":"Marshall Pro Guides","pages":[{"title":"Overview","href":"/docs/integrate-pos-device/marshall-pro/getting-started"},{"title":"Integration Process","href":"/docs/integrate-pos-device/marshall-pro/getting-started/marshall-pro-integration-process"},{"title":"Forecourt Architecture","href":"/docs/integrate-pos-device/marshall-pro/getting-started/forecourt-architecture"},{"title":"Marshall Pro Network Requirements","sidebarTitle":"Network Requirements","href":"/docs/integrate-pos-device/marshall-pro/getting-started/network-requirements"},{"title":"Best Practices","href":"/docs/integrate-pos-device/marshall-pro/getting-started/best-practices"},{"title":"Security \u0026 Digital Signatures","href":"/docs/integrate-pos-device/marshall-pro/getting-started/security-digital-signatures"}]},{"group":"Payment Flows","pages":[{"title":"Two-Phase Pre-Authorization Flow","href":"/docs/integrate-pos-device/marshall-pro/methods/payment/two-phase-pre-authorization"},{"title":"Post-Pay Flow","href":"/docs/integrate-pos-device/marshall-pro/methods/payment/post-pay"},{"title":"Periodic Reconciliation","href":"/docs/integrate-pos-device/marshall-pro/methods/payment/periodic-reconciliation"}]},{"group":"Messaging Protocol","pages":[{"title":"TCP Communication","href":"/docs/integrate-pos-device/marshall-pro/messaging-protocol/tcp-communication"},{"title":"Request and Response Format","href":"/docs/integrate-pos-device/marshall-pro/messaging-protocol/request-response-format"},{"title":"Error Codes","href":"/docs/integrate-pos-device/marshall-pro/messaging-protocol/error-codes"},{"title":"Example: Fuel Station Flow","href":"/docs/integrate-pos-device/marshall-pro/messaging-protocol/example-fuel-station-flow"}]},{"group":"Methods","pages":[{"title":"API Introduction","href":"/docs/integrate-pos-device/marshall-pro/methods/api"},{"group":"General","pages":[{"title":"info","href":"/docs/integrate-pos-device/marshall-pro/methods/general/info"},{"title":"status","href":"/docs/integrate-pos-device/marshall-pro/methods/general/status"}]},{"group":"Payment","pages":[{"title":"cardDetect","href":"/docs/integrate-pos-device/marshall-pro/methods/payment/card-detect"},{"title":"stopCardDetect","href":"/docs/integrate-pos-device/marshall-pro/methods/payment/stop-card-detect"},{"title":"authorize","href":"/docs/integrate-pos-device/marshall-pro/methods/payment/authorize"},{"title":"detectAndAuth","href":"/docs/integrate-pos-device/marshall-pro/methods/payment/detect-and-auth"},{"title":"settle","href":"/docs/integrate-pos-device/marshall-pro/methods/payment/settle"},{"title":"pay","href":"/docs/integrate-pos-device/marshall-pro/methods/payment/pay"},{"title":"query","href":"/docs/integrate-pos-device/marshall-pro/methods/payment/query"}]},{"group":"Display","pages":[{"title":"displayScreen","href":"/docs/integrate-pos-device/marshall-pro/methods/display/display-screen"},{"title":"displayInput","href":"/docs/integrate-pos-device/marshall-pro/methods/display/display-input"},{"title":"displaySelect","href":"/docs/integrate-pos-device/marshall-pro/methods/display/display-select"},{"title":"displayConfirm","href":"/docs/integrate-pos-device/marshall-pro/methods/display/display-confirm"}]},{"group":"Utility","pages":[{"title":"print","href":"/docs/integrate-pos-device/marshall-pro/methods/utility/print"}]}]},{"group":"Marshall Pro Release Notes","pages":[{"title":"FuelApp Release Notes","sidebarTitle":"FuelApp","href":"/docs/integrate-pos-device/marshall-pro/fuelapp-release-notes"}]},{"group":"FAQ","pages":[{"title":"Flow \u0026 Configuration","href":"/docs/integrate-pos-device/marshall-pro/faq"}]}]},{"item":"TweezerComm","groups":[{"group":"TweezerComm Guides","pages":[{"title":"Overview","href":"/docs/integrate-pos-device/tweezercomm/overview-tweezer"},{"title":"Integration Process","href":"/docs/integrate-pos-device/tweezercomm/tweezercomm-integration-process"},{"title":"Get Started","href":"/docs/integrate-pos-device/tweezercomm/tweezercomm-get-started"},{"group":"Global Payment Flows","root":{"title":"Global Payment Flows","href":"/docs/integrate-pos-device/tweezercomm/global-payment-flows/payment-flows-copy-1"},"pages":[{"title":"Pre-Selection","href":"/docs/integrate-pos-device/tweezercomm/global-payment-flows/tweezercomm-engine-preselection-flow"},{"title":"Pre-Authorization","href":"/docs/integrate-pos-device/tweezercomm/global-payment-flows/tweezercomm-engine-preauth-flow"}]},{"group":"Global Payment Methods","root":{"title":"Global Payment Methods","mode":"wide","href":"/docs/integrate-pos-device/tweezercomm/global-payment-methods/payment-services-methods-copy-1"},"pages":[{"title":"doTransaction","href":"/docs/integrate-pos-device/tweezercomm/global-payment-methods/dotransaction"},{"title":"Refunds","href":"/docs/integrate-pos-device/tweezercomm/global-payment-methods/refunds-dotransaction"},{"title":"abortTransaction","href":"/docs/integrate-pos-device/tweezercomm/global-payment-methods/abort-transaction"},{"title":"getTransactionByVuid","href":"/docs/integrate-pos-device/tweezercomm/global-payment-methods/gettransactionbyvuid"},{"title":"getReport","href":"/docs/integrate-pos-device/tweezercomm/global-payment-methods/getreport"},{"title":"getStatus","href":"/docs/integrate-pos-device/tweezercomm/global-payment-methods/getstatus"},{"title":"getInternalStatus","href":"/docs/integrate-pos-device/tweezercomm/global-payment-methods/getinternalstatus"},{"title":"getRetailerInfo","href":"/docs/integrate-pos-device/tweezercomm/global-payment-methods/getretailerinfo"},{"title":"startPinpadTransaction","href":"/docs/integrate-pos-device/tweezercomm/global-payment-methods/startpinpadtransaction"},{"title":"doPinpadTransaction","href":"/docs/integrate-pos-device/tweezercomm/global-payment-methods/dopinpadtransaction"},{"title":"endPinpadTransaction","href":"/docs/integrate-pos-device/tweezercomm/global-payment-methods/endpinpadtransaction"}]},{"group":"Israel Payment Flows","root":{"title":"Israel Payment Flows","href":"/docs/integrate-pos-device/tweezercomm/israel-payment-flows/tweezercomm-israel-payment-flows"},"pages":[{"title":"Regular Transaction","href":"/docs/integrate-pos-device/tweezercomm/israel-payment-flows/single-phase-transaction"},{"title":"Two Phases Transaction","href":"/docs/integrate-pos-device/tweezercomm/israel-payment-flows/2-phase-transaction"},{"title":"Pre-Authorization (Israel)","href":"/docs/integrate-pos-device/tweezercomm/israel-payment-flows/tweezercomm-pre-authorization-israel"},{"title":"Deferred Payment","href":"/docs/integrate-pos-device/tweezercomm/israel-payment-flows/tweezercomm-deferred-payment"},{"title":"Split Transaction","href":"/docs/integrate-pos-device/tweezercomm/israel-payment-flows/tweezercomm-split-transaction"}]},{"group":"Israel Payment Methods","root":{"title":"Israel Payment Methods","mode":"wide","href":"/docs/integrate-pos-device/tweezercomm/israel-payment-methods/tweezercomm-israel-payment-methods"},"pages":[{"title":"doTransaction","href":"/docs/integrate-pos-device/tweezercomm/israel-payment-methods/dotransaction-ashrait"},{"title":"doTransactionPhase1","href":"/docs/integrate-pos-device/tweezercomm/israel-payment-methods/dotransactionphase1"},{"title":"doTransactionPhase2","href":"/docs/integrate-pos-device/tweezercomm/israel-payment-methods/dotransactionphase2"},{"title":"doPeriodic","href":"/docs/integrate-pos-device/tweezercomm/israel-payment-methods/doperiodic"},{"title":"doMiniSettlement","href":"/docs/integrate-pos-device/tweezercomm/israel-payment-methods/dominisettlement"},{"title":"addSubRetailer","href":"/docs/integrate-pos-device/tweezercomm/israel-payment-methods/addsubretailer"},{"title":"abortTransaction","href":"/docs/integrate-pos-device/tweezercomm/israel-payment-methods/aborttransaction-copy"},{"title":"cancelTransaction","href":"/docs/integrate-pos-device/tweezercomm/israel-payment-methods/canceltransaction-1"},{"title":"getTransactionByUid","href":"/docs/integrate-pos-device/tweezercomm/israel-payment-methods/gettransactionbyvuid-copy"},{"title":"getTransactionByVuid","href":"/docs/integrate-pos-device/tweezercomm/israel-payment-methods/gettransactionbyvuid-copy-1"},{"title":"getReport","href":"/docs/integrate-pos-device/tweezercomm/israel-payment-methods/getreport-1"},{"title":"getRetailerInfo","href":"/docs/integrate-pos-device/tweezercomm/israel-payment-methods/getreport-copy-1"},{"title":"getStatus","href":"/docs/integrate-pos-device/tweezercomm/israel-payment-methods/getreport-copy"},{"title":"getInternalStatus","href":"/docs/integrate-pos-device/tweezercomm/israel-payment-methods/getstatus-copy"},{"title":"getSubRetailer","href":"/docs/integrate-pos-device/tweezercomm/israel-payment-methods/addsubretailer-copy"},{"title":"removeSubRetailer","href":"/docs/integrate-pos-device/tweezercomm/israel-payment-methods/dotransactionphase2-copy-1"},{"title":"authorizePendingTransactions","href":"/docs/integrate-pos-device/tweezercomm/israel-payment-methods/authorizependingtransactions"}]},{"group":"Device Methods","root":{"title":"Device Methods","mode":"wide","href":"/docs/integrate-pos-device/tweezercomm/device-methods/index"},"pages":[{"title":"getInfo","href":"/docs/integrate-pos-device/tweezercomm/device-methods/getinfo"},{"title":"readCard","href":"/docs/integrate-pos-device/tweezercomm/device-methods/readcard"},{"title":"abortReadCard","href":"/docs/integrate-pos-device/tweezercomm/device-methods/abortreadcard"},{"title":"getConfig","href":"/docs/integrate-pos-device/tweezercomm/device-methods/getconfig"},{"title":"setConfig","href":"/docs/integrate-pos-device/tweezercomm/device-methods/setconfig"},{"title":"getVersion","href":"/docs/integrate-pos-device/tweezercomm/device-methods/getversion"},{"title":"uploadLogs","href":"/docs/integrate-pos-device/tweezercomm/device-methods/uploadlogs"},{"title":"getProperty","href":"/docs/integrate-pos-device/tweezercomm/device-methods/getproperty"},{"title":"getUserInput","href":"/docs/integrate-pos-device/tweezercomm/device-methods/getuserinput"},{"title":"abortGetUserInput","href":"/docs/integrate-pos-device/tweezercomm/device-methods/abortgetuserinput"},{"title":"getUserSelection","href":"/docs/integrate-pos-device/tweezercomm/device-methods/getuserselection"},{"title":"abortGetUserSelection","href":"/docs/integrate-pos-device/tweezercomm/device-methods/abortgetuserselection"},{"title":"showAnimation","href":"/docs/integrate-pos-device/tweezercomm/device-methods/showanimation"},{"title":"hideAnimation","href":"/docs/integrate-pos-device/tweezercomm/device-methods/hideanimation"},{"title":"displaySwipeCard","href":"/docs/integrate-pos-device/tweezercomm/device-methods/displayswipecard"},{"title":"abortSwipe","href":"/docs/integrate-pos-device/tweezercomm/device-methods/abortswipe"},{"title":"displayQR","href":"/docs/integrate-pos-device/tweezercomm/device-methods/displayqr"},{"title":"abortDisplayQR","href":"/docs/integrate-pos-device/tweezercomm/device-methods/abortdisplayqr"},{"title":"abortDisplay","href":"/docs/integrate-pos-device/tweezercomm/device-methods/abortdisplay"},{"title":"sendGeneralEvent","href":"/docs/integrate-pos-device/tweezercomm/device-methods/sendgeneralevent"},{"title":"readCardForExternalTransaction","href":"/docs/integrate-pos-device/tweezercomm/device-methods/readcardforexternaltransaction"},{"title":"updatePinpadTransactionStatus","href":"/docs/integrate-pos-device/tweezercomm/device-methods/updatepinpadtransactionstatus"},{"title":"updateExternalTransaction","href":"/docs/integrate-pos-device/tweezercomm/device-methods/updateexternaltransaction"},{"title":"getLocation","href":"/docs/integrate-pos-device/tweezercomm/device-methods/getlocation"}]},{"title":"PinPad Mode","href":"/docs/integrate-pos-device/tweezercomm/pinpad-mode"},{"title":"Resilience Mechanism","href":"/docs/integrate-pos-device/tweezercomm/resilience-mechanism-copy"},{"title":"TC Service","href":"/docs/integrate-pos-device/tweezercomm/tc-service"},{"group":"Additional Resources","root":{"title":"Additional Resources","href":"/docs/integrate-pos-device/tweezercomm/additional-resources/tweezercomm-additional-resources"},"pages":[{"title":"Certification \u0026 Testing","href":"/docs/integrate-pos-device/tweezercomm/additional-resources/certification-files"},{"title":"Response Codes","href":"/docs/integrate-pos-device/tweezercomm/additional-resources/response-codes"},{"title":"Configure Static IP","href":"/docs/integrate-pos-device/tweezercomm/additional-resources/configuring-static-ip"},{"title":"Test Terminal Setup","href":"/docs/integrate-pos-device/tweezercomm/additional-resources/using-test-cards-real-cards-during-the-integration"}]}]}]},{"item":"EMV Core","groups":[{"group":"EMV Core Guides","pages":[{"title":"Overview","href":"/docs/integrate-pos-device/emv-core/overview"},{"title":"Integration Process","href":"/docs/integrate-pos-device/emv-core/get-started/emv-core-integration-process"}]},{"group":"Android \u0026 Linux SDK","pages":[{"title":"Get Started","href":"/docs/integrate-pos-device/emv-core/get-started/emv-core-get-started-1"},{"group":"Installation","pages":[{"title":"Android SDK Installation","href":"/docs/integrate-pos-device/emv-core/get-started/emv-core-android-installation"},{"title":"Linux SDK Installation","href":"/docs/integrate-pos-device/emv-core/get-started/emv-core-linux-installation"}]},{"title":"Obtain Your Device ID","href":"/docs/integrate-pos-device/emv-core/get-started/emv-core-device-id"},{"group":"Payment Flows","root":{"title":"Payment Flows","mode":"wide","href":"/docs/integrate-pos-device/emv-core/payment-flows/transaction-flow"},"pages":[{"title":"Payment with Pre-Authorization","href":"/docs/integrate-pos-device/emv-core/payment-flows/payment-with-authorization"},{"title":"Closed Loop Transaction","href":"/docs/integrate-pos-device/emv-core/payment-flows/closed-loop-transaction"},{"title":"Single Step Payment","href":"/docs/integrate-pos-device/emv-core/payment-flows/single-step-payment"},{"title":"Pre-Authorization with External Settlement","href":"/docs/integrate-pos-device/emv-core/payment-flows/pre-authorization-with-external-settlement"},{"title":"Deferred Transaction","href":"/docs/integrate-pos-device/emv-core/payment-flows/deferred-transaction"}]},{"group":"SDK Methods \u0026 Functions","root":{"title":"SDK Methods \u0026 Functions","mode":"wide","href":"/docs/integrate-pos-device/emv-core/sdk-methods-functions/emv-core-apis"},"pages":[{"title":"Payment","href":"/docs/integrate-pos-device/emv-core/sdk-methods-functions/payment-1"},{"title":"Remote Management","href":"/docs/integrate-pos-device/emv-core/sdk-methods-functions/remote-management"},{"title":"Event Callbacks","href":"/docs/integrate-pos-device/emv-core/sdk-methods-functions/event-callbacks"},{"title":"Reader Messages","href":"/docs/integrate-pos-device/emv-core/sdk-methods-functions/reader-messages"}]},{"group":"Demo Applications","root":{"title":"Demo Applications","href":"/docs/integrate-pos-device/emv-core/demo-applications/emv-core-demo-applications"},"pages":[{"title":"Android App","href":"/docs/integrate-pos-device/emv-core/demo-applications/android-demo-application"},{"title":"Linux App","href":"/docs/integrate-pos-device/emv-core/demo-applications/linux-demo-application"}]},{"title":"Configuration Parameters","href":"/docs/integrate-pos-device/emv-core/emv-core-configuration"}]},{"group":"RTOS SDK","pages":[{"title":"Overview","href":"/docs/integrate-pos-device/emv-core/rtos/rtos-overview"},{"title":"Get Started","href":"/docs/integrate-pos-device/emv-core/rtos/rtos-get-started"},{"title":"Platform Porting","href":"/docs/integrate-pos-device/emv-core/rtos/rtos-platform-porting"},{"title":"Integration Guide","href":"/docs/integrate-pos-device/emv-core/rtos/rtos-integration-guide"},{"group":"API Reference","pages":[{"title":"C API Reference","mode":"wide","href":"/docs/integrate-pos-device/emv-core/rtos/rtos-c-api"},{"title":"JSON-RPC API","mode":"wide","href":"/docs/integrate-pos-device/emv-core/rtos/rtos-json-rpc-api"},{"title":"Datalink Layer","href":"/docs/integrate-pos-device/emv-core/rtos/rtos-datalink-layer"}]},{"title":"Linux Sample Application","href":"/docs/integrate-pos-device/emv-core/rtos/rtos-linux-sample-app"},{"title":"Configuration File Reference","href":"/docs/integrate-pos-device/emv-core/rtos/rtos-configuration"},{"title":"Firmware \u0026 Configuration Updates","href":"/docs/integrate-pos-device/emv-core/rtos/rtos-firmware-updates"},{"title":"Error Handling \u0026 Troubleshooting","href":"/docs/integrate-pos-device/emv-core/rtos/rtos-troubleshooting"}]},{"group":"UNO-mini Hardware","pages":[{"title":"UNO-mini Overview","href":"/docs/integrate-pos-device/emv-core/uno-mini/uno-mini-overview"},{"title":"Mechanical Integration","href":"/docs/integrate-pos-device/emv-core/uno-mini/uno-mini-mechanical"},{"title":"User Interface Requirements","href":"/docs/integrate-pos-device/emv-core/uno-mini/uno-mini-user-interface"},{"title":"Power Supply","href":"/docs/integrate-pos-device/emv-core/uno-mini/uno-mini-power-supply"},{"title":"Connection Interfaces","href":"/docs/integrate-pos-device/emv-core/uno-mini/uno-mini-connections"}]},{"group":"EMV Core Release Notes","pages":[{"title":"EMV Core Android \u0026 Linux SDK Release Notes","sidebarTitle":"Android \u0026 Linux","href":"/docs/integrate-pos-device/emv-core/emv-core-android-linux-release-notes"},{"title":"EMV Core RTOS SDK Release Notes","sidebarTitle":"RTOS","href":"/docs/integrate-pos-device/emv-core/emv-core-rtos-release-notes"}]}]},{"item":"Spark","groups":[{"group":"Spark Guides","pages":[{"title":"Overview","href":"/docs/integrate-pos-device/spark/spark"},{"title":"Integration Process","href":"/docs/integrate-pos-device/spark/spark-integration-process"},{"title":"Spark Network Requirements","sidebarTitle":"Network Requirements","href":"/docs/integrate-pos-device/spark/spark-network-requirement"},{"group":"Security \u0026 Authentication","root":{"title":"Security \u0026 Authentication","href":"/docs/integrate-pos-device/spark/security-authentication/index"},"pages":[{"title":"Authentication","href":"/docs/integrate-pos-device/spark/security-authentication/spark-authentication"},{"title":"Legacy Authentication","href":"/docs/integrate-pos-device/spark/security-authentication/spark-legacy-authentication"},{"title":"Interactive Authentication Tool","href":"/docs/integrate-pos-device/spark/security-authentication/spark-auth-tool"}]},{"group":"Payment Flows","root":{"mode":"wide","title":"Payment Flows","href":"/docs/integrate-pos-device/spark/payment-flows/transaction-flows-spark"},"pages":[{"title":"Device Start","href":"/docs/integrate-pos-device/spark/payment-flows/spark-device-start"},{"title":"Remote Start","href":"/docs/integrate-pos-device/spark/payment-flows/spark-remote-start"},{"title":"Device Stop","href":"/docs/integrate-pos-device/spark/payment-flows/spark-device-stop"},{"title":"External Settlement","href":"/docs/integrate-pos-device/spark/payment-flows/external-settlement"},{"title":"External Cancel","href":"/docs/integrate-pos-device/spark/payment-flows/external-cancel"}]},{"group":"Machine Configuration","root":{"title":"Machine Configuration Overview","href":"/docs/integrate-pos-device/spark/machine-configuration/index"},"pages":[{"title":"Remote Start Configuration","href":"/docs/integrate-pos-device/spark/machine-configuration/spark-remote-start-configuration"},{"title":"Device Start Configuration","href":"/docs/integrate-pos-device/spark/machine-configuration/spark-device-start-configuration"},{"title":"Device Stop Configuration","href":"/docs/integrate-pos-device/spark/machine-configuration/spark-device-stop-configuration"},{"title":"External Settlement Configuration","href":"/docs/integrate-pos-device/spark/machine-configuration/spark-external-settlement-configuration"},{"title":"Additional Features","href":"/docs/integrate-pos-device/spark/machine-configuration/additional-features"}]},{"group":"Webhook Callbacks","root":{"title":"Webhook Callbacks","href":"/docs/integrate-pos-device/spark/webhook-callbacks/index"},"pages":[{"title":"TransactionCallback","href":"/docs/integrate-pos-device/spark/webhook-callbacks/transactioncallback"},{"title":"StopCallback","href":"/docs/integrate-pos-device/spark/webhook-callbacks/stopcallback"},{"title":"TimeoutCallback","href":"/docs/integrate-pos-device/spark/webhook-callbacks/timeoutcallback"},{"title":"DeclineCallback","href":"/docs/integrate-pos-device/spark/webhook-callbacks/declinecallback"}]},{"group":"Additional Resources","root":{"title":"Additional Resources","href":"/docs/integrate-pos-device/spark/additional-resources/index"},"pages":[{"title":"Closed Loop Card Support","href":"/docs/integrate-pos-device/spark/additional-resources/smc-support"},{"title":"PosDisplay Format","href":"/docs/integrate-pos-device/spark/additional-resources/spark-posdisplay-format"},{"title":"eReceiptData Format","href":"/docs/integrate-pos-device/spark/additional-resources/spark-ereceiptdata-format"},{"title":"Response Codes","href":"/docs/integrate-pos-device/spark/additional-resources/spark-response-codes"}]},{"group":"Sample Codes","pages":[{"title":"Authentication Code Sample","href":"/docs/integrate-pos-device/spark/sample-codes/spark-authentication-code-sample"}]}]},{"group":"API Reference","pages":[{"group":"Transactions","pages":[{"title":"Get Version","deprecated":null,"version":null,"openapi":"/openapi/spark.yaml get /Version","href":"/reference/spark/transactions/get-version"},{"title":"ExternalCancel","deprecated":null,"version":null,"openapi":"/openapi/spark.yaml post /ExternalCancel","href":"/reference/spark/transactions/externalcancel"},{"title":"ExternalSettlement","deprecated":null,"version":null,"openapi":"/openapi/spark.yaml post /ExternalSettlement","href":"/reference/spark/transactions/externalsettlement"},{"title":"StartAuthentication","deprecated":null,"version":null,"openapi":"/openapi/spark.yaml post /StartAuthentication","href":"/reference/spark/transactions/startauthentication"},{"title":"StartSession","deprecated":null,"version":null,"openapi":"/openapi/spark.yaml post /StartSession","href":"/reference/spark/transactions/startsession"},{"title":"TriggerTransaction","deprecated":null,"version":null,"openapi":"/openapi/spark.yaml post /TriggerTransaction","href":"/reference/spark/transactions/triggertransaction"},{"title":"TransactionCallback","deprecated":null,"version":null,"openapi":"/openapi/spark.yaml post /TransactionCallback","href":"/reference/spark/transactions/transactioncallback"},{"title":"TransactionNotify","deprecated":null,"version":null,"openapi":"/openapi/spark.yaml post /TransactionNotify","href":"/reference/spark/transactions/transactionnotify"},{"title":"Settlement","deprecated":null,"version":null,"openapi":"/openapi/spark.yaml post /Settlement","href":"/reference/spark/transactions/settlement"},{"title":"TimeoutCallback","deprecated":null,"version":null,"openapi":"/openapi/spark.yaml post /TimeoutCallback","href":"/reference/spark/transactions/timeoutcallback"},{"title":"CancelTransaction","deprecated":null,"version":null,"openapi":"/openapi/spark.yaml post /CancelTransaction","href":"/reference/spark/transactions/canceltransaction"},{"title":"StopNotify","deprecated":null,"version":null,"openapi":"/openapi/spark.yaml post /StopNotify","href":"/reference/spark/transactions/stopnotify"},{"title":"AvailabilityCheck","deprecated":null,"version":null,"openapi":"/openapi/spark.yaml post /AvailabilityCheck","href":"/reference/spark/transactions/availabilitycheck"},{"title":"StopCallback","deprecated":null,"version":null,"openapi":"/openapi/spark.yaml post /StopCallback","href":"/reference/spark/transactions/stopcallback"},{"title":"DeclineCallback","deprecated":null,"version":null,"openapi":"/openapi/spark.yaml post /DeclineCallback","href":"/reference/spark/transactions/declinecallback"},{"title":"InfoQuery","deprecated":null,"version":null,"openapi":"/openapi/spark.yaml post /InfoQuery","href":"/reference/spark/transactions/infoquery"}]}]}]}]},{"tab":"Platform Management","menu":[{"item":"Transaction Reporting","groups":[{"group":"Transaction Reporting Guides","pages":[{"title":"Overview","href":"/docs/manage-data-operations/amazon-sqs/overview"},{"group":"Nayax Core Setup","root":{"title":"Nayax Core Setup","href":"/docs/manage-data-operations/amazon-sqs/set-up-nayax-core/nayax-back-office-setup"},"pages":[{"group":"Set Up Transaction Delivery","root":{"title":"Transaction Report Delivery","href":"/docs/manage-data-operations/amazon-sqs/set-up-nayax-core/set-up-transaction-delivery"},"pages":[{"title":"Transaction Message Fields","href":"/docs/manage-data-operations/amazon-sqs/set-up-nayax-core/transaction-json-reference"}]},{"title":"DEX Audit File Delivery","href":"/docs/manage-data-operations/amazon-sqs/set-up-nayax-core/set-up-eva-dts-dexddcmp-audit-file-delivery"},{"title":"Event and Alert Delivery","href":"/docs/manage-data-operations/amazon-sqs/set-up-nayax-core/set-up-events-delivery"},{"title":"SQS Message Encryption","href":"/docs/manage-data-operations/amazon-sqs/set-up-nayax-core/set-up-encryption-on-amazon-sqs-delivery"}]},{"group":"Amazon Queue Setup","root":{"title":"Amazon Queue Setup","href":"/docs/manage-data-operations/amazon-sqs/amazon-queue-setup/index"},"pages":[{"title":"Create New Queue","href":"/docs/manage-data-operations/amazon-sqs/amazon-queue-setup/create-new-queue"},{"title":"Queue Permissions","href":"/docs/manage-data-operations/amazon-sqs/amazon-queue-setup/set-up-queue-permissions"},{"title":"Create User for Queue Access","href":"/docs/manage-data-operations/amazon-sqs/amazon-queue-setup/create-user-for-queue-access"}]}]}]},{"item":"Lynx API","groups":[{"group":"Lynx API Guides","pages":[{"title":"Overview","href":"/docs/manage-data-operations/lynx-api/lynx-overview"},{"title":"Create Sandbox Account","href":"/docs/manage-data-operations/lynx-api/request-access"},{"group":"Security \u0026 Token","root":{"title":"Security \u0026 Token","href":"/docs/manage-data-operations/lynx-api/security"},"pages":[{"title":"App Tokens (JWT)","href":"/docs/manage-data-operations/lynx-api/app-tokens"}]},{"group":"Cards","pages":[{"title":"Create Cards","href":"/docs/manage-data-operations/lynx-api/cards/create-cards"},{"title":"Retrieve Card Data","href":"/docs/manage-data-operations/lynx-api/cards/retrieve-card-data"},{"title":"Add Credit to Card","href":"/docs/manage-data-operations/lynx-api/cards/add-credit-to-card"},{"title":"Cards","href":"/reference/manage-data-operations/lynx-api/cards"}]},{"group":"Refunds","pages":[{"title":"Request Refunds","href":"/docs/manage-data-operations/lynx-api/refunds/request-refunds"},{"title":"Approve or Decline Refunds","href":"/docs/manage-data-operations/lynx-api/refunds/approve-or-decline-a-refund"},{"title":"Upload Refund Documentation","href":"/docs/manage-data-operations/lynx-api/refunds/upload-refund-document"}]},{"group":"Operator","pages":[{"title":"Nayax Hierarchy","href":"/docs/manage-data-operations/lynx-api/operator/nayax-hierarchy"},{"title":"Retrieve Hierarchy","href":"/docs/manage-data-operations/lynx-api/operator/retrieve-hierarchy"},{"title":"Create Operator","href":"/docs/manage-data-operations/lynx-api/operator/create-operator"},{"title":"Operator Actions","href":"/docs/manage-data-operations/lynx-api/operator/operator-actions"},{"title":"Actor Types","href":"/reference/manage-data-operations/lynx-api/actor-types"}]},{"group":"Machines","pages":[{"title":"Create New Machine","href":"/docs/manage-data-operations/lynx-api/machines/create-new-machine-guides"},{"title":"Retrieve Machine Information","href":"/docs/manage-data-operations/lynx-api/machines/retrieve-machine-information"},{"title":"Get Machine's Last Sales","href":"/docs/manage-data-operations/lynx-api/machines/getting-a-machines-last-sales"},{"title":"Get Monyx ID","href":"/docs/manage-data-operations/lynx-api/machines/get-monyx-id"},{"title":"Machine Attributes","href":"/docs/manage-data-operations/lynx-api/machines/updating-a-machines-attribute"},{"title":"Restart a Machine","href":"/docs/manage-data-operations/lynx-api/machines/restart-a-machine"},{"title":"Get a Machine's ID by the Device's ID","href":"/docs/manage-data-operations/lynx-api/machines/getting-a-machines-id-by-the-devices-serial-number"},{"title":"Get a Machine's Last Sales \u0026 Generate eReceipt","href":"/docs/manage-data-operations/lynx-api/machines/getting-a-machines-last-sales-ereceipt-information"},{"title":"Machine Types","href":"/reference/manage-data-operations/lynx-api/machine-types"}]},{"group":"Devices","pages":[{"title":"Retrieve Device Information","href":"/docs/manage-data-operations/lynx-api/devices/getting-all-devices-under-an-operator"},{"title":"Disable a Device","href":"/docs/manage-data-operations/lynx-api/devices/disabling-a-device"},{"title":"Move Devices Between Operators","href":"/docs/manage-data-operations/lynx-api/devices/moving-device-between-operators"}]},{"group":"Inventory Management","pages":[{"title":"Inventory Workflow","href":"/docs/manage-data-operations/lynx-api/inventory-management/inventory-workflow"},{"title":"Product Groups","href":"/docs/manage-data-operations/lynx-api/inventory-management/create-product-group"},{"title":"Operator Products","href":"/docs/manage-data-operations/lynx-api/inventory-management/create-products"},{"title":"Machine Products","href":"/docs/manage-data-operations/lynx-api/inventory-management/machine-products-1"},{"title":"Pick Lists","href":"/docs/manage-data-operations/lynx-api/inventory-management/pick-lists"},{"title":"Pick List Actions","href":"/docs/manage-data-operations/lynx-api/inventory-management/pick-list-actions"}]},{"title":"Languages","href":"/reference/manage-data-operations/lynx-api/languages"},{"title":"FAQs","href":"/docs/manage-data-operations/lynx-api/product-faqs"},{"group":"Reports","root":{"title":"Reports","href":"/docs/manage-data-operations/lynx-api/reports/index"},"pages":[{"group":"Dashboard Widgets","root":{"title":"Dashboard Widgets Overview","href":"/docs/manage-data-operations/lynx-api/reports/widgets-overview"},"pages":[{"title":"Sales By Period","href":"/docs/manage-data-operations/lynx-api/reports/widget-sales-by-period"},{"title":"Dashboard Sales Table","href":"/docs/manage-data-operations/lynx-api/reports/widget-dashboard-sales-table"},{"title":"Last Year vs This Year Monthly Sales","href":"/docs/manage-data-operations/lynx-api/reports/widget-last-year-vs-this-year"},{"title":"10 Most Popular Machines Sales/Vends","href":"/docs/manage-data-operations/lynx-api/reports/widget-10-most-popular-machines"}]},{"group":"Widget API","pages":[{"title":"Get Machine Widget Data (API)","href":"/docs/manage-data-operations/lynx-api/reports/retrieve-machine-widget-data"},{"title":"Widgets ID List","href":"/docs/manage-data-operations/lynx-api/reports/available-widgets"},{"title":"Widget Filters Reference","href":"/docs/manage-data-operations/lynx-api/reports/widget-filters"},{"title":"Revenue Per Machine: Integration Guide","href":"/docs/manage-data-operations/lynx-api/reports/integration-guide"}]}]}]},{"group":"API Reference","pages":[{"group":"Endpoints","pages":[{"group":"Actors","pages":[{"title":"Get Actor Details by ActorID","deprecated":null,"version":null,"openapi":"/openapi/lynx.yaml get /v1/actors/{ActorID}","href":"/reference/lynx/actors/get-actor-details-by-actorid"},{"title":"Update Operator/Sub-Operator","deprecated":null,"version":null,"openapi":"/openapi/lynx.yaml put /v1/actors/{ActorID}","href":"/reference/lynx/actors/update-operatorsub-operator"},{"title":"Get Actor by ActorCode","deprecated":null,"version":null,"openapi":"/openapi/lynx.yaml get /v1/actors","href":"/reference/lynx/actors/get-actor-by-actorcode"},{"title":"Create a New Actor","deprecated":null,"version":null,"openapi":"/openapi/lynx.yaml post /v2/actors/{ParentActorID}","href":"/reference/lynx/actors/create-a-new-actor"},{"title":"Get payment methods by ActorID","deprecated":null,"version":null,"openapi":"/openapi/lynx.yaml get /v1/actors/{ActorID}/paymentMethods","href":"/reference/lynx/actors/get-payment-methods-by-actorid"},{"title":"Update Actor's Payment Methods","deprecated":null,"version":null,"openapi":"/openapi/lynx.yaml put /v1/actors/{ActorID}/paymentMethods","href":"/reference/lynx/actors/update-actors-payment-methods"},{"title":"Create Actor's Payment Methods","deprecated":null,"version":null,"openapi":"/openapi/lynx.yaml post /v1/actors/{ActorID}/paymentMethods","href":"/reference/lynx/actors/create-actors-payment-methods"},{"title":"Delete a Payment Method","deprecated":null,"version":null,"openapi":"/openapi/lynx.yaml delete /v1/actors/{ActorID}/paymentMethods/{paymentMethodID}","href":"/reference/lynx/actors/delete-a-payment-method"},{"title":"Get Operator EV Meter Dashboard","deprecated":null,"version":null,"openapi":"/openapi/lynx.yaml get /v1/actors/{ActorID}/evDashboard","href":"/reference/lynx/actors/get-operator-ev-meter-dashboard"},{"title":"Get Encryption Keys by ActorID","deprecated":null,"version":null,"openapi":"/openapi/lynx.yaml get /v1/actors/GetEncKeys","href":"/reference/lynx/actors/get-encryption-keys-by-actorid"},{"title":"Get Actor Hierarchy for Current User","deprecated":null,"version":null,"openapi":"/openapi/lynx.yaml get /v1/actors/hierarchy","href":"/reference/lynx/actors/get-actor-hierarchy-for-current-user"},{"title":"Generate Encryption Key","deprecated":null,"version":null,"openapi":"/openapi/lynx.yaml put /v1/actors/GenarateEncKey","href":"/reference/lynx/actors/generate-encryption-key"},{"title":"Decrypt Message by Encryption Version","deprecated":null,"version":null,"openapi":"/openapi/lynx.yaml put /v1/actors/DecryptionMessageByVer","href":"/reference/lynx/actors/decrypt-message-by-encryption-version"},{"title":"List All Machine Groups for Actor","deprecated":null,"version":null,"openapi":"/openapi/lynx.yaml get /v1/actor/{ActorID}/machineGroups","href":"/reference/lynx/actors/list-all-machine-groups-for-actor"},{"title":"Update Machine Group","deprecated":null,"version":null,"openapi":"/openapi/lynx.yaml put /v1/actor/{ActorID}/machineGroups","href":"/reference/lynx/actors/update-machine-group"},{"title":"Add Machine Group","deprecated":null,"version":null,"openapi":"/openapi/lynx.yaml post /v1/actor/{ActorID}/machineGroups","href":"/reference/lynx/actors/add-machine-group"},{"title":"Get All Actor Groups by ActorID","deprecated":null,"version":null,"openapi":"/openapi/lynx.yaml get /v1/actors/{ActorID}/roleGroups","href":"/reference/lynx/actors/get-all-actor-groups-by-actorid"},{"title":"Add Actor Group","deprecated":null,"version":null,"openapi":"/openapi/lynx.yaml post /v1/actors/{ActorID}/roleGroups","href":"/reference/lynx/actors/add-actor-group"},{"title":"Delete Actor Group","deprecated":null,"version":null,"openapi":"/openapi/lynx.yaml delete /v1/actors/{ActorID}/roleGroups","href":"/reference/lynx/actors/delete-actor-group"}]},{"group":"Cards","pages":[{"title":"Get Cards","deprecated":null,"version":null,"openapi":"/openapi/lynx.yaml get /v1/cards","href":"/reference/lynx/cards/get-cards"},{"title":"Update Card Details","deprecated":null,"version":null,"openapi":"/openapi/lynx.yaml put /v1/cards","href":"/reference/lynx/cards/update-card-details"},{"title":"Create Virtual Card","deprecated":null,"version":null,"openapi":"/openapi/lynx.yaml post /v1/cards","href":"/reference/lynx/cards/create-virtual-card"},{"title":"Get the Credit from a Card","deprecated":null,"version":null,"openapi":"/openapi/lynx.yaml get /v1/cards/{CardUniqueIdentifier}/credit","href":"/reference/lynx/cards/get-the-credit-from-a-card"},{"title":"Get Card by ID","deprecated":null,"version":null,"openapi":"/openapi/lynx.yaml get /v1/cards/uniqueIdentifier/{CardUniqueIdentifier}","href":"/reference/lynx/cards/get-card-by-id"},{"title":"Get Card's Revalue","deprecated":null,"version":null,"openapi":"/openapi/lynx.yaml get /v1/cards/{CardUniqueIdentifier}/revalue","href":"/reference/lynx/cards/get-cards-revalue"},{"title":"Get Card by the Cards Display Number","deprecated":null,"version":null,"openapi":"/openapi/lynx.yaml get /v1/cards/displayNumber/{CardDisplayNumber}","href":"/reference/lynx/cards/get-card-by-the-cards-display-number"},{"title":"Get Prepaid Card","deprecated":null,"version":null,"openapi":"/openapi/lynx.yaml get /v1/cards/{CardId}/prepaid","href":"/reference/lynx/cards/get-prepaid-card"},{"title":"Update Prepaid Card","deprecated":null,"version":null,"openapi":"/openapi/lynx.yaml put /v1/cards/{CardId}/prepaid","href":"/reference/lynx/cards/update-prepaid-card"},{"title":"Validates Card for Machine Use","deprecated":null,"version":null,"openapi":"/openapi/lynx.yaml get /v1/cards/validate-machine/{machineId}","href":"/reference/lynx/cards/validates-card-for-machine-use"},{"title":"Get Card Group","deprecated":null,"version":null,"openapi":"/openapi/lynx.yaml get /v1/cards/{cardId}/cardGroups","href":"/reference/lynx/cards/get-card-group"},{"title":"Get Credit Card's Latest Transactions","deprecated":null,"version":null,"openapi":"/openapi/lynx.yaml post /v1/cards/query","href":"/reference/lynx/cards/get-credit-cards-latest-transactions"},{"title":"Add Credit to a Card","deprecated":null,"version":null,"openapi":"/openapi/lynx.yaml post /v1/cards/{CardUniqueIdentifier}/credit/add","href":"/reference/lynx/cards/add-credit-to-a-card"},{"title":"Add to the Card's Revalue","deprecated":null,"version":null,"openapi":"/openapi/lynx.yaml post /v1/cards/{CardUniqueIdentifier}/revalue/add","href":"/reference/lynx/cards/add-to-the-cards-revalue"},{"title":"Transfer Revalue Between Cards","deprecated":null,"version":null,"openapi":"/openapi/lynx.yaml post /v1/cards/{FromCardUniqueIdentifier}/revalue/send/{ToCardUniqueIdentifier}","href":"/reference/lynx/cards/transfer-revalue-between-cards"},{"title":"Update Card Status","deprecated":null,"version":null,"openapi":"/openapi/lynx.yaml post /v1/cards/{CardUniqueIdentifier}/status/{CardStatus}","href":"/reference/lynx/cards/update-card-status"},{"title":"Update Card Details by Display Number","deprecated":null,"version":null,"openapi":"/openapi/lynx.yaml put /v1/cards/{CardDisplayNumber}","href":"/reference/lynx/cards/update-card-details-by-display-number"},{"title":"Update Card Groups","deprecated":null,"version":null,"openapi":"/openapi/lynx.yaml put /v1/cards/{CardId}/cardGroups","href":"/reference/lynx/cards/update-card-groups"},{"title":"Create New Card","deprecated":null,"version":null,"openapi":"/openapi/lynx.yaml post /v2/cards","href":"/reference/lynx/cards/create-new-card"},{"title":"Update Card by ID","deprecated":null,"version":null,"openapi":"/openapi/lynx.yaml put /v2/cards/{CardID}","href":"/reference/lynx/cards/update-card-by-id"}]},{"group":"Devices","pages":[{"title":"Get Device by DeviceID","deprecated":null,"version":null,"openapi":"/openapi/lynx.yaml get /v1/devices/{DeviceID}","href":"/reference/lynx/devices/get-device-by-deviceid"},{"title":"Update Device","deprecated":null,"version":null,"openapi":"/openapi/lynx.yaml put /v1/devices/{DeviceID}","href":"/reference/lynx/devices/update-device"},{"title":"Get All Devices","deprecated":null,"version":null,"openapi":"/openapi/lynx.yaml get /v1/devices","href":"/reference/lynx/devices/get-all-devices"},{"title":"Move Devices to Actor ID","deprecated":null,"version":null,"openapi":"/openapi/lynx.yaml put /v1/devices/move/{actorId}","href":"/reference/lynx/devices/move-devices-to-actor-id"}]},{"group":"EReceipt","pages":[{"title":"Generate eReceipt for your Transaction","deprecated":null,"version":null,"openapi":"/openapi/lynx.yaml post /v1/ereceipt/generate","href":"/reference/lynx/ereceipt/generate-ereceipt-for-your-transaction"}]},{"group":"Lookups","pages":[{"title":"Get All Actor Types","deprecated":null,"version":null,"openapi":"/openapi/lynx.yaml get /v1/actorTypes","href":"/reference/lynx/lookups/get-all-actor-types"},{"title":"Get Lookup Types","deprecated":null,"version":null,"openapi":"/openapi/lynx.yaml get /v1/lookupTypes","href":"/reference/lynx/lookups/get-lookup-types"},{"title":"Get Machine Models","deprecated":null,"version":null,"openapi":"/openapi/lynx.yaml get /v1/lookupTypes/machineModels","href":"/reference/lynx/lookups/get-machine-models"},{"title":"Get Lookup Values by Lookup Type ID","deprecated":null,"version":null,"openapi":"/openapi/lynx.yaml get /v1/lookupTypes/{LutTypeID}/values","href":"/reference/lynx/lookups/get-lookup-values-by-lookup-type-id"},{"title":"Get Lookup Value by Lookup ID","deprecated":null,"version":null,"openapi":"/openapi/lynx.yaml get /v1/lookups/values/{LutID}","href":"/reference/lynx/lookups/get-lookup-value-by-lookup-id"},{"title":"Get Time Zones by Offset","deprecated":null,"version":null,"openapi":"/openapi/lynx.yaml get /v1/timeZones","href":"/reference/lynx/lookups/get-time-zones-by-offset"},{"title":"Get Time Zones by Time Zone Key","deprecated":null,"version":null,"openapi":"/openapi/lynx.yaml get /v1/timeZones/{TimeZoneKey}","href":"/reference/lynx/lookups/get-time-zones-by-time-zone-key"},{"title":"Get Countries","deprecated":null,"version":null,"openapi":"/openapi/lynx.yaml get /v1/countries","href":"/reference/lynx/lookups/get-countries"},{"title":"Get Country by Code","deprecated":null,"version":null,"openapi":"/openapi/lynx.yaml get /v1/countries/{CountryCode}","href":"/reference/lynx/lookups/get-country-by-code"},{"title":"Get Currencies","deprecated":null,"version":null,"openapi":"/openapi/lynx.yaml get /v1/currencies","href":"/reference/lynx/lookups/get-currencies"},{"title":"Get Currency by Code","deprecated":null,"version":null,"openapi":"/openapi/lynx.yaml get /v1/currencies/{CurrencyCode}","href":"/reference/lynx/lookups/get-currency-by-code"},{"title":"Get Billing Providers","deprecated":null,"version":null,"openapi":"/openapi/lynx.yaml get /v1/billingProviders","href":"/reference/lynx/lookups/get-billing-providers"},{"title":"Get Payment Methods","deprecated":null,"version":null,"openapi":"/openapi/lynx.yaml get /v1/paymentMethods","href":"/reference/lynx/lookups/get-payment-methods"},{"title":"Get States","deprecated":null,"version":null,"openapi":"/openapi/lynx.yaml get /v1/states","href":"/reference/lynx/lookups/get-states"},{"title":"Get Cities","deprecated":null,"version":null,"openapi":"/openapi/lynx.yaml get /v1/cities","href":"/reference/lynx/lookups/get-cities"},{"title":"Get Groups","deprecated":null,"version":null,"openapi":"/openapi/lynx.yaml get /v1/groups","href":"/reference/lynx/lookups/get-groups"},{"title":"Get Group Roles","deprecated":null,"version":null,"openapi":"/openapi/lynx.yaml get /v1/group/{GroupID}/roles","href":"/reference/lynx/lookups/get-group-roles"},{"title":"Get Regions","deprecated":null,"version":null,"openapi":"/openapi/lynx.yaml get /v1/regions","href":"/reference/lynx/lookups/get-regions"}]},{"group":"Machine Attribute","pages":[{"title":"Update Machine Attribute to Model Defaults","deprecated":null,"version":null,"openapi":"/openapi/lynx.yaml post /v1/machines/{MachineID}/attributes/defaults","href":"/reference/lynx/machine-attribute/update-machine-attribute-to-model-defaults"},{"title":"Update Machine Attribute to Current Configuration","deprecated":null,"version":null,"openapi":"/openapi/lynx.yaml post /v1/machines/{MachineID}/attributes/resendConfig","href":"/reference/lynx/machine-attribute/update-machine-attribute-to-current-configuration"},{"title":"Get All Machine Attributes","deprecated":null,"version":null,"openapi":"/openapi/lynx.yaml get /v1/machines/{MachineID}/attributes","href":"/reference/lynx/machine-attribute/get-all-machine-attributes"},{"title":"Bulk Update Machine Attributes","deprecated":null,"version":null,"openapi":"/openapi/lynx.yaml put /v1/machines/{MachineID}/attributes","href":"/reference/lynx/machine-attribute/bulk-update-machine-attributes"},{"title":"Insert/Update Machine Attributes","deprecated":null,"version":null,"openapi":"/openapi/lynx.yaml post /v2/machines/attributes","href":"/reference/lynx/machine-attribute/insertupdate-machine-attributes"},{"title":"Get Specific Machine Attribute","deprecated":null,"version":null,"openapi":"/openapi/lynx.yaml get /v1/machines/{MachineID}/attributes/{DeviceAttributeID}","href":"/reference/lynx/machine-attribute/get-specific-machine-attribute"},{"title":"Update Specific Machine Attribute","deprecated":null,"version":null,"openapi":"/openapi/lynx.yaml put /v1/machines/{MachineID}/attributes/{DeviceAttributeID}","href":"/reference/lynx/machine-attribute/update-specific-machine-attribute"}]},{"group":"Machine Inventory","pages":[{"title":"Get Pick List","deprecated":null,"version":null,"openapi":"/openapi/lynx.yaml get /v1/machines/{MachineID}/pickList","href":"/reference/lynx/machine-inventory/get-pick-list"},{"title":"Create Pick List","deprecated":null,"version":null,"openapi":"/openapi/lynx.yaml post /v1/machines/{MachineID}/pickList","href":"/reference/lynx/machine-inventory/create-pick-list"},{"title":"Delete Pick List","deprecated":null,"version":null,"openapi":"/openapi/lynx.yaml delete /v1/machines/{MachineID}/pickList","href":"/reference/lynx/machine-inventory/delete-pick-list"},{"title":"Set All Machine Bins as Full","deprecated":null,"version":null,"openapi":"/openapi/lynx.yaml post /v1/machines/{MachineID}/inventory/full","href":"/reference/lynx/machine-inventory/set-all-machine-bins-as-full"},{"title":"Empty Machine Products Inventory","deprecated":null,"version":null,"openapi":"/openapi/lynx.yaml post /v1/machines/{MachineID}/inventory/empty","href":"/reference/lynx/machine-inventory/empty-machine-products-inventory"},{"title":"Update Pick List","deprecated":null,"version":null,"openapi":"/openapi/lynx.yaml put /v1/machines/inventory/picklists/update","href":"/reference/lynx/machine-inventory/update-pick-list"}]},{"group":"Machine Products","pages":[{"title":"Get Machine Products","deprecated":null,"version":null,"openapi":"/openapi/lynx.yaml get /v1/machines/{MachineID}/machineProducts","href":"/reference/lynx/machine-products/get-machine-products"},{"title":"Update Machine Products","deprecated":null,"version":null,"openapi":"/openapi/lynx.yaml put /v1/machines/{MachineID}/machineProducts","href":"/reference/lynx/machine-products/update-machine-products"},{"title":"Create Machine Products","deprecated":null,"version":null,"openapi":"/openapi/lynx.yaml post /v1/machines/{MachineID}/machineProducts","href":"/reference/lynx/machine-products/create-machine-products"},{"title":"Get a Machine Product","deprecated":null,"version":null,"openapi":"/openapi/lynx.yaml get /v1/machines/{MachineID}/machineProducts/{MachineProductID}","href":"/reference/lynx/machine-products/get-a-machine-product"},{"title":"Update a Machine Product","deprecated":null,"version":null,"openapi":"/openapi/lynx.yaml put /v1/machines/{MachineID}/machineProducts/{MachineProductID}","href":"/reference/lynx/machine-products/update-a-machine-product"}]},{"group":"Machines","pages":[{"title":"Get Specific Machine Basic Info","deprecated":null,"version":null,"openapi":"/openapi/lynx.yaml get /v1/machines/{MachineID}","href":"/reference/lynx/machines/get-specific-machine-basic-info"},{"title":"Update Specific Machine Basic Info","deprecated":null,"version":null,"openapi":"/openapi/lynx.yaml put /v1/machines/{MachineID}","href":"/reference/lynx/machines/update-specific-machine-basic-info"},{"title":"Get All Machine Basic Info","deprecated":null,"version":null,"openapi":"/openapi/lynx.yaml get /v1/machines","href":"/reference/lynx/machines/get-all-machine-basic-info"},{"title":"Create New Machine","deprecated":null,"version":null,"openapi":"/openapi/lynx.yaml post /v1/machines","href":"/reference/lynx/machines/create-new-machine"},{"title":"Search Machine Basic Info","deprecated":null,"version":null,"openapi":"/openapi/lynx.yaml post /v1/machines/search","href":"/reference/lynx/machines/search-machine-basic-info"},{"title":"Get Machine Change Logs","deprecated":null,"version":null,"openapi":"/openapi/lynx.yaml get /v1/machines/changeLogs","href":"/reference/lynx/machines/get-machine-change-logs"},{"title":"Get Specific Machine Basic Info by Device","deprecated":null,"version":null,"openapi":"/openapi/lynx.yaml get /v1/devices/{DeviceSerialNumber}/machine","href":"/reference/lynx/machines/get-specific-machine-basic-info-by-device"},{"title":"Get Specific Machine Basic Info by VPOS","deprecated":null,"version":null,"openapi":"/openapi/lynx.yaml get /v1/vpos/{VPOSSerial}/machine","href":"/reference/lynx/machines/get-specific-machine-basic-info-by-vpos"},{"title":"Get Specific Machine Statistics","deprecated":null,"version":null,"openapi":"/openapi/lynx.yaml get /v1/machines/{MachineID}/status","href":"/reference/lynx/machines/get-specific-machine-statistics"},{"title":"Get Machine Last Alerts","deprecated":null,"version":null,"openapi":"/openapi/lynx.yaml get /v1/machines/{MachineID}/lastAlerts","href":"/reference/lynx/machines/get-machine-last-alerts"},{"title":"Get Payment Methods for Machine","deprecated":null,"version":null,"openapi":"/openapi/lynx.yaml get /v1/machines/{MachineID}/paymentMethods","href":"/reference/lynx/machines/get-payment-methods-for-machine"},{"title":"Update Payment Methods for Machine","deprecated":null,"version":null,"openapi":"/openapi/lynx.yaml put /v1/machines/{MachineID}/paymentMethods","href":"/reference/lynx/machines/update-payment-methods-for-machine"},{"title":"Create Payment Methods for Machine","deprecated":null,"version":null,"openapi":"/openapi/lynx.yaml post /v1/machines/{MachineID}/paymentMethods","href":"/reference/lynx/machines/create-payment-methods-for-machine"},{"title":"Get Last Sales for Machine by MachineID","deprecated":null,"version":null,"openapi":"/openapi/lynx.yaml get /v1/machines/{MachineID}/lastSales","href":"/reference/lynx/machines/get-last-sales-for-machine-by-machineid"},{"title":"Delete Specific Payment Method for Machine","deprecated":null,"version":null,"openapi":"/openapi/lynx.yaml delete /v1/machines/{MachineID}/paymentMethods/{paymentMethodID}","href":"/reference/lynx/machines/delete-specific-payment-method-for-machine"}]},{"group":"Metadata","pages":[{"title":"Upload Picture","deprecated":null,"version":null,"openapi":"/openapi/lynx.yaml post /v1/metadata/upload-picture","href":"/reference/lynx/metadata/upload-picture"},{"title":"Get Event Rules","deprecated":null,"version":null,"openapi":"/openapi/lynx.yaml get /v1/metadata/v1/event-rules","href":"/reference/lynx/metadata/get-event-rules"}]},{"group":"Payment","pages":[{"title":"Request a Payment Refund","deprecated":null,"version":null,"openapi":"/openapi/lynx.yaml post /v1/payment/refund-request","href":"/reference/lynx/payment/request-a-payment-refund"},{"title":"Approve Payment Refund","deprecated":null,"version":null,"openapi":"/openapi/lynx.yaml post /v1/payment/refund-approve","href":"/reference/lynx/payment/approve-payment-refund"},{"title":"Decline a Payment Refund","deprecated":null,"version":null,"openapi":"/openapi/lynx.yaml post /v1/payment/refund-decline","href":"/reference/lynx/payment/decline-a-payment-refund"},{"title":"Upload Refund Documentation","deprecated":null,"version":null,"openapi":"/openapi/lynx.yaml post /v1/payment/upload-refund","href":"/reference/lynx/payment/upload-refund-documentation"}]},{"group":"Product Groups","pages":[{"title":"Get Product Group","deprecated":null,"version":null,"openapi":"/openapi/lynx.yaml get /v1/productGroups/{ProductGroupID}","href":"/reference/lynx/product-groups/get-product-group"},{"title":"Update Product Group","deprecated":null,"version":null,"openapi":"/openapi/lynx.yaml put /v1/productGroups/{ProductGroupID}","href":"/reference/lynx/product-groups/update-product-group"},{"title":"Get Product Groups by Actor","deprecated":null,"version":null,"openapi":"/openapi/lynx.yaml get /v1/operators/{ActorID}/productGroups","href":"/reference/lynx/product-groups/get-product-groups-by-actor"},{"title":"Get All Product Groups","deprecated":null,"version":null,"openapi":"/openapi/lynx.yaml get /v1/productGroups","href":"/reference/lynx/product-groups/get-all-product-groups"},{"title":"Create New Product Groups","deprecated":null,"version":null,"openapi":"/openapi/lynx.yaml post /v1/productGroups","href":"/reference/lynx/product-groups/create-new-product-groups"},{"title":"Get Product Group Tax","deprecated":null,"version":null,"openapi":"/openapi/lynx.yaml get /v1/productGroups/{ProductGroupID}/tax","href":"/reference/lynx/product-groups/get-product-group-tax"},{"title":"Update Product Group Tax","deprecated":null,"version":null,"openapi":"/openapi/lynx.yaml put /v1/productGroups/{ProductGroupID}/tax","href":"/reference/lynx/product-groups/update-product-group-tax"},{"title":"Create Product Group Tax","deprecated":null,"version":null,"openapi":"/openapi/lynx.yaml post /v1/productGroups/{ProductGroupID}/tax","href":"/reference/lynx/product-groups/create-product-group-tax"},{"title":"Delete Product Group Tax","deprecated":null,"version":null,"openapi":"/openapi/lynx.yaml delete /v1/productGroups/{ProductGroupID}/tax/{TaxRowID}","href":"/reference/lynx/product-groups/delete-product-group-tax"}]},{"group":"Products","pages":[{"title":"Get Specific Operator Products","deprecated":null,"version":null,"openapi":"/openapi/lynx.yaml get /v1/operators/{OperatorID}/products","href":"/reference/lynx/products/get-specific-operator-products"},{"title":"Create New Operator Product","deprecated":null,"version":null,"openapi":"/openapi/lynx.yaml post /v1/operators/{OperatorID}/products","href":"/reference/lynx/products/create-new-operator-product"},{"title":"Get Specific Product","deprecated":null,"version":null,"openapi":"/openapi/lynx.yaml get /v1/products/{NayaxProductID}","href":"/reference/lynx/products/get-specific-product"},{"title":"Update Specific Product","deprecated":null,"version":null,"openapi":"/openapi/lynx.yaml put /v1/products/{NayaxProductID}","href":"/reference/lynx/products/update-specific-product"}]},{"group":"Scheduling","pages":[{"title":"Get Drivers","deprecated":null,"version":null,"openapi":"/openapi/lynx.yaml get /v1/Scheduling/drivers","href":"/reference/lynx/scheduling/get-drivers"},{"title":"Update Driver","deprecated":null,"version":null,"openapi":"/openapi/lynx.yaml put /v1/Scheduling/drivers","href":"/reference/lynx/scheduling/update-driver"},{"title":"Add New Driver","deprecated":null,"version":null,"openapi":"/openapi/lynx.yaml post /v1/Scheduling/drivers","href":"/reference/lynx/scheduling/add-new-driver"},{"title":"Delete Driver","deprecated":null,"version":null,"openapi":"/openapi/lynx.yaml delete /v1/Scheduling/drivers","href":"/reference/lynx/scheduling/delete-driver"},{"title":"Get Routes","deprecated":null,"version":null,"openapi":"/openapi/lynx.yaml get /v1/Scheduling/routes","href":"/reference/lynx/scheduling/get-routes"},{"title":"Update Route","deprecated":null,"version":null,"openapi":"/openapi/lynx.yaml put /v1/Scheduling/routes","href":"/reference/lynx/scheduling/update-route"},{"title":"Create New Route","deprecated":null,"version":null,"openapi":"/openapi/lynx.yaml post /v1/Scheduling/routes","href":"/reference/lynx/scheduling/create-new-route"},{"title":"Get Route Machines","deprecated":null,"version":null,"openapi":"/openapi/lynx.yaml get /v1/Scheduling/route-machines","href":"/reference/lynx/scheduling/get-route-machines"},{"title":"Assign Machine to Route","deprecated":null,"version":null,"openapi":"/openapi/lynx.yaml post /v1/Scheduling/route-machines","href":"/reference/lynx/scheduling/assign-machine-to-route"},{"title":"Remove Machine from Route","deprecated":null,"version":null,"openapi":"/openapi/lynx.yaml delete /v1/Scheduling/route-machines","href":"/reference/lynx/scheduling/remove-machine-from-route"},{"title":"Get Visit Orders","deprecated":null,"version":null,"openapi":"/openapi/lynx.yaml get /v1/Scheduling/schedule/visit-order","href":"/reference/lynx/scheduling/get-visit-orders"},{"title":"Create Visit Orders","deprecated":null,"version":null,"openapi":"/openapi/lynx.yaml post /v1/Scheduling/schedule/visit-order","href":"/reference/lynx/scheduling/create-visit-orders"},{"title":"Get Machine Tasks","deprecated":null,"version":null,"openapi":"/openapi/lynx.yaml get /v1/Scheduling/schedule/machine-tasks","href":"/reference/lynx/scheduling/get-machine-tasks"},{"title":"Update Machine Tasks","deprecated":null,"version":null,"openapi":"/openapi/lynx.yaml put /v1/Scheduling/schedule/machine-tasks","href":"/reference/lynx/scheduling/update-machine-tasks"},{"title":"Create Machine Tasks","deprecated":null,"version":null,"openapi":"/openapi/lynx.yaml post /v1/Scheduling/schedule/machine-tasks","href":"/reference/lynx/scheduling/create-machine-tasks"},{"title":"Delete Machine Tasks","deprecated":null,"version":null,"openapi":"/openapi/lynx.yaml delete /v1/Scheduling/schedule/machine-tasks","href":"/reference/lynx/scheduling/delete-machine-tasks"}]},{"group":"Sign In","pages":[{"title":"User Sign In","deprecated":null,"version":null,"openapi":"/openapi/lynx.yaml post /v1/signin","href":"/reference/lynx/sign-in/user-sign-in"},{"title":"Sign In","deprecated":null,"version":null,"openapi":"/openapi/lynx.yaml get /signin","href":"/reference/lynx/sign-in/sign-in"}]},{"group":"Report","pages":[{"title":"Retrieve Widget Data","deprecated":null,"version":null,"openapi":"/openapi/lynx.yaml post /v1/dashboard/get-widget-data","href":"/reference/lynx/report/retrieve-widget-data"},{"title":"Get Available Widgets","deprecated":null,"version":null,"openapi":"/openapi/lynx.yaml get /v1/dashboard/widgets","href":"/reference/lynx/report/get-available-widgets"}]}]}]}]}]},{"tab":"Core Extension","groups":[{"group":"Core Extension Guides","pages":[{"title":"Overview","href":"/docs/core-extension/overview"},{"title":"Get Started","href":"/docs/core-extension/get-started"},{"title":"Authentication","href":"/docs/core-extension/authentication"},{"title":"Extension Types","href":"/docs/core-extension/extension-types"},{"title":"Support Translations","href":"/docs/core-extension/translations"},{"title":"Implement Role-Based UI Visibility","href":"/docs/core-extension/role-based-visibility"}]}]},{"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","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","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":[{"group":"Build with AI","root":{"title":"Build with AI on Nayax","href":"/docs/get-started/build-with-ai"},"pages":[{"title":"Connect to the Nayax MCP Server","href":"/docs/get-started/mcp-setup"}]}]},{"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":"Security Certifications","href":"/docs/get-started/certifications"}]},{"item":"Integration FAQ","pages":[{"title":"Integration FAQ","href":"/docs/get-started/integration-faq"}]}]}]},{"language":"zh","pages":[{"title":"zh","href":"/docs/zh"}]}]},"basePath":"","title":"Charge Token - Nayax Developer Portal","buildId":"dpl_345ReqzYaAjzS9QpeJemsKdb7KDj","deploymentId":"dpl_345ReqzYaAjzS9QpeJemsKdb7KDj","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-C8RPHPxo.js","utils-0BK-9q6z.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DfjzsUJT.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-B4v9psJ4.js","snippetPresets-CpTQv-Ez.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-BNP-Fvr0.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BSgu6h1D.js","shallow-Biv1i9Gs.js","getApiPlaygroundDisplay-BoGOXhtF.js","CodeSnippet-DvQoT18_.js","CodeSnippets-Dnpa15xT.js","Page-Buji1S4J.js","getPastedJson-xAIyhUFE.js","icon-S6FBih11.js","MethodPill-SaYeUZyk.js","DuplicateIcon-Cs-p3v2Q.js","createIcon-DjCFEoHq.js","DynamicMarkdown-BcnBltEQ.js","SectionHeading-BUBl0eEF.js","axios-vUo_bRtp.js","Markdown-h4cOoD8d.js","clsx-B2v50t8t.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-DJnKvr0g.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BHrrjR1K.js"]}