Return the current BRL balance for the company associated with the API key. The endpoint takes no parameters — the company is always derived from the API key. The four balance buckets are independent and additive: available (settled funds free to use; a withdrawal is also bounded by GET /v1/withdrawals/limits), frozen (set aside for in-flight withdrawals, refunds, or operational holds — not currently withdrawable), held (confirmed but pending settlement), and reserved (a rolling reserve withheld from settled funds and released on a schedule — not currently withdrawable). The total account balance is available + frozen + held + reserved. A split credit received from another YuvexPay company follows your own rolling reserve policy, not the originating company’s. A sandbox API key always returns zeros, since sandbox transactions do not accumulate to a real balance.
YuvexPay API key. Include as Authorization: Bearer ypk_<env>_<kid>_<secret> where <env> is test (sandbox) or live (production). Create and manage keys in the dashboard under Settings > API Keys.
Account balance for the company associated with the API key. The four buckets available, frozen, held, and reserved are independent and additive — total = available + frozen + held + reserved.
Show child attributes
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"YuvexPay","colors":{"primary":"#16A34A","light":"#07C983","dark":"#15803D"},"logo":{"light":"https://mintcdn.com/yuvexpay/_p0fopc5ZJwqr6Ao/logo/light.png?fit=max\u0026auto=format\u0026n=_p0fopc5ZJwqr6Ao\u0026q=85\u0026s=85eb8014f41b3db8d62050d2ff2d17eb","dark":"https://mintcdn.com/yuvexpay/_p0fopc5ZJwqr6Ao/logo/dark.png?fit=max\u0026auto=format\u0026n=_p0fopc5ZJwqr6Ao\u0026q=85\u0026s=bb76c5782cd7c2617b6337f945d8ce09"},"favicon":"https://mintcdn.com/yuvexpay/y4ZbUn0Z_aeTofU3/favicon.svg?fit=max\u0026auto=format\u0026n=y4ZbUn0Z_aeTofU3\u0026q=85\u0026s=149e82b739356ac0368489279ddb2785","api":{},"navbar":{"links":[{"href":"mailto:support@yuvexpay.com","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://app.yuvexpay.com"}},"footer":{"socials":{"github":"https://github.com/yuvexpay"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Dashboard","icon":"gauge","href":"https://app.yuvexpay.com"},{"anchor":"API status","icon":"signal","href":"https://status.yuvexpay.com"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"yuvexpay","hasAudioNarration":false,"actualSubdomain":"yuvexpay","customDomains":["docs.yuvexpay.com"],"gitSource":{"type":"github","owner":"yuvexpay","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6add2ecb41bc09b755441f21","collectionId":"f7c0a0d1-3dc0-4c6f-9c35-f75bb0f47542","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6add2ecb41bc09b755441f21"},"entitlements":{},"buildId":"6add2ecb41bc09b755441f21","clientVersion":"0.0.4043","searchFilterCounts":[{"language":"default","tag":"API reference","count":33},{"language":"default","tag":"Products","count":13},{"language":"default","tag":"Guides","count":13},{"language":"default","tag":"Payments","count":8},{"language":"default","tag":"Core concepts","count":6},{"language":"default","tag":"Customers","count":5},{"language":"default","tag":"Withdrawals","count":4},{"language":"default","tag":"Documents","count":3},{"language":"default","tag":"Getting started","count":2},{"language":"default","tag":"Authentication","count":1}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"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":"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":"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":"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":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","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":"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":"turbopuffer-dual-write","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},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/balance/get","slug":"/api-reference/balance/get","pageMetadata":{"title":"Get account balance","openapi":"GET /v1/balance","description":"Return the current BRL balance for the company associated with the API key. The endpoint takes no parameters — the company is always derived from the API key. The four balance buckets are independent and additive: `available` (settled funds free to use; a withdrawal is also bounded by `GET /v1/withdrawals/limits`), `frozen` (set aside for in-flight withdrawals, refunds, or operational holds — not currently withdrawable), `held` (confirmed but pending settlement), and `reserved` (a rolling reserve withheld from settled funds and released on a schedule — not currently withdrawable). The total account balance is `available + frozen + held + reserved`. A split credit received from another YuvexPay company follows your own rolling reserve policy, not the originating company's. A sandbox API key always returns zeros, since sandbox transactions do not accumulate to a real balance.","href":"/api-reference/balance/get"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Return the current BRL balance for the company associated with the API key. The endpoint takes no parameters — the company is always derived from the API key. The four balance buckets are independent and additive: \", _jsx(_components.code, {\n children: \"available\"\n }), \" (settled funds free to use; a withdrawal is also bounded by \", _jsx(_components.code, {\n children: \"GET /v1/withdrawals/limits\"\n }), \"), \", _jsx(_components.code, {\n children: \"frozen\"\n }), \" (set aside for in-flight withdrawals, refunds, or operational holds — not currently withdrawable), \", _jsx(_components.code, {\n children: \"held\"\n }), \" (confirmed but pending settlement), and \", _jsx(_components.code, {\n children: \"reserved\"\n }), \" (a rolling reserve withheld from settled funds and released on a schedule — not currently withdrawable). The total account balance is \", _jsx(_components.code, {\n children: \"available + frozen + held + reserved\"\n }), \". A split credit received from another YuvexPay company follows your own rolling reserve policy, not the originating company’s. A sandbox API key always returns zeros, since sandbox transactions do not accumulate to a real 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":"Get account balance","openapi":"GET /v1/balance","description":"Return the current BRL balance for the company associated with the API key. The endpoint takes no parameters — the company is always derived from the API key. The four balance buckets are independent and additive: `available` (settled funds free to use; a withdrawal is also bounded by `GET /v1/withdrawals/limits`), `frozen` (set aside for in-flight withdrawals, refunds, or operational holds — not currently withdrawable), `held` (confirmed but pending settlement), and `reserved` (a rolling reserve withheld from settled funds and released on a schedule — not currently withdrawable). The total account balance is `available + frozen + held + reserved`. A split credit received from another YuvexPay company follows your own rolling reserve policy, not the originating company's. A sandbox API key always returns zeros, since sandbox transactions do not accumulate to a real balance.","href":"/api-reference/balance/get"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"getBalance","summary":"Get account balance","description":"Return the current BRL balance for the company associated with the API key. The endpoint takes no parameters — the company is always derived from the API key. The four balance buckets are independent and additive: `available` (settled funds free to use; a withdrawal is also bounded by `GET /v1/withdrawals/limits`), `frozen` (set aside for in-flight withdrawals, refunds, or operational holds — not currently withdrawable), `held` (confirmed but pending settlement), and `reserved` (a rolling reserve withheld from settled funds and released on a schedule — not currently withdrawable). The total account balance is `available + frozen + held + reserved`. A split credit received from another YuvexPay company follows your own rolling reserve policy, not the originating company's. A sandbox API key always returns zeros, since sandbox transactions do not accumulate to a real balance.","tags":["Balance"],"responses":{"200":"0f9b28ae-c0a3-4172-823f-aa69245a0337","401":"1f162869-fc91-42b3-93a8-d638240747d8","403":"523fd84e-9adf-4e86-88d0-14fc86bae58d","429":"34c1b10f-cbf8-4f00-ae67-a406de31fe6e"},"method":"get","type":"path","servers":["30caf778-26b8-4811-87ad-19a2f5724d43"],"security":["2137f48b-cc8e-489b-84f6-226ef7e46562"],"path":"/v1/balance","baseUrlOptions":["https://api.yuvexpay.com"],"title":"Get account balance","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"responses":{"0f9b28ae-c0a3-4172-823f-aa69245a0337":{"description":"Balance retrieved.","content":{"application/json":{"schema":{"type":"object","properties":{"balance":{"type":"object","description":"Account balance for the company associated with the API key. The four buckets `available`, `frozen`, `held`, and `reserved` are independent and additive — `total = available + frozen + held + reserved`.","properties":{"available":{"type":"number","description":"Settled funds free to use, in BRL. The largest withdrawal you can request right now is also bounded by `remaining` and `perTransactionLimit` from `GET /v1/withdrawals/limits`. This can be negative: when a refund or a PIX MED is apportioned across a split, each recipient is debited its share even if it has already withdrawn the money. A negative balance blocks withdrawals until it is covered by new settlements.","isRequired":true,"uniqueKey":"balance.available","typeLabel":"number"},"frozen":{"type":"number","description":"Funds reserved/frozen for in-flight withdrawals, refunds, or operational holds. Not currently withdrawable, but still part of the account balance until the underlying operation reaches a terminal state. Independent from `available`.","isRequired":true,"uniqueKey":"balance.frozen","typeLabel":"number"},"held":{"type":"number","description":"Confirmed amount pending settlement (for example, card or boleto payments confirmed but not yet liquidated). Will move to `available` once settled.","isRequired":true,"uniqueKey":"balance.held","typeLabel":"number"},"reserved":{"type":"number","description":"Rolling reserve: a share of settled funds withheld when your account is subject to a reserve policy, released back to `available` on each release date. Not currently withdrawable, and not usable to fund a refund you issue, until released. A split credit received from another YuvexPay company follows your own reserve policy, not the originating company's; when a refund or MED debit lands on a split share that is still reserved, that payment's own reserve hold is released first and the debit is written against it. `0` when no reserve applies.","isRequired":true,"uniqueKey":"balance.reserved","typeLabel":"number"},"total":{"type":"number","description":"Total account balance: `available + frozen + held + reserved`.","isRequired":true,"uniqueKey":"balance.total","typeLabel":"number"},"currency":{"type":"string","enum":["BRL"],"description":"Always `BRL`. Multi-currency is not yet supported on the public API.","isRequired":true,"uniqueKey":"balance.currency","typeLabel":"enum\u003cstring>"},"environment":{"type":"string","enum":["SANDBOX","PRODUCTION"],"description":"Environment of the API key used to make this call. Sandbox keys always return zeros.","isRequired":true,"uniqueKey":"balance.environment","typeLabel":"enum\u003cstring>"},"updatedAt":{"oneOf":[{"type":"string","format":"date-time","description":"When the balance row was last updated. `null` if the company has never had any balance activity.","isRequired":true,"uniqueKey":"balance.updatedAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"When the balance row was last updated. `null` if the company has never had any balance activity.","isRequired":true,"uniqueKey":"balance.updatedAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"balance.updatedAt","typeLabel":"string\u003cdate-time> | null"}},"required":["available","frozen","held","reserved","total","currency","environment","updatedAt"],"isRequired":true,"uniqueKey":"balance","typeLabel":"object"}},"required":["balance"],"uniqueKey":"","typeLabel":"object"},"examples":{"noFrozenFunds":{"title":"noFrozenFunds","value":{"balance":{"available":13.45,"frozen":0,"held":10.2,"reserved":0,"total":23.65,"currency":"BRL","environment":"PRODUCTION","updatedAt":"2026-05-06T12:00:00.000Z"}}},"withFrozenFunds":{"title":"withFrozenFunds","value":{"balance":{"available":6.47,"frozen":6.99,"held":10.2,"reserved":0,"total":23.66,"currency":"BRL","environment":"PRODUCTION","updatedAt":"2026-05-06T12:00:00.000Z"}}},"withReservedFunds":{"title":"withReservedFunds","value":{"balance":{"available":90,"frozen":0,"held":0,"reserved":10,"total":100,"currency":"BRL","environment":"PRODUCTION","updatedAt":"2026-05-06T12:00:00.000Z"}}},"sandboxKey":{"title":"sandboxKey","value":{"balance":{"available":0,"frozen":0,"held":0,"reserved":0,"total":0,"currency":"BRL","environment":"SANDBOX","updatedAt":null}}}},"exampleType":"examples"}},"exampleType":"examples"},"1f162869-fc91-42b3-93a8-d638240747d8":{"description":"Missing or invalid authentication token.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code.","uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable error message.","uniqueKey":"error.message","typeLabel":"string"},"details":{"type":"object","description":"Additional error context.","uniqueKey":"error.details","typeLabel":"object"}},"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"INVALID_API_KEY","message":"Invalid or revoked API key"}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"INVALID_API_KEY","message":"Invalid or revoked API key"}}}},"exampleType":"examples"}},"exampleType":"examples"},"523fd84e-9adf-4e86-88d0-14fc86bae58d":{"description":"The API key is valid but does not have the required scope for this endpoint.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code.","uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable error message.","uniqueKey":"error.message","typeLabel":"string"},"details":{"type":"object","description":"Additional error context.","uniqueKey":"error.details","typeLabel":"object"}},"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"INSUFFICIENT_SCOPE","message":"Required scope missing: balance:read"}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"INSUFFICIENT_SCOPE","message":"Required scope missing: balance:read"}}}},"exampleType":"examples"}},"exampleType":"examples"},"34c1b10f-cbf8-4f00-ae67-a406de31fe6e":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"schema":{"type":"integer"},"description":"Request limit per window."},"X-RateLimit-Remaining":{"schema":{"type":"integer"},"description":"Remaining requests in window."},"X-RateLimit-Reset":{"schema":{"type":"integer"},"description":"Seconds until the window resets."}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code.","uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable error message.","uniqueKey":"error.message","typeLabel":"string"},"details":{"type":"object","description":"Additional error context.","uniqueKey":"error.details","typeLabel":"object"}},"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","message":"Too many requests"}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"RATE_LIMIT_EXCEEDED","message":"Too many requests"}}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"2137f48b-cc8e-489b-84f6-226ef7e46562":{"bearerAuth":{"type":"http","scheme":"bearer","description":"YuvexPay API key. Include as `Authorization: Bearer ypk_\u003cenv>_\u003ckid>_\u003csecret>` where `\u003cenv>` is `test` (sandbox) or `live` (production). Create and manage keys in the dashboard under **Settings > API Keys**.","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"30caf778-26b8-4811-87ad-19a2f5724d43":{"url":"https://api.yuvexpay.com","description":"Same base URL serves both sandbox and production. Send a `ypk_test_*` key for sandbox or a `ypk_live_*` key for production."}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"YuvexPay API key. Include as `Authorization: Bearer ypk_\u003cenv>_\u003ckid>_\u003csecret>` where `\u003cenv>` is `test` (sandbox) or `live` (production). Create and manage keys in the dashboard under **Settings > API Keys**.","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"YuvexPay API key. Include as `Authorization: Bearer ypk_\u003cenv>_\u003ckid>_\u003csecret>` where `\u003cenv>` is `test` (sandbox) or `live` (production). Create and manage keys in the dashboard under **Settings > API Keys**.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"yuvexpay","siteName":"YuvexPay","title":"Get account balance - YuvexPay","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-22T13:42:21.993Z","originalFileLocation":"api-reference/balance/get.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=\"Return the current BRL balance for the company associated with the API key. The endpoint takes no parameters — the company is always derived from the API key. The four balance buckets are independent and additive: available (settled funds free to use; a withdrawal is also bounded by GET /v1/withdrawals/limits), frozen (set aside for in-flight withdrawals, refunds, or operational holds — not currently withdrawable), held (confirmed but pending settlement), and reserved (a rolling reserve withheld from settled funds and released on a schedule — not currently withdrawable). The total account balance is available + frozen + held + reserved. A split credit received from another YuvexPay company follows your own rolling reserve policy, not the originating company\u0026#x27;s. A sandbox API key always returns zeros, since sandbox transactions do not accumulate to a real balance.\">\u003cmeta data-mint-head name=\"application-name\" content=\"YuvexPay\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/yuvexpay/qrsJ3VUJ-racyQUp/_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/yuvexpay/qrsJ3VUJ-racyQUp/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/yuvexpay/qrsJ3VUJ-racyQUp/_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/yuvexpay/qrsJ3VUJ-racyQUp/_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/yuvexpay/qrsJ3VUJ-racyQUp/_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/yuvexpay/qrsJ3VUJ-racyQUp/_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/yuvexpay/qrsJ3VUJ-racyQUp/_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/yuvexpay/qrsJ3VUJ-racyQUp/_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/yuvexpay/qrsJ3VUJ-racyQUp/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get account balance - YuvexPay\">\u003cmeta data-mint-head property=\"og:description\" content=\"Return the current BRL balance for the company associated with the API key. The endpoint takes no parameters — the company is always derived from the API key. The four balance buckets are independent and additive: available (settled funds free to use; a withdrawal is also bounded by GET /v1/withdrawals/limits), frozen (set aside for in-flight withdrawals, refunds, or operational holds — not currently withdrawable), held (confirmed but pending settlement), and reserved (a rolling reserve withheld from settled funds and released on a schedule — not currently withdrawable). The total account balance is available + frozen + held + reserved. A split credit received from another YuvexPay company follows your own rolling reserve policy, not the originating company\u0026#x27;s. A sandbox API key always returns zeros, since sandbox transactions do not accumulate to a real balance.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"YuvexPay\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.yuvexpay.com/api-reference/balance/get\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://yuvexpay.mintlify.app/_mintlify/api/og/v2?division=Balance\u0026amp;title=Get+account+balance\u0026amp;description=Return+the+current+BRL+balance+for+the+company+associated+with+the+API+key.+The+endpoint+takes+no+parameters+%E2%80%94+the+company+is+always+derived+from+the+API+key.+T\u0026amp;theme=e1bc7c37ec59feb92a55994b\u0026amp;signature=82b05fe6110f159362cf4d3708ed7b6689ae897822a5c92b2acc2bef7d81a503\">\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=\"Get account balance - YuvexPay\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Return the current BRL balance for the company associated with the API key. The endpoint takes no parameters — the company is always derived from the API key. The four balance buckets are independent and additive: available (settled funds free to use; a withdrawal is also bounded by GET /v1/withdrawals/limits), frozen (set aside for in-flight withdrawals, refunds, or operational holds — not currently withdrawable), held (confirmed but pending settlement), and reserved (a rolling reserve withheld from settled funds and released on a schedule — not currently withdrawable). The total account balance is available + frozen + held + reserved. A split credit received from another YuvexPay company follows your own rolling reserve policy, not the originating company\u0026#x27;s. A sandbox API key always returns zeros, since sandbox transactions do not accumulate to a real balance.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://yuvexpay.mintlify.app/_mintlify/api/og/v2?division=Balance\u0026amp;title=Get+account+balance\u0026amp;description=Return+the+current+BRL+balance+for+the+company+associated+with+the+API+key.+The+endpoint+takes+no+parameters+%E2%80%94+the+company+is+always+derived+from+the+API+key.+T\u0026amp;theme=e1bc7c37ec59feb92a55994b\u0026amp;signature=82b05fe6110f159362cf4d3708ed7b6689ae897822a5c92b2acc2bef7d81a503\">\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/yuvexpay/qrsJ3VUJ-racyQUp/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"YuvexPay\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#16A34A\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.yuvexpay.com/api-reference/balance/get\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/balance/get.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.yuvexpay.com/#organization\",\"name\":\"YuvexPay\",\"url\":\"https://docs.yuvexpay.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/yuvexpay/_p0fopc5ZJwqr6Ao/logo/light.png?fit=max\u0026auto=format\u0026n=_p0fopc5ZJwqr6Ao\u0026q=85\u0026s=85eb8014f41b3db8d62050d2ff2d17eb\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.yuvexpay.com#website\",\"name\":\"YuvexPay\",\"url\":\"https://docs.yuvexpay.com\",\"publisher\":{\"@id\":\"https://docs.yuvexpay.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.yuvexpay.com/api-reference/balance/get#webpage\",\"url\":\"https://docs.yuvexpay.com/api-reference/balance/get\",\"name\":\"Get account balance\",\"description\":\"Return the current BRL balance for the company associated with the API key. The endpoint takes no parameters — the company is always derived from the API key. The four balance buckets are independent and additive: available (settled funds free to use; a withdrawal is also bounded by GET /v1/withdrawals/limits), frozen (set aside for in-flight withdrawals, refunds, or operational holds — not currently withdrawable), held (confirmed but pending settlement), and reserved (a rolling reserve withheld from settled funds and released on a schedule — not currently withdrawable). The total account balance is available + frozen + held + reserved. A split credit received from another YuvexPay company follows your own rolling reserve policy, not the originating company's. A sandbox API key always returns zeros, since sandbox transactions do not accumulate to a real balance.\",\"dateModified\":\"2026-10-22T13:42:21.993Z\",\"isPartOf\":{\"@id\":\"https://docs.yuvexpay.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.yuvexpay.com/api-reference/balance/get#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.yuvexpay.com/api-reference/balance/get#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"YuvexPay\",\"item\":\"https://docs.yuvexpay.com\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get account balance\",\"item\":\"https://docs.yuvexpay.com/api-reference/balance/get\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.yuvexpay.com/api-reference/balance/get#apireference\",\"headline\":\"Get account balance\",\"name\":\"Get account balance\",\"description\":\"Return the current BRL balance for the company associated with the API key. The endpoint takes no parameters — the company is always derived from the API key. The four balance buckets are independent and additive: available (settled funds free to use; a withdrawal is also bounded by GET /v1/withdrawals/limits), frozen (set aside for in-flight withdrawals, refunds, or operational holds — not currently withdrawable), held (confirmed but pending settlement), and reserved (a rolling reserve withheld from settled funds and released on a schedule — not currently withdrawable). The total account balance is available + frozen + held + reserved. A split credit received from another YuvexPay company follows your own rolling reserve policy, not the originating company's. A sandbox API key always returns zeros, since sandbox transactions do not accumulate to a real balance.\",\"url\":\"https://docs.yuvexpay.com/api-reference/balance/get\",\"mainEntityOfPage\":{\"@id\":\"https://docs.yuvexpay.com/api-reference/balance/get#webpage\"},\"dateModified\":\"2026-10-22T13:42:21.993Z\",\"publisher\":{\"@id\":\"https://docs.yuvexpay.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.yuvexpay.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"YuvexPay\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"YuvexPay","nav":{"global":{"anchors":[{"anchor":"Dashboard","icon":"gauge","href":"https://app.yuvexpay.com"},{"anchor":"API status","icon":"signal","href":"https://status.yuvexpay.com"}]},"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":""}]},{"tab":"API reference","groups":[{"group":"Overview","pages":[{"title":"API reference","href":"/api-reference/introduction"}]},{"group":"Authentication","pages":[{"title":"Inspect the current API key","openapi":"GET /v1/auth/self","href":"/api-reference/auth/self"}]},{"group":"Payments","pages":[{"title":"Create a payment","openapi":"POST /v1/payments","href":"/api-reference/payments/create"},{"title":"List payments","openapi":"GET /v1/payments","href":"/api-reference/payments/list"},{"title":"Get a payment","openapi":"GET /v1/payments/{paymentId}","href":"/api-reference/payments/get"},{"title":"Get a payment by transaction ID","openapi":"GET /v1/payments/txid/{txId}","href":"/api-reference/payments/get-by-txid"},{"title":"Download boleto PDF","openapi":"GET /v1/payments/{paymentId}/boleto","href":"/api-reference/payments/get-boleto"},{"title":"Refund a payment","openapi":"POST /v1/payments/{paymentId}/refund","href":"/api-reference/payments/refund"},{"title":"List payment refunds","openapi":"GET /v1/payments/{paymentId}/refunds","href":"/api-reference/payments/list-refunds"},{"title":"Simulate a payment","openapi":"POST /v1/payments/{paymentId}/simulate","href":"/api-reference/payments/simulate"}]},{"group":"Withdrawals","pages":[{"title":"Create a withdrawal","openapi":"POST /v1/withdrawals","href":"/api-reference/withdrawals/create"},{"title":"List withdrawals","openapi":"GET /v1/withdrawals","href":"/api-reference/withdrawals/list"},{"title":"Get a withdrawal","openapi":"GET /v1/withdrawals/{withdrawalId}","href":"/api-reference/withdrawals/get"},{"title":"Get withdrawal limits","openapi":"GET /v1/withdrawals/limits","description":"Retrieve your current withdrawal limits, usage and fee. A reduced \"nightly\" limit applies outside the `dayStartHour`–`dayEndHour` window (BRT); `isNightTime` tells you which one `currentLimit` currently reflects. Day and night share one `used` counter for the whole Brazilian calendar day.","href":"/api-reference/withdrawals/limits"}]},{"group":"Balance","pages":[{"title":"Get account balance","openapi":"GET /v1/balance","href":"/api-reference/balance/get"}]},{"group":"Splits","pages":[{"title":"List split partners","openapi":"GET /v1/splits/partners","description":"Return the companies your account may split payments with, in both directions, for the environment of the API key. A pair is created in the dashboard: the originating company invites the recipient by company ID and the recipient accepts. There is no API to invite, accept, decline or revoke — accepting is a human act. The one exception is an approved split platform, which connects a seller on the seller's first payment by sending `X-Split-Platform-Key` on `POST /v1/payments`, in production and in sandbox. Use this endpoint to discover which `companyId` values you may send as `recipientCompanyId` in `splits[]`: only a partner whose `status` is `ACCEPTED` is usable. The list carries the live row for each pair, plus the most recent answered row for a pair that has no live one, so a rejected or revoked pair is still visible. Every partner is returned in one response, newest first, unless `limit` is sent: then at most `limit` relationships are read per call, a page can carry fewer partners than `limit`, and you pass `nextCursor` back as `cursor` until it is `null`. Requires the `payments:read` scope.","href":"/api-reference/splits/partners"}]},{"group":"Products","pages":[{"title":"Create a product","openapi":"POST /v1/products","href":"/api-reference/products/create"},{"title":"List products","openapi":"GET /v1/products","href":"/api-reference/products/list"},{"title":"Get a product","openapi":"GET /v1/products/{productId}","href":"/api-reference/products/get"},{"title":"Get a product by external ID","openapi":"GET /v1/products/external/{externalId}","href":"/api-reference/products/get-by-external-id"},{"title":"Update a product","openapi":"PATCH /v1/products/{productId}","href":"/api-reference/products/update"},{"title":"Delete a product","openapi":"DELETE /v1/products/{productId}","href":"/api-reference/products/delete"},{"title":"Upload product image","openapi":"POST /v1/products/{productId}/image","href":"/api-reference/products/upload-image"},{"title":"Delete product image","openapi":"DELETE /v1/products/{productId}/image","href":"/api-reference/products/delete-image"}]},{"group":"Customers","pages":[{"title":"Create a customer","openapi":"POST /v1/customers","href":"/api-reference/customers/create"},{"title":"List customers","openapi":"GET /v1/customers","href":"/api-reference/customers/list"},{"title":"Get a customer","openapi":"GET /v1/customers/{customerId}","href":"/api-reference/customers/get"},{"title":"Update a customer","openapi":"PATCH /v1/customers/{customerId}","href":"/api-reference/customers/update"},{"title":"Delete a customer","openapi":"DELETE /v1/customers/{customerId}","href":"/api-reference/customers/delete"}]},{"group":"Documents","pages":[{"title":"Get payment receipt","openapi":"GET /v1/documents/payments/{paymentId}/receipt","href":"/api-reference/documents/payment-receipt"},{"title":"Get withdrawal receipt","openapi":"GET /v1/documents/withdrawals/{withdrawalId}/receipt","href":"/api-reference/documents/withdrawal-receipt"},{"title":"Get account statement","openapi":"GET /v1/documents/statements","href":"/api-reference/documents/statement"}]},{"group":"Public","pages":[{"title":"Get standard pricing","openapi":"GET /public/pricing","href":"/api-reference/public/pricing"}]}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/changelog"}]}]},"basePath":"","title":"Get account balance - YuvexPay","buildId":"dpl_G9nrg4qeJSZtah1Ziwbc2n6WkLch","deploymentId":"dpl_G9nrg4qeJSZtah1Ziwbc2n6WkLch","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-B7XKH4J3.js","utils-lOYzL7z-.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DF6jUUIM.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Dpsj5f7C.js","snippetPresets-CYeiDe8v.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CUFz1YZ_.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-D8H_iLS4.js","shallow-DdluZBHX.js","getApiPlaygroundDisplay-B9922vev.js","CodeSnippet-CMoRNGYs.js","CodeSnippets-DwyrPHuw.js","Page-DSVu9Ucl.js","getPastedJson-G-zIvlHh.js","icon-B03fnEy0.js","MethodPill-CW7teklc.js","DuplicateIcon-CtO8eekd.js","createIcon-DZTKdM_A.js","DynamicMarkdown-D5M2At0B.js","SectionHeading-C_2NaA2U.js","axios-vUo_bRtp.js","Markdown-D7QRHV3m.js","clsx-D1Z-ELXV.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-lvhuD9Du.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-CKfC4ywL.js"]}