{
"error": {
"code": "RATE_LIMITED",
"message": "Rate limit exceeded. Slow down and retry after the window.",
"request_id": "req_abc123",
"occurred_at": "2026-07-07T12:00:00.000Z",
"actor": null,
"docs_url": "https://docs.usecleff.com/errors#rate_limited"
}
}
Funding
Top up sandbox balance
Sets the available + total balance on the Business’s sandbox Cleff Account so it can exercise payouts. Sandbox only: a production API key is refused with SANDBOX_ONLY (409) and can never touch a real wallet. The account must already be provisioned, or the call returns FUNDING_DEDICATED_ACCOUNT_NOT_PROVISIONED (404).
POST
/
v1
/
business
/
funding-account
/
sandbox-balance
Top up the current Business's sandbox Cleff Account (sandbox only)
Instant Cleff last applied a balance report from the provider — the balance is only as fresh as this. Always Cleff's own clock, whether the provider pushed the balance or Cleff polled for it, so it is directly comparable with the timestamps on your payouts. A report that arrives out of order is discarded and does not move this. Null until the first report lands (status 'pending').
The coordinates the Business funds this account with; absent on non-Checkbook paths.
Show child attributes
{"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-sandbox-balance","slug":"/api-reference/funding-sandbox-balance","pageMetadata":{"title":"Top up sandbox balance","openapi":"POST /v1/business/funding-account/sandbox-balance","description":"Sets the available + total balance on the Business's sandbox Cleff Account so it can exercise payouts. Sandbox only: a production API key is refused with SANDBOX_ONLY (409) and can never touch a real wallet. The account must already be provisioned, or the call returns FUNDING_DEDICATED_ACCOUNT_NOT_PROVISIONED (404).","href":"/api-reference/funding-sandbox-balance"},"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: \"Sets the available + total balance on the Business’s sandbox Cleff Account so it can exercise payouts. Sandbox only: a production API key is refused with SANDBOX_ONLY (409) and can never touch a real wallet. The account must already be provisioned, or the call returns FUNDING_DEDICATED_ACCOUNT_NOT_PROVISIONED (404).\"\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{jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={code:`code`,p:`p`,strong:`strong`,..._provideComponents(),...props.components},{Note}=_components;if(!Note)_missingMdxReference(`Note`,true);return _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-sandbox-balance.md`}),`.`]})})}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":"Top up sandbox balance","openapi":"POST /v1/business/funding-account/sandbox-balance","description":"Sets the available + total balance on the Business's sandbox Cleff Account so it can exercise payouts. Sandbox only: a production API key is refused with SANDBOX_ONLY (409) and can never touch a real wallet. The account must already be provisioned, or the call returns FUNDING_DEDICATED_ACCOUNT_NOT_PROVISIONED (404).","href":"/api-reference/funding-sandbox-balance"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"description":"Sets the available + total balance on the Business's sandbox Cleff Account so it can exercise payouts. Sandbox only: a production API key is refused with SANDBOX_ONLY (409) and can never touch a real wallet. The account must already be provisioned, or the call returns FUNDING_DEDICATED_ACCOUNT_NOT_PROVISIONED (404).","operationId":"SandboxBalanceController_setBalance","parameters":[],"requestBody":"7159f5a2-0f32-482a-9a8c-90a00771fa89","responses":{"200":"abe0d9f9-69d5-417e-8a01-fee6e0bb4797","400":"7ffade8e-5270-433b-b096-bb083c22f0f9","401":"adf31fcc-a37c-477c-9d06-109f1e27888f","403":"a59bf88a-dd86-4be3-b4ae-e2e93c84d3b8","404":"942690d7-f37a-49f3-8595-7d9982b6be07","409":"fdfe4f42-5b7e-40c0-b691-5612c0ee844e","422":"5f182a9b-0dbd-4327-9d02-2afc116c0b23","429":"fcc58f63-d2af-4acb-9688-5b514b29bfdf"},"security":["2963e2b6-69a9-4ac3-8239-1b00c337dee6"],"summary":"Top up the current Business's sandbox Cleff Account (sandbox only)","tags":["Funding"],"method":"post","type":"path","servers":["23957774-ce69-4779-ae1b-7bae81a3b325"],"path":"/v1/business/funding-account/sandbox-balance","baseUrlOptions":["https://api.usecleff.com"],"title":"Top up the current Business's sandbox Cleff Account (sandbox only)","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"available_balance_minor":{"type":"number","description":"Available balance to set, in minor units. Max 9007199254740991.","maximum":9007199254740991,"isRequired":true,"uniqueKey":"available_balance_minor","typeLabel":"number"},"total_balance_minor":{"type":"number","description":"Total balance to set, in minor units. Max 9007199254740991.","maximum":9007199254740991,"isRequired":true,"uniqueKey":"total_balance_minor","typeLabel":"number"},"currency":{"type":"string","description":"ISO 4217 currency code; defaults to the account currency.","uniqueKey":"currency","typeLabel":"string"}},"required":["available_balance_minor","total_balance_minor"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"available_balance_minor":123,"total_balance_minor":123,"currency":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"abe0d9f9-69d5-417e-8a01-fee6e0bb4797":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"currency":{"type":"string","isRequired":true,"uniqueKey":"currency","typeLabel":"string"},"available_balance_minor":{"type":"number","description":"Available balance, in minor units.","isRequired":true,"uniqueKey":"available_balance_minor","typeLabel":"number"},"total_balance_minor":{"type":"number","description":"Total balance, in minor units.","isRequired":true,"uniqueKey":"total_balance_minor","typeLabel":"number"},"status":{"type":"string","enum":["pending","active","suspended"],"description":"Neutral account status derived server-side: 'pending' until the provider first reports, 'active' thereafter, 'suspended' when frozen.","isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"reported_at":{"oneOf":[{"type":"string","format":"date-time","description":"Instant Cleff last applied a balance report from the provider — the balance is only as fresh as this. Always Cleff's own clock, whether the provider pushed the balance or Cleff polled for it, so it is directly comparable with the timestamps on your payouts. A report that arrives out of order is discarded and does not move this. Null until the first report lands (status 'pending').","isRequired":true,"uniqueKey":"reported_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Instant Cleff last applied a balance report from the provider — the balance is only as fresh as this. Always Cleff's own clock, whether the provider pushed the balance or Cleff polled for it, so it is directly comparable with the timestamps on your payouts. A report that arrives out of order is discarded and does not move this. Null until the first report lands (status 'pending').","isRequired":true,"uniqueKey":"reported_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"reported_at","typeLabel":"string\u003cdate-time> | null"},"deposit_instructions":{"oneOf":[{"type":"object","description":"The coordinates the Business funds this account with; absent on non-Checkbook paths.","required":["bank_name","routing_number","account_number","account_holder_name","reference"],"properties":{"bank_name":{"oneOf":[{"type":"string","description":"Display-only bank name; may be absent.","isRequired":true,"uniqueKey":"deposit_instructions.oneOf.0.bank_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Display-only bank name; may be absent.","isRequired":true,"uniqueKey":"deposit_instructions.oneOf.0.bank_name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"deposit_instructions.oneOf.0.bank_name","typeLabel":"string | null"},"routing_number":{"type":"string","isRequired":true,"uniqueKey":"deposit_instructions.oneOf.0.routing_number","typeLabel":"string"},"account_number":{"type":"string","isRequired":true,"uniqueKey":"deposit_instructions.oneOf.0.account_number","typeLabel":"string"},"account_holder_name":{"oneOf":[{"type":"string","description":"Display-only account holder name; may be absent.","isRequired":true,"uniqueKey":"deposit_instructions.oneOf.0.account_holder_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Display-only account holder name; may be absent.","isRequired":true,"uniqueKey":"deposit_instructions.oneOf.0.account_holder_name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"deposit_instructions.oneOf.0.account_holder_name","typeLabel":"string | null"},"reference":{"oneOf":[{"type":"string","description":"Optional memo to tag inbound deposits with for reconciliation.","isRequired":true,"uniqueKey":"deposit_instructions.oneOf.0.reference.oneOf.0","typeLabel":"string"},{"type":"null","description":"Optional memo to tag inbound deposits with for reconciliation.","isRequired":true,"uniqueKey":"deposit_instructions.oneOf.0.reference.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"deposit_instructions.oneOf.0.reference","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"deposit_instructions.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"deposit_instructions.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"deposit_instructions","typeLabel":"object | null"}},"required":["currency","available_balance_minor","total_balance_minor","status","reported_at","deposit_instructions"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"currency":"\u003cstring>","available_balance_minor":123,"total_balance_minor":123,"status":"pending","reported_at":"2023-11-07T05:31:56Z","deposit_instructions":{"bank_name":"\u003cstring>","routing_number":"\u003cstring>","account_number":"\u003cstring>","account_holder_name":"\u003cstring>","reference":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"7ffade8e-5270-433b-b096-bb083c22f0f9":{"description":"The request body failed validation.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"request_id":{"type":"string","isRequired":true,"uniqueKey":"error.request_id","typeLabel":"string"},"occurred_at":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"error.occurred_at","typeLabel":"string\u003cdate-time>"},"actor":{"oneOf":[{"type":"object","required":["user_id","membership_id","role","environment"],"properties":{"user_id":{"type":"string","isRequired":true,"uniqueKey":"error.actor.oneOf.0.user_id","typeLabel":"string"},"membership_id":{"type":"string","isRequired":true,"uniqueKey":"error.actor.oneOf.0.membership_id","typeLabel":"string"},"role":{"type":"string","isRequired":true,"uniqueKey":"error.actor.oneOf.0.role","typeLabel":"string"},"environment":{"type":"string","enum":["sandbox","production"],"isRequired":true,"uniqueKey":"error.actor.oneOf.0.environment","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"error.actor.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"error.actor.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"error.actor","typeLabel":"object | null"},"docs_url":{"type":"string","isRequired":true,"uniqueKey":"error.docs_url","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].field","typeLabel":"string"},"code":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].message","typeLabel":"string"}},"required":["field","code","message"],"uniqueKey":"error.details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"error.details","typeLabel":"object[]"}},"required":["code","message","request_id","occurred_at","actor","docs_url"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"validation_failed","message":"Request validation failed","request_id":"req_abc123","occurred_at":"2026-07-07T12:00:00.000Z","actor":{"user_id":"usr_...","membership_id":"mem_...","role":"business_admin","environment":"sandbox"},"details":[{"field":"available_balance_minor","code":"is_required","message":"available_balance_minor should not be null or undefined"}],"docs_url":"https://docs.usecleff.com/errors#validation_failed"}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"validation_failed","message":"Request validation failed","request_id":"req_abc123","occurred_at":"2026-07-07T12:00:00.000Z","actor":{"user_id":"usr_...","membership_id":"mem_...","role":"business_admin","environment":"sandbox"},"details":[{"field":"available_balance_minor","code":"is_required","message":"available_balance_minor should not be null or undefined"}],"docs_url":"https://docs.usecleff.com/errors#validation_failed"}}}},"exampleType":"examples"}},"exampleType":"examples"},"adf31fcc-a37c-477c-9d06-109f1e27888f":{"description":"The API key is missing, invalid or revoked.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"request_id":{"type":"string","isRequired":true,"uniqueKey":"error.request_id","typeLabel":"string"},"occurred_at":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"error.occurred_at","typeLabel":"string\u003cdate-time>"},"actor":{"oneOf":[{"type":"object","required":["user_id","membership_id","role","environment"],"properties":{"user_id":{"type":"string","isRequired":true,"uniqueKey":"error.actor.oneOf.0.user_id","typeLabel":"string"},"membership_id":{"type":"string","isRequired":true,"uniqueKey":"error.actor.oneOf.0.membership_id","typeLabel":"string"},"role":{"type":"string","isRequired":true,"uniqueKey":"error.actor.oneOf.0.role","typeLabel":"string"},"environment":{"type":"string","enum":["sandbox","production"],"isRequired":true,"uniqueKey":"error.actor.oneOf.0.environment","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"error.actor.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"error.actor.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"error.actor","typeLabel":"object | null"},"docs_url":{"type":"string","isRequired":true,"uniqueKey":"error.docs_url","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].field","typeLabel":"string"},"code":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].message","typeLabel":"string"}},"required":["field","code","message"],"uniqueKey":"error.details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"error.details","typeLabel":"object[]"}},"required":["code","message","request_id","occurred_at","actor","docs_url"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"unauthorized","message":"Unauthorized","request_id":"req_abc123","occurred_at":"2026-07-07T12:00:00.000Z","actor":null,"docs_url":"https://docs.usecleff.com/errors#unauthorized"}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"unauthorized","message":"Unauthorized","request_id":"req_abc123","occurred_at":"2026-07-07T12:00:00.000Z","actor":null,"docs_url":"https://docs.usecleff.com/errors#unauthorized"}}}},"exampleType":"examples"}},"exampleType":"examples"},"a59bf88a-dd86-4be3-b4ae-e2e93c84d3b8":{"description":"The API key's role cannot make this request.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"request_id":{"type":"string","isRequired":true,"uniqueKey":"error.request_id","typeLabel":"string"},"occurred_at":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"error.occurred_at","typeLabel":"string\u003cdate-time>"},"actor":{"oneOf":[{"type":"object","required":["user_id","membership_id","role","environment"],"properties":{"user_id":{"type":"string","isRequired":true,"uniqueKey":"error.actor.oneOf.0.user_id","typeLabel":"string"},"membership_id":{"type":"string","isRequired":true,"uniqueKey":"error.actor.oneOf.0.membership_id","typeLabel":"string"},"role":{"type":"string","isRequired":true,"uniqueKey":"error.actor.oneOf.0.role","typeLabel":"string"},"environment":{"type":"string","enum":["sandbox","production"],"isRequired":true,"uniqueKey":"error.actor.oneOf.0.environment","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"error.actor.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"error.actor.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"error.actor","typeLabel":"object | null"},"docs_url":{"type":"string","isRequired":true,"uniqueKey":"error.docs_url","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].field","typeLabel":"string"},"code":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].message","typeLabel":"string"}},"required":["field","code","message"],"uniqueKey":"error.details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"error.details","typeLabel":"object[]"}},"required":["code","message","request_id","occurred_at","actor","docs_url"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"forbidden","message":"Forbidden resource","request_id":"req_abc123","occurred_at":"2026-07-07T12:00:00.000Z","actor":{"user_id":"usr_...","membership_id":"mem_...","role":"business_read_only","environment":"sandbox"},"docs_url":"https://docs.usecleff.com/errors#forbidden"}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"forbidden","message":"Forbidden resource","request_id":"req_abc123","occurred_at":"2026-07-07T12:00:00.000Z","actor":{"user_id":"usr_...","membership_id":"mem_...","role":"business_read_only","environment":"sandbox"},"docs_url":"https://docs.usecleff.com/errors#forbidden"}}}},"exampleType":"examples"}},"exampleType":"examples"},"942690d7-f37a-49f3-8595-7d9982b6be07":{"description":"The Business has no Cleff Account yet. In sandbox one is created shortly after you submit your company profile; in production, once your Business is approved.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"request_id":{"type":"string","isRequired":true,"uniqueKey":"error.request_id","typeLabel":"string"},"occurred_at":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"error.occurred_at","typeLabel":"string\u003cdate-time>"},"actor":{"oneOf":[{"type":"object","required":["user_id","membership_id","role","environment"],"properties":{"user_id":{"type":"string","isRequired":true,"uniqueKey":"error.actor.oneOf.0.user_id","typeLabel":"string"},"membership_id":{"type":"string","isRequired":true,"uniqueKey":"error.actor.oneOf.0.membership_id","typeLabel":"string"},"role":{"type":"string","isRequired":true,"uniqueKey":"error.actor.oneOf.0.role","typeLabel":"string"},"environment":{"type":"string","enum":["sandbox","production"],"isRequired":true,"uniqueKey":"error.actor.oneOf.0.environment","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"error.actor.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"error.actor.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"error.actor","typeLabel":"object | null"},"docs_url":{"type":"string","isRequired":true,"uniqueKey":"error.docs_url","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].field","typeLabel":"string"},"code":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].message","typeLabel":"string"}},"required":["field","code","message"],"uniqueKey":"error.details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"error.details","typeLabel":"object[]"}},"required":["code","message","request_id","occurred_at","actor","docs_url"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"FUNDING_DEDICATED_ACCOUNT_NOT_PROVISIONED","message":"Business 5f1d3a2c-8b4e-4c7a-9e6d-2b0f1a3c5d7e has no provisioned dedicated account","request_id":"req_abc123","occurred_at":"2026-07-07T12:00:00.000Z","actor":{"user_id":"usr_...","membership_id":"mem_...","role":"business_admin","environment":"sandbox"},"docs_url":"https://docs.usecleff.com/errors#funding_dedicated_account_not_provisioned"}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"FUNDING_DEDICATED_ACCOUNT_NOT_PROVISIONED","message":"Business 5f1d3a2c-8b4e-4c7a-9e6d-2b0f1a3c5d7e has no provisioned dedicated account","request_id":"req_abc123","occurred_at":"2026-07-07T12:00:00.000Z","actor":{"user_id":"usr_...","membership_id":"mem_...","role":"business_admin","environment":"sandbox"},"docs_url":"https://docs.usecleff.com/errors#funding_dedicated_account_not_provisioned"}}}},"exampleType":"examples"}},"exampleType":"examples"},"fdfe4f42-5b7e-40c0-b691-5612c0ee844e":{"description":"The API key is a production key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"request_id":{"type":"string","isRequired":true,"uniqueKey":"error.request_id","typeLabel":"string"},"occurred_at":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"error.occurred_at","typeLabel":"string\u003cdate-time>"},"actor":{"oneOf":[{"type":"object","required":["user_id","membership_id","role","environment"],"properties":{"user_id":{"type":"string","isRequired":true,"uniqueKey":"error.actor.oneOf.0.user_id","typeLabel":"string"},"membership_id":{"type":"string","isRequired":true,"uniqueKey":"error.actor.oneOf.0.membership_id","typeLabel":"string"},"role":{"type":"string","isRequired":true,"uniqueKey":"error.actor.oneOf.0.role","typeLabel":"string"},"environment":{"type":"string","enum":["sandbox","production"],"isRequired":true,"uniqueKey":"error.actor.oneOf.0.environment","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"error.actor.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"error.actor.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"error.actor","typeLabel":"object | null"},"docs_url":{"type":"string","isRequired":true,"uniqueKey":"error.docs_url","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].field","typeLabel":"string"},"code":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].message","typeLabel":"string"}},"required":["field","code","message"],"uniqueKey":"error.details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"error.details","typeLabel":"object[]"}},"required":["code","message","request_id","occurred_at","actor","docs_url"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"SANDBOX_ONLY","message":"Setting the funding-account balance directly is only permitted in the sandbox","request_id":"req_abc123","occurred_at":"2026-07-07T12:00:00.000Z","actor":{"user_id":"usr_...","membership_id":"mem_...","role":"business_admin","environment":"production"},"docs_url":"https://docs.usecleff.com/errors#sandbox_only"}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"SANDBOX_ONLY","message":"Setting the funding-account balance directly is only permitted in the sandbox","request_id":"req_abc123","occurred_at":"2026-07-07T12:00:00.000Z","actor":{"user_id":"usr_...","membership_id":"mem_...","role":"business_admin","environment":"production"},"docs_url":"https://docs.usecleff.com/errors#sandbox_only"}}}},"exampleType":"examples"}},"exampleType":"examples"},"5f182a9b-0dbd-4327-9d02-2afc116c0b23":{"description":"`currency` is not the account's currency.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"request_id":{"type":"string","isRequired":true,"uniqueKey":"error.request_id","typeLabel":"string"},"occurred_at":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"error.occurred_at","typeLabel":"string\u003cdate-time>"},"actor":{"oneOf":[{"type":"object","required":["user_id","membership_id","role","environment"],"properties":{"user_id":{"type":"string","isRequired":true,"uniqueKey":"error.actor.oneOf.0.user_id","typeLabel":"string"},"membership_id":{"type":"string","isRequired":true,"uniqueKey":"error.actor.oneOf.0.membership_id","typeLabel":"string"},"role":{"type":"string","isRequired":true,"uniqueKey":"error.actor.oneOf.0.role","typeLabel":"string"},"environment":{"type":"string","enum":["sandbox","production"],"isRequired":true,"uniqueKey":"error.actor.oneOf.0.environment","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"error.actor.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"error.actor.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"error.actor","typeLabel":"object | null"},"docs_url":{"type":"string","isRequired":true,"uniqueKey":"error.docs_url","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].field","typeLabel":"string"},"code":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].message","typeLabel":"string"}},"required":["field","code","message"],"uniqueKey":"error.details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"error.details","typeLabel":"object[]"}},"required":["code","message","request_id","occurred_at","actor","docs_url"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"FUNDING_CURRENCY_MISMATCH","message":"Balance report currency EUR does not match dedicated account currency USD","request_id":"req_abc123","occurred_at":"2026-07-07T12:00:00.000Z","actor":{"user_id":"usr_...","membership_id":"mem_...","role":"business_admin","environment":"sandbox"},"docs_url":"https://docs.usecleff.com/errors#funding_currency_mismatch"}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"FUNDING_CURRENCY_MISMATCH","message":"Balance report currency EUR does not match dedicated account currency USD","request_id":"req_abc123","occurred_at":"2026-07-07T12:00:00.000Z","actor":{"user_id":"usr_...","membership_id":"mem_...","role":"business_admin","environment":"sandbox"},"docs_url":"https://docs.usecleff.com/errors#funding_currency_mismatch"}}}},"exampleType":"examples"}},"exampleType":"examples"},"fcc58f63-d2af-4acb-9688-5b514b29bfdf":{"description":"Too many requests for this Business and environment.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"request_id":{"type":"string","isRequired":true,"uniqueKey":"error.request_id","typeLabel":"string"},"occurred_at":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"error.occurred_at","typeLabel":"string\u003cdate-time>"},"actor":{"oneOf":[{"type":"object","required":["user_id","membership_id","role","environment"],"properties":{"user_id":{"type":"string","isRequired":true,"uniqueKey":"error.actor.oneOf.0.user_id","typeLabel":"string"},"membership_id":{"type":"string","isRequired":true,"uniqueKey":"error.actor.oneOf.0.membership_id","typeLabel":"string"},"role":{"type":"string","isRequired":true,"uniqueKey":"error.actor.oneOf.0.role","typeLabel":"string"},"environment":{"type":"string","enum":["sandbox","production"],"isRequired":true,"uniqueKey":"error.actor.oneOf.0.environment","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"error.actor.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"error.actor.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"error.actor","typeLabel":"object | null"},"docs_url":{"type":"string","isRequired":true,"uniqueKey":"error.docs_url","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].field","typeLabel":"string"},"code":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].message","typeLabel":"string"}},"required":["field","code","message"],"uniqueKey":"error.details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"error.details","typeLabel":"object[]"}},"required":["code","message","request_id","occurred_at","actor","docs_url"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"RATE_LIMITED","message":"Rate limit exceeded. Slow down and retry after the window.","request_id":"req_abc123","occurred_at":"2026-07-07T12:00:00.000Z","actor":null,"docs_url":"https://docs.usecleff.com/errors#rate_limited"}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"RATE_LIMITED","message":"Rate limit exceeded. Slow down and retry after the window.","request_id":"req_abc123","occurred_at":"2026-07-07T12:00:00.000Z","actor":null,"docs_url":"https://docs.usecleff.com/errors#rate_limited"}}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"2963e2b6-69a9-4ac3-8239-1b00c337dee6":{"api_key":{"scheme":"bearer","bearerFormat":"ck_\u003cenv>_\u003cid>_\u003csecret>","type":"http","description":"Cleff API key, created in the dashboard under Settings → API keys","scopes":[],"schemeName":"api_key"}}},"servers":{"23957774-ce69-4779-ae1b-7bae81a3b325":{"url":"https://api.usecleff.com"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"scheme":"bearer","bearerFormat":"ck_\u003cenv>_\u003cid>_\u003csecret>","type":"http","description":"Cleff API key, created in the dashboard under Settings → API keys","scopes":[],"schemeName":"api_key"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Cleff API key, created in the dashboard under Settings → API keys","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"api_key","name":"Authorization"}],"title":"api_key"}]},"originalFileLocation":"openapi.json"},"subdomain":"cleff","siteName":"Cleff API","title":"Top up sandbox balance - Cleff API","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-01T22:17:22.231Z","originalFileLocation":"api-reference/funding-sandbox-balance.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=\"Sets the available + total balance on the Business\u0026#x27;s sandbox Cleff Account so it can exercise payouts. Sandbox only: a production API key is refused with SANDBOX_ONLY (409) and can never touch a real wallet. The account must already be provisioned, or the call returns FUNDING_DEDICATED_ACCOUNT_NOT_PROVISIONED (404).\">\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=\"Top up sandbox balance - Cleff API\">\u003cmeta data-mint-head property=\"og:description\" content=\"Sets the available + total balance on the Business\u0026#x27;s sandbox Cleff Account so it can exercise payouts. Sandbox only: a production API key is refused with SANDBOX_ONLY (409) and can never touch a real wallet. The account must already be provisioned, or the call returns FUNDING_DEDICATED_ACCOUNT_NOT_PROVISIONED (404).\">\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-sandbox-balance\">\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=Top+up+sandbox+balance\u0026amp;description=Sets+the+available+%2B+total+balance+on+the+Business%27s+sandbox+Cleff+Account+so+it+can+exercise+payouts.+Sandbox+only%3A+a+production+API+key+is+refused+with+SANDBO\u0026amp;theme=7e252cb4f803b62f4977cf56\u0026amp;signature=f50672251bc64875bf85e07e34b4fcd41d5391cf11cdd7bb1b8617608a4b432f\">\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=\"Top up sandbox balance - Cleff API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Sets the available + total balance on the Business\u0026#x27;s sandbox Cleff Account so it can exercise payouts. Sandbox only: a production API key is refused with SANDBOX_ONLY (409) and can never touch a real wallet. The account must already be provisioned, or the call returns FUNDING_DEDICATED_ACCOUNT_NOT_PROVISIONED (404).\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://cleff.mintlify.app/_mintlify/api/og/v2?division=Funding\u0026amp;title=Top+up+sandbox+balance\u0026amp;description=Sets+the+available+%2B+total+balance+on+the+Business%27s+sandbox+Cleff+Account+so+it+can+exercise+payouts.+Sandbox+only%3A+a+production+API+key+is+refused+with+SANDBO\u0026amp;theme=7e252cb4f803b62f4977cf56\u0026amp;signature=f50672251bc64875bf85e07e34b4fcd41d5391cf11cdd7bb1b8617608a4b432f\">\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-sandbox-balance\">\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-sandbox-balance.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-sandbox-balance#webpage\",\"url\":\"https://docs.usecleff.com/api-reference/funding-sandbox-balance\",\"name\":\"Top up sandbox balance\",\"description\":\"Sets the available + total balance on the Business's sandbox Cleff Account so it can exercise payouts. Sandbox only: a production API key is refused with SANDBOX_ONLY (409) and can never touch a real wallet. The account must already be provisioned, or the call returns FUNDING_DEDICATED_ACCOUNT_NOT_PROVISIONED (404).\",\"dateModified\":\"2026-10-01T22:17:22.231Z\",\"isPartOf\":{\"@id\":\"https://docs.usecleff.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.usecleff.com/api-reference/funding-sandbox-balance#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.usecleff.com/api-reference/funding-sandbox-balance#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Reference\",\"item\":\"https://docs.usecleff.com/api-reference/beneficiaries\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Funding\",\"item\":\"https://docs.usecleff.com/api-reference/funding\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Top up sandbox balance\",\"item\":\"https://docs.usecleff.com/api-reference/funding-sandbox-balance\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.usecleff.com/api-reference/funding-sandbox-balance#apireference\",\"headline\":\"Top up sandbox balance\",\"name\":\"Top up sandbox balance\",\"description\":\"Sets the available + total balance on the Business's sandbox Cleff Account so it can exercise payouts. Sandbox only: a production API key is refused with SANDBOX_ONLY (409) and can never touch a real wallet. The account must already be provisioned, or the call returns FUNDING_DEDICATED_ACCOUNT_NOT_PROVISIONED (404).\",\"url\":\"https://docs.usecleff.com/api-reference/funding-sandbox-balance\",\"mainEntityOfPage\":{\"@id\":\"https://docs.usecleff.com/api-reference/funding-sandbox-balance#webpage\"},\"dateModified\":\"2026-10-01T22:17:22.231Z\",\"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}","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","description":"The unit of money movement in Cleff. A Payout is created in pending_approval, validated by a Decision, and disbursed once approved.","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":"Top up sandbox balance - Cleff API","buildId":"dpl_849ArpqvBiCczQiT1Y1stNGpbqHT","deploymentId":"dpl_849ArpqvBiCczQiT1Y1stNGpbqHT","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-Bbp7I60D.js","utils-C3RIvJha.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DqD-vLt8.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-B31Loprg.js","snippetPresets-DKpk-b8t.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-Cj65AhOR.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BXtn5gcC.js","shallow-RY2b03Cp.js","getApiPlaygroundDisplay-B0jeiPk3.js","CodeSnippet-CYgBjjwn.js","CodeSnippets-DOngDrYB.js","Page-n7I5XbKb.js","getPastedJson-DRQbJx-T.js","icon-CQiQCicY.js","MethodPill-BKTLdNtu.js","DuplicateIcon-B9jpAdat.js","createIcon-DCddRrXv.js","DynamicMarkdown-a8hUKrw6.js","SectionHeading-eECVV2eH.js","axios-vUo_bRtp.js","Markdown--GF7ZIpf.js","clsx-DZLdJUrt.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-2LoAhjKH.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-Zwc0ZncM.js"]}