Currency code of your deposit account. If not provided, the default value will be DRE.Allowed values: USD, AUD, EUR, GBP, BRL, CAD, CHFExample: BRL
string
ID of your recipientExample: 12
Response
This status is returned in the following scenarios:
The search was successful
When the currency is incorrectly provided, the return will have this status with zeroed values
When the merchant has no accounts, the return will have this status with zeroed values
number
Example: 12000
number
Example: 10000
number
Example: 0
number or null
This field will only be different from null when the account is configured to receive fees in a wallet. Other than in this case, the balance of the other fee account(wallet) that will receive the fees is returned.Default: nullExample: 100
Cache Balance Data: Balance information doesn’t change frequently. Consider caching the response for a short period (e.g., 1-5 minutes) to reduce API calls.
Check Available Balance: Always use available_balance rather than balance when determining if funds are available for transactions, as balance includes reserved amounts.
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"WEpayments API","colors":{"primary":"#0070F3","light":"#3B82F6","dark":"#1E40AF"},"logo":{"light":"https://mintcdn.com/wepayments/GK7WnsFFvtF-KM57/logo/light.png?fit=max\u0026auto=format\u0026n=GK7WnsFFvtF-KM57\u0026q=85\u0026s=7fc96daf3fce22b28043ddd60dc04dab","dark":"https://mintcdn.com/wepayments/GK7WnsFFvtF-KM57/logo/dark.png?fit=max\u0026auto=format\u0026n=GK7WnsFFvtF-KM57\u0026q=85\u0026s=7646399133c566139392d17a9aa3a598"},"favicon":"https://mintcdn.com/wepayments/GK7WnsFFvtF-KM57/favicon.png?fit=max\u0026auto=format\u0026n=GK7WnsFFvtF-KM57\u0026q=85\u0026s=9acc6fa7d8d2cb32974438376b9d611b","api":{"mdx":{"auth":{"method":"bearer"},"server":"https://api.sandbox.wepayout.com.br"}},"navbar":{"links":[{"href":"https://app.wepayout.co/#/dashboard","label":"Dashboard"},{"href":"https://wepayments.instatus.com/","label":"Status Page"}],"primary":{"type":"button","label":"Get API Key","href":"https://support.wepayments.com.br/support/legal/api-authentication"}},"footer":{"socials":{"linkedin":"https://linkedin.com/company/wepayments"}},"seo":{"metatags":{"canonical":"https://docs.wepayout.co"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","cursor","vscode"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"wepayments","hasAudioNarration":false,"actualSubdomain":"wepayments","customDomains":["docs.wepayout.co"],"gitSource":{"type":"gitlab","owner":"wepayout","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"projectId":75684596,"mountPath":"","label":"","_id":"6af6135da14da7b1b52dc27f"},"feedback":{"thumbs":true},"entitlements":{},"buildId":"6af6135da14da7b1b52dc284","clientVersion":"0.0.4177","searchFilterCounts":[{"language":"default","tag":"API Reference","count":71},{"language":"default","tag":"Payin","count":42},{"language":"default","tag":"Documentation","count":35},{"language":"default","tag":"Pix","count":28},{"language":"default","tag":"Payout","count":26},{"language":"default","tag":"Account","count":22},{"language":"default","tag":"Automatic Pix","count":16},{"language":"default","tag":"Markup","count":14},{"language":"default","tag":"Onboarding","count":11},{"language":"default","tag":"Webhooks","count":8}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":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":"custom-rbac-roles","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":"rbac-expansion","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":"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":"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":"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":"editor-metadata","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},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/account/get-balance","slug":"/api-reference/account/get-balance","pageMetadata":{"title":"Get Balance","api":"GET /v2/account/{merchantId}/balance","description":"Check the balance of all the accounts you have access to","href":"/api-reference/account/get-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: \"Check the balance of all the accounts you have access to\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={code:`code`,li:`li`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,ul:`ul`,..._provideComponents(),...props.components},{Accordion,AccordionGroup,CodeBlock,CodeGroup,Heading,Note,ParamField,ResponseField,Warning}=_components;if(!Accordion)_missingMdxReference(`Accordion`,true);if(!AccordionGroup)_missingMdxReference(`AccordionGroup`,true);if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!CodeGroup)_missingMdxReference(`CodeGroup`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Note)_missingMdxReference(`Note`,true);if(!ParamField)_missingMdxReference(`ParamField`,true);if(!ResponseField)_missingMdxReference(`ResponseField`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsx(Heading,{level:`2`,id:`path-parameters`,children:`Path Parameters`}),`\n`,_jsx(ParamField,{path:`merchantId`,type:`string`,required:true,id:`param-merchant-id`,children:_jsx(_components.p,{children:`Merchant ID`})}),`\n`,_jsx(Heading,{level:`2`,id:`query-parameters`,children:`Query Parameters`}),`\n`,_jsxs(ParamField,{query:`currency`,type:`string`,id:`param-currency`,children:[_jsx(_components.p,{children:`Currency code of your deposit account. If not provided, the default value will be DRE.`}),_jsxs(_components.p,{children:[`Allowed values: `,_jsx(_components.code,{children:`USD`}),`, `,_jsx(_components.code,{children:`AUD`}),`, `,_jsx(_components.code,{children:`EUR`}),`, `,_jsx(_components.code,{children:`GBP`}),`, `,_jsx(_components.code,{children:`BRL`}),`, `,_jsx(_components.code,{children:`CAD`}),`, `,_jsx(_components.code,{children:`CHF`})]}),_jsxs(_components.p,{children:[`Example: `,_jsx(_components.code,{children:`BRL`})]})]}),`\n`,_jsxs(ParamField,{query:`recipient_id`,type:`string`,id:`param-recipient-id`,children:[_jsx(_components.p,{children:`ID of your recipient`}),_jsxs(_components.p,{children:[`Example: `,_jsx(_components.code,{children:`12`})]})]}),`\n`,_jsx(Heading,{level:`2`,id:`response`,children:`Response`}),`\n`,_jsx(_components.p,{children:`This status is returned in the following scenarios:`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`The search was successful`}),`\n`,_jsx(_components.li,{children:`When the currency is incorrectly provided, the return will have this status with zeroed values`}),`\n`,_jsx(_components.li,{children:`When the merchant has no accounts, the return will have this status with zeroed values`}),`\n`]}),`\n`,_jsx(ResponseField,{name:`balance`,type:`number`,id:`param-balance`,children:_jsxs(_components.p,{children:[`Example: `,_jsx(_components.code,{children:`12000`})]})}),`\n`,_jsx(ResponseField,{name:`available_balance`,type:`number`,id:`param-available-balance`,children:_jsxs(_components.p,{children:[`Example: `,_jsx(_components.code,{children:`10000`})]})}),`\n`,_jsx(ResponseField,{name:`reserve_balance`,type:`number`,id:`param-reserve-balance`,children:_jsxs(_components.p,{children:[`Example: `,_jsx(_components.code,{children:`0`})]})}),`\n`,_jsxs(ResponseField,{name:`fee`,type:`number or null`,id:`param-fee`,children:[_jsx(_components.p,{children:`This field will only be different from null when the account is configured to receive fees in a wallet. Other than in this case, the balance of the other fee account(wallet) that will receive the fees is returned.`}),_jsxs(_components.p,{children:[`Default: `,_jsx(_components.code,{children:`null`})]}),_jsxs(_components.p,{children:[`Example: `,_jsx(_components.code,{children:`100`})]})]}),`\n`,_jsx(Heading,{level:`2`,id:`request-example`,children:`Request Example`}),`\n`,_jsx(CodeGroup,{children:_jsx(CodeBlock,{filename:`cURL`,numberOfLines:`4`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`4`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --request`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` GET`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --url`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 'https://api.sandbox.wepayout.com.br/v2/account/{merchantId}/balance'`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --header`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 'Accept: application/json'`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --header`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 'Authorization: Bearer {token}'`})]}),`\n`]})})})}),`\n`,`\n`,_jsx(Heading,{level:`2`,id:`response-fields`,children:`Response Fields`}),`\n`,_jsx(Heading,{level:`3`,id:`balance`,children:`balance`}),`\n`,_jsx(_components.p,{children:`The total balance in the account.`}),`\n`,_jsx(Heading,{level:`3`,id:`available_balance`,children:`available_balance`}),`\n`,_jsx(_components.p,{children:`The balance available for withdrawal or transactions.`}),`\n`,_jsx(Heading,{level:`3`,id:`reserve_balance`,children:`reserve_balance`}),`\n`,_jsx(_components.p,{children:`The amount held in reserve (if applicable).`}),`\n`,_jsx(Heading,{level:`3`,id:`fee`,children:`fee`}),`\n`,_jsx(_components.p,{children:`Fee balance (only applicable when the account is configured to receive fees in a wallet).`}),`\n`,_jsx(Heading,{level:`2`,id:`use-cases`,children:`Use Cases`}),`\n`,_jsxs(AccordionGroup,{children:[_jsxs(Accordion,{title:`Check Available Funds`,id:`check-available-funds`,children:[_jsx(_components.p,{children:`Before processing a transaction, check if the merchant has sufficient available balance:`}),_jsx(CodeBlock,{filename:``,numberOfLines:`6`,language:`javascript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`javascript`,children:_jsxs(_components.code,{language:`javascript`,numberOfLines:`6`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`const`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4FC1FF`},children:` balance`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:` =`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:` await`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:` getBalance`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`merchantId`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`);`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`if`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` (`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`balance`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`.`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`available_balance`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:` >=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` transactionAmount`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`) {`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:` // Proceed with transaction`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`} `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`else`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:` // Insufficient funds`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})})]}),_jsxs(Accordion,{title:`Multi-Currency Balance`,id:`multi-currency-balance`,children:[_jsx(_components.p,{children:`Check balances across different currencies:`}),_jsx(CodeBlock,{filename:``,numberOfLines:`6`,language:`javascript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`javascript`,children:_jsxs(_components.code,{language:`javascript`,numberOfLines:`6`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`const`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4FC1FF`},children:` currencies`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:` =`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` [`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'USD'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'BRL'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'EUR'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`];`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`const`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4FC1FF`},children:` balances`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:` =`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:` await`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4EC9B0`},children:` Promise`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`.`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:`all`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` currencies`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`.`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:`map`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(`}),_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:`currency`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:` =>`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` `})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:` getBalance`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`merchantId`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, { `}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`currency`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` })`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` )`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`);`})}),`\n`]})})})]}),_jsxs(Accordion,{title:`Monitor Reserve Balance`,id:`monitor-reserve-balance`,children:[_jsx(_components.p,{children:`Track the reserve balance to ensure compliance with reserve requirements:`}),_jsx(CodeBlock,{filename:``,numberOfLines:`4`,language:`javascript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`javascript`,children:_jsxs(_components.code,{language:`javascript`,numberOfLines:`4`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`const`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4FC1FF`},children:` balance`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:` =`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:` await`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:` getBalance`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`merchantId`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`);`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`if`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` (`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`balance`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`.`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`reserve_balance`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:` \u003c`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` requiredReserve`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`) {`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:` // Alert: Reserve below threshold`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})})]})]}),`\n`,_jsx(Heading,{level:`2`,id:`error-handling`,children:`Error Handling`}),`\n`,_jsx(Heading,{level:`3`,id:`invalid-currency`,children:`Invalid Currency`}),`\n`,_jsx(_components.p,{children:`When an invalid currency is provided, the API returns a 200 status with zeroed values:`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`5`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`5`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"balance\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`0`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"available_balance\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`0`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"reserve_balance\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`0`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsx(Heading,{level:`3`,id:`no-accounts`,children:`No Accounts`}),`\n`,_jsx(_components.p,{children:`When the merchant has no accounts, the API returns a 200 status with zeroed values:`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`5`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`5`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"balance\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`0`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"available_balance\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`0`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"reserve_balance\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`0`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsx(Heading,{level:`2`,id:`best-practices`,children:`Best Practices`}),`\n`,_jsx(Note,{children:_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Cache Balance Data`}),`: Balance information doesn’t change frequently. Consider caching the response for a short period (e.g., 1-5 minutes) to reduce API calls.`]})}),`\n`,_jsx(Warning,{children:_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Check Available Balance`}),`: Always use `,_jsx(_components.code,{children:`available_balance`}),` rather than `,_jsx(_components.code,{children:`balance`}),` when determining if funds are available for transactions, as `,_jsx(_components.code,{children:`balance`}),` includes reserved amounts.`]})})]})}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":"Get Balance","api":"GET /v2/account/{merchantId}/balance","description":"Check the balance of all the accounts you have access to","href":"/api-reference/account/get-balance"}}},"mdxSourceWithNoJs":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={code:`code`,li:`li`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,ul:`ul`,..._provideComponents(),...props.components},{Accordion,AccordionGroup,CodeBlock,CodeGroup,Heading,Note,ParamField,ResponseExample,ResponseField,Warning}=_components;if(!Accordion)_missingMdxReference(`Accordion`,true);if(!AccordionGroup)_missingMdxReference(`AccordionGroup`,true);if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!CodeGroup)_missingMdxReference(`CodeGroup`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Note)_missingMdxReference(`Note`,true);if(!ParamField)_missingMdxReference(`ParamField`,true);if(!ResponseExample)_missingMdxReference(`ResponseExample`,true);if(!ResponseField)_missingMdxReference(`ResponseField`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsx(Heading,{level:`2`,id:`path-parameters`,children:`Path Parameters`}),`\n`,_jsx(ParamField,{path:`merchantId`,type:`string`,required:true,id:`param-merchant-id`,children:_jsx(_components.p,{children:`Merchant ID`})}),`\n`,_jsx(Heading,{level:`2`,id:`query-parameters`,children:`Query Parameters`}),`\n`,_jsxs(ParamField,{query:`currency`,type:`string`,id:`param-currency`,children:[_jsx(_components.p,{children:`Currency code of your deposit account. If not provided, the default value will be DRE.`}),_jsxs(_components.p,{children:[`Allowed values: `,_jsx(_components.code,{children:`USD`}),`, `,_jsx(_components.code,{children:`AUD`}),`, `,_jsx(_components.code,{children:`EUR`}),`, `,_jsx(_components.code,{children:`GBP`}),`, `,_jsx(_components.code,{children:`BRL`}),`, `,_jsx(_components.code,{children:`CAD`}),`, `,_jsx(_components.code,{children:`CHF`})]}),_jsxs(_components.p,{children:[`Example: `,_jsx(_components.code,{children:`BRL`})]})]}),`\n`,_jsxs(ParamField,{query:`recipient_id`,type:`string`,id:`param-recipient-id`,children:[_jsx(_components.p,{children:`ID of your recipient`}),_jsxs(_components.p,{children:[`Example: `,_jsx(_components.code,{children:`12`})]})]}),`\n`,_jsx(Heading,{level:`2`,id:`response`,children:`Response`}),`\n`,_jsx(_components.p,{children:`This status is returned in the following scenarios:`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`The search was successful`}),`\n`,_jsx(_components.li,{children:`When the currency is incorrectly provided, the return will have this status with zeroed values`}),`\n`,_jsx(_components.li,{children:`When the merchant has no accounts, the return will have this status with zeroed values`}),`\n`]}),`\n`,_jsx(ResponseField,{name:`balance`,type:`number`,id:`param-balance`,children:_jsxs(_components.p,{children:[`Example: `,_jsx(_components.code,{children:`12000`})]})}),`\n`,_jsx(ResponseField,{name:`available_balance`,type:`number`,id:`param-available-balance`,children:_jsxs(_components.p,{children:[`Example: `,_jsx(_components.code,{children:`10000`})]})}),`\n`,_jsx(ResponseField,{name:`reserve_balance`,type:`number`,id:`param-reserve-balance`,children:_jsxs(_components.p,{children:[`Example: `,_jsx(_components.code,{children:`0`})]})}),`\n`,_jsxs(ResponseField,{name:`fee`,type:`number or null`,id:`param-fee`,children:[_jsx(_components.p,{children:`This field will only be different from null when the account is configured to receive fees in a wallet. Other than in this case, the balance of the other fee account(wallet) that will receive the fees is returned.`}),_jsxs(_components.p,{children:[`Default: `,_jsx(_components.code,{children:`null`})]}),_jsxs(_components.p,{children:[`Example: `,_jsx(_components.code,{children:`100`})]})]}),`\n`,_jsx(Heading,{level:`2`,id:`request-example`,children:`Request Example`}),`\n`,_jsx(CodeGroup,{children:_jsx(CodeBlock,{filename:`cURL`,numberOfLines:`4`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`4`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --request`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` GET`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --url`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 'https://api.sandbox.wepayout.com.br/v2/account/{merchantId}/balance'`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --header`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 'Accept: application/json'`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --header`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 'Authorization: Bearer {token}'`})]}),`\n`]})})})}),`\n`,_jsxs(ResponseExample,{children:[_jsx(CodeBlock,{filename:`200 OK`,numberOfLines:`5`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`5`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"balance\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`10000`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"available_balance\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`10000`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"reserve_balance\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`0`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),_jsx(CodeBlock,{filename:`500 Internal Server Error`,numberOfLines:`3`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`3`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"error\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Internal server error\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})})]}),`\n`,_jsx(Heading,{level:`2`,id:`response-fields`,children:`Response Fields`}),`\n`,_jsx(Heading,{level:`3`,id:`balance`,children:`balance`}),`\n`,_jsx(_components.p,{children:`The total balance in the account.`}),`\n`,_jsx(Heading,{level:`3`,id:`available_balance`,children:`available_balance`}),`\n`,_jsx(_components.p,{children:`The balance available for withdrawal or transactions.`}),`\n`,_jsx(Heading,{level:`3`,id:`reserve_balance`,children:`reserve_balance`}),`\n`,_jsx(_components.p,{children:`The amount held in reserve (if applicable).`}),`\n`,_jsx(Heading,{level:`3`,id:`fee`,children:`fee`}),`\n`,_jsx(_components.p,{children:`Fee balance (only applicable when the account is configured to receive fees in a wallet).`}),`\n`,_jsx(Heading,{level:`2`,id:`use-cases`,children:`Use Cases`}),`\n`,_jsxs(AccordionGroup,{children:[_jsxs(Accordion,{title:`Check Available Funds`,id:`check-available-funds`,children:[_jsx(_components.p,{children:`Before processing a transaction, check if the merchant has sufficient available balance:`}),_jsx(CodeBlock,{filename:``,numberOfLines:`6`,language:`javascript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`javascript`,children:_jsxs(_components.code,{language:`javascript`,numberOfLines:`6`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`const`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4FC1FF`},children:` balance`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:` =`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:` await`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:` getBalance`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`merchantId`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`);`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`if`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` (`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`balance`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`.`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`available_balance`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:` >=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` transactionAmount`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`) {`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:` // Proceed with transaction`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`} `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`else`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:` // Insufficient funds`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})})]}),_jsxs(Accordion,{title:`Multi-Currency Balance`,id:`multi-currency-balance`,children:[_jsx(_components.p,{children:`Check balances across different currencies:`}),_jsx(CodeBlock,{filename:``,numberOfLines:`6`,language:`javascript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`javascript`,children:_jsxs(_components.code,{language:`javascript`,numberOfLines:`6`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`const`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4FC1FF`},children:` currencies`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:` =`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` [`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'USD'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'BRL'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'EUR'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`];`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`const`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4FC1FF`},children:` balances`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:` =`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:` await`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4EC9B0`},children:` Promise`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`.`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:`all`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` currencies`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`.`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:`map`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(`}),_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:`currency`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:` =>`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` `})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:` getBalance`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`merchantId`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, { `}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`currency`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` })`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` )`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`);`})}),`\n`]})})})]}),_jsxs(Accordion,{title:`Monitor Reserve Balance`,id:`monitor-reserve-balance`,children:[_jsx(_components.p,{children:`Track the reserve balance to ensure compliance with reserve requirements:`}),_jsx(CodeBlock,{filename:``,numberOfLines:`4`,language:`javascript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`javascript`,children:_jsxs(_components.code,{language:`javascript`,numberOfLines:`4`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`const`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4FC1FF`},children:` balance`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:` =`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:` await`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:` getBalance`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`merchantId`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`);`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`if`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` (`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`balance`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`.`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`reserve_balance`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:` \u003c`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` requiredReserve`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`) {`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:` // Alert: Reserve below threshold`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})})]})]}),`\n`,_jsx(Heading,{level:`2`,id:`error-handling`,children:`Error Handling`}),`\n`,_jsx(Heading,{level:`3`,id:`invalid-currency`,children:`Invalid Currency`}),`\n`,_jsx(_components.p,{children:`When an invalid currency is provided, the API returns a 200 status with zeroed values:`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`5`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`5`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"balance\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`0`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"available_balance\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`0`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"reserve_balance\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`0`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsx(Heading,{level:`3`,id:`no-accounts`,children:`No Accounts`}),`\n`,_jsx(_components.p,{children:`When the merchant has no accounts, the API returns a 200 status with zeroed values:`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`5`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`5`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"balance\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`0`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"available_balance\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`0`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"reserve_balance\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`0`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsx(Heading,{level:`2`,id:`best-practices`,children:`Best Practices`}),`\n`,_jsx(Note,{children:_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Cache Balance Data`}),`: Balance information doesn’t change frequently. Consider caching the response for a short period (e.g., 1-5 minutes) to reduce API calls.`]})}),`\n`,_jsx(Warning,{children:_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Check Available Balance`}),`: Always use `,_jsx(_components.code,{children:`available_balance`}),` rather than `,_jsx(_components.code,{children:`balance`}),` when determining if funds are available for transactions, as `,_jsx(_components.code,{children:`balance`}),` includes reserved amounts.`]})})]})}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":"Get Balance","api":"GET /v2/account/{merchantId}/balance","description":"Check the balance of all the accounts you have access to","href":"/api-reference/account/get-balance"}}}},"mdxExtracts":{"tableOfContents":[{"title":"Path Parameters","slug":"path-parameters","depth":2,"children":[]},{"title":"Query Parameters","slug":"query-parameters","depth":2,"children":[]},{"title":"Response","slug":"response","depth":2,"children":[]},{"title":"Request Example","slug":"request-example","depth":2,"children":[]},{"title":"Response Fields","slug":"response-fields","depth":2,"children":[{"title":"balance","slug":"balance","depth":3,"children":[]},{"title":"available_balance","slug":"available_balance","depth":3,"children":[]},{"title":"reserve_balance","slug":"reserve_balance","depth":3,"children":[]},{"title":"fee","slug":"fee","depth":3,"children":[]}]},{"title":"Use Cases","slug":"use-cases","depth":2,"children":[]},{"title":"Error Handling","slug":"error-handling","depth":2,"children":[{"title":"Invalid Currency","slug":"invalid-currency","depth":3,"children":[]},{"title":"No Accounts","slug":"no-accounts","depth":3,"children":[]}]},{"title":"Best Practices","slug":"best-practices","depth":2,"children":[]}],"codeExamples":{"response":{"type":"ResponseExample","children":[{"filename":"200 OK","html":"\u003cpre class=\"shiki shiki-themes github-light-default dark-plus\" style=\"background-color:#ffffff;--shiki-dark-bg:#0B0C0E;color:#1f2328;--shiki-dark:#D4D4D4\" language=\"json\">\u003ccode language=\"json\" numberOfLines=\"5\">\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">{\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"balance\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#B5CEA8\">10000\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"available_balance\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#B5CEA8\">10000\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"reserve_balance\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#B5CEA8\">0\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">}\u003c/span>\u003c/span>\n\u003c/code>\u003c/pre>"},{"filename":"500 Internal Server Error","html":"\u003cpre class=\"shiki shiki-themes github-light-default dark-plus\" style=\"background-color:#ffffff;--shiki-dark-bg:#0B0C0E;color:#1f2328;--shiki-dark:#D4D4D4\" language=\"json\">\u003ccode language=\"json\" numberOfLines=\"3\">\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">{\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"error\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"Internal server error\"\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">}\u003c/span>\u003c/span>\n\u003c/code>\u003c/pre>"}],"attributes":[]}},"endpoint":{"title":"Get Balance","path":"/v2/account/{merchantId}/balance","servers":[{"url":"https://api.sandbox.wepayout.com.br"}],"method":"get","request":{"security":[{"title":"Bearer Auth","parameters":{"header":{"Authorization":{"type":"http","scheme":"bearer","description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token."}},"query":{},"cookie":{}}}],"parameters":{"query":{"currency":{"schema":[{"type":"string","description":"Currency code of your deposit account. If not provided, the default value will be DRE. Allowed values: `USD` , `AUD` , `EUR` , `GBP` , `BRL` , `CAD` , `CHF` Example: `BRL`"}]},"recipient_id":{"schema":[{"type":"string","description":"ID of your recipient Example: `12`"}]}},"header":{},"cookie":{},"path":{"merchantId":{"schema":[{"type":"string","description":"Merchant ID","required":true}]}}},"body":{}},"response":{"200":{"application/json":{"schemaArray":[{"type":"object","properties":{"balance":[{"type":"number","description":"Example: `12000`"}],"available_balance":[{"type":"number","description":"Example: `10000`"}],"reserve_balance":[{"type":"number","description":"Example: `0`"}],"fee":[{"type":"object","properties":{},"description":"This field will only be different from null when the account is configured to receive fees in a wallet. Other than in this case, the balance of the other fee account(wallet) that will receive the fees is returned. Default: `null` Example: `100`"}]}}],"examples":{"example":{"value":{"balance":123,"available_balance":123,"reserve_balance":123,"fee":{}}}}}}},"deprecated":false}},"jsLinks":[],"subdomain":"wepayments","siteName":"WEpayments API","title":"Get Balance - WEpayments API","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-02-13T18:17:12.090Z","originalFileLocation":"api-reference/account/get-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=\"Check the balance of all the accounts you have access to\">\u003cmeta data-mint-head name=\"application-name\" content=\"WEpayments API\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/wepayments/qGQxngX3buQQZYlT/_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/wepayments/qGQxngX3buQQZYlT/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/wepayments/qGQxngX3buQQZYlT/_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/wepayments/qGQxngX3buQQZYlT/_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/wepayments/qGQxngX3buQQZYlT/_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/wepayments/qGQxngX3buQQZYlT/_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/wepayments/qGQxngX3buQQZYlT/_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/wepayments/qGQxngX3buQQZYlT/_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/wepayments/qGQxngX3buQQZYlT/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get Balance - WEpayments API\">\u003cmeta data-mint-head property=\"og:description\" content=\"Check the balance of all the accounts you have access to\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"WEpayments API\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.wepayout.co/api-reference/account/get-balance\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://wepayments.mintlify.site/_mintlify/api/og/v2?division=Account\u0026amp;title=Get+Balance\u0026amp;description=Check+the+balance+of+all+the+accounts+you+have+access+to\u0026amp;theme=454de0a85d45bbe4028f3e3f\u0026amp;signature=722648add3e859886ed2c1113b75b0e4556778399cbc3bc1843e91d2ffe372d7\">\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 Balance - WEpayments API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Check the balance of all the accounts you have access to\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://wepayments.mintlify.site/_mintlify/api/og/v2?division=Account\u0026amp;title=Get+Balance\u0026amp;description=Check+the+balance+of+all+the+accounts+you+have+access+to\u0026amp;theme=454de0a85d45bbe4028f3e3f\u0026amp;signature=722648add3e859886ed2c1113b75b0e4556778399cbc3bc1843e91d2ffe372d7\">\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/wepayments/qGQxngX3buQQZYlT/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"WEpayments API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0070F3\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.wepayout.co/api-reference/account/get-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/account/get-balance.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.wepayout.co/#organization\",\"name\":\"WEpayments API\",\"url\":\"https://docs.wepayout.co\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/wepayments/GK7WnsFFvtF-KM57/logo/light.png?fit=max\u0026auto=format\u0026n=GK7WnsFFvtF-KM57\u0026q=85\u0026s=7fc96daf3fce22b28043ddd60dc04dab\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.wepayout.co#website\",\"name\":\"WEpayments API\",\"url\":\"https://docs.wepayout.co\",\"publisher\":{\"@id\":\"https://docs.wepayout.co/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.wepayout.co/api-reference/account/get-balance#webpage\",\"url\":\"https://docs.wepayout.co/api-reference/account/get-balance\",\"name\":\"Get Balance\",\"description\":\"Check the balance of all the accounts you have access to\",\"dateModified\":\"2026-02-13T18:17:12.090Z\",\"isPartOf\":{\"@id\":\"https://docs.wepayout.co#website\"},\"breadcrumb\":{\"@id\":\"https://docs.wepayout.co/api-reference/account/get-balance#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.wepayout.co/api-reference/account/get-balance#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Account\",\"item\":\"https://docs.wepayout.co/api-reference/account/create\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get Balance\",\"item\":\"https://docs.wepayout.co/api-reference/account/get-balance\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.wepayout.co/api-reference/account/get-balance#apireference\",\"headline\":\"Get Balance\",\"name\":\"Get Balance\",\"description\":\"Check the balance of all the accounts you have access to\",\"url\":\"https://docs.wepayout.co/api-reference/account/get-balance\",\"mainEntityOfPage\":{\"@id\":\"https://docs.wepayout.co/api-reference/account/get-balance#webpage\"},\"dateModified\":\"2026-02-13T18:17:12.090Z\",\"publisher\":{\"@id\":\"https://docs.wepayout.co/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.wepayout.co#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"WEpayments API\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"WEpayments API\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/account/get-balance.md","siteName":"WEpayments API","nav":{"global":null,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/model-context-protocol"}]},{"tab":"API Reference","groups":[{"group":"Account","pages":[{"group":"Onboarding","pages":[{"title":"Account Opening Request","api":"POST https://api.sandbox.wepayout.com.br/v2/register/companies","href":"/api-reference/account/create"},{"title":"List Account Opening Requests","api":"GET /v2/register/companies","href":"/api-reference/account/list-accounts"},{"title":"Get Account Opening Request By ID","api":"GET /v2/register/companies/{id}","href":"/api-reference/account/get-account-by-id"},{"group":"Segments","pages":[{"title":"List Segments","api":"GET /v2/register/segments","href":"/api-reference/account/segments/list-segments"}]},{"group":"Webhook","pages":[{"title":"Setup","api":"POST /v2/register/companies/webhooks","href":"/api-reference/account/webhook/webhook-setup"},{"title":"Query","api":"GET /v2/register/companies/webhooks","href":"/api-reference/account/webhook/webhook-query"},{"title":"Update","api":"PUT /v2/register/companies/webhooks","href":"/api-reference/account/webhook/webhook-update"},{"title":"Remove","api":"DELETE /v2/register/companies/webhooks","href":"/api-reference/account/webhook/webhook-remove"}]},{"group":"Documents","pages":[{"title":"Upload Document","api":"POST /v2/register/companies/{uuid}/documents","href":"/api-reference/account/documents/upload-document"},{"title":"List Documents","api":"GET /v2/register/companies/{uuid}/documents","href":"/api-reference/account/documents/list-documents"}]},{"group":"Signature","pages":[{"title":"Get Signature Link","api":"GET /v2/register/companies/{uuid}/signature/link","href":"/api-reference/account/signature/signature-link"}]}]},{"group":"Pix Keys","pages":[{"title":"List Merchant Pix Keys","api":"GET /v2/register/pix-keys","description":"Consolidated list of the Pix keys of a merchant and its submerchants, with search filters and result counters. Read-only.","href":"/api-reference/account/pix-keys/list-pix-keys"}]},{"title":"Get Balance","api":"GET /v2/account/{merchantId}/balance","href":"/api-reference/account/get-balance"},{"title":"Get Balance Specific Day","api":"GET /v2/account/{merchantId}/balance/history","description":"Check what the account balance was on a specific day","href":"/api-reference/account/get-balance-specific-day"},{"title":"Get Statement","api":"GET /v2/account/{merchantId}/statement","href":"/api-reference/account/get-statement"},{"title":"Change Fee Target Account","api":"POST /v2/account/{merchantId}/fee-target","href":"/api-reference/account/change-fee-target"}]},{"group":"Banks","pages":[{"title":"List Institutions","api":"GET /v2/banks","href":"/api-reference/banks/list-institutions"}]},{"group":"Payin","pages":[{"group":"Pix","pages":[{"group":"Charge","pages":[{"title":"Create Charge (Pix)","api":"POST /v2/payin/payments","href":"/api-reference/cash-in/payin/create-charge-pix"},{"title":"List Charge","api":"GET /v2/payin/payments","href":"/api-reference/cash-in/payin/list-charge"},{"title":"Get Unique Charge","api":"GET /v2/payin/payments/{id}","href":"/api-reference/cash-in/payin/get-unique-charge"},{"title":"Cancel Charges","api":"DELETE /v2/payin/payments/request-multiple-cancel","href":"/api-reference/cash-in/payin/request-multiple-cancel"},{"title":"Cancel Charges by Period","api":"DELETE /v2/payin/payments/request-cancel-by-period","href":"/api-reference/cash-in/payin/cancel-by-period"}]},{"group":"Refund","pages":[{"title":"Create Refund","api":"POST /v2/payin/payments/payin-refund/{id}","href":"/api-reference/cash-in/refund/create-refund"},{"title":"Get Unique Refund","api":"GET /v1/payin/payments/payin-refund/{refundId}","href":"/api-reference/cash-in/refund/get-unique-refund"}]},{"group":"Webhooks","pages":[{"title":"Resend Payin Webhooks (Bulk)","api":"POST /v2/payin/notifications/resend","href":"/api-reference/cash-in/webhooks/resend-bulk"},{"title":"Resend Job Status","api":"GET /v2/payin/notifications/resend/{jobId}","href":"/api-reference/cash-in/webhooks/resend-bulk-status"}]},{"group":"Automatic Pix","pages":[{"group":"Authorizations","pages":[{"title":"Create Authorization","api":"POST /v2/payin/payments","href":"/api-reference/automatic-pix/authorizations/create"},{"title":"List Authorizations","api":"GET /v2/automatic-pix/authorizations","href":"/api-reference/automatic-pix/authorizations/list"},{"title":"Get Authorization","api":"GET /v2/automatic-pix/authorizations/{id}","href":"/api-reference/automatic-pix/authorizations/get"},{"title":"Update Authorization","api":"PATCH /v2/automatic-pix/authorizations/{id}","href":"/api-reference/automatic-pix/authorizations/update"},{"title":"Cancel Authorization","api":"DELETE /v2/automatic-pix/authorizations/{id}","href":"/api-reference/automatic-pix/authorizations/cancel"}]},{"group":"Schedules","pages":[{"title":"List Schedules","api":"GET /v2/automatic-pix/schedules","href":"/api-reference/automatic-pix/schedules/list"},{"title":"Get Schedule","api":"GET /v2/automatic-pix/schedules/{id}","href":"/api-reference/automatic-pix/schedules/get"},{"title":"Update Schedule","api":"PATCH /v2/automatic-pix/schedules/{id}","href":"/api-reference/automatic-pix/schedules/update"},{"title":"Cancel Schedule","api":"DELETE /v2/automatic-pix/schedules/{id}","href":"/api-reference/automatic-pix/schedules/cancel"}]},{"group":"Webhooks","pages":[{"title":"List Authorization History Webhooks","api":"GET /v2/automatic-pix/webhooks/authorization-history/{id}","href":"/api-reference/automatic-pix/webhooks/list-authorization-history"},{"title":"Resend Authorization Webhook","api":"POST /v2/automatic-pix/webhooks/authorization-history/{id}/resend","href":"/api-reference/automatic-pix/webhooks/resend-authorization-history"},{"title":"List Schedule Webhooks","api":"GET /v2/automatic-pix/webhooks/schedule/{id}","href":"/api-reference/automatic-pix/webhooks/list-schedule"},{"title":"Resend Schedule Webhook","api":"POST /v2/automatic-pix/webhooks/schedule/resend/{historyId}","href":"/api-reference/automatic-pix/webhooks/resend-schedule"}]}]}]},{"group":"Bank Slip","pages":[{"title":"Create Charge (Bank Slip)","api":"POST /v2/payin/payments","href":"/api-reference/cash-in/payin/create-charge-bank-slip"}]},{"group":"CreditCard","pages":[{"title":"Create Charge","api":"POST /v1/payin/payments/credit-card","href":"/api-reference/credit-card/create-charge"}]}]},{"group":"Payout","pages":[{"group":"Payout","pages":[{"title":"Create Payment","api":"POST /v2/payout/payments","href":"/api-reference/cash-out/payout/create-payment"},{"title":"List Payment","api":"GET /v2/payout/payments","href":"/api-reference/cash-out/payout/list-payment"},{"title":"Get Unique Payment","api":"GET /v2/payout/payments/{id}","href":"/api-reference/cash-out/payout/get-unique-payment"},{"title":"Create Transfer","api":"POST /v2/payout/transfers","href":"/api-reference/cash-out/payout/create-transfer"},{"title":"Decode QR Code","api":"POST /v2/payout/qrcode-decode","href":"/api-reference/cash-out/payout/decode-qr-code"}]},{"group":"Webhooks","pages":[{"title":"Resend Payout Webhooks (Bulk)","api":"POST /v2/payout/notifications/resend","href":"/api-reference/cash-out/webhooks/resend-bulk"},{"title":"Resend Job Status","api":"GET /v2/payout/notifications/resend/{jobId}","href":"/api-reference/cash-out/webhooks/resend-bulk-status"}]},{"group":"Data Qualification","pages":[{"title":"Get Data Qualification Services","api":"GET /v1/payout/data-qualification/services","href":"/api-reference/data-qualification/get-services"},{"title":"Create Data Qualification","api":"POST /v1/payout/data-qualification","href":"/api-reference/data-qualification/create-data-qualification"},{"title":"List Data Qualifications","api":"GET /v1/payout/data-qualification","href":"/api-reference/data-qualification/list-data-qualification"},{"title":"Get Data Qualification By ID","api":"GET /v1/payout/data-qualification/{id}","href":"/api-reference/data-qualification/get-by-id"},{"title":"Get Data Qualification Statuses","api":"GET /v1/payout/data-qualification/status","href":"/api-reference/data-qualification/get-status"},{"title":"Get Data Qualification By Custom Code","api":"GET /v1/payout/data-qualification/custom-code/{customCode}","href":"/api-reference/data-qualification/get-by-custom-code"}]}]},{"group":"KYC","pages":[{"title":"KYC Webhook","icon":"webhook","href":"/api-reference/kyc/webhook"},{"title":"List KYC","api":"GET /v1/kyc","href":"/api-reference/kyc/list-kyc"},{"title":"Get KYC By ID","api":"GET /v1/kyc/{id}","href":"/api-reference/kyc/get"},{"title":"Get KYC By Document","api":"POST /v1/kyc/document/{cpf_or_cnpj}","href":"/api-reference/kyc/get-by-document"},{"title":"Submit Document For KYC","api":"POST /v1/kyc/documents/{documentId}/update","href":"/api-reference/kyc/submit-document"}]},{"group":"Markup","pages":[{"group":"Account","pages":[{"title":"Create Merchant Markup Configuration","api":"POST https://api.sandbox.wepayout.com.br/v2/account/markup","href":"/api-reference/markup/account/create-merchant-markup"},{"title":"Update Merchant Markup Configuration","api":"PATCH https://api.sandbox.wepayout.com.br/v2/account/markup/{markupId}","href":"/api-reference/markup/account/update-merchant-markup"},{"title":"List Merchant Markups Configuration","api":"GET https://api.sandbox.wepayout.com.br/v2/account/markups","href":"/api-reference/markup/account/list-merchant-markups"}]},{"group":"Submerchant","pages":[{"title":"List Submerchant Markups","api":"GET https://api.sandbox.wepayout.com.br/v2/account/{merchantId}/submerchants/markups","href":"/api-reference/markup/submerchant/list-submerchant-markups"},{"title":"Get Submerchant Markup","api":"GET https://api.sandbox.wepayout.com.br/v2/account/{merchantId}/submerchants/{subMerchantId}/markups","href":"/api-reference/markup/submerchant/get-submerchant-markup"},{"title":"Configure Submerchant Markup","api":"PUT https://api.sandbox.wepayout.com.br/v2/account/{merchantId}/submerchants/{subMerchantId}/markups","href":"/api-reference/markup/submerchant/upsert-submerchant-markup"},{"title":"Remove Submerchant Markup","api":"DELETE https://api.sandbox.wepayout.com.br/v2/account/{merchantId}/submerchants/{subMerchantId}/markups","href":"/api-reference/markup/submerchant/delete-submerchant-markup"},{"title":"Batch Apply Submerchant Markup","api":"POST https://api.sandbox.wepayout.com.br/v2/account/{merchantId}/submerchants/markups/batch","href":"/api-reference/markup/submerchant/batch-apply-submerchant-markup"}]},{"group":"Payin","pages":[{"title":"Create Payin with Inline Markup","api":"POST https://api.sandbox.wepayout.com.br/v2/payin/payments","href":"/api-reference/markup/payin/create-payin-with-inline-markup"},{"title":"Create Payin with Global Markup","api":"POST https://api.sandbox.wepayout.com.br/v2/payin/payments","href":"/api-reference/markup/payin/create-payin-with-global-markup"}]},{"group":"Payout","pages":[{"title":"Create Payout with Inline Markup","api":"POST https://api.sandbox.wepayout.com.br/v2/payout/payments","href":"/api-reference/markup/payout/create-payout-with-inline-markup"},{"title":"Create Payout with Global Markup","api":"POST https://api.sandbox.wepayout.com.br/v2/payout/payments","href":"/api-reference/markup/payout/create-payout-with-global-markup"}]}]}]}]},"basePath":"","title":"Get Balance - WEpayments API","deploymentId":"dpl_HhUetB7eHHDAmK9T1Teip38TgFx9","buildId":"dpl_HhUetB7eHHDAmK9T1Teip38TgFx9","dynamics":["c2aa737661","2b790eda92","b0f84f53ff"],"chunks":["OpenApiReferenceProvider-jJHA3WSo.js","utils-DbZn3Mjn.js","cloneDeep-CnBnaSyy.js","_Uint8Array-CMQtTgBR.js","isObject-FP1Yky1u.js","utils-Bl2DvzOJ.js","addUniqueKeysToSchema-BwOLo9p1.js","snippetPresets-BBiPpKa-.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-C0px4Tml.js","isEqual-zAyttAAO.js","usePlaygroundInputsStore-Dell6dGw.js","shallow-0VKqkSqN.js","getApiPlaygroundDisplay-CP_ctPEB.js","CodeSnippet-5L35ic0s.js","CodeSnippets-DOXbNhJw.js","Page-DRLI_2Ue.js","getPastedJson-VhzT9m2P.js","icon-CD8_AtCO.js","MethodPill-DGgOMftG.js","DuplicateIcon-DZ6A_EtN.js","createIcon-DUl4oM5f.js","DynamicMarkdown-BGHukeRM.js","SectionHeading-ChrEUs8u.js","axios-vUo_bRtp.js"]}