{"docsConfig":{"theme":"maple","$schema":"https://mintlify.com/docs.json","name":"Carbn Connect","colors":{"primary":"#07BEB8","light":"#07BEB8","dark":"#07BEB8"},"logo":{"light":"https://mintcdn.com/carbn/7lmPj4w7jR_8X2ta/logo/Carbn_logo_full.svg?fit=max\u0026auto=format\u0026n=7lmPj4w7jR_8X2ta\u0026q=85\u0026s=7defcb3bc1fed108c5379b2dff06314f","dark":"https://mintcdn.com/carbn/7lmPj4w7jR_8X2ta/logo/carbn_logo_full_dark.svg?fit=max\u0026auto=format\u0026n=7lmPj4w7jR_8X2ta\u0026q=85\u0026s=6b372a7db4034f1d06c096e9a1cabfbd"},"favicon":{"light":"https://mintcdn.com/carbn/7lmPj4w7jR_8X2ta/carbn_logo_favicon.svg?fit=max\u0026auto=format\u0026n=7lmPj4w7jR_8X2ta\u0026q=85\u0026s=dc37d415b75f6a602ff1d89feebba036","dark":"https://mintcdn.com/carbn/7lmPj4w7jR_8X2ta/carbn_logo_dark_favicon.svg?fit=max\u0026auto=format\u0026n=7lmPj4w7jR_8X2ta\u0026q=85\u0026s=e5117471d36b52b040da6340a0c8d4f0"},"appearance":{"default":"system"},"background":{"decoration":"grid"},"navbar":{"primary":{"type":"button","label":"Dashboard","href":"https://dashboard.carbnconnect.com"}},"footer":{"socials":{"linkedin":"https://linkedin.com/company/carbnxyz"}},"icons":{"library":"lucide"},"styling":{"eyebrows":"section","latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"carbn","hasAudioNarration":false,"actualSubdomain":"carbn","customDomains":["docs.carbn.xyz"],"gitSource":{"type":"gitlab","owner":"carbn-connect","repo":"carbn-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"projectId":74389973,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6a9b06a4094bc627a3306128","collectionId":"e5efe8f8-ad70-47b2-83da-58425d7ab3ef","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6a9b06a4094bc627a3306128"},"entitlements":{"AI_CHAT":{"status":"ENABLED"}},"buildId":"6a9b086a7e3d9ec0e4b9678b","clientVersion":"0.0.3971","searchFilterCounts":[{"language":"default","tag":"API Reference","count":34},{"language":"default","tag":"API Endpoints","count":32},{"language":"default","tag":"Developer Platform","count":8},{"language":"default","tag":"Documentation","count":8},{"language":"default","tag":"Custody Wallet","count":6},{"language":"default","tag":"User Management","count":6},{"language":"default","tag":"Users","count":5},{"language":"default","tag":"Compliance","count":5},{"language":"default","tag":"Payments","count":5},{"language":"default","tag":"Payouts","count":4}]},"assistantConfig":{},"basePath":"","hasChatPermissions":true,"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":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"#sidebar-group li a,.sidebar-group-header+ul li a{padding:8px 12px!important;border-radius:8px!important;transition:all .2s ease!important}#sidebar-group li a:hover,.sidebar-group-header+ul li a:hover{background-color:rgba(0,0,0,.05)!important;transform:scale(1.02)!important}#sidebar-group a.border-primary.text-primary{background-color:rgba(7,190,184,.08)!important;color:#07beb8!important;font-weight:500!important;transform:scale(1.01)!important;border-radius:6px!important;border-left:3px solid #07beb8!important;padding-left:9px!important}.card:hover{transform:translateY(-2px)!important;transition:all .2s ease!important}.nav-dropdown-item-icon,.nav-dropdown-trigger{display:flex!important;align-items:center!important}.nav-dropdown-trigger{background:rgba(255,255,255,.6)!important;border:1px solid rgba(0,0,0,.08)!important;border-radius:.75rem!important;padding:8px 12px 8px 10px!important;margin-bottom:12px!important;margin-top:12px!important;gap:10px!important;width:100%!important;cursor:pointer!important;transition:all .15s ease!important}.nav-dropdown-trigger:hover{background:rgba(96,96,96,.05)!important}.dark .nav-dropdown-trigger{background:rgba(0,0,0,.4)!important}.dark .nav-dropdown-trigger:hover{background:rgba(200,200,200,.05)!important}.nav-dropdown-item-icon{height:32px!important;width:32px!important;justify-content:center!important;border-radius:8px!important;border:1px solid rgba(0,0,0,.1)!important;flex-shrink:0!important}.dark .nav-dropdown-item-icon,.dark .nav-dropdown-trigger{border:1px solid rgba(255,255,255,.07)!important}.nav-dropdown-item-text-container{flex:1!important;padding:0 4px!important;display:flex!important;flex-direction:column!important;text-align:left!important}.nav-dropdown-item-title{font-size:14px!important;color:rgba(0,0,0,.87)!important;font-weight:400!important;line-height:1.3!important}.dark .nav-dropdown-item-title{color:rgba(255,255,255,.87)!important}.nav-dropdown-item-description{font-size:11px!important;color:rgba(0,0,0,.54)!important;line-height:1.4!important;margin-top:1px!important}.dark .nav-dropdown-item-description{color:rgba(255,255,255,.54)!important}.nav-dropdown-arrow{color:rgba(0,0,0,.4)!important;transition:transform .2s ease!important;transform:rotate(90deg)!important}.dark .nav-dropdown-arrow{color:rgba(255,255,255,.6)!important}.nav-dropdown-trigger:hover .nav-dropdown-arrow{color:rgba(0,0,0,.6)!important}.dark .nav-dropdown-trigger:hover .nav-dropdown-arrow{color:rgba(255,255,255,.4)!important}.mintlify-hero-container{position:relative;width:100%}.mintlify-hero-background{position:absolute;top:-20px;left:0;right:0;z-index:-1}.mintlify-hero-bg-dark,.mintlify-hero-bg-light{width:100%;height:auto;object-fit:contain;display:block;pointer-events:none;aspect-ratio:2304/776;filter:hue-rotate(30deg) saturate(1) brightness(1)}.mintlify-hero-bg-dark{display:none}.dark .mintlify-hero-bg-light{display:none}.dark .mintlify-hero-bg-dark{display:block}.mintlify-hero-content{padding:2rem 1rem 6rem;max-width:48rem;margin:0 auto;position:relative;z-index:1}@media (min-width:1024px){.mintlify-hero-content{padding:4rem 0 6rem}}.mintlify-hero-title{display:block;font-size:2.25rem;font-weight:600;text-align:center;color:rgb(17 24 39);letter-spacing:-.025em;margin:0}.dark .mintlify-hero-title{color:rgb(250 250 250)}.mintlify-hero-subtitle{max-width:36rem;margin:1rem auto 0;padding:0 1rem;font-size:1.125rem;text-align:center;color:rgb(107 114 128)}.dark .mintlify-hero-subtitle{color:rgb(161 161 170)}.mintlify-hero-cards{padding:0 1.5rem;margin-top:2rem;display:grid;grid-template-columns:repeat(1,minmax(0,1fr));gap:1.5rem 1rem}@media (min-width:640px){.mintlify-hero-cards{grid-template-columns:repeat(2,minmax(0,1fr));gap:1rem}}@media (min-width:1024px){.mintlify-hero-cards{padding:0;margin-top:4rem}}.mintlify-hero-card{display:block;cursor:pointer;padding-bottom:2rem;transition:all .1s ease}.mintlify-hero-card,.mintlify-hero-card:hover{text-decoration:none;color:inherit}.mintlify-hero-card-image{position:relative}.mintlify-card-img-dark,.mintlify-card-img-light{border-radius:.5rem;display:block;pointer-events:none;transition:transform .1s ease;width:100%;height:auto;filter:hue-rotate(30deg) saturate(1) brightness(1)}.mintlify-card-img-dark{display:none}.dark .mintlify-card-img-light{display:none}.dark .mintlify-card-img-dark{display:block}.mintlify-hero-card:hover .mintlify-card-img-dark,.mintlify-hero-card:hover .mintlify-card-img-light{transform:scale(1.05)}.mintlify-hero-card-title{margin-top:1.25rem;color:rgb(17 24 39);font-weight:500;font-size:1rem;margin-bottom:0}.dark .mintlify-hero-card-title{color:rgb(250 250 250)}.mintlify-hero-card-description{margin-top:.375rem;display:block;color:rgb(107 114 128);font-size:.875rem;line-height:1.25rem}.dark .mintlify-hero-card-description{color:rgb(161 161 170)}.mintlify-hero-container+* [data-as=p]:first-of-type{display:none!important}.mintlify-hero-card,.mintlify-hero-card *,.mintlify-hero-card::after,.mintlify-hero-card::before,.mintlify-hero-cards ::after,.mintlify-hero-cards ::before{border:0!important;border-bottom:none!important;border-top:none!important;border-left:none!important;border-right:none!important;box-shadow:none!important;outline:0!important}.mintlify-hero-card ::after,.mintlify-hero-card ::before,.mintlify-hero-card::after,.mintlify-hero-card::before{content:none!important;display:none!important}.mintlify-hero-container .link,.mintlify-hero-container .link *,.mintlify-hero-container a,.mintlify-hero-container a *{border:0!important;border-bottom:none!important;text-decoration:none!important}.mintlify-hero-container .divider,.mintlify-hero-container hr{display:none!important}:not(.dark) h1,:not(.dark) h2,:not(.dark) h3,:not(.dark) h4,:not(.dark) h5,:not(.dark) h6{color:#013364!important}h2{font-weight:500!important}h3{font-weight:485!important}h4{font-weight:420!important}.dark h1,.dark h2,.dark h3,.dark h4,.dark h5,.dark h6{color:#fff!important}"}],"page":{"pagePath":"api-reference/payouts/create-payout","slug":"/api-reference/payouts/create-payout","pageMetadata":{"title":"Create Payout","description":"Create a local currency payout to a user's bank account using their available balance.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /payment/api/v1/payout","href":"/api-reference/payouts/create-payout","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: \"Create a local currency payout to a user’s bank account using their available balance.\"\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":{"config":{},"pageMetadata":{"title":"Create Payout","description":"Create a local currency payout to a user's bank account using their available balance.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /payment/api/v1/payout","href":"/api-reference/payouts/create-payout","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Payouts"],"summary":"Create Payout","description":"Create a local currency payout to a user's bank account using their available balance.","operationId":"createPayout","security":["08ab65f1-6dfb-4d33-831f-49173ab4b50e"],"requestBody":"7402e8b6-6f20-4d7e-b1cb-9cd1aac24dc0","responses":{"200":"c434a8eb-fd9d-44ba-8cf6-487caf949b33","400":"44e20494-4882-440e-a629-b36589fce164","401":"d0c6abdb-cd64-4e22-9733-d96ebab1313b","404":"2d38629a-79b8-44a2-8fcb-83a1045ad3ae"},"method":"post","type":"path","servers":["9129d5a6-67f7-4316-83f6-587c90f24b2e"],"path":"/payment/api/v1/payout","baseUrlOptions":["https://api.carbnconnect.com"],"title":"Create Payout","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["user_id","currency","customer_payout_id","amount","recipient_details"],"properties":{"user_id":{"type":"string","format":"uuid","example":"9973efd0-410c-4b1a-991c-5a00f1581734","description":"The unique identifier of the user the payout is for","isRequired":true,"uniqueKey":"user_id","typeLabel":"string\u003cuuid>"},"currency":{"type":"string","example":"PHP","description":"Payout currency (ISO 4217 code, for example PHP)","isRequired":true,"uniqueKey":"currency","typeLabel":"string"},"customer_payout_id":{"type":"string","format":"uuid","example":"491595e0-2d40-4aa3-9f3d-4e8cdd79511e","description":"Idempotent identifier for this payout in your system","isRequired":true,"uniqueKey":"customer_payout_id","typeLabel":"string\u003cuuid>"},"amount":{"type":"string","example":"20","description":"Amount to pay out in the given currency","isRequired":true,"uniqueKey":"amount","typeLabel":"string"},"recipient_details":{"type":"object","required":["bank_name","account_holder_name","recipient_account_number"],"properties":{"bank_name":{"type":"string","example":"gotyme","description":"Name of the receiving bank or wallet provider","isRequired":true,"uniqueKey":"recipient_details.bank_name","typeLabel":"string"},"account_holder_name":{"type":"string","example":"Chelsea Mae Esguerra","description":"Name of the account holder","isRequired":true,"uniqueKey":"recipient_details.account_holder_name","typeLabel":"string"},"recipient_account_number":{"type":"string","example":"019794249552","description":"Destination account number or wallet identifier","isRequired":true,"uniqueKey":"recipient_details.recipient_account_number","typeLabel":"string"}},"isRequired":true,"uniqueKey":"recipient_details","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"user_id":"9973efd0-410c-4b1a-991c-5a00f1581734","currency":"PHP","customer_payout_id":"491595e0-2d40-4aa3-9f3d-4e8cdd79511e","amount":"20","recipient_details":{"bank_name":"gotyme","account_holder_name":"Chelsea Mae Esguerra","recipient_account_number":"019794249552"}}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"c434a8eb-fd9d-44ba-8cf6-487caf949b33":{"description":"Payout created successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"052471e2-1819-448f-ad74-03f237c1dfd6","description":"Unique identifier for the payout","uniqueKey":"id","typeLabel":"string\u003cuuid>"},"currency":{"type":"string","example":"php","description":"Payout currency","uniqueKey":"currency","typeLabel":"string"},"rail":{"type":"string","example":"INSTAPAY","description":"Payment rail used for the payout","uniqueKey":"rail","typeLabel":"string"},"reference":{"type":"string","example":"051567","description":"Reference provided by the underlying rail, if available","uniqueKey":"reference","typeLabel":"string"},"amount":{"type":"number","example":20,"description":"Payout amount in the given currency","uniqueKey":"amount","typeLabel":"number"},"status":{"type":"string","example":"PAYOUT_PROCESSED","description":"Current status of the payout","uniqueKey":"status","typeLabel":"string"},"user_id":{"type":"string","format":"uuid","example":"9973efd0-410c-4b1a-991c-5a00f1581734","description":"The unique identifier of the user","uniqueKey":"user_id","typeLabel":"string\u003cuuid>"},"customer_payout_id":{"type":"string","format":"uuid","example":"491595e0-2d40-4aa3-9f3d-4e8cdd79511e","description":"Your idempotent identifier for this payout","uniqueKey":"customer_payout_id","typeLabel":"string\u003cuuid>"},"rail_fee":{"type":"number","example":10,"description":"Fee charged by the underlying payment rail","uniqueKey":"rail_fee","typeLabel":"number"},"account_details":{"type":"object","properties":{"bank_name":{"type":"string","example":"gotyme","description":"Name of the receiving bank or wallet provider","uniqueKey":"account_details.bank_name","typeLabel":"string"},"account_holder_name":{"type":"string","example":"Chelsea Mae Esguerra","description":"Name of the account holder","uniqueKey":"account_details.account_holder_name","typeLabel":"string"},"recipient_account_number":{"type":"string","example":"019794249552","description":"Destination account number or wallet identifier","uniqueKey":"account_details.recipient_account_number","typeLabel":"string"}},"uniqueKey":"account_details","typeLabel":"object"},"created_at":{"type":"string","format":"date-time","example":"2026-03-13T16:32:17.604935Z","description":"Timestamp when the payout was created","uniqueKey":"created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"type":"string","format":"date-time","example":"2026-03-13T16:32:46.364880Z","description":"Timestamp when the payout was last updated","uniqueKey":"updated_at","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"052471e2-1819-448f-ad74-03f237c1dfd6","currency":"php","rail":"INSTAPAY","reference":"051567","amount":20,"status":"PAYOUT_PROCESSED","user_id":"9973efd0-410c-4b1a-991c-5a00f1581734","customer_payout_id":"491595e0-2d40-4aa3-9f3d-4e8cdd79511e","rail_fee":10,"account_details":{"bank_name":"gotyme","account_holder_name":"Chelsea Mae Esguerra","recipient_account_number":"019794249552"},"created_at":"2026-03-13T16:32:17.604935Z","updated_at":"2026-03-13T16:32:46.364880Z"}}},"exampleType":"generated"}},"exampleType":"generated"},"44e20494-4882-440e-a629-b36589fce164":{"description":"Invalid request","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"d0c6abdb-cd64-4e22-9733-d96ebab1313b":{"description":"Unauthorized - API key is missing or invalid","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"2d38629a-79b8-44a2-8fcb-83a1045ad3ae":{"description":"User or balance not found","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}}},"security":{"08ab65f1-6dfb-4d33-831f-49173ab4b50e":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key","description":"API key for authentication. Must be included in the x-api-key header.","scopes":[]}}},"servers":{"9129d5a6-67f7-4316-83f6-587c90f24b2e":{"url":"https://api.carbnconnect.com","description":"Production server"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"x-api-key","description":"API key for authentication. Must be included in the x-api-key header.","scopes":[]},"schema":{"title":"x-api-key","type":"string","description":"API key for authentication. Must be included in the x-api-key header.","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"ApiKeyAuth","name":"x-api-key"}],"title":"ApiKeyAuth"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"carbn","siteName":"Carbn Connect","title":"Create Payout - Carbn Connect","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-05-22T13:37:05.068Z","originalFileLocation":"api-reference/payouts/create-payout.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=\"description\" content=\"Create a local currency payout to a user\u0026#x27;s bank account using their available balance.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Carbn Connect\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/carbn/j1ioB5AZAWXLeN2j/_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/carbn/j1ioB5AZAWXLeN2j/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/carbn/j1ioB5AZAWXLeN2j/_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/carbn/j1ioB5AZAWXLeN2j/_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/carbn/j1ioB5AZAWXLeN2j/_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/carbn/j1ioB5AZAWXLeN2j/_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/carbn/j1ioB5AZAWXLeN2j/_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/carbn/j1ioB5AZAWXLeN2j/_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/carbn/j1ioB5AZAWXLeN2j/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create Payout - Carbn Connect\">\u003cmeta data-mint-head property=\"og:description\" content=\"Create a local currency payout to a user\u0026#x27;s bank account using their available balance.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Carbn Connect\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.carbn.xyz/api-reference/payouts/create-payout\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://carbn.mintlify.app/_mintlify/api/og/v2?division=Payouts\u0026amp;title=Create+Payout\u0026amp;description=Create+a+local+currency+payout+to+a+user%27s+bank+account+using+their+available+balance.\u0026amp;theme=995d7ad1d9daeca4b9f8af54\u0026amp;signature=6ba25d71945d491add8bca19ada569e12f37d1b4198ac37b5e062a873d5e73ef\">\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=\"Create Payout - Carbn Connect\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Create a local currency payout to a user\u0026#x27;s bank account using their available balance.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://carbn.mintlify.app/_mintlify/api/og/v2?division=Payouts\u0026amp;title=Create+Payout\u0026amp;description=Create+a+local+currency+payout+to+a+user%27s+bank+account+using+their+available+balance.\u0026amp;theme=995d7ad1d9daeca4b9f8af54\u0026amp;signature=6ba25d71945d491add8bca19ada569e12f37d1b4198ac37b5e062a873d5e73ef\">\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/carbn/j1ioB5AZAWXLeN2j/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Carbn Connect\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#07BEB8\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.carbn.xyz/api-reference/payouts/create-payout\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/payouts/create-payout.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.carbn.xyz/#organization\",\"name\":\"Carbn Connect\",\"url\":\"https://docs.carbn.xyz\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/carbn/7lmPj4w7jR_8X2ta/logo/Carbn_logo_full.svg?fit=max\u0026auto=format\u0026n=7lmPj4w7jR_8X2ta\u0026q=85\u0026s=7defcb3bc1fed108c5379b2dff06314f\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.carbn.xyz#website\",\"name\":\"Carbn Connect\",\"url\":\"https://docs.carbn.xyz\",\"publisher\":{\"@id\":\"https://docs.carbn.xyz/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.carbn.xyz/api-reference/payouts/create-payout#webpage\",\"url\":\"https://docs.carbn.xyz/api-reference/payouts/create-payout\",\"name\":\"Create Payout\",\"description\":\"Create a local currency payout to a user's bank account using their available balance.\",\"dateModified\":\"2026-05-22T13:37:05.068Z\",\"isPartOf\":{\"@id\":\"https://docs.carbn.xyz#website\"},\"breadcrumb\":{\"@id\":\"https://docs.carbn.xyz/api-reference/payouts/create-payout#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.carbn.xyz/api-reference/payouts/create-payout#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API Endpoints\",\"item\":\"https://docs.carbn.xyz/api-reference/user-management/user-onboarding\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Create Payout\",\"item\":\"https://docs.carbn.xyz/api-reference/payouts/create-payout\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.carbn.xyz/api-reference/payouts/create-payout#apireference\",\"headline\":\"Create Payout\",\"name\":\"Create Payout\",\"description\":\"Create a local currency payout to a user's bank account using their available balance.\",\"url\":\"https://docs.carbn.xyz/api-reference/payouts/create-payout\",\"mainEntityOfPage\":{\"@id\":\"https://docs.carbn.xyz/api-reference/payouts/create-payout#webpage\"},\"dateModified\":\"2026-05-22T13:37:05.068Z\",\"publisher\":{\"@id\":\"https://docs.carbn.xyz/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.carbn.xyz#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Carbn Connect\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Carbn Connect","nav":{"global":null,"dropdowns":[{"dropdown":"Documentation","icon":"book","description":"Integration guides","groups":[{"group":"Home","pages":[{"title":"Welcome","icon":"house","mode":"custom","href":"/welcome"},{"title":"Introduction","icon":"book-open","href":"/documentation/home/introduction"}]},{"group":"Getting started","pages":[{"title":"Get Setup with Carbn","icon":"rocket","href":"/documentation/getting-started/setup"},{"title":"Onboard Your First User","icon":"user-plus","href":"/documentation/getting-started/onboard-first-user"},{"title":"Create Your First Payment","icon":"credit-card","href":"/documentation/getting-started/first-payment"},{"title":"Configure Webhooks","icon":"webhook","href":"/documentation/getting-started/configure-webhook"}]},{"group":"Network and Global Coverage","pages":[{"title":"Geographic Coverage","icon":"globe","href":"/documentation/network/geographic-coverage"},{"title":"Payment Rails \u0026 Currency","icon":"route","href":"/documentation/network/supported-payment-methods"}]}]},{"dropdown":"Developer Platform","icon":"layers","description":"Tools and resources","groups":[{"group":"Users","pages":[{"group":"Compliance","pages":[{"title":"Overview","icon":"users","href":"/documentation/developer-platform/users/compliance/overview"},{"title":"KYC Requirements","icon":"shield-check","href":"/documentation/developer-platform/users/compliance/kyc-requirements"},{"title":"Enhanced Due Diligence","icon":"scan-search","href":"/documentation/developer-platform/users/compliance/enhanced-due-diligence"},{"title":"User Onboarding Status","icon":"loader","href":"/documentation/developer-platform/users/compliance/user-status"},{"title":"Rejection Reasons","icon":"circle-x","href":"/documentation/developer-platform/users/compliance/rejection-reasons"}]}]},{"group":"Monitoring","pages":[{"group":"Transfers","pages":[{"title":"Transfer Status","icon":"chart-line","href":"/documentation/developer-platform/monitoring/transfer-status"}]},{"group":"Webhooks","pages":[{"title":"Webhook Verification","icon":"shield-check","href":"/documentation/developer-platform/monitoring/webhook-verification"}]},{"group":"Payouts","pages":[{"title":"Payouts","icon":"money-bill-transfer","href":"/documentation/developer-platform/monitoring/payouts"}]}]}]},{"dropdown":"API Reference","icon":"terminal","description":"Reference for the API","groups":[{"group":"Overview","pages":[{"title":"Authentication","icon":"key","href":"/api-reference/authentication"},{"title":"Error Handling","icon":"triangle-alert","href":"/api-reference/errors"}]},{"group":"API Endpoints","pages":[{"group":"User Management","pages":[{"title":"User Onboarding","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /onboarding/api/v1/users","href":"/api-reference/user-management/user-onboarding"},{"title":"Get User Details","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /onboarding/api/v1/users/{user_id}","href":"/api-reference/user-management/get-user-details"},{"title":"Update User","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /onboarding/api/v1/users/{user_id}","href":"/api-reference/user-management/update-user"},{"title":"Get All Users","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /onboarding/api/v1/users/all","href":"/api-reference/user-management/get-all-users"},{"title":"Create User Onboarding Session","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /onboarding/api/v1/users/session","href":"/api-reference/user-management/create-user-onboarding-session"},{"title":"Generate User Consent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /onboarding/api/v1/tnc","href":"/api-reference/user-management/generate-user-consent"}]},{"group":"Webhook Management","pages":[{"title":"Update Webhook","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /onboarding/api/v1/webhooks","href":"/api-reference/webhook-management/update-webhook"},{"title":"Register Webhook","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /onboarding/api/v1/webhooks","href":"/api-reference/webhook-management/register-webhook"},{"title":"Trigger Webhook Event","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /onboarding/api/v1/webhooks/trigger/{webhook_id}","href":"/api-reference/webhook-management/trigger-webhook-event"}]},{"group":"Account Management","pages":[{"title":"Register Wallet","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /payment/api/v1/wallets/register","href":"/api-reference/account-management/register-wallet"},{"title":"Register Destination Account","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /payment/api/v1/accounts/register","href":"/api-reference/account-management/register-destination-account"},{"title":"Get Crypto Balance","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /payment/api/v1/offramp-audit/crypto-balance/{crypto}/{blockchain}/{user_id}","href":"/api-reference/account-management/get-crypto-balance"}]},{"group":"Payments","pages":[{"title":"Get Offramp Quote","deprecated":true,"version":null,"openapi":"/api-reference/openapi.json post /payment/api/v1/offramp/get-quote","href":"/api-reference/payments/get-offramp-quote"},{"title":"Accept Offramp Quote","deprecated":true,"version":null,"openapi":"/api-reference/openapi.json post /payment/api/v1/offramp/accept-quote","href":"/api-reference/payments/accept-offramp-quote"},{"title":"Initiate Offramp","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /payment/api/v1/offramp","href":"/api-reference/payments/initiate-offramp"},{"title":"Initiate Offramp Payout","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /payment/api/v1/offramp/payout","href":"/api-reference/payments/initiate-offramp-payout"},{"title":"Onramp Transfer","description":"Initiate a new onramp transfer","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /payment/api/v1/transfers/onramp","href":"/api-reference/payments/onramp-transfer"}]},{"group":"Payouts","pages":[{"title":"Create Payout","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /payment/api/v1/payout","href":"/api-reference/payouts/create-payout"},{"title":"Get Payout Status","description":"Retrieve the current status and details of a payout.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /payment/api/v1/payout/{payout_id}","href":"/api-reference/payouts/get-payout-status"},{"title":"Get Payout Balances","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /payment/api/v1/payout/balances/{user_id}","href":"/api-reference/payouts/get-payout-balances"}]},{"group":"Custody Wallet","pages":[{"title":"Create Custody Wallet","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /payment/api/v1/custody-wallet","href":"/api-reference/custody-wallet/create-custody-wallet"},{"title":"Custody Wallet Transfer","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /payment/api/v1/custody-wallet/transfer","href":"/api-reference/custody-wallet/custody-wallet-transfer"},{"title":"Get Custody Wallet Transfer Status","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /payment/api/v1/custody-wallet/transfer/{transaction_id}","href":"/api-reference/custody-wallet/get-custody-wallet-transfer-status"},{"title":"Get Custody Wallet","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /payment/api/v1/custody-wallet/{custody_wallet_id}","href":"/api-reference/custody-wallet/get-custody-wallet"},{"title":"Get Custody Wallet Transactions","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /payment/api/v1/custody-wallet/{custody_wallet_id}/transactions","href":"/api-reference/custody-wallet/get-custody-wallet-transactions"},{"title":"Get Total Custody Wallet Balances","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /payment/api/v1/custody-wallet/total-balances","href":"/api-reference/custody-wallet/get-total-custody-wallet-balances"}]},{"group":"Exchange","pages":[{"title":"Get Carbn Currency Exchange Rate","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /payment/api/v1/exchange/currency-rates/carbn","href":"/api-reference/exchange/get-carbn-currency-exchange-rate"}]},{"group":"Open Banking","pages":[{"title":"Get Open Banking Payment Status","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /payment/api/v1/ob/{payment_id}","href":"/api-reference/open-banking/get-open-banking-payment-status"},{"title":"Get Open Banking Institutions","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /payment/api/v1/transfers/get-institutes","href":"/api-reference/open-banking/get-open-banking-institutions"}]},{"group":"Audit \u0026 Reporting","pages":[{"title":"Get Onramp Audit","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /payment/api/v1/onramp-audit/{wallet_id}","href":"/api-reference/audit-\u0026-reporting/get-onramp-audit"},{"title":"Get Onramp Transaction Status","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /payment/api/v1/onramp-audit/status/{transaction_id}","href":"/api-reference/audit-\u0026-reporting/get-onramp-transaction-status"},{"title":"Get Offramp Transaction Status","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /payment/api/v1/offramp-audit/status/{transaction_id}","href":"/api-reference/audit-\u0026-reporting/get-offramp-transaction-status"}]}]}]},{"dropdown":"Changelog","icon":"clock","description":"Updates and changes","pages":[{"title":"Changelog","href":"/changelog/overview"}]}]},"title":"Create Payout - Carbn Connect","buildId":"dpl_DFJrtvUi8HS5F9nkooKuDJsuD5BM","deploymentId":"dpl_DFJrtvUi8HS5F9nkooKuDJsuD5BM","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["OpenApiReferenceProvider-rfhihCWU.js","utils-BmH1XFxk.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-BcNsxPKB.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-BAES3tkd.js","snippetPresets-DCMQBKLP.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","Page-D5fEM6aW.js","ApiExamples-D6l_bzE9.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BOktbnNh.js","shallow-BCs8SgM7.js","getApiPlaygroundDisplay-DEmW5bJB.js","CodeSnippet-CpZOpB9C.js","CodeSnippets-BOBDqibl.js","getPastedJson-DH2JBvmr.js","icon-BBJH-kKh.js","MethodPill-D2Sd5NLC.js","DuplicateIcon-CGgfL2qN.js","createIcon-BKudBBzi.js","DynamicMarkdown-85clUA0i.js","SectionHeading-D0JiMgDx.js","axios-vUo_bRtp.js","Markdown-Cfiy0xZO.js","clsx-rL8ZCCw4.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-aeztFa9U.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BywkCr5C.js"]}