Tabby uses region-specific domains. Choose the base URL based on the merchant’s operating country:
Region
API Base URL
Checkout / Promo
Merchant Dashboard
UAE
https://api.tabby.ai
checkout.tabby.ai
merchant.tabby.ai
KSA
https://api.tabby.sa
checkout.tabby.sa
merchant.tabby.sa
All API paths and payloads are identical across both domains. Tabby identifies the environment (test or live) based on the API keys used.
Use the base URL that matches the merchant’s region for every call. Many existing integrations call api.tabby.ai for all regions and rely on Tabby-side request routing — but not every endpoint is routed (e.g. payments retrieval and disputes), and cross-region calls can return 404/403. New integrations must pin all calls — session creation, payment retrieval, captures, refunds, webhooks, dispute webhooks, disputes — to the regional base URL.
To access and download the raw OpenAPI specification file kindly use this: openapi.yaml.You can also view this API specification using ReDoc, the same is present below:
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Tabby","colors":{"primary":"#41A854","light":"#6CFF93","dark":"#41A854"},"logo":{"light":"https://mintcdn.com/tabby-5f40add6/1f-EIKwKexPNgWGm/logo/tabby-badge.svg?fit=max\u0026auto=format\u0026n=1f-EIKwKexPNgWGm\u0026q=85\u0026s=f9bf7cbe04bdae76df344b4746a6b12d","dark":"https://mintcdn.com/tabby-5f40add6/1f-EIKwKexPNgWGm/logo/tabby-badge.svg?fit=max\u0026auto=format\u0026n=1f-EIKwKexPNgWGm\u0026q=85\u0026s=f9bf7cbe04bdae76df344b4746a6b12d"},"favicon":"https://mintcdn.com/tabby-5f40add6/DEnsVYrXIrpLyZIh/favicon-new.png?fit=max\u0026auto=format\u0026n=DEnsVYrXIrpLyZIh\u0026q=85\u0026s=2f86273ef58d487ed55812e722f3db93","api":{"playground":{"display":"interactive"},"examples":{"defaults":"all","languages":["curl","python","javascript","php","go","java","ruby"],"prefill":true}},"appearance":{"default":"light","strict":false},"navbar":{"primary":{"type":"button","label":"Register","href":"https://merchant.tabby.ai"}},"footer":{"socials":{"facebook":"https://www.facebook.com/tabbypay-100185885064531","instagram":"https://instagram.com/tabbypay","linkedin":"https://www.linkedin.com/company/tabbypay","x":"https://twitter.com/paywithtabby?lang=en"}},"styling":{"codeblocks":"dark","latex":false},"contextual":{"options":["copy","view","chatgpt","claude","mcp"],"display":"header"},"navigation":{"languages":[{"language":"en","default":true,"href":"introduction/what-is-tabby"},{"language":"ar","href":"ar/marketing/toolkit"}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"tabby-5f40add6","hasAudioNarration":false,"actualSubdomain":"tabby-5f40add6","customDomains":["docs.tabby.ai"],"gitSource":{"type":"github","owner":"tabby-ai","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6adb060cb8cee1c0eaa27a4e","collectionId":"5d6447fb-7b7d-4278-8447-65c492cc55b8","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6adb060cb8cee1c0eaa27a4e"},"feedback":{"issues":true,"edits":true,"thumbs":true},"entitlements":{},"buildId":"6adb060cb8cee1c0eaa27a4e","clientVersion":"0.0.3966","searchFilterCounts":[{"language":"en","tag":"Documentation","count":36},{"language":"en","tag":"API Playground","count":28},{"language":"en","tag":"E-commerce Platforms","count":15},{"language":"en","tag":"Online Custom Integration","count":12},{"language":"en","tag":"Webhooks","count":7},{"language":"en","tag":"Disputes","count":6},{"language":"en","tag":"Payments","count":6},{"language":"en","tag":"Dispute Webhooks","count":5},{"language":"en","tag":"Introduction","count":5},{"language":"en","tag":"Shopify","count":3},{"language":"ar","tag":"مجموعة أدوات التسويق","count":1}]},"assistantConfig":{},"hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"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}],"isAtlas":false,"googleFontsInlined":false},"customCss":[{"filePath":"styles.css","content":"@font-face{font-family:'Tabby Sans Display';src:url(/fonts/TabbySansDisplay-Bold.woff2) format('woff2');font-weight:100 900;font-style:normal;font-display:swap}@font-face{font-family:'Tabby Sans Text';src:url(/fonts/TabbySansText-Regular.woff2) format('woff2');font-weight:100 400;font-style:normal;font-display:swap}@font-face{font-family:'Tabby Sans Text';src:url(/fonts/TabbySansText-Medium.woff2) format('woff2');font-weight:500 600;font-style:normal;font-display:swap}@font-face{font-family:'Tabby Sans Text';src:url(/fonts/TabbySansText-Bold.woff2) format('woff2');font-weight:700 900;font-style:normal;font-display:swap}.font-sans,body{font-family:'Tabby Sans Text',ui-sans-serif,system-ui,-apple-system,sans-serif!important}h1,h2,h3,h4{font-family:'Tabby Sans Display','Tabby Sans Text',sans-serif;letter-spacing:normal!important}img.product-shot,video.product-shot{display:block;margin:1.5rem auto;border-radius:1rem;border:1px solid rgb(10 10 10/.1);box-shadow:0 10px 25px -5px rgb(0 0 0/.12),0 4px 10px -6px rgb(0 0 0/.1)}.dark img.product-shot,.dark video.product-shot{border-color:rgb(255 255 255/.15);box-shadow:0 10px 25px -5px rgb(0 0 0/.45)}img.framed-shot,img.snippet-shot{display:block;margin:1.5rem auto}img.framed-shot{width:min(520px,100%);border-radius:12px}li img.framed-shot{width:min(520px,calc(100% - 38px))}div.product-shot-figure{margin:1.5rem auto;text-align:center}div.product-shot-figure img.product-shot{margin:1.5rem auto 0}p.product-shot-caption{margin-top:.75rem;font-size:.875rem;color:rgb(107 114 128)}html[lang=ar] #content,html[lang=ar] .mdx-content{direction:rtl}html[lang=ar] #header{direction:rtl;text-align:right}html[lang=ar] #content :is(ul, ol)>li{padding-left:6px;padding-right:32px}html[lang=ar] #content :is(ul, ol)>li::before{left:auto;right:8px}html[lang=ar] #content a svg.rotate-0.overflow-visible,html[lang=ar] #content svg.lucide-arrow-right,html[lang=ar] #content svg.lucide-arrow-up-right,html[lang=ar] #content svg.lucide-chevron-right{transform:scaleX(-1)}html[lang=ar] #content .absolute:has(>svg.lucide-arrow-up-right){right:auto;left:1.25rem}html[lang=ar] #content blockquote{border-left-width:0}#content-area .mdx-content,#content-container .mdx-content{max-width:80ch}@media (min-width:1280px){.max-w-8xl,div:has(>#content-container){max-width:100rem!important}}button[data-component-part=code-block-footer-button]{color:#6cff93!important;font-weight:600}button[data-component-part=code-block-footer-button]:hover{text-decoration:underline}.messaging-table table td:first-child,.messaging-table table th:first-child{width:1%;min-width:0;white-space:nowrap}:root:not(.dark) span[data-badge=true][data-color=gray]{background-color:#f5f4f2!important;color:#1a1919!important}:root:not(.dark) span[data-badge=true][data-color=blue]{background-color:#dfecf7!important;color:#3380c0!important}:root:not(.dark) span[data-badge=true][data-color=green]{background-color:#daf0df!important;color:#238e3b!important}:root:not(.dark) span[data-badge=true][data-color=yellow]{background-color:#fcedb8!important;color:#d66a1e!important}:root:not(.dark) span[data-badge=true][data-color=orange]{background-color:#ffe6cc!important;color:#d66a1e!important}:root:not(.dark) span[data-badge=true][data-color=red]{background-color:#ffe1de!important;color:#d44c3b!important}:root:not(.dark) span[data-badge=true][data-color=purple]{background-color:#f5defa!important;color:#a55ab8!important}:root:not(.dark) .callout[data-callout-type=info],:root:not(.dark) .callout[data-callout-type=note]{background-color:#dfecf7!important;border-color:#c4dcef!important}:root:not(.dark) .callout[data-callout-type=info] [data-component-part=callout-content],:root:not(.dark) .callout[data-callout-type=info] [data-component-part=callout-icon],:root:not(.dark) .callout[data-callout-type=note] [data-component-part=callout-content],:root:not(.dark) .callout[data-callout-type=note] [data-component-part=callout-icon]{color:#3380c0!important}:root:not(.dark) .callout[data-callout-type=check],:root:not(.dark) .callout[data-callout-type=tip]{background-color:#daf0df!important;border-color:#bfe4c9!important}:root:not(.dark) .callout[data-callout-type=check] [data-component-part=callout-content],:root:not(.dark) .callout[data-callout-type=check] [data-component-part=callout-icon],:root:not(.dark) .callout[data-callout-type=tip] [data-component-part=callout-content],:root:not(.dark) .callout[data-callout-type=tip] [data-component-part=callout-icon]{color:#238e3b!important}:root:not(.dark) .callout[data-callout-type=danger]{background-color:#ffe1de!important;border-color:#ffc7c1!important}:root:not(.dark) .callout[data-callout-type=danger] [data-component-part=callout-content],:root:not(.dark) .callout[data-callout-type=danger] [data-component-part=callout-icon]{color:#d44c3b!important}:root:not(.dark) .callout[data-callout-type=warning]{background-color:#fcedb8!important;border-color:#f5de8e!important}:root:not(.dark) .callout[data-callout-type=warning] [data-component-part=callout-content],:root:not(.dark) .callout[data-callout-type=warning] [data-component-part=callout-icon]{color:#d66a1e!important}.dark span[data-badge=true][data-color=gray]{background-color:rgb(245 244 242/.12)!important;color:#e8e6e3!important}.dark span[data-badge=true][data-color=blue]{background-color:rgb(51 128 192/.22)!important;color:#dfecf7!important}.dark span[data-badge=true][data-color=green]{background-color:rgb(35 142 59/.22)!important;color:#daf0df!important}.dark span[data-badge=true][data-color=yellow]{background-color:rgb(214 106 30/.22)!important;color:#fcedb8!important}.dark span[data-badge=true][data-color=orange]{background-color:rgb(214 106 30/.22)!important;color:#ffe6cc!important}.dark span[data-badge=true][data-color=red]{background-color:rgb(212 76 59/.22)!important;color:#ffe1de!important}.dark span[data-badge=true][data-color=purple]{background-color:rgb(165 90 184/.22)!important;color:#f5defa!important}.dark .callout[data-callout-type=info],.dark .callout[data-callout-type=note]{background-color:rgb(51 128 192/.18)!important;border-color:rgb(51 128 192/.45)!important}.dark .callout[data-callout-type=info] [data-component-part=callout-content],.dark .callout[data-callout-type=info] [data-component-part=callout-icon],.dark .callout[data-callout-type=note] [data-component-part=callout-content],.dark .callout[data-callout-type=note] [data-component-part=callout-icon]{color:#dfecf7!important}.dark .callout[data-callout-type=check],.dark .callout[data-callout-type=tip]{background-color:rgb(35 142 59/.18)!important;border-color:rgb(35 142 59/.45)!important}.dark .callout[data-callout-type=check] [data-component-part=callout-content],.dark .callout[data-callout-type=check] [data-component-part=callout-icon],.dark .callout[data-callout-type=tip] [data-component-part=callout-content],.dark .callout[data-callout-type=tip] [data-component-part=callout-icon]{color:#daf0df!important}.dark .callout[data-callout-type=danger]{background-color:rgb(212 76 59/.18)!important;border-color:rgb(212 76 59/.45)!important}.dark .callout[data-callout-type=danger] [data-component-part=callout-content],.dark .callout[data-callout-type=danger] [data-component-part=callout-icon]{color:#ffe1de!important}.dark .callout[data-callout-type=warning]{background-color:rgb(214 106 30/.18)!important;border-color:rgb(214 106 30/.45)!important}.dark .callout[data-callout-type=warning] [data-component-part=callout-content],.dark .callout[data-callout-type=warning] [data-component-part=callout-icon]{color:#fcedb8!important}.callout [data-component-part=callout-icon] svg{color:inherit!important}#content a.cta-button{display:inline-flex;align-items:center;gap:.5rem;padding:.75rem 1.5rem;border-radius:9999px;background-color:#41a854;color:#fff!important;font-weight:600;font-size:1rem;line-height:1.25;text-decoration:none!important;transition:background-color .15s ease,transform .15s ease}#content a.cta-button::after{content:\"↗\";font-size:1.05em;line-height:1}#content a.cta-button:hover{background-color:#2f8b41;transform:translateY(-1px)}.dark #content a.cta-button{background-color:#6cff93;color:#0a0a0a!important}.dark #content a.cta-button:hover{background-color:#8cffab}html[lang=ar] #content a.cta-button::after{content:\"↖\"}[id^=body-] [data-component-part=field-meta-post]{background-color:#fcedb8!important;color:#d66a1e!important}.dark [id^=body-] [data-component-part=field-meta-post]{background-color:rgba(252,237,184,.12)!important;color:#fcedb8!important}"},{"filePath":"swagger/swagger-ui.css","href":"/_mintlify/custom/tabby-5f40add6/7e77e8f2d6246341/swagger/swagger-ui.css"}],"page":{"pagePath":"api-reference/overview","slug":"/api-reference/overview","pageMetadata":{"title":"API Reference Documentation","description":null,"href":"/api-reference/overview"},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,li:`li`,p:`p`,strong:`strong`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,ul:`ul`,..._provideComponents(),...props.components},{Heading,OptimizedFrame,Table,Warning}=_components;if(!Heading)_missingMdxReference(`Heading`,true);if(!OptimizedFrame)_missingMdxReference(`OptimizedFrame`,true);if(!Table)_missingMdxReference(`Table`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`In this part of the documentation all the needed API calls for Tabby Integration can be found and tested:`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`Checkout - it is a whole process of customer data collection and payment authorization.`}),`\n`,_jsx(_components.li,{children:`Payments - the core of Tabby is a payments flow enabling you to handle payments at your webstore.`}),`\n`,_jsx(_components.li,{children:`Webhooks - serve to ensure a seamless payment verification flow.`}),`\n`,_jsx(_components.li,{children:`Dispute webhooks - notify you when a dispute is opened on your payment or changes its status.`}),`\n`,_jsx(_components.li,{children:`Disputes - help merchants resolve issues with customers orders more efficiently.`}),`\n`]}),`\n`,_jsx(Heading,{level:`2`,id:`base-urls`,children:`Base URLs`}),`\n`,_jsx(_components.p,{children:`Tabby uses region-specific domains. Choose the base URL based on the merchant’s operating country:`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Region`}),_jsx(_components.th,{children:`API Base URL`}),_jsx(_components.th,{children:`Checkout / Promo`}),_jsx(_components.th,{children:`Merchant Dashboard`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.strong,{children:`UAE`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`https://api.tabby.ai`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`checkout.tabby.ai`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`merchant.tabby.ai`})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.strong,{children:`KSA`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`https://api.tabby.sa`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`checkout.tabby.sa`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`merchant.tabby.sa`})})]})]})]}),`\n`,_jsx(_components.p,{children:`All API paths and payloads are identical across both domains. Tabby identifies the environment (test or live) based on the API keys used.`}),`\n`,_jsx(Warning,{children:_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Use the base URL that matches the merchant’s region for every call.`}),` Many existing integrations call `,_jsx(_components.code,{children:`api.tabby.ai`}),` for all regions and rely on Tabby-side request routing — but not every endpoint is routed (e.g. payments retrieval and disputes), and cross-region calls can return `,_jsx(_components.code,{children:`404`}),`/`,_jsx(_components.code,{children:`403`}),`. New integrations must pin all calls — session creation, payment retrieval, captures, refunds, webhooks, dispute webhooks, disputes — to the regional base URL.`]})}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Contact`}),_jsx(_components.th,{children:`UAE`}),_jsx(_components.th,{children:`KSA`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.strong,{children:`Partner Support`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`partner@tabby.ai`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`partner@tabby.sa`})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.strong,{children:`Customer Support`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`help@tabby.ai`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`help@tabby.sa`})})]})]})]}),`\n`,_jsx(Heading,{level:`2`,id:`openapi-specification`,children:`OpenAPI Specification`}),`\n`,_jsxs(_components.p,{children:[`To access and download the raw OpenAPI specification file kindly use this: `,_jsx(_components.a,{href:`https://docs.tabby.ai/openapi.yaml`,children:`openapi.yaml`}),`.`]}),`\n`,_jsxs(_components.p,{children:[`You can also view this API specification using `,_jsx(_components.a,{href:`https://redocly.github.io/redoc/?url=https://docs.tabby.ai/openapi.yaml`,children:`ReDoc`}),`, the same is present below:`]}),`\n`,_jsx(OptimizedFrame,{frameBorder:`0`,height:`800px`,src:`https://redocly.github.io/redoc/?url=https://docs.tabby.ai/openapi.yaml`,style:{border:`1px solid #e1e5e9`,borderRadius:`8px`},title:`Tabby API Swagger UI`,width:`100%`}),`\n`,_jsx(Heading,{level:`2`,id:`quick-links-to-documentation`,children:`Quick Links to Documentation`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:_jsx(_components.a,{href:`/pay-in-4-custom-integration/quick-start`,children:`Direct API Integration Guide`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.a,{href:`/testing-guidelines/testing-credentials`,children:`Testing Credentials`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.a,{href:`/testing-guidelines/postman-api-collections`,children:`Postman API Collection`})}),`\n`]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"codeStyling":"dark","config":{},"pageMetadata":{"title":"API Reference Documentation","description":null,"href":"/api-reference/overview"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Base URLs","slug":"base-urls","depth":2,"children":[]},{"title":"OpenAPI Specification","slug":"openapi-specification","depth":2,"children":[]},{"title":"Quick Links to Documentation","slug":"quick-links-to-documentation","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":["/_mintlify/custom/tabby-5f40add6/9f2b5ecdf0f199ba/eslint.config.js","/_mintlify/custom/tabby-5f40add6/b8a8460aa1a4fa11/swagger/swagger-ui-bundle.js","/_mintlify/custom/tabby-5f40add6/19a31c3b1620a182/swagger/swagger-ui-standalone-preset.js","/_mintlify/custom/tabby-5f40add6/316fd6bc989c58f1/swagger/swagger-ui.js","/_mintlify/custom/tabby-5f40add6/b26a86079cee90e6/next.config.js"],"subdomain":"tabby-5f40add6","siteName":"Tabby","title":"API Reference Documentation - Tabby","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"en":{"href":"/api-reference/overview","matchLevel":0},"ar":{"href":"/ar/marketing/toolkit","matchLevel":4}}},"lastModified":"2026-10-02T13:30:08.103Z","originalFileLocation":"api-reference/overview.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=\"light\"}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=\"Tabby\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/tabby-5f40add6/Lsj-1o9eEOnU_rir/_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/tabby-5f40add6/Lsj-1o9eEOnU_rir/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/tabby-5f40add6/Lsj-1o9eEOnU_rir/_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/tabby-5f40add6/Lsj-1o9eEOnU_rir/_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/tabby-5f40add6/Lsj-1o9eEOnU_rir/_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/tabby-5f40add6/Lsj-1o9eEOnU_rir/_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/tabby-5f40add6/Lsj-1o9eEOnU_rir/_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/tabby-5f40add6/Lsj-1o9eEOnU_rir/_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/tabby-5f40add6/Lsj-1o9eEOnU_rir/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"API Reference Documentation - Tabby\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Tabby\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.tabby.ai/api-reference/overview\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://tabby-5f40add6.mintlify.app/_mintlify/api/og/v2?division=API+Playground\u0026amp;title=API+Reference+Documentation\u0026amp;theme=a18093f88c8f4a84a1db7bcf\u0026amp;signature=50e1037ccd3bb7d6bb99158e39afeae1e2cc2b456660e54717860dd7dde5ac2b\">\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=\"API Reference Documentation - Tabby\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://tabby-5f40add6.mintlify.app/_mintlify/api/og/v2?division=API+Playground\u0026amp;title=API+Reference+Documentation\u0026amp;theme=a18093f88c8f4a84a1db7bcf\u0026amp;signature=50e1037ccd3bb7d6bb99158e39afeae1e2cc2b456660e54717860dd7dde5ac2b\">\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/tabby-5f40add6/Lsj-1o9eEOnU_rir/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Tabby\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#41A854\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.tabby.ai/api-reference/overview\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/overview.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.tabby.ai/#organization\",\"name\":\"Tabby\",\"url\":\"https://docs.tabby.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/tabby-5f40add6/1f-EIKwKexPNgWGm/logo/tabby-badge.svg?fit=max\u0026auto=format\u0026n=1f-EIKwKexPNgWGm\u0026q=85\u0026s=f9bf7cbe04bdae76df344b4746a6b12d\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.tabby.ai#website\",\"name\":\"Tabby\",\"url\":\"https://docs.tabby.ai\",\"publisher\":{\"@id\":\"https://docs.tabby.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.tabby.ai/api-reference/overview#webpage\",\"url\":\"https://docs.tabby.ai/api-reference/overview\",\"name\":\"API Reference Documentation\",\"dateModified\":\"2026-10-02T13:30:08.103Z\",\"isPartOf\":{\"@id\":\"https://docs.tabby.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.tabby.ai/api-reference/overview#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.tabby.ai/api-reference/overview#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Tabby\",\"item\":\"https://docs.tabby.ai\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"API Reference Documentation\",\"item\":\"https://docs.tabby.ai/api-reference/overview\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.tabby.ai/api-reference/overview#article\",\"headline\":\"API Reference Documentation\",\"name\":\"API Reference Documentation\",\"url\":\"https://docs.tabby.ai/api-reference/overview\",\"mainEntityOfPage\":{\"@id\":\"https://docs.tabby.ai/api-reference/overview#webpage\"},\"dateModified\":\"2026-10-02T13:30:08.103Z\",\"publisher\":{\"@id\":\"https://docs.tabby.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.tabby.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Tabby\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Tabby","nav":{"global":null,"languages":[{"language":"en","default":true,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/introduction/what-is-tabby"}]},{"tab":"API Playground","groups":[{"group":"API Playground","pages":[{"title":"API Reference Documentation","href":"/api-reference/overview"},{"title":"API Error Codes","sidebarTitle":"Error codes","description":"Errors returned by the Tabby API — status codes, response bodies, and how to handle each one.","href":"/api-reference/response-codes"}]},{"group":"Checkout","pages":[{"openapi":"post /api/v2/checkout","title":"Create a session","href":"/api-reference/checkout/create-a-session"},{"title":"Session creation payload model","href":"/api-reference/checkout/session-payload-model"}]},{"group":"Payments","pages":[{"openapi":"get /api/v2/payments/{id}","title":"Retrieve a payment","href":"/api-reference/payments/retrieve-a-payment"},{"openapi":"put /api/v2/payments/{id}","title":"Update a payment","href":"/api-reference/payments/update-a-payment"},{"openapi":"post /api/v2/payments/{id}/captures","title":"Capture a payment","href":"/api-reference/payments/capture-a-payment"},{"openapi":"post /api/v2/payments/{id}/refunds","title":"Refund a payment","href":"/api-reference/payments/refund-a-payment"},{"openapi":"post /api/v2/payments/{id}/close","title":"Close a payment","href":"/api-reference/payments/close-a-payment"},{"openapi":"get /api/v2/payments","title":"List of all payments","href":"/api-reference/payments/list-of-all-payments"}]},{"group":"Webhooks","pages":[{"openapi":"post /api/v1/webhooks","title":"Register a webhook","href":"/api-reference/webhooks/register-a-webhook"},{"openapi":"get /api/v1/webhooks","title":"Retrieve all webhooks","href":"/api-reference/webhooks/retrieve-all-webhooks"},{"openapi":"get /api/v1/webhooks/{id}","title":"Retrieve a webhook","href":"/api-reference/webhooks/retrieve-a-webhook"},{"openapi":"put /api/v1/webhooks/{id}","title":"Update a webhook","href":"/api-reference/webhooks/update-a-webhook"},{"openapi":"delete /api/v1/webhooks/{id}","title":"Remove a webhook","href":"/api-reference/webhooks/remove-a-webhook"}]},{"group":"Dispute Webhooks","pages":[{"openapi":"post /api/v1/dispute-webhooks","title":"Register a dispute webhook","href":"/api-reference/dispute-webhooks/register-a-dispute-webhook"},{"openapi":"get /api/v1/dispute-webhooks","title":"Retrieve all dispute webhooks","href":"/api-reference/dispute-webhooks/retrieve-all-dispute-webhooks"},{"openapi":"get /api/v1/dispute-webhooks/{id}","title":"Retrieve a dispute webhook","href":"/api-reference/dispute-webhooks/retrieve-a-dispute-webhook"},{"openapi":"put /api/v1/dispute-webhooks/{id}","title":"Update a dispute webhook","href":"/api-reference/dispute-webhooks/update-a-dispute-webhook"},{"openapi":"delete /api/v1/dispute-webhooks/{id}","title":"Remove a dispute webhook","href":"/api-reference/dispute-webhooks/remove-a-dispute-webhook"}]},{"group":"Disputes","pages":[{"openapi":"get /api/v1/disputes","title":"Get disputes list","href":"/api-reference/disputes/get-disputes-list"},{"openapi":"get /api/v1/disputes/{disputeId}","title":"Get dispute by id","href":"/api-reference/disputes/get-dispute-by-id"},{"openapi":"post /api/v1/disputes/{disputeId}/provide-evidence","title":"Provide evidence for a dispute","href":"/api-reference/disputes/provide-evidence"},{"openapi":"post /api/v1/disputes/approve","title":"Approve disputes","href":"/api-reference/disputes/approve-disputes"},{"openapi":"post /api/v1/disputes/challenge","title":"Challenge disputes","href":"/api-reference/disputes/challenge-disputes"},{"openapi":"post /api/v1/disputes/attachments/upload","title":"Upload attachment","href":"/api-reference/disputes/upload-attachment"}]}]},{"tab":"Marketing Toolkit","pages":[{"title":"Marketing Toolkit","href":"/marketing/toolkit"}]}]},{"language":"ar","pages":[{"title":"ar","href":"/ar/marketing/toolkit"}]}]},"title":"API Reference Documentation - Tabby","buildId":"dpl_cadrRc5H9XQiJQbDFN5mcYRs2PAj","deploymentId":"dpl_cadrRc5H9XQiJQbDFN5mcYRs2PAj","dynamics":[],"chunks":[]}