Admin-supplied exchange rate as "1 USD = X local currency". Overrides the auto-fetched rate for USD snapshot computation. Only meaningful for non-USD wallets.
Example:
129.5
Response
201
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Kotani Pay","colors":{"primary":"#0084FF","light":"#33A0FF","dark":"#0066CC"},"logo":{"light":"https://mintcdn.com/kotanipay/fs4MTXqtgN7LNvaG/logo/light.svg?fit=max\u0026auto=format\u0026n=fs4MTXqtgN7LNvaG\u0026q=85\u0026s=15bc628eae89c2a52647d24165fb8842","dark":"https://mintcdn.com/kotanipay/fs4MTXqtgN7LNvaG/logo/dark.svg?fit=max\u0026auto=format\u0026n=fs4MTXqtgN7LNvaG\u0026q=85\u0026s=780c8d8a8bee0a46b8283552fb40a4c3"},"favicon":"https://mintcdn.com/kotanipay/LKT7d2c_PosTYIvy/favicon.svg?fit=max\u0026auto=format\u0026n=LKT7d2c_PosTYIvy\u0026q=85\u0026s=c8b691efb2db300de578869bae956be6","api":{"playground":{}},"navbar":{"links":[{"href":"mailto:sales@kotanipay.com","label":"Support"}],"primary":{"type":"button","label":"Contact Support","href":"mailto:sales@kotanipay.com"}},"footer":{"socials":{"x":"https://x.com/kotanipay","github":"https://github.com/kotanipay","linkedin":"https://linkedin.com/company/kotanipay"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"kotanipay","hasAudioNarration":false,"actualSubdomain":"kotanipay","customDomains":["documentation.kotanipay.com"],"gitSource":{"type":"gitlab","owner":"katlego3","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"projectId":77528614,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6acf6b5e6eb222735be6dedd","collectionId":"e7e33117-0702-4350-a74a-fe26dd40d857","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6acf6b5e6eb222735be6dedd"},"entitlements":{},"buildId":"6acf6b5e6eb222735be6dedd","clientVersion":"0.0.3964","searchFilterCounts":[{"language":"default","tag":"API Reference","count":120},{"language":"default","tag":"Documentation","count":22},{"language":"default","tag":"Bulk Payments","count":11},{"language":"default","tag":"Settlement Requests","count":9},{"language":"default","tag":"Products","count":9},{"language":"default","tag":"Exchange Rates","count":8},{"language":"default","tag":"Customer Management","count":7},{"language":"default","tag":"Offramp (Sell Crypto)","count":7},{"language":"default","tag":"Onramp (Buy Crypto)","count":7},{"language":"default","tag":"Payment Links","count":7}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":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":"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":[],"page":{"pagePath":"v3/api-reference/settlements/request-settlement","slug":"/v3/api-reference/settlements/request-settlement","pageMetadata":{"title":"Request Settlement","openapi":"POST /api/v3/integrator/settlements","description":null,"href":"/v3/api-reference/settlements/request-settlement"},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={p:`p`,..._provideComponents(),...props.components};return _jsx(_components.p,{children:`Submit a settlement request for processing.`})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Request Settlement","openapi":"POST /api/v3/integrator/settlements","description":null,"href":"/v3/api-reference/settlements/request-settlement"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"IntegratorSettlementsController_createRequest_api/v3","parameters":[],"requestBody":"e6c0fd83-97b7-49e8-b5df-c3155d2a1192","responses":{"201":"8ac697e9-ed21-46f8-9236-4fb9b478616c"},"security":["a6b2ad56-9a36-4038-b7b6-f9f31b966e66"],"tags":["INTEGRATOR"],"method":"post","type":"path","servers":["1c9c5db6-018a-491b-80d6-2401e2795afa"],"path":"/api/v3/integrator/settlements","baseUrlOptions":["{baseUrl}"],"title":"","description":"","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"walletId":{"type":"string","isRequired":true,"uniqueKey":"walletId","typeLabel":"string"},"amount":{"type":"number","isRequired":true,"uniqueKey":"amount","typeLabel":"number"},"balanceSource":{"type":"string","enum":["PAYOUT","DEPOSIT","ADMIN_SELECT"],"uniqueKey":"balanceSource","typeLabel":"enum\u003cstring>"},"integratorNote":{"type":"string","uniqueKey":"integratorNote","typeLabel":"string"},"callbackUrl":{"type":"string","uniqueKey":"callbackUrl","typeLabel":"string"},"beneficiaryDetails":{"type":"object","properties":{"beneficiaryType":{"type":"string","enum":["bank","crypto"],"uniqueKey":"beneficiaryDetails.beneficiaryType","typeLabel":"enum\u003cstring>"},"name":{"type":"string","uniqueKey":"beneficiaryDetails.name","typeLabel":"string"},"walletAddress":{"type":"string","uniqueKey":"beneficiaryDetails.walletAddress","typeLabel":"string"},"chain":{"type":"string","uniqueKey":"beneficiaryDetails.chain","typeLabel":"string"},"token":{"type":"string","description":"Token/asset symbol (e.g. USDT, USDC)","uniqueKey":"beneficiaryDetails.token","typeLabel":"string"},"network":{"type":"string","description":"Network sub-type (legacy)","uniqueKey":"beneficiaryDetails.network","typeLabel":"string"},"bankName":{"type":"string","uniqueKey":"beneficiaryDetails.bankName","typeLabel":"string"},"bankCode":{"type":"string","uniqueKey":"beneficiaryDetails.bankCode","typeLabel":"string"},"accountNumber":{"type":"string","uniqueKey":"beneficiaryDetails.accountNumber","typeLabel":"string"},"accountName":{"type":"string","uniqueKey":"beneficiaryDetails.accountName","typeLabel":"string"},"accountType":{"type":"string","uniqueKey":"beneficiaryDetails.accountType","typeLabel":"string"}},"uniqueKey":"beneficiaryDetails","typeLabel":"object"},"savedBeneficiaryId":{"type":"string","description":"ID of a saved beneficiary on the integrator config — used when beneficiaryDetails is not explicitly provided","uniqueKey":"savedBeneficiaryId","typeLabel":"string"},"overrideUsdRate":{"type":"number","description":"Admin-supplied exchange rate as \"1 USD = X local currency\". Overrides the auto-fetched rate for USD snapshot computation. Only meaningful for non-USD wallets.","example":129.5,"uniqueKey":"overrideUsdRate","typeLabel":"number"}},"required":["walletId","amount"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"walletId":"\u003cstring>","amount":123,"integratorNote":"\u003cstring>","callbackUrl":"\u003cstring>","beneficiaryDetails":{"name":"\u003cstring>","walletAddress":"\u003cstring>","chain":"\u003cstring>","token":"\u003cstring>","network":"\u003cstring>","bankName":"\u003cstring>","bankCode":"\u003cstring>","accountNumber":"\u003cstring>","accountName":"\u003cstring>","accountType":"\u003cstring>"},"savedBeneficiaryId":"\u003cstring>","overrideUsdRate":129.5}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"8ac697e9-ed21-46f8-9236-4fb9b478616c":{"description":""}},"security":{"a6b2ad56-9a36-4038-b7b6-f9f31b966e66":{"JWT":{"scheme":"bearer","bearerFormat":"JWT","type":"http","scopes":[],"schemeName":"JWT"}}},"servers":{"1c9c5db6-018a-491b-80d6-2401e2795afa":{"url":"{baseUrl}","description":"Base URL provided by Kotani Pay support","variables":{"baseUrl":{"default":"https://kotani-pay-base-url.example","description":"Contact Kotani Pay support for your sandbox and production base URLs"}}}},"processedSecurityOptions":[{"schemes":[{"scheme":{"scheme":"bearer","bearerFormat":"JWT","type":"http","scopes":[],"schemeName":"JWT"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"JWT","name":"Authorization"}],"title":"JWT"}]},"originalFileLocation":"v3/api-reference/openapi.json"},"subdomain":"kotanipay","siteName":"Kotani Pay","title":"Request Settlement - Kotani Pay","navMaps":{"firstHrefInVersion":{"Sandbox":{"href":"/v3/api-reference/settlements/request-settlement","matchLevel":0}},"firstHrefInLanguage":{}},"lastModified":"2026-10-14T11:45:51.223Z","originalFileLocation":"v3/api-reference/settlements/request-settlement.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=\"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=\"Kotani Pay\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/kotanipay/BzXeu9b-yTw5DWiM/_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/kotanipay/BzXeu9b-yTw5DWiM/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/kotanipay/BzXeu9b-yTw5DWiM/_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/kotanipay/BzXeu9b-yTw5DWiM/_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/kotanipay/BzXeu9b-yTw5DWiM/_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/kotanipay/BzXeu9b-yTw5DWiM/_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/kotanipay/BzXeu9b-yTw5DWiM/_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/kotanipay/BzXeu9b-yTw5DWiM/_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/kotanipay/BzXeu9b-yTw5DWiM/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Request Settlement - Kotani Pay\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Kotani Pay\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://documentation.kotanipay.com/v3/api-reference/settlements/request-settlement\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://kotanipay.mintlify.app/_mintlify/api/og/v2?division=Settlement+Requests\u0026amp;title=Request+Settlement\u0026amp;theme=385b71bd5655d7bc8d730557\u0026amp;signature=d980746826e77e4d5d997a5a7856bd6300a9d5499952018feb4c707758b68019\">\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=\"Request Settlement - Kotani Pay\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://kotanipay.mintlify.app/_mintlify/api/og/v2?division=Settlement+Requests\u0026amp;title=Request+Settlement\u0026amp;theme=385b71bd5655d7bc8d730557\u0026amp;signature=d980746826e77e4d5d997a5a7856bd6300a9d5499952018feb4c707758b68019\">\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/kotanipay/BzXeu9b-yTw5DWiM/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Kotani Pay\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0084FF\">\u003clink data-mint-head rel=\"canonical\" href=\"https://documentation.kotanipay.com/v3/api-reference/settlements/request-settlement\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/v3/api-reference/settlements/request-settlement.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://documentation.kotanipay.com/#organization\",\"name\":\"Kotani Pay\",\"url\":\"https://documentation.kotanipay.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/kotanipay/fs4MTXqtgN7LNvaG/logo/light.svg?fit=max\u0026auto=format\u0026n=fs4MTXqtgN7LNvaG\u0026q=85\u0026s=15bc628eae89c2a52647d24165fb8842\"}},{\"@type\":\"WebSite\",\"@id\":\"https://documentation.kotanipay.com#website\",\"name\":\"Kotani Pay\",\"url\":\"https://documentation.kotanipay.com\",\"publisher\":{\"@id\":\"https://documentation.kotanipay.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://documentation.kotanipay.com/v3/api-reference/settlements/request-settlement#webpage\",\"url\":\"https://documentation.kotanipay.com/v3/api-reference/settlements/request-settlement\",\"name\":\"Request Settlement\",\"dateModified\":\"2026-10-14T11:45:51.223Z\",\"isPartOf\":{\"@id\":\"https://documentation.kotanipay.com#website\"},\"breadcrumb\":{\"@id\":\"https://documentation.kotanipay.com/v3/api-reference/settlements/request-settlement#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://documentation.kotanipay.com/v3/api-reference/settlements/request-settlement#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Settlement Requests\",\"item\":\"https://documentation.kotanipay.com/v3/api-reference/settlements/dashboard-settlements\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Request Settlement\",\"item\":\"https://documentation.kotanipay.com/v3/api-reference/settlements/request-settlement\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://documentation.kotanipay.com/v3/api-reference/settlements/request-settlement#apireference\",\"headline\":\"Request Settlement\",\"name\":\"Request Settlement\",\"url\":\"https://documentation.kotanipay.com/v3/api-reference/settlements/request-settlement\",\"mainEntityOfPage\":{\"@id\":\"https://documentation.kotanipay.com/v3/api-reference/settlements/request-settlement#webpage\"},\"dateModified\":\"2026-10-14T11:45:51.223Z\",\"publisher\":{\"@id\":\"https://documentation.kotanipay.com/#organization\"},\"isPartOf\":{\"@id\":\"https://documentation.kotanipay.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Kotani Pay\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Kotani Pay","nav":{"global":null,"versions":[{"version":"Sandbox","tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/v3/overview"}]},{"tab":"API Reference","groups":[{"group":"Getting Started","pages":[{"title":"API Reference","href":"/v3/api-reference/introduction"}]},{"group":"Health \u0026 System","pages":[{"title":"Health Check","openapi":"GET /health","href":"/v3/api-reference/system/health"},{"title":"Payment Providers","openapi":"POST /api/v3/providers","href":"/v3/api-reference/system/providers"}]},{"group":"Authentication \u0026 Setup","pages":[{"title":"Authentication Login","openapi":"POST /api/v3/auth/login","href":"/v3/api-reference/authentication/login"},{"title":"Generate API Key","openapi":"GET /api/v3/auth/api-key","href":"/v3/api-reference/authentication/generate-key"},{"title":"Refresh Access Token","openapi":"GET /api/v3/auth/refresh-token","href":"/v3/api-reference/authentication/refresh-token"},{"title":"Human Verification","openapi":"POST /api/v3/auth/human-verify","href":"/v3/api-reference/authentication/human-verify"},{"title":"Get Integrator","openapi":"GET /api/v3/integrator","href":"/v3/api-reference/integrator/get"},{"title":"Update Webhook Configuration","openapi":"PATCH /api/v3/integrator/webhook","href":"/v3/api-reference/integrator/update-webhook"}]},{"group":"Fiat Wallets","pages":[{"title":"Create Fiat Wallet","openapi":"POST /api/v3/wallet/fiat","href":"/v3/api-reference/wallets/fiat/create"},{"title":"List Fiat Wallets","openapi":"GET /api/v3/wallet/fiat","href":"/v3/api-reference/wallets/fiat/list"},{"title":"Get Fiat Wallet","openapi":"GET /api/v3/wallet/fiat/{id}","href":"/v3/api-reference/wallets/fiat/get"},{"title":"Get Wallet by Currency","openapi":"GET /api/v3/wallet/fiat/currency/{currency}","href":"/v3/api-reference/wallets/fiat/get-by-currency"},{"title":"Update Fiat Wallet","openapi":"PATCH /api/v3/wallet/fiat/{id}","href":"/v3/api-reference/wallets/fiat/update"},{"title":"Transfer Deposit Balance","openapi":"POST /api/v3/wallet/transfer/deposit-balance","href":"/v3/api-reference/wallets/fiat/transfer-deposit-balance"}]},{"group":"Crypto Wallets","pages":[{"title":"Create Crypto Wallet","openapi":"POST /api/v3/wallet/crypto","href":"/v3/api-reference/wallets/crypto/create"},{"title":"List Crypto Wallets","openapi":"GET /api/v3/wallet/crypto","href":"/v3/api-reference/wallets/crypto/list"},{"title":"Get Crypto Wallet","openapi":"GET /api/v3/wallet/crypto/{id}","href":"/v3/api-reference/wallets/crypto/get"}]},{"group":"Customer Management","pages":[{"title":"Create Mobile Money Customer","openapi":"POST /api/v3/customer/mobile-money","href":"/v3/api-reference/customers/mobile-money/create"},{"title":"List Mobile Money Customers","openapi":"GET /api/v3/customer/mobile-money","href":"/v3/api-reference/customers/mobile-money/list"},{"title":"Get Mobile Money Customer","openapi":"GET /api/v3/customer/mobile-money/{customer_key}","href":"/v3/api-reference/customers/mobile-money/get"},{"title":"Get Customer by Phone","openapi":"GET /api/v3/customer/mobile-money/phone/{phone_number}","href":"/v3/api-reference/customers/mobile-money/get-by-phone"},{"title":"Update Mobile Money Customer","openapi":"PATCH /api/v3/customer/mobile-money/{customer_key}","href":"/v3/api-reference/customers/mobile-money/update"},{"title":"Validate Mobile Money Account","openapi":"POST /api/v3/customer/validate/mobile-money","href":"/v3/api-reference/customers/validate-mobile-money"},{"title":"Validate Bank Account","openapi":"POST /api/v3/customer/validate/bank","href":"/v3/api-reference/customers/validate-bank"}]},{"group":"Mobile Money Deposits","pages":[{"title":"Deposit via Mobile Money","openapi":"POST /api/v3/deposit/mobile-money","href":"/v3/api-reference/deposits/mobile-money"},{"title":"Get Deposit Mobile Money Status","openapi":"GET /api/v3/deposit/mobile-money/status/{reference_id}","href":"/v3/api-reference/deposits/mobile-money-status"},{"title":"List Deposit Transactions","openapi":"GET /api/v3/deposit/mobile-money/transactions","href":"/v3/api-reference/deposits/list-transactions"}]},{"group":"Mobile Money Withdrawals","pages":[{"title":"Mobile Money Withdrawal","openapi":"POST /api/v3/withdraw/mobile-money","href":"/v3/api-reference/withdrawals/mobile-money"},{"title":"Mobile Money Withdrawal Status","openapi":"GET /api/v3/withdraw/status/{reference_id}","href":"/v3/api-reference/withdrawals/mobile-money-status"},{"title":"List Withdrawal Transactions","openapi":"GET /api/v3/withdraw/transactions","href":"/v3/api-reference/withdrawals/list-transactions"}]},{"group":"SMS","pages":[{"title":"Send SMS","openapi":"POST /api/v3/sms/send","href":"/v3/api-reference/sms/send"},{"title":"Register SMS Webhook","openapi":"POST /api/v3/sms/clients","href":"/v3/api-reference/sms/register-webhook"},{"title":"Incoming SMS Webhook","openapi":"POST /api/v3/sms/incoming","href":"/v3/api-reference/sms/incoming"}]},{"group":"Card Deposits","pages":[{"title":"Card Deposit","openapi":"POST /api/v3/deposit/card","href":"/v3/api-reference/deposits/card"},{"title":"Card Deposit Status","openapi":"GET /api/v3/deposit/card/{reference_id}","href":"/v3/api-reference/deposits/card-status"}]},{"group":"Bank Deposits","pages":[{"title":"Bank Checkout Deposit","openapi":"POST /api/v3/deposit/bank/checkout","href":"/v3/api-reference/deposits/bank-checkout"},{"title":"Bank Checkout Deposit Status","openapi":"GET /api/v3/deposit/bank/checkout/status/{reference_id}","href":"/v3/api-reference/deposits/bank-checkout-status"}]},{"group":"Bank Withdrawals","pages":[{"title":"Supporting Banks","openapi":"GET /api/v3/withdraw/v2/bank/supporting-banks/{currency}","href":"/v3/api-reference/withdrawals/supporting-banks"},{"title":"Bank Withdrawal","openapi":"POST /api/v3/withdraw/v2/bank","href":"/v3/api-reference/withdrawals/bank-v2"},{"title":"Bank Withdrawal Status","openapi":"GET /api/v3/withdraw/v2/bank/status/{referenceId}","href":"/v3/api-reference/withdrawals/bank-status"}]},{"group":"Kenya Withdrawals","pages":[{"title":"Lipa na M-Pesa Withdrawal","openapi":"POST /api/v3/withdraw/lipa-na-mpesa","href":"/v3/api-reference/withdrawals/lipa-na-mpesa"},{"title":"Paybill Withdrawal","openapi":"POST /api/v3/withdraw/paybill","href":"/v3/api-reference/withdrawals/paybill"}]},{"group":"Country \u0026 Service Support","pages":[{"title":"Get Supported Countries","openapi":"GET /api/v3/customer/support/countries","href":"/v3/api-reference/country-support/countries"},{"title":"Get Country Details","openapi":"GET /api/v3/customer/support/countries/{countryCode}","href":"/v3/api-reference/country-support/country-details"},{"title":"Get Available Networks","openapi":"GET /api/v3/customer/support/networks/{countryCode}","href":"/v3/api-reference/country-support/networks"},{"title":"Get Available Banks","openapi":"GET /api/v3/customer/support/banks","href":"/v3/api-reference/country-support/banks"},{"title":"Get Deposit Service Configuration","openapi":"GET /api/v3/customer/support/services/deposit","href":"/v3/api-reference/country-support/deposit-services"},{"title":"Get Withdraw Service Configuration","openapi":"GET /api/v3/customer/support/services/withdraw","href":"/v3/api-reference/country-support/withdraw-services"}]},{"group":"Exchange Rates","pages":[{"title":"Get All Exchange Rates","openapi":"GET /api/v3/rate","href":"/v3/api-reference/rates/get-all-rates"},{"title":"Get Exchange Rate","openapi":"GET /api/v3/rate/{from}/{to}","href":"/v3/api-reference/rates/get-rate"},{"title":"Get All Public Exchange Rates","openapi":"GET /api/v3/public/rate","href":"/v3/api-reference/rates/get-all-public-rates"},{"title":"Get Public Exchange Rate","openapi":"GET /api/v3/public/rate/{from}/{to}","href":"/v3/api-reference/rates/get-public-rate"},{"title":"Get Onramp Exchange Rate","openapi":"POST /api/v3/rate/onramp","href":"/v3/api-reference/rates/onramp-rate"},{"title":"Get Offramp Exchange Rate","openapi":"POST /api/v3/rate/offramp","href":"/v3/api-reference/rates/offramp-rate"},{"title":"Get Fiat to Fiat Exchange Rate","openapi":"POST /api/v3/rate/fiat","href":"/v3/api-reference/rates/fiat-to-fiat"},{"title":"Get Crypto Bridge Rate","openapi":"POST /api/v3/rate/crypto-bridge","href":"/v3/api-reference/rates/crypto-bridge-rate"}]},{"group":"Onramp (Buy Crypto)","pages":[{"title":"Create Onramp","openapi":"POST /api/v3/onramp","href":"/v3/api-reference/onramp/create"},{"title":"Get Onramp Status","openapi":"GET /api/v3/onramp/{referenceId}","href":"/v3/api-reference/onramp/status"},{"title":"Get Onramp Status (by Reference ID)","openapi":"GET /api/v3/onramp/{referenceId}","href":"/v3/api-reference/onramp/get-status"},{"title":"Get Onramp Transactions","openapi":"GET /api/v3/onramp/transactions","href":"/v3/api-reference/onramp/list-transactions"},{"title":"Send Token to Crypto Wallet","openapi":"POST /api/v3/onramp/crypto","href":"/v3/api-reference/onramp/crypto"},{"title":"Get Crypto Onramp Status","openapi":"GET /api/v3/onramp/crypto/{referenceId}","href":"/v3/api-reference/onramp/crypto-status"},{"title":"Get Crypto Onramp Status (by Reference ID)","openapi":"GET /api/v3/onramp/crypto/{referenceId}","href":"/v3/api-reference/onramp/get-crypto-status"}]},{"group":"Offramp (Sell Crypto)","pages":[{"title":"Create Offramp Request","openapi":"POST /api/v3/offramp","href":"/v3/api-reference/offramp/create"},{"title":"Get Offramp Status","openapi":"GET /api/v3/offramp/{referenceId}","href":"/v3/api-reference/offramp/status"},{"title":"Get Offramp Status (by Reference ID)","openapi":"GET /api/v3/offramp/{referenceId}","href":"/v3/api-reference/offramp/get-status"},{"title":"Cancel Offramp Transaction","openapi":"GET /api/v3/offramp/cancel/{referenceId}","href":"/v3/api-reference/offramp/cancel"},{"title":"Get Offramp Transactions","openapi":"GET /api/v3/offramp/transactions","href":"/v3/api-reference/offramp/list-transactions"},{"title":"Get Refund Status","openapi":"GET /api/v3/offramp/refund-status/{referenceId}","href":"/v3/api-reference/offramp/refund-status"},{"title":"Retry Failed Refund","openapi":"POST /api/v3/offramp/retry-refund/{referenceId}","href":"/v3/api-reference/offramp/retry-refund"}]},{"group":"Crypto Deposits (On-Chain)","pages":[{"title":"Deposit On-Chain (Receive Crypto)","openapi":"POST /api/v3/deposit/on-chain","href":"/v3/api-reference/deposits/deposit-on-chain"},{"title":"Get Deposit On-Chain Status","openapi":"GET /api/v3/deposit/on-chain/status/{reference_id}","href":"/v3/api-reference/deposits/deposit-on-chain-status"},{"title":"Get Supported Chains \u0026 Tokens","openapi":"GET /api/v3/deposit/on-chain/supported-chains","href":"/v3/api-reference/deposits/deposit-on-chain-supported-chains"}]},{"group":"Settlement Requests","pages":[{"title":"Dashboard Settlements","description":"API reference for settlement requests, batch settlements, merging, beneficiaries, and notification preferences","href":"/v3/api-reference/settlements/dashboard-settlements"},{"title":"Request Settlement","openapi":"POST /api/v3/integrator/settlements","href":"/v3/api-reference/settlements/request-settlement"},{"title":"List Settlements","openapi":"GET /api/v3/integrator/settlements","description":null,"href":"/v3/api-reference/settlements/list-settlements"},{"title":"Get Settlement","openapi":"GET /api/v3/integrator/settlements/{settlementId}","href":"/v3/api-reference/settlements/get-settlement"},{"title":"Cancel Settlement","openapi":"DELETE /api/v3/integrator/settlements/{settlementId}","href":"/v3/api-reference/settlements/cancel"},{"title":"Settlement Fee Preview","openapi":"GET /api/v3/integrator/settlements/fee-preview","href":"/v3/api-reference/settlements/fee-preview"},{"title":"Settlement Schedule","openapi":"GET /api/v3/integrator/settlements/schedule","href":"/v3/api-reference/settlements/schedule"},{"title":"Update Notification Preferences","openapi":"PATCH /api/v3/integrator/settlements/notification-preferences","href":"/v3/api-reference/settlements/notification-preferences"},{"title":"Merge Settlements into Batch","openapi":"POST /api/v3/integrator/settlements/merge","href":"/v3/api-reference/settlements/merge"}]},{"group":"Settlement Batches","pages":[{"title":"Create Batch Settlement","openapi":"POST /api/v3/integrator/settlements/batch","href":"/v3/api-reference/settlements/batch/create"},{"title":"List Settlement Batches","openapi":"GET /api/v3/integrator/settlements/batch","href":"/v3/api-reference/settlements/batch/list"},{"title":"Get Settlement Batch","openapi":"GET /api/v3/integrator/settlements/batch/{batchId}","href":"/v3/api-reference/settlements/batch/get"},{"title":"Cancel Settlement Batch","openapi":"DELETE /api/v3/integrator/settlements/batch/{batchId}","href":"/v3/api-reference/settlements/batch/cancel"}]},{"group":"Saved Beneficiaries","pages":[{"title":"Get Settlement Config","openapi":"GET /api/v3/integrator/settlement-config","href":"/v3/api-reference/settlements/settlement-config"},{"title":"Update Settlement Config","openapi":"PATCH /api/v3/integrator/settlement-config","href":"/v3/api-reference/settlements/update-settlement-config"},{"title":"List Settlement Beneficiaries","openapi":"GET /api/v3/integrator/settlement-config/beneficiaries","href":"/v3/api-reference/settlements/settlement-config/beneficiaries"},{"title":"Create Settlement Beneficiary","openapi":"POST /api/v3/integrator/settlement-config/beneficiaries","href":"/v3/api-reference/settlements/settlement-config/create-beneficiary"},{"title":"Update Settlement Beneficiary","openapi":"PATCH /api/v3/integrator/settlement-config/beneficiaries/{beneficiaryId}","href":"/v3/api-reference/settlements/settlement-config/get-beneficiary"},{"title":"Delete Settlement Beneficiary","openapi":"DELETE /api/v3/integrator/settlement-config/beneficiaries/{beneficiaryId}","href":"/v3/api-reference/settlements/settlement-config/delete-beneficiary"}]},{"group":"Cross-Border Payments","pages":[{"title":"Generate Invoice","openapi":"POST /api/v3/cross-boarder/invoice","href":"/v3/api-reference/cross-border/generate-invoice"},{"title":"Get Invoice","openapi":"GET /api/v3/cross-boarder/invoice/{referenceId}","href":"/v3/api-reference/cross-border/get-invoice"},{"title":"Pay Invoice","openapi":"POST /api/v3/cross-boarder/invoice/pay","href":"/v3/api-reference/cross-border/pay-invoice"},{"title":"Get Paid Invoice Status","openapi":"GET /api/v3/cross-boarder/invoice/pay/{referenceId}","href":"/v3/api-reference/cross-border/pay-invoice-status"}]},{"group":"KYC \u0026 Compliance","pages":[{"title":"Create KYC Basic Details","openapi":"POST /api/v3/kyc","href":"/v3/api-reference/kyc/create-basic-details"},{"title":"Create KYC Address","openapi":"POST /api/v3/kyc/address","href":"/v3/api-reference/kyc/create-address"},{"title":"Create KYC Document","openapi":"POST /api/v3/kyc/document","href":"/v3/api-reference/kyc/create-document"},{"title":"Get KYC Status","openapi":"GET /api/v3/kyc/status/{kycId}","href":"/v3/api-reference/kyc/get-status"},{"title":"Get Integrator KYC Users","openapi":"GET /api/v3/kyc/integrator/users","href":"/v3/api-reference/kyc/list-integrator-users"}]},{"group":"Payment Links","pages":[{"title":"Create Payment Link","openapi":"POST /api/v3/payment-links","href":"/v3/api-reference/payment-links/create"},{"title":"List Payment Links","openapi":"GET /api/v3/payment-links","href":"/v3/api-reference/payment-links/list"},{"title":"Get Payment Link","openapi":"GET /api/v3/payment-links/{id}","href":"/v3/api-reference/payment-links/get"},{"title":"Update Payment Link","openapi":"PATCH /api/v3/payment-links/{id}","href":"/v3/api-reference/payment-links/update"},{"title":"Activate Payment Link","openapi":"POST /api/v3/payment-links/{id}/activate","href":"/v3/api-reference/payment-links/activate"},{"title":"Deactivate Payment Link","openapi":"POST /api/v3/payment-links/{id}/deactivate","href":"/v3/api-reference/payment-links/deactivate"},{"title":"Get Payment Link Transactions","openapi":"GET /api/v3/payment-links/{id}/transactions","href":"/v3/api-reference/payment-links/list-transactions"}]},{"group":"Bulk Payments","pages":[{"title":"Get Available Wallets","openapi":"GET /api/v3/dashboard/bulk-payments/api/wallets","href":"/v3/api-reference/bulk-payments/get-wallets"},{"title":"Validate CSV File","openapi":"POST /api/v3/dashboard/bulk-payments/api/validate-csv","href":"/v3/api-reference/bulk-payments/validate-csv"},{"title":"Preview Bulk Payment Batches","openapi":"POST /api/v3/dashboard/bulk-payments/api/preview","href":"/v3/api-reference/bulk-payments/preview-batches"},{"title":"Create Bulk Payment Batches","openapi":"POST /api/v3/dashboard/bulk-payments/api/batches/create","href":"/v3/api-reference/bulk-payments/create-batches"},{"title":"Get Bulk Payment Batches","openapi":"GET /api/v3/dashboard/bulk-payments/api/batches","href":"/v3/api-reference/bulk-payments/list-batches"},{"title":"Get Bulk Payment Batch by ID","openapi":"GET /api/v3/dashboard/bulk-payments/api/batches/{batchId}","href":"/v3/api-reference/bulk-payments/get-batch"},{"title":"Process Bulk Payment Batch","openapi":"POST /api/v3/dashboard/bulk-payments/api/batches/{batchId}/process","href":"/v3/api-reference/bulk-payments/process-batch"},{"title":"Get Batch Payments","openapi":"GET /api/v3/dashboard/bulk-payments/api/batches/{batchId}/payments","href":"/v3/api-reference/bulk-payments/get-batch-payments"},{"title":"Get Paginated Transactions","openapi":"GET /api/v3/dashboard/bulk-payments/api/transactions","href":"/v3/api-reference/bulk-payments/list-transactions"},{"title":"Get Transaction Details","openapi":"GET /api/v3/dashboard/bulk-payments/api/transactions/{transactionId}","href":"/v3/api-reference/bulk-payments/get-transaction"},{"title":"Get Bulk Payment Statistics","openapi":"GET /api/v3/dashboard/bulk-payments/api/stats","href":"/v3/api-reference/bulk-payments/get-statistics"}]}]}]}]},"title":"Request Settlement - Kotani Pay","buildId":"dpl_HcHmUS6i3UwswnTHJUEdcTtwfdTQ","deploymentId":"dpl_HcHmUS6i3UwswnTHJUEdcTtwfdTQ","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-BRm_l__d.js","utils-f1l1Oc-G.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-BlhqDhJO.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DHCB7rsC.js","snippetPresets-CYXLx6Hv.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-B78P2dEq.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C4YLPVAh.js","shallow-vlLnTDkQ.js","getApiPlaygroundDisplay-D_98hhvf.js","CodeSnippet-DtnZHGqq.js","CodeSnippets-CLFb8KJt.js","Page-kQh739Uz.js","getPastedJson-Cq-zlbnU.js","icon-sN3t983t.js","MethodPill-P_YQ2s09.js","DuplicateIcon-BVzyNsGJ.js","createIcon-B3jqgqC6.js","DynamicMarkdown-Crwq6WG_.js","SectionHeading-C7pGS2Bb.js","axios-vUo_bRtp.js","Markdown-BuPH8yuW.js","clsx-CCOYKgaU.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-BnkC_6oA.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BM4S31-f.js"]}