{"docsConfig":{"theme":"aspen","$schema":"https://mintlify.com/docs.json","name":"Cleff API","description":"What it is: Cleff is a payout orchestration platform. A business registers each payee (a Beneficiary), funds its Cleff Account and sends payout instructions. Cleff validates, routes and tracks each payout to disbursement. It is available through a REST/JSON API (api.usecleff.com) and a dashboard (app.usecleff.com).\n\nWho it’s for: Businesses that pay people at volume: contractors, traders and agents. The beachhead is prop trading firms, but the architecture isn’t tied to that industry.\n\nWhat sets it apart:\n\n- It does not hold or move funds. Cleff sends instructions to downstream providers, so it positions itself as infrastructure and not a money services business.\n- ACH is the default rail. RTP and FedNow are available once a Business is approved for them.\n- Sandbox is open as soon as you verify your email. Production unlocks after business verification.\n- It has webhooks, idempotency and approvals, and the docs are built for AI agents: llms.txt, per-page .md, an MCP server and an installable skill.","colors":{"primary":"#0E1216","light":"#42D898","dark":"#15803D"},"logo":{"light":"https://mintcdn.com/cleff/Vp4Ivrsqo5WIMAII/images/Cleff-Brand-Black.svg?fit=max\u0026auto=format\u0026n=Vp4Ivrsqo5WIMAII\u0026q=85\u0026s=76d5efab56d934dba1ef8f82c6f3e3da","dark":"https://mintcdn.com/cleff/Vp4Ivrsqo5WIMAII/images/Cleff-Brand-White.svg?fit=max\u0026auto=format\u0026n=Vp4Ivrsqo5WIMAII\u0026q=85\u0026s=39ae818520b68ee890b4d5008a4bc08d","href":"https://www.usecleff.com"},"favicon":{"light":"https://mintcdn.com/cleff/Vp4Ivrsqo5WIMAII/images/cleff-favicon.png?fit=max\u0026auto=format\u0026n=Vp4Ivrsqo5WIMAII\u0026q=85\u0026s=09077340a0ea4762bc3828d9966ea137","dark":"https://mintcdn.com/cleff/Vp4Ivrsqo5WIMAII/images/cleff-favicon.png?fit=max\u0026auto=format\u0026n=Vp4Ivrsqo5WIMAII\u0026q=85\u0026s=09077340a0ea4762bc3828d9966ea137"},"api":{"openapi":"openapi.json","examples":{"prefill":false}},"appearance":{"default":"system","strict":false},"background":{"decoration":"grid","color":{"light":"#F8FAFB","dark":"#0E1216"}},"navbar":{"links":[{"href":"https://app.usecleff.com/signup","label":"Sign Up"}],"primary":{"type":"button","label":"Dashboard","href":"https://app.usecleff.com"}},"footer":{"socials":{"linkedin":"https://www.linkedin.com/company/cleff-inc","website":"https://www.usecleff.com","github":"https://github.com/usecleff"},"links":[{"header":"COMPANY","items":[{"label":"Brand Assets","href":"https://usecleff.com/brand-assets"},{"label":"Contact","href":"mailto:support@usecleff.com"}]},{"header":"LEGAL","items":[{"label":"Terms \u0026 Conditions","href":"https://usecleff.com/legal/terms"},{"label":"Privacy Policy","href":"https://usecleff.com/legal/privacy"}]}]},"seo":{"metatags":{"og:site_name":"Cleff API Docs","og:type":"website","robots":"index, follow, max-snippet:-1, max-image-preview:large","theme-color":"#0E1216"}},"icons":{"library":"lucide"},"styling":{"eyebrows":"section","latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"cleff","hasAudioNarration":false,"actualSubdomain":"cleff","customDomains":["docs.usecleff.com"],"gitSource":{"type":"github","owner":"usecleff","repo":"cleff","deployBranch":"main","contentDirectory":"docs/api","isPrivate":true,"mountPath":"","label":""},"chroma":{"latestBuiltDeploymentHistoryId":"6adba51ff69436d352bb4820","collectionId":"8ec4aa8d-643d-44f7-b69f-9f5b98e9747f","liveDeploymentHistoryId":"6adba51ff69436d352bb4820","schemaVersion":"v3"},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6adba51ff69436d352bb4820","clientVersion":"0.0.3965","searchFilterCounts":[{"language":"default","tag":"API Reference","count":34},{"language":"default","tag":"Reference","count":34},{"language":"default","tag":"Beneficiaries","count":18},{"language":"default","tag":"Documentation","count":14},{"language":"default","tag":"Payouts","count":11},{"language":"default","tag":"Webhooks","count":6},{"language":"default","tag":"Get started","count":5},{"language":"default","tag":"Essentials","count":5},{"language":"default","tag":"Bank accounts","count":3},{"language":"default","tag":"Collection invites","count":3}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true,"deflection":{"enabled":true,"email":"support@usecleff.com"}},"hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"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}],"privacy":{"consentBanner":{"enabled":true}},"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/funding","slug":"/api-reference/funding","pageMetadata":{"title":"Overview","description":"The Cleff Account payouts draw from.","href":"/api-reference/funding"},"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: \"The Cleff Account payouts draw from.\"\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,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={code:`code`,p:`p`,strong:`strong`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,..._provideComponents(),...props.components},{Heading,Note,Table}=_components;if(!Heading)_missingMdxReference(`Heading`,true);if(!Note)_missingMdxReference(`Note`,true);if(!Table)_missingMdxReference(`Table`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`Payouts draw from your `,_jsx(_components.strong,{children:`Cleff Account`}),`, the funding balance held per Business and\nenvironment. Read the Account to see its balance and details.`]}),`\n`,_jsx(Note,{children:_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Agents:`}),` fetch this page as plain markdown at\n`,_jsx(_components.code,{children:`https://docs.usecleff.com/api-reference/funding.md`}),`.`]})}),`\n`,_jsx(Heading,{level:`2`,id:`endpoints`,children:`Endpoints`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Method`}),_jsx(_components.th,{children:`Path`}),_jsx(_components.th,{children:`Purpose`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`GET`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`/v1/funding/account`})}),_jsx(_components.td,{children:`Read the current Business’s Cleff Account`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`POST`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`/v1/business/funding-account/sandbox-balance`})}),_jsxs(_components.td,{children:[`Top up the sandbox Account (`,_jsx(_components.strong,{children:`sandbox only`}),`)`]})]})]})]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Overview","description":"The Cleff Account payouts draw from.","href":"/api-reference/funding"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Endpoints","slug":"endpoints","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"cleff","siteName":"Cleff API","title":"Overview - Cleff API","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-01T22:17:22.235Z","originalFileLocation":"api-reference/funding.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=\"The Cleff Account payouts draw from.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Cleff API\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003cmeta data-mint-head name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"https://mintcdn.com/cleff/Vp4Ivrsqo5WIMAII/images/cleff-favicon.png?fit=max\u0026amp;auto=format\u0026amp;n=Vp4Ivrsqo5WIMAII\u0026amp;q=85\u0026amp;s=09077340a0ea4762bc3828d9966ea137\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"https://mintcdn.com/cleff/Vp4Ivrsqo5WIMAII/images/cleff-favicon.png?fit=max\u0026amp;auto=format\u0026amp;n=Vp4Ivrsqo5WIMAII\u0026amp;q=85\u0026amp;s=09077340a0ea4762bc3828d9966ea137\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"https://mintcdn.com/cleff/Vp4Ivrsqo5WIMAII/images/cleff-favicon.png?fit=max\u0026amp;auto=format\u0026amp;n=Vp4Ivrsqo5WIMAII\u0026amp;q=85\u0026amp;s=09077340a0ea4762bc3828d9966ea137\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/png\" href=\"https://mintcdn.com/cleff/Vp4Ivrsqo5WIMAII/images/cleff-favicon.png?fit=max\u0026amp;auto=format\u0026amp;n=Vp4Ivrsqo5WIMAII\u0026amp;q=85\u0026amp;s=09077340a0ea4762bc3828d9966ea137\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"https://mintcdn.com/cleff/Vp4Ivrsqo5WIMAII/images/cleff-favicon.png?fit=max\u0026amp;auto=format\u0026amp;n=Vp4Ivrsqo5WIMAII\u0026amp;q=85\u0026amp;s=09077340a0ea4762bc3828d9966ea137\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"https://mintcdn.com/cleff/Vp4Ivrsqo5WIMAII/images/cleff-favicon.png?fit=max\u0026amp;auto=format\u0026amp;n=Vp4Ivrsqo5WIMAII\u0026amp;q=85\u0026amp;s=09077340a0ea4762bc3828d9966ea137\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/png\" href=\"https://mintcdn.com/cleff/Vp4Ivrsqo5WIMAII/images/cleff-favicon.png?fit=max\u0026amp;auto=format\u0026amp;n=Vp4Ivrsqo5WIMAII\u0026amp;q=85\u0026amp;s=09077340a0ea4762bc3828d9966ea137\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Overview - Cleff API\">\u003cmeta data-mint-head property=\"og:description\" content=\"The Cleff Account payouts draw from.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Cleff API Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.usecleff.com/api-reference/funding\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://cleff.mintlify.app/_mintlify/api/og/v2?division=Funding\u0026amp;title=Overview\u0026amp;description=The+Cleff+Account+payouts+draw+from.\u0026amp;theme=7e252cb4f803b62f4977cf56\u0026amp;signature=7c1f13bc2c11f4c016b7bd0ed550096f64bf3c974b0b2c0952b7cfed44cdbe96\">\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=\"Overview - Cleff API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"The Cleff Account payouts draw from.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://cleff.mintlify.app/_mintlify/api/og/v2?division=Funding\u0026amp;title=Overview\u0026amp;description=The+Cleff+Account+payouts+draw+from.\u0026amp;theme=7e252cb4f803b62f4977cf56\u0026amp;signature=7c1f13bc2c11f4c016b7bd0ed550096f64bf3c974b0b2c0952b7cfed44cdbe96\">\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=\"https://mintlify.s3.us-west-1.amazonaws.com/cleff/_generated/favicon/browserconfig.xml?v=3\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Cleff API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0E1216\">\u003cmeta data-mint-head name=\"theme-color\" content=\"#0E1216\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.usecleff.com/api-reference/funding\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/funding.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.usecleff.com/#organization\",\"name\":\"Cleff API\",\"url\":\"https://docs.usecleff.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/cleff/Vp4Ivrsqo5WIMAII/images/Cleff-Brand-Black.svg?fit=max\u0026auto=format\u0026n=Vp4Ivrsqo5WIMAII\u0026q=85\u0026s=76d5efab56d934dba1ef8f82c6f3e3da\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.usecleff.com#website\",\"name\":\"Cleff API\",\"url\":\"https://docs.usecleff.com\",\"publisher\":{\"@id\":\"https://docs.usecleff.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.usecleff.com/api-reference/funding#webpage\",\"url\":\"https://docs.usecleff.com/api-reference/funding\",\"name\":\"Overview\",\"description\":\"The Cleff Account payouts draw from.\",\"dateModified\":\"2026-10-01T22:17:22.235Z\",\"isPartOf\":{\"@id\":\"https://docs.usecleff.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.usecleff.com/api-reference/funding#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.usecleff.com/api-reference/funding#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Reference\",\"item\":\"https://docs.usecleff.com/api-reference/beneficiaries\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Overview\",\"item\":\"https://docs.usecleff.com/api-reference/funding\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.usecleff.com/api-reference/funding#article\",\"headline\":\"Overview\",\"name\":\"Overview\",\"description\":\"The Cleff Account payouts draw from.\",\"url\":\"https://docs.usecleff.com/api-reference/funding\",\"mainEntityOfPage\":{\"@id\":\"https://docs.usecleff.com/api-reference/funding#webpage\"},\"dateModified\":\"2026-10-01T22:17:22.235Z\",\"publisher\":{\"@id\":\"https://docs.usecleff.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.usecleff.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Cleff API\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Cleff API","nav":{"global":null,"tabs":[{"tab":"Documentation","icon":"rocket","pages":[{"title":"Documentation","href":"/introduction"}]},{"tab":"API Reference","icon":"code","groups":[{"group":"Reference","pages":[{"group":"Beneficiaries","pages":[{"title":"Beneficiaries","href":"/api-reference/beneficiaries"},{"title":"Create a Beneficiary","openapi":"POST /v1/beneficiaries","href":"/api-reference/beneficiaries-create"},{"title":"Import a Beneficiary base","openapi":"POST /v1/beneficiaries/import","href":"/api-reference/beneficiaries-import"},{"title":"Update a Beneficiary","openapi":"PUT /v1/beneficiaries/{id}","href":"/api-reference/beneficiaries-update"},{"title":"List Beneficiaries","openapi":"GET /v1/beneficiaries","href":"/api-reference/beneficiaries-list"},{"title":"Retrieve a Beneficiary","openapi":"GET /v1/beneficiaries/{id}","href":"/api-reference/beneficiaries-get"},{"title":"Export Beneficiaries","openapi":"GET /v1/beneficiaries/export","href":"/api-reference/beneficiaries-export"},{"title":"Archive a Beneficiary","openapi":"DELETE /v1/beneficiaries/{id}","href":"/api-reference/beneficiaries-archive"},{"title":"Acknowledge compliance","openapi":"POST /v1/beneficiaries/{id}/compliance-acknowledgment","href":"/api-reference/beneficiaries-acknowledge"},{"title":"Set a declared destination","openapi":"PUT /v1/beneficiaries/{id}/declared-destination","href":"/api-reference/beneficiaries-declared-destination-update"},{"group":"Collection invites","pages":[{"title":"Invite Beneficiaries to submit details","openapi":"POST /v1/beneficiaries/collection-invites","href":"/api-reference/beneficiaries-collection-invites"},{"title":"Bulk-invite Beneficiaries","openapi":"POST /v1/beneficiaries/bulk-invites","href":"/api-reference/beneficiaries-bulk-invites"},{"title":"Cancel a collection request","openapi":"DELETE /v1/beneficiaries/{id}/collection-requests/{requestId}","href":"/api-reference/beneficiaries-collection-requests-cancel"}]},{"group":"Bank accounts","pages":[{"title":"List bank accounts","openapi":"GET /v1/beneficiaries/{id}/bank-accounts","href":"/api-reference/beneficiaries-bank-accounts-list"},{"title":"Register a bank account","openapi":"POST /v1/beneficiaries/{id}/bank-accounts","href":"/api-reference/beneficiaries-bank-accounts-create"},{"title":"Delete a destination","openapi":"DELETE /v1/beneficiaries/{id}/bank-accounts/{accountId}","description":"Deletes a destination, a bank account or a card, so it can no longer be paid or chosen: it leaves `GET /v1/beneficiaries/{id}/bank-accounts` and the Beneficiary’s collection link, and a payout that names it is refused. Payouts already created to it keep showing its last four digits, and one that is approved or on compliance hold is still sent to it. If it was the Beneficiary’s declared destination, `declared_destination_id` is cleared and the Beneficiary is told by email. Refused with `DESTINATION_HAS_PENDING_PAYOUT` while a payout awaiting approval is headed to it: reject that payout, then delete. Idempotent: deleting a destination that is already deleted succeeds.","href":"/api-reference/beneficiaries-bank-accounts-delete"}]}]},{"group":"Funding","pages":[{"title":"Overview","href":"/api-reference/funding"},{"title":"Get Cleff Account","openapi":"GET /v1/funding/account","description":"Returns the Business's provisioned Cleff Account as a provider-neutral DTO — currency, balance, derived status, and the deposit instructions it funds the account with. Scoped to the caller's Business and environment.","href":"/api-reference/funding-account-get"},{"title":"Top up sandbox balance","openapi":"POST /v1/business/funding-account/sandbox-balance","href":"/api-reference/funding-sandbox-balance"}]},{"group":"Payouts","pages":[{"title":"Overview","href":"/api-reference/payouts"},{"title":"Create a Payout","openapi":"POST /v1/payouts","href":"/api-reference/payouts-create"},{"title":"Bulk-create Payouts","openapi":"POST /v1/payouts/bulk","href":"/api-reference/payouts-bulk-create"},{"title":"List Payouts","openapi":"GET /v1/payouts","href":"/api-reference/payouts-list"},{"title":"Retrieve a Payout","openapi":"GET /v1/payouts/{payoutId}","href":"/api-reference/payouts-get"},{"title":"Approve a Payout","openapi":"POST /v1/payouts/{payoutId}/approve","href":"/api-reference/payouts-approve"},{"title":"Reject a Payout","openapi":"POST /v1/payouts/{payoutId}/reject","href":"/api-reference/payouts-reject"},{"title":"Submit a Decision","openapi":"POST /v1/payouts/{payoutId}/decisions","href":"/api-reference/payouts-decisions-create"},{"title":"List Decisions","openapi":"GET /v1/payouts/{payoutId}/decisions","href":"/api-reference/payouts-decisions-list"}]},{"group":"Webhooks","pages":[{"title":"Create or rotate a webhook subscription","openapi":"POST /v1/webhook-subscriptions","href":"/api-reference/webhook-subscriptions-create"},{"title":"Get the webhook subscription","openapi":"GET /v1/webhook-subscriptions","href":"/api-reference/webhook-subscriptions-get"},{"title":"Update the webhook subscription","openapi":"PATCH /v1/webhook-subscriptions","href":"/api-reference/webhook-subscriptions-update"},{"title":"Delete the webhook subscription","openapi":"DELETE /v1/webhook-subscriptions","href":"/api-reference/webhook-subscriptions-delete"},{"title":"Payout events","href":"/api-reference/webhook-events-payout"},{"title":"Beneficiary events","href":"/api-reference/webhook-events-beneficiary"}]}]}]},{"tab":"Changelog","icon":"clock","pages":[{"title":"Changelog","href":"/changelog"}]}]},"title":"Overview - Cleff API","buildId":"dpl_849ArpqvBiCczQiT1Y1stNGpbqHT","deploymentId":"dpl_849ArpqvBiCczQiT1Y1stNGpbqHT","dynamics":[],"chunks":[]}