{"docsConfig":{"theme":"maple","$schema":"https://mintlify.com/docs.json","name":"Demat Escrow API","description":"Secret-key API reference for Demat Escrow — customers, holds, checkout, wallets, payouts, and webhooks.","colors":{"primary":"#5D2E8F","light":"#A78BDB","dark":"#4A2472"},"logo":{"light":"https://mintcdn.com/demat-shop-enterprise/38IVRaUbZVGwAsgT/logo/light.svg?fit=max\u0026auto=format\u0026n=38IVRaUbZVGwAsgT\u0026q=85\u0026s=9a76cf5cc9bfa666a81246563036733e","dark":"https://mintcdn.com/demat-shop-enterprise/38IVRaUbZVGwAsgT/logo/dark.svg?fit=max\u0026auto=format\u0026n=38IVRaUbZVGwAsgT\u0026q=85\u0026s=f3c9d161643cb3bc4d3390eabb34bb7c","href":"https://usedemat.com"},"favicon":"https://mintcdn.com/demat-shop-enterprise/38IVRaUbZVGwAsgT/favicon.svg?fit=max\u0026auto=format\u0026n=38IVRaUbZVGwAsgT\u0026q=85\u0026s=ddbc4d2ba3c1ca578a6f5d76d5c1767b","api":{"playground":{"display":"interactive"},"examples":{"defaults":"required","languages":["curl","node","python"],"prefill":true}},"appearance":{"default":"light"},"background":{"decoration":"gradient","color":{"light":"#FAF8FC","dark":"#120E18"}},"navbar":{"links":[{"href":"https://merchant.usedemat.com","label":"Dashboard"},{"href":"https://merchant.usedemat.com","label":"Website"}],"primary":{"type":"button","label":"Get API keys","href":"https://merchant.usedemat.com"}},"fonts":{"family":"Jost"},"icons":{"library":"lucide"},"styling":{"eyebrows":"breadcrumbs","codeblocks":{"theme":{"light":"github-light","dark":"github-dark"}},"latex":false},"contextual":{"options":["copy","view","chatgpt","claude","cursor"],"display":"header"},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"demat-shop-enterprise","hasAudioNarration":false,"actualSubdomain":"demat-shop-enterprise","customDomains":["docs.usedemat.com"],"gitSource":{"type":"github","owner":"hostel-paddy","repo":"demat-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"latestBuiltDeploymentHistoryId":"6ac2d50b3605e3b2ae6e5fd6","collectionId":"9878f90a-45ce-461b-9f69-15fd3489d6ad","liveDeploymentHistoryId":"6ac2d50b3605e3b2ae6e5fd6","schemaVersion":"v3"},"entitlements":{"AI_CHAT":{"status":"DISABLED"},"WEB_MCP":{"status":"DISABLED"},"NARRATION":{"status":"DISABLED"}},"buildId":"6ad7c4af2b5ff80356f2de6b","clientVersion":"0.0.3902","searchFilterCounts":[{"language":"default","tag":"API Reference","count":32},{"language":"default","tag":"Guides","count":11},{"language":"default","tag":"escrows","count":9},{"language":"default","tag":"API basics","count":6},{"language":"default","tag":"customers","count":5},{"language":"default","tag":"checkout","count":4},{"language":"default","tag":"wallets","count":4},{"language":"default","tag":"Get started","count":3},{"language":"default","tag":"identity","count":3},{"language":"default","tag":"payouts","count":3}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"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":"editor-branches-v2-autocommit","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-branches-v2","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":"teamspace","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":"vite-origin","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":"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":"revalidation-jwt","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":"client-snapshot-docs-config","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":true},"customCss":[{"filePath":"style.css","content":":root{--demat-purple:#5d2e8f;--demat-purple-soft:#f3eef8;--demat-orange:#faa51e;--demat-ink:#1e1528;--demat-muted:#5c5268}::selection{background:rgba(93,46,143,.18);color:var(--demat-ink)}#navbar img,#navbar svg,#navbar-logo img,#navbar-logo svg{max-height:28px;width:auto}#page-title{letter-spacing:-.02em;color:var(--demat-ink);font-weight:600}#content-area h2,#content-area h3,#content-area th{letter-spacing:-.015em;color:var(--demat-ink)}#content-area li,#content-area p{color:var(--demat-muted);line-height:1.7}#topbar-cta-button{background:var(--demat-purple)!important;border-color:transparent!important;box-shadow:0 1px 0 rgba(93,46,143,.15)}#topbar-cta-button:hover{background:#4a2472!important}#content-area a[class*=card],#content-area a[href].card{border-radius:12px;border-color:#ebe4f3!important;background:rgba(255,255,255,.8)!important;transition:border-color .15s ease,box-shadow .15s ease}#content-area a[class*=card]:hover,#content-area a[href].card:hover{border-color:#d8c8ea!important;box-shadow:0 8px 24px rgba(93,46,143,.08)}#content-area table{border-collapse:separate;border-spacing:0;overflow:hidden;border-radius:10px}#content-area th{background:var(--demat-purple-soft);font-weight:600;letter-spacing:-.01em}#content-area td{border-color:#eee8f4}#content-area tr:hover td{background:#fcfaff}#content-area :not(pre)>code{background:var(--demat-purple-soft);color:var(--demat-purple);border-radius:5px;padding:.12em .38em;font-weight:500}#sidebar a[aria-current=page]{color:var(--demat-purple)!important}#page-title::after{content:\"\";display:block;width:2.5rem;height:3px;margin-top:.85rem;border-radius:999px;background:linear-gradient(90deg,var(--demat-orange),var(--demat-purple))}#header,#pagination{border-color:#efe8f6}.dark ::selection{background:rgba(167,139,219,.28);color:#f4eefc}.dark #content-area h2,.dark #content-area h3,.dark #page-title{color:#f4eefc}.dark #content-area li,.dark #content-area p{color:#b7aec6}.dark #content-area th{background:#1c1526;color:#f4eefc}.dark #content-area :not(pre)>code{background:#241b30;color:#cbb6ef}.dark #content-area a[class*=card],.dark #content-area a[href].card{background:rgba(24,18,31,.85)!important;border-color:#2e243c!important}.dark #header,.dark #pagination{border-color:#2a2235}"}],"page":{"pagePath":"api-reference/checkout/get-a-checkout-session","slug":"/api-reference/checkout/get-a-checkout-session","pageMetadata":{"title":"Get a checkout session","description":"Fetch one checkout session you created, including checkoutUrl.","deprecated":null,"version":null,"openapi":"/openapi.json get /checkout/sessions/{checkoutId}","href":"/api-reference/checkout/get-a-checkout-session","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Fetch one checkout session you created, including checkoutUrl.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"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":{"codeStyling":{"theme":{"light":"github-light","dark":"github-dark"}},"config":{},"pageMetadata":{"title":"Get a checkout session","description":"Fetch one checkout session you created, including checkoutUrl.","deprecated":null,"version":null,"openapi":"/openapi.json get /checkout/sessions/{checkoutId}","href":"/api-reference/checkout/get-a-checkout-session","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"description":"Fetch one checkout session you created, including checkoutUrl.","operationId":"CheckoutController_get","parameters":["8e719bc5-b8aa-4929-8558-bed87f9d7b76"],"responses":{"200":"08914fac-b2a6-4cef-b1f2-f520c91c421e","401":"3ea90cc3-f05e-4fad-b345-4d96b13c3bae","404":"ea8aced2-fab0-40c3-90b9-156272dca85f"},"security":["4df787b5-93a9-46d2-a5fb-a5a17566d9af"],"summary":"Get a checkout session","tags":["checkout"],"method":"get","type":"path","servers":["409dd45c-8f2a-49e0-8e00-041fc26564cb"],"path":"/checkout/sessions/{checkoutId}","baseUrlOptions":["{baseUrl}"],"title":"Get a checkout session","codeSamples":[],"requestExampleLanguages":["bash","node","python"],"requiredOnlyExamples":true,"requestExampleType":"generated","responseExampleType":"generated","prefillPlaygroundWithExample":true,"prefillPlaygroundExamples":[]},"dependencies":{"parameters":{"8e719bc5-b8aa-4929-8558-bed87f9d7b76":{"name":"checkoutId","required":true,"in":"path","schema":{"type":"string","isRequired":true,"uniqueKey":"","typeLabel":"string"}}},"responses":{"08914fac-b2a6-4cef-b1f2-f520c91c421e":{"description":"Request succeeded","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"uniqueKey":"success","typeLabel":"boolean"},"data":{"type":"object","properties":{"checkoutId":{"type":"string","example":"chk_01hxyz","isRequired":true,"uniqueKey":"data.checkoutId","typeLabel":"string"},"status":{"type":"string","enum":["pending","completed","expired","failed"],"description":"pending: checkout URL live, not paid. completed: payment succeeded and money was booked. failed: checkout could not be started. expired: unused. we do not reject a successful payment because of time.","isRequired":true,"uniqueKey":"data.status","typeLabel":"enum\u003cstring>"},"paymentId":{"type":"string","example":"pay_01hxyz","isRequired":true,"uniqueKey":"data.paymentId","typeLabel":"string"},"customerId":{"type":"string","example":"cus_01hxyz","isRequired":true,"uniqueKey":"data.customerId","typeLabel":"string"},"provider":{"type":"string","isRequired":true,"uniqueKey":"data.provider","typeLabel":"string"},"amount":{"type":"number","example":400,"description":"Business amount in naira (hold or wallet credit).","isRequired":true,"uniqueKey":"data.amount","typeLabel":"number"},"chargedAmount":{"type":"number","example":407.5,"description":"Total charged to the payer including fees.","isRequired":true,"uniqueKey":"data.chargedAmount","typeLabel":"number"},"netAmount":{"type":"number","example":400,"description":"Amount applied to the hold or wallet after fees.","isRequired":true,"uniqueKey":"data.netAmount","typeLabel":"number"},"fees":{"type":"object","properties":{"providerFee":{"type":"number","example":6,"isRequired":true,"uniqueKey":"data.fees.providerFee","typeLabel":"number"},"platformFee":{"type":"number","example":1.5,"isRequired":true,"uniqueKey":"data.fees.platformFee","typeLabel":"number"},"merchantFee":{"type":"number","example":0,"isRequired":true,"uniqueKey":"data.fees.merchantFee","typeLabel":"number"},"totalFees":{"type":"number","example":7.5,"isRequired":true,"uniqueKey":"data.fees.totalFees","typeLabel":"number"}},"required":["providerFee","platformFee","merchantFee","totalFees"],"isRequired":true,"uniqueKey":"data.fees","typeLabel":"object"},"checkoutUrl":{"oneOf":[{"type":"string","example":"https://checkout.example.com/abc","description":"URL the merchant should share with the payer to complete checkout.","uniqueKey":"data.checkoutUrl.oneOf.0","typeLabel":"string"},{"type":"null","example":"https://checkout.example.com/abc","description":"URL the merchant should share with the payer to complete checkout.","uniqueKey":"data.checkoutUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.checkoutUrl","typeLabel":"string | null"},"escrowId":{"oneOf":[{"type":"string","example":"esc_01hxyz","uniqueKey":"data.escrowId.oneOf.0","typeLabel":"string"},{"type":"null","example":"esc_01hxyz","uniqueKey":"data.escrowId.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.escrowId","typeLabel":"string | null"},"walletId":{"oneOf":[{"type":"string","example":"wal_01hxyz","uniqueKey":"data.walletId.oneOf.0","typeLabel":"string"},{"type":"null","example":"wal_01hxyz","uniqueKey":"data.walletId.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.walletId","typeLabel":"string | null"}},"required":["checkoutId","status","paymentId","customerId","provider","amount","chargedAmount","netAmount","fees"],"uniqueKey":"data","typeLabel":"object"},"meta":{"type":"object","properties":{"requestId":{"type":"string","example":"req_01hxyz","isRequired":true,"uniqueKey":"meta.requestId","typeLabel":"string"}},"required":["requestId"],"uniqueKey":"meta","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":true,"data":{"checkoutId":"chk_01hxyz","status":"pending","paymentId":"pay_01hxyz","customerId":"cus_01hxyz","provider":"\u003cstring>","amount":400,"chargedAmount":407.5,"netAmount":400,"fees":{"providerFee":6,"platformFee":1.5,"merchantFee":0,"totalFees":7.5},"checkoutUrl":"https://checkout.example.com/abc","escrowId":"esc_01hxyz","walletId":"wal_01hxyz"},"meta":{"requestId":"req_01hxyz"}}}},"exampleType":"generated"}},"exampleType":"generated"},"3ea90cc3-f05e-4fad-b345-4d96b13c3bae":{"description":"Missing or invalid credentials","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":false,"isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"error":{"type":"object","properties":{"code":{"type":"string","example":"INVALID_REQUEST","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","example":"Invalid request","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"type":"object","additionalProperties":true,"example":{},"isRequired":true,"uniqueKey":"error.details","typeLabel":"object"}},"required":["code","message","details"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"},"meta":{"type":"object","properties":{"requestId":{"type":"string","example":"req_01hxyz","isRequired":true,"uniqueKey":"meta.requestId","typeLabel":"string"}},"required":["requestId"],"isRequired":true,"uniqueKey":"meta","typeLabel":"object"}},"required":["success","error","meta"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":false,"error":{"code":"INVALID_REQUEST","message":"Invalid request","details":{}},"meta":{"requestId":"req_01hxyz"}}}},"exampleType":"generated"}},"exampleType":"generated"},"ea8aced2-fab0-40c3-90b9-156272dca85f":{"description":"Resource not found","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":false,"isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"error":{"type":"object","properties":{"code":{"type":"string","example":"INVALID_REQUEST","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","example":"Invalid request","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"type":"object","additionalProperties":true,"example":{},"isRequired":true,"uniqueKey":"error.details","typeLabel":"object"}},"required":["code","message","details"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"},"meta":{"type":"object","properties":{"requestId":{"type":"string","example":"req_01hxyz","isRequired":true,"uniqueKey":"meta.requestId","typeLabel":"string"}},"required":["requestId"],"isRequired":true,"uniqueKey":"meta","typeLabel":"object"}},"required":["success","error","meta"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":false,"error":{"code":"INVALID_REQUEST","message":"Invalid request","details":{}},"meta":{"requestId":"req_01hxyz"}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"4df787b5-93a9-46d2-a5fb-a5a17566d9af":{"bearer":{"scheme":"bearer","bearerFormat":"Secret Key","type":"http","description":"Secret API key. Use `sk_test_...` for sandbox data or `sk_live_...` for live data (after verification and live mode). Do not use `pk_` keys.","scopes":[]}}},"servers":{"409dd45c-8f2a-49e0-8e00-041fc26564cb":{"url":"{baseUrl}","description":"API base URL. type your host here","variables":{"baseUrl":{"default":"https://prod.demat.shop/api/v1","description":"Full base URL including /api/v1. Change this for local development if needed."}}}},"processedSecurityOptions":[{"schemes":[{"scheme":{"scheme":"bearer","bearerFormat":"Secret Key","type":"http","description":"Secret API key. Use `sk_test_...` for sandbox data or `sk_live_...` for live data (after verification and live mode). Do not use `pk_` keys.","scopes":[]},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Secret API key. Use `sk_test_...` for sandbox data or `sk_live_...` for live data (after verification and live mode). Do not use `pk_` keys.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearer","name":"Authorization"}],"title":"bearer"}]},"originalFileLocation":"openapi.json"},"subdomain":"demat-shop-enterprise","siteName":"Demat Escrow API","title":"Get a checkout session - Demat Escrow API","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-04T22:37:03.352Z","originalFileLocation":"api-reference/checkout/get-a-checkout-session.mdx"},"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=\"description\" content=\"Fetch one checkout session you created, including checkoutUrl.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Demat Escrow API\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/demat-shop-enterprise/oBWYcEk0DmNgXDmM/_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/demat-shop-enterprise/oBWYcEk0DmNgXDmM/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/demat-shop-enterprise/oBWYcEk0DmNgXDmM/_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/demat-shop-enterprise/oBWYcEk0DmNgXDmM/_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/demat-shop-enterprise/oBWYcEk0DmNgXDmM/_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/demat-shop-enterprise/oBWYcEk0DmNgXDmM/_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/demat-shop-enterprise/oBWYcEk0DmNgXDmM/_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/demat-shop-enterprise/oBWYcEk0DmNgXDmM/_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/demat-shop-enterprise/oBWYcEk0DmNgXDmM/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get a checkout session - Demat Escrow API\">\u003cmeta data-mint-head property=\"og:description\" content=\"Fetch one checkout session you created, including checkoutUrl.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Demat Escrow API\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.usedemat.com/api-reference/checkout/get-a-checkout-session\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Get a checkout session - Demat Escrow API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Fetch one checkout session you created, including checkoutUrl.\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/demat-shop-enterprise/oBWYcEk0DmNgXDmM/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Demat Escrow API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#5D2E8F\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.usedemat.com/api-reference/checkout/get-a-checkout-session\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/checkout/get-a-checkout-session.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.usedemat.com/#organization\",\"name\":\"Demat Escrow API\",\"url\":\"https://docs.usedemat.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/demat-shop-enterprise/38IVRaUbZVGwAsgT/logo/light.svg?fit=max\u0026auto=format\u0026n=38IVRaUbZVGwAsgT\u0026q=85\u0026s=9a76cf5cc9bfa666a81246563036733e\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.usedemat.com#website\",\"name\":\"Demat Escrow API\",\"url\":\"https://docs.usedemat.com\",\"publisher\":{\"@id\":\"https://docs.usedemat.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.usedemat.com/api-reference/checkout/get-a-checkout-session#webpage\",\"url\":\"https://docs.usedemat.com/api-reference/checkout/get-a-checkout-session\",\"name\":\"Get a checkout session\",\"description\":\"Fetch one checkout session you created, including checkoutUrl.\",\"dateModified\":\"2026-10-04T22:37:03.352Z\",\"isPartOf\":{\"@id\":\"https://docs.usedemat.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.usedemat.com/api-reference/checkout/get-a-checkout-session#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.usedemat.com/api-reference/checkout/get-a-checkout-session#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"checkout\",\"item\":\"https://docs.usedemat.com/api-reference/checkout/get-a-public-checkout-session\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get a checkout session\",\"item\":\"https://docs.usedemat.com/api-reference/checkout/get-a-checkout-session\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.usedemat.com/api-reference/checkout/get-a-checkout-session#apireference\",\"headline\":\"Get a checkout session\",\"name\":\"Get a checkout session\",\"description\":\"Fetch one checkout session you created, including checkoutUrl.\",\"url\":\"https://docs.usedemat.com/api-reference/checkout/get-a-checkout-session\",\"mainEntityOfPage\":{\"@id\":\"https://docs.usedemat.com/api-reference/checkout/get-a-checkout-session#webpage\"},\"dateModified\":\"2026-10-04T22:37:03.352Z\",\"publisher\":{\"@id\":\"https://docs.usedemat.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.usedemat.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Demat Escrow API\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Demat Escrow API","nav":{"global":null,"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":""}]},{"tab":"API Reference","groups":[{"group":"customers","pages":[{"title":"List customers","deprecated":null,"version":null,"openapi":"/openapi.json get /customers","href":"/api-reference/customers/list-customers"},{"title":"Create a customer","deprecated":null,"version":null,"openapi":"/openapi.json post /customers","href":"/api-reference/customers/create-a-customer"},{"title":"Get a customer","deprecated":null,"version":null,"openapi":"/openapi.json get /customers/{customerId}","href":"/api-reference/customers/get-a-customer"},{"title":"Delete a customer","deprecated":null,"version":null,"openapi":"/openapi.json delete /customers/{customerId}","href":"/api-reference/customers/delete-a-customer"},{"title":"Update a customer","deprecated":null,"version":null,"openapi":"/openapi.json patch /customers/{customerId}","href":"/api-reference/customers/update-a-customer"}]},{"group":"escrows","pages":[{"title":"List escrows","deprecated":null,"version":null,"openapi":"/openapi.json get /escrows","href":"/api-reference/escrows/list-escrows"},{"title":"Create an escrow","deprecated":null,"version":null,"openapi":"/openapi.json post /escrows","href":"/api-reference/escrows/create-an-escrow"},{"title":"Get an escrow","deprecated":null,"version":null,"openapi":"/openapi.json get /escrows/{escrowId}","href":"/api-reference/escrows/get-an-escrow"},{"title":"Cancel an unfunded escrow","deprecated":null,"version":null,"openapi":"/openapi.json post /escrows/{escrowId}/cancel","href":"/api-reference/escrows/cancel-an-unfunded-escrow"},{"title":"Get the dispute on an escrow","deprecated":null,"version":null,"openapi":"/openapi.json get /escrows/{escrowId}/disputes","href":"/api-reference/escrows/get-the-dispute-on-an-escrow"},{"title":"Open a dispute on a held escrow","deprecated":null,"version":null,"openapi":"/openapi.json post /escrows/{escrowId}/disputes","href":"/api-reference/escrows/open-a-dispute-on-a-held-escrow"},{"title":"Resolve a dispute by release, refund, or split","deprecated":null,"version":null,"openapi":"/openapi.json post /escrows/{escrowId}/disputes/{disputeId}/resolve","href":"/api-reference/escrows/resolve-a-dispute-by-release-refund-or-split"},{"title":"Refund held funds","deprecated":null,"version":null,"openapi":"/openapi.json post /escrows/{escrowId}/refund","href":"/api-reference/escrows/refund-held-funds"},{"title":"Release held funds","deprecated":null,"version":null,"openapi":"/openapi.json post /escrows/{escrowId}/release","href":"/api-reference/escrows/release-held-funds"}]},{"group":"checkout","pages":[{"title":"Get a public checkout session","deprecated":null,"version":null,"openapi":"/openapi.json get /checkout/public/{checkoutToken}","href":"/api-reference/checkout/get-a-public-checkout-session"},{"title":"List checkout sessions","deprecated":null,"version":null,"openapi":"/openapi.json get /checkout/sessions","href":"/api-reference/checkout/list-checkout-sessions"},{"title":"Create a checkout session","description":"Start hosted checkout. Pass escrowId XOR customerId. EscrowId funds an awaiting_funding hold (amount and currency must match). A second POST for that same unfunded hold returns the existing pending session. It does not start another charge. Same Idempotency-Key + same body replays the first response. Different key + same escrowId still returns that pending session. CustomerId credits that customer’s available and does not lock a hold; wallet top-ups may have more than one open session. PaymentMethods, if omitted, uses the channels enabled on your Demat dashboard (card only until you turn others on). See Callback URL. Webhook: payment.pending.","deprecated":null,"version":null,"openapi":"/openapi.json post /checkout/sessions","href":"/api-reference/checkout/create-a-checkout-session"},{"title":"Get a checkout session","deprecated":null,"version":null,"openapi":"/openapi.json get /checkout/sessions/{checkoutId}","href":"/api-reference/checkout/get-a-checkout-session"}]},{"group":"transactions","pages":[{"title":"List transactions","description":"Page through customer money activity for this merchant. Filter with customerId, type, direction, relatedId, startDate, and endDate. Each row is one customer’s view of an event (wallet credit, escrow funded/released/refunded, withdrawal).","deprecated":null,"version":null,"openapi":"/openapi.json get /transactions","href":"/api-reference/transactions/list-transactions"},{"title":"Export transactions","deprecated":null,"version":null,"openapi":"/openapi.json get /transactions/export","href":"/api-reference/transactions/export-transactions"},{"title":"Get a transaction","deprecated":null,"version":null,"openapi":"/openapi.json get /transactions/{transactionId}","href":"/api-reference/transactions/get-a-transaction"}]},{"group":"wallets","pages":[{"title":"List wallets","deprecated":null,"version":null,"openapi":"/openapi.json get /wallets","href":"/api-reference/wallets/list-wallets"},{"title":"Provision a customer NUBAN wallet","deprecated":null,"version":null,"openapi":"/openapi.json post /wallets","href":"/api-reference/wallets/provision-a-customer-nuban-wallet"},{"title":"Get a wallet and balances","deprecated":null,"version":null,"openapi":"/openapi.json get /wallets/{walletId}","href":"/api-reference/wallets/get-a-wallet-and-balances"},{"title":"Simulate a NUBAN credit","deprecated":null,"version":null,"openapi":"/openapi.json post /wallets/{walletId}/credits","href":"/api-reference/wallets/simulate-a-nuban-credit"}]},{"group":"payouts","pages":[{"title":"List withdrawals","deprecated":null,"version":null,"openapi":"/openapi.json get /withdrawals","href":"/api-reference/payouts/list-withdrawals"},{"title":"Send a customer’s available balance to a bank account","deprecated":null,"version":null,"openapi":"/openapi.json post /withdrawals","href":"/api-reference/payouts/send-a-customer’s-available-balance-to-a-bank-account"},{"title":"Get a withdrawal","deprecated":null,"version":null,"openapi":"/openapi.json get /withdrawals/{withdrawalId}","href":"/api-reference/payouts/get-a-withdrawal"}]},{"group":"fees","pages":[{"title":"Quote transaction fees","deprecated":null,"version":null,"openapi":"/openapi.json get /fees","href":"/api-reference/fees/quote-transaction-fees"}]},{"group":"identity","pages":[{"title":"Verify a bank account","deprecated":null,"version":null,"openapi":"/openapi.json post /identity/bank-accounts/verify","href":"/api-reference/identity/verify-a-bank-account"},{"title":"List supported banks","deprecated":null,"version":null,"openapi":"/openapi.json get /identity/banks","href":"/api-reference/identity/list-supported-banks"},{"title":"Look up NIN or BVN","deprecated":null,"version":null,"openapi":"/openapi.json post /identity/lookups","href":"/api-reference/identity/look-up-nin-or-bvn"}]}]}]},"title":"Get a checkout session - Demat Escrow API","buildId":"dpl_C3fsfi1EcrBns9Vx91gUSN1X3Hi4","deploymentId":"dpl_C3fsfi1EcrBns9Vx91gUSN1X3Hi4","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["OpenApiReferenceProvider-WsdpkmZS.js","utils-v3NXaRhE.js","cloneDeep-CsK1MRZH.js","_Uint8Array-JMZMJLdF.js","isArray-CXeVWmfx.js","isObject-Bw72BMo0.js","utils-BM0BJrb-.js","toString-Ci69GPsS.js","addUniqueKeysToSchema-xblj_90j.js","snippetPresets-v8MhBpsI.js","style-to-object-8s5bpEGF.js","v4-DIgz8zy6.js","Page-Dh1M83X1.js","ApiExamples-DTqFH4GC.js","isEqual-XZWsFdP7.js","usePlaygroundInputsStore-0j65DmWp.js","shallow-C9R2KsR3.js","getApiPlaygroundDisplay-k5gpc1DM.js","ChevronDownIcon-Cct7NMX_.js","CodeSnippet-BVFHrHqS.js","CodeSnippets-5tSwXuDE.js","getPastedJson-B8csGquB.js","icon-BUUJSQVu.js","MethodPill-CxJla7Dc.js","DynamicMarkdown-B-Kaxar8.js","SectionHeading-xtHIDzye.js","PlusIcon-DYlJbUaT.js","TrashIcon-CUC6PAPm.js","axios-CXgqDoFS.js","Markdown-DxJDlEO9.js","clsx-Cm_RkB1d.js","lib-DnkIZQB2.js","lib-q-9GBWeW.js","html-void-elements-mCSPHezU.js","dist-C4WbBOfn.js","katex-Cnv50rb0.js","marked.esm-BKo0Hl1x.js","AssistantPageLink-C-MOkQdJ.js"]}