{
"status": "error",
"code": "FORBIDDEN",
"message": "Missing balances:read permission, balances service access or ownership of the selected business/profile."
}
{
"status": "error",
"code": "NOT_FOUND",
"message": "The selected profile or parent business was not found."
}
{
"status": "error",
"code": "FORBIDDEN",
"message": "Missing balances:read permission, balances service access or ownership of the selected business/profile."
}
{
"status": "error",
"code": "NOT_FOUND",
"message": "The selected profile or parent business was not found."
}
{
"status": "error",
"code": "PROVIDER_UNAVAILABLE",
"message": "An authoritative dependency is unavailable. No successful empty fallback is returned. Indicative rate-store failures use RATE_AUTHORITATIVE_STORE_UNAVAILABLE."
}
Required scope:balances:readRequires balances:read. Exact balances remain in their original currencies; USD values are indicative estimates, not a quote or permission to pay. valuationStatus=partial means some balances could not be valued: null totals are unavailable, not zero, and valuedSubtotalUsd covers only valued balances. Estimates cover the selected profile. payoutAllowance is shared by profiles belonging to the same business; it shows the per-payment cap, monthly usage, reservations, remaining allowance and reset time. Null limits mean unlimited; zero prevents new positive payouts when enforcementEnabled is true. enforcementEnabled tells you whether these USD limits are currently applied. Payment creation checks current balance, allowance and eligibility again. Responses use Cache-Control: private, no-store.
A user access token from sign-in. Send Authorization: Bearer followed by the token. Use this only on endpoints that list BearerAuth.
Headers
X-Request-ID
string
x-ledig-business-id
string
The business whose balances you are authorised to view.
Pattern: ^[A-Za-z0-9][A-Za-z0-9_-]{0,199}$
x-ledig-acting-business-id
string
Your institution when acting for a managed business. It must match your credentials; use HMAC v2.
Pattern: ^[A-Za-z0-9][A-Za-z0-9_-]{0,199}$
x-ledig-profile-id
string
The profile whose balances you are authorised to view. Profiles in the same business share its payout allowance.
Pattern: ^[A-Za-z0-9][A-Za-z0-9_-]{0,199}$
Response
Your estimated USD balances and current payout allowance.
status
string
required
Allowed value: "success"
data
object
required
Show child attributes
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Ledig Payments","description":"Receive funds, manage balances, convert currencies and send payments with Ledig's payments API.","colors":{"primary":"#4361EE","light":"#4361EE","dark":"#8DA1FF"},"logo":{"light":"https://mintcdn.com/ledig/kOFkh89JDbhYVCSA/logo/light.svg?fit=max\u0026auto=format\u0026n=kOFkh89JDbhYVCSA\u0026q=85\u0026s=36e926371f686474be67796eb9056852","dark":"https://mintcdn.com/ledig/kOFkh89JDbhYVCSA/logo/dark.svg?fit=max\u0026auto=format\u0026n=kOFkh89JDbhYVCSA\u0026q=85\u0026s=eb4c8cbd824a8a1f030a02d846130873"},"favicon":"https://mintcdn.com/ledig/kOFkh89JDbhYVCSA/favicon.svg?fit=max\u0026auto=format\u0026n=kOFkh89JDbhYVCSA\u0026q=85\u0026s=75402fa9c148e3cf31e176f089455db8","api":{"playground":{"display":"simple","proxy":false},"examples":{"autogenerate":false}},"navbar":{"links":[{"href":"mailto:support@ledig.io","label":"Support"},{"href":"https://www.ledig.io","label":"Website"}],"primary":{"type":"button","label":"Request access","href":"https://www.ledig.io/contact"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","cursor","vscode"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"ledig","hasAudioNarration":false,"actualSubdomain":"ledig","customDomains":[],"gitSource":{"type":"github","owner":"ledig-tech","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":"","_id":"6ad88f0730a73012893740ea"},"entitlements":{},"buildId":"6afb0709b31d8d74aeececda","clientVersion":"0.0.4270","searchFilterCounts":[{"language":"default","tag":"API reference","count":50},{"language":"default","tag":"Managed businesses","count":18},{"language":"default","tag":"Guides","count":16},{"language":"default","tag":"Build","count":7},{"language":"default","tag":"Deposit wallets","count":6},{"language":"default","tag":"Getting started","count":5},{"language":"default","tag":"Recipients","count":5},{"language":"default","tag":"Payment options","count":4},{"language":"default","tag":"Balances","count":3},{"language":"default","tag":"Currencies and rates","count":3}]},"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":"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":"site-roles","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":"control","enabled":true,"payload":{"type":"string","value":"control"},"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/balances/view-your-usd-balance-estimate-and-payout-allowance","slug":"/api-reference/balances/view-your-usd-balance-estimate-and-payout-allowance","pageMetadata":{"title":"View your USD balance estimate and payout allowance","description":"See estimated USD balances and your business's payout allowance.","deprecated":null,"version":null,"openapi":"/openapi/public.yaml get /v1/balances/summary","href":"/api-reference/balances/view-your-usd-balance-estimate-and-payout-allowance","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"See estimated USD balances and your business’s payout allowance.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={code:`code`,p:`p`,strong:`strong`,..._provideComponents(),...props.components};return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Required scope:`}),` `,_jsx(_components.code,{children:`balances:read`})]}),`\n`,_jsx(_components.p,{children:`Requires balances:read. Exact balances remain in their original currencies; USD values are indicative estimates, not a quote or permission to pay. valuationStatus=partial means some balances could not be valued: null totals are unavailable, not zero, and valuedSubtotalUsd covers only valued balances. Estimates cover the selected profile. payoutAllowance is shared by profiles belonging to the same business; it shows the per-payment cap, monthly usage, reservations, remaining allowance and reset time. Null limits mean unlimited; zero prevents new positive payouts when enforcementEnabled is true. enforcementEnabled tells you whether these USD limits are currently applied. Payment creation checks current balance, allowance and eligibility again. Responses use Cache-Control: private, no-store.`})]})}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":"View your USD balance estimate and payout allowance","description":"See estimated USD balances and your business's payout allowance.","deprecated":null,"version":null,"openapi":"/openapi/public.yaml get /v1/balances/summary","href":"/api-reference/balances/view-your-usd-balance-estimate-and-payout-allowance","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Balances"],"operationId":"getEstimatedUsdBalanceSummary","summary":"View your USD balance estimate and payout allowance","description":"See estimated USD balances and your business's payout allowance.","security":["ddf44ac8-8cf2-475c-b750-f012bf07f2c8","bc2e8ece-cca5-4bf2-998c-2fb379bbb126"],"parameters":["cc90cb20-3385-4bdd-b693-3dab85aed73d","8fe3b9a8-5fbc-407a-a9c9-d700106604f5","516d6551-a91e-4118-8ef9-60cf7deb6aef","276184d0-2402-41bb-b515-e7129064fc6a"],"responses":{"200":"970e7f5b-f2b9-4178-abfc-22e55db4d7b0","400":"2b37d984-393b-41e4-b838-e9089da414e8","401":"64b7fb0e-f544-4eff-a6b6-a9927f224cc5","403":"ecd97884-288a-4dc5-8ed6-b49a53aa1fa3","404":"a7bc7374-65ce-469c-9ca9-6178b64dd4c9","429":"963388c9-5040-45cd-ac4f-5fc15e441f73","500":"5adce339-8290-4816-967a-992e6a7a20a8","503":"e696cb45-ccdc-4949-b592-74a02cf4a700"},"x-scope":"balances:read","x-mint":{"content":"**Required scope:** `balances:read`\n\nRequires balances:read. Exact balances remain in their original currencies; USD values are indicative estimates, not a quote or permission to pay. valuationStatus=partial means some balances could not be valued: null totals are unavailable, not zero, and valuedSubtotalUsd covers only valued balances. Estimates cover the selected profile. payoutAllowance is shared by profiles belonging to the same business; it shows the per-payment cap, monthly usage, reservations, remaining allowance and reset time. Null limits mean unlimited; zero prevents new positive payouts when enforcementEnabled is true. enforcementEnabled tells you whether these USD limits are currently applied. Payment creation checks current balance, allowance and eligibility again. Responses use Cache-Control: private, no-store."},"x-codeSamples":[{"lang":"javascript","label":"Node.js","source":"import { createHmac } from \"node:crypto\";\n\n// Node.js 18+. Set credentials and resource values on your server.\nfunction required(name) {\n const value = process.env[name];\n if (!value) throw new Error(`Set ${name} before running this example.`);\n return value;\n}\n\nconst baseUrl = process.env.LEDIG_API_BASE_URL ?? \"https://api-sandbox.ledig.io\";\nconst method = \"GET\";\nconst path = `/v1/balances/summary`;\nconst pathWithQuery = path;\nconst rawBody = \"\";\nconst headers = { \"Accept\": \"application/json\" };\nconst timestamp = Math.floor(Date.now() / 1000).toString();\nconst payload = `${timestamp}.${method}.${pathWithQuery}.${rawBody}`;\nheaders[\"x-ledig-key\"] = required(\"LEDIG_API_KEY\");\nheaders[\"x-ledig-timestamp\"] = timestamp;\nheaders[\"x-ledig-signature\"] = \"v1=\" + createHmac(\"sha256\", required(\"LEDIG_API_SECRET\"))\n .update(payload).digest(\"base64\");\n\nconst response = await fetch(`${baseUrl}${pathWithQuery}`, {\n method,\n headers,\n});\nconst result = await response.json();\n// Use result in your application; do not log credentials or upload links.\nconsole.log(response.status);"}],"method":"get","type":"path","servers":["c1543be6-0781-4dcb-bc86-b1b22b949bd2","e6ca68e6-66bd-44af-bc94-74b08e2d343a"],"path":"/v1/balances/summary","baseUrlOptions":["https://api-sandbox.ledig.io","https://api.ledig.io"],"title":"View your USD balance estimate and payout allowance","codeSamples":[{"label":"Node.js","lang":"javascript","source":"import { createHmac } from \"node:crypto\";\n\n// Node.js 18+. Set credentials and resource values on your server.\nfunction required(name) {\n const value = process.env[name];\n if (!value) throw new Error(`Set ${name} before running this example.`);\n return value;\n}\n\nconst baseUrl = process.env.LEDIG_API_BASE_URL ?? \"https://api-sandbox.ledig.io\";\nconst method = \"GET\";\nconst path = `/v1/balances/summary`;\nconst pathWithQuery = path;\nconst rawBody = \"\";\nconst headers = { \"Accept\": \"application/json\" };\nconst timestamp = Math.floor(Date.now() / 1000).toString();\nconst payload = `${timestamp}.${method}.${pathWithQuery}.${rawBody}`;\nheaders[\"x-ledig-key\"] = required(\"LEDIG_API_KEY\");\nheaders[\"x-ledig-timestamp\"] = timestamp;\nheaders[\"x-ledig-signature\"] = \"v1=\" + createHmac(\"sha256\", required(\"LEDIG_API_SECRET\"))\n .update(payload).digest(\"base64\");\n\nconst response = await fetch(`${baseUrl}${pathWithQuery}`, {\n method,\n headers,\n});\nconst result = await response.json();\n// Use result in your application; do not log credentials or upload links.\nconsole.log(response.status);"}],"requiredOnlyExamples":false,"disableCodeSampleGeneration":true,"requestExampleType":"codeSamples","responseExampleType":"generated","disableProxy":true},"dependencies":{"parameters":{"cc90cb20-3385-4bdd-b693-3dab85aed73d":{"name":"X-Request-ID","in":"header","required":false,"schema":{"type":"string","isRequired":false,"uniqueKey":"","typeLabel":"string"}},"8fe3b9a8-5fbc-407a-a9c9-d700106604f5":{"name":"x-ledig-business-id","in":"header","required":false,"schema":{"type":"string","pattern":"^[A-Za-z0-9][A-Za-z0-9_-]{0,199}$","isRequired":false,"description":"The business whose balances you are authorised to view.","uniqueKey":"","typeLabel":"string"},"description":"The business whose balances you are authorised to view."},"516d6551-a91e-4118-8ef9-60cf7deb6aef":{"name":"x-ledig-acting-business-id","in":"header","required":false,"schema":{"type":"string","pattern":"^[A-Za-z0-9][A-Za-z0-9_-]{0,199}$","isRequired":false,"description":"Your institution when acting for a managed business. It must match your credentials; use HMAC v2.","uniqueKey":"","typeLabel":"string"},"description":"Your institution when acting for a managed business. It must match your credentials; use HMAC v2."},"276184d0-2402-41bb-b515-e7129064fc6a":{"name":"x-ledig-profile-id","in":"header","required":false,"schema":{"type":"string","pattern":"^[A-Za-z0-9][A-Za-z0-9_-]{0,199}$","isRequired":false,"description":"The profile whose balances you are authorised to view. Profiles in the same business share its payout allowance.","uniqueKey":"","typeLabel":"string"},"description":"The profile whose balances you are authorised to view. Profiles in the same business share its payout allowance."}},"responses":{"970e7f5b-f2b9-4178-abfc-22e55db4d7b0":{"description":"Your estimated USD balances and current payout allowance.","headers":{"Cache-Control":{"schema":{"type":"string","const":"private, no-store"}}},"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["status","data"],"properties":{"status":{"type":"string","const":"success","isRequired":true,"uniqueKey":"status","typeLabel":"string"},"data":{"type":"object","additionalProperties":false,"required":["profileId","valuationCurrency","estimated","asOf","balanceScope","valuationStatus","estimatedTotalUsd","estimatedAvailableUsd","estimatedReservedUsd","valuedSubtotalUsd","balances","payoutAllowance"],"properties":{"profileId":{"type":"string","pattern":"^[A-Za-z0-9][A-Za-z0-9_-]{0,199}$","isRequired":true,"uniqueKey":"data.profileId","typeLabel":"string"},"valuationCurrency":{"type":"string","const":"USD","isRequired":true,"uniqueKey":"data.valuationCurrency","typeLabel":"string"},"estimated":{"type":"boolean","const":true,"isRequired":true,"uniqueKey":"data.estimated","typeLabel":"boolean"},"asOf":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"data.asOf","typeLabel":"string\u003cdate-time>"},"balanceScope":{"type":"string","const":"profile","isRequired":true,"uniqueKey":"data.balanceScope","typeLabel":"string"},"valuationStatus":{"type":"string","enum":["complete","partial"],"isRequired":true,"uniqueKey":"data.valuationStatus","typeLabel":"enum\u003cstring>"},"estimatedTotalUsd":{"oneOf":[{"type":"string","description":"Signed estimated USD value, rounded to cents.","pattern":"^-?(?:0|[1-9]\\d*)(?:\\.\\d{1,2})?$","isRequired":true,"uniqueKey":"data.estimatedTotalUsd.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"data.estimatedTotalUsd.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.estimatedTotalUsd","typeLabel":"string | null"},"estimatedAvailableUsd":{"oneOf":[{"type":"string","description":"Signed estimated USD value, rounded to cents.","pattern":"^-?(?:0|[1-9]\\d*)(?:\\.\\d{1,2})?$","isRequired":true,"uniqueKey":"data.estimatedAvailableUsd.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"data.estimatedAvailableUsd.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.estimatedAvailableUsd","typeLabel":"string | null"},"estimatedReservedUsd":{"oneOf":[{"type":"string","description":"Signed estimated USD value, rounded to cents.","pattern":"^-?(?:0|[1-9]\\d*)(?:\\.\\d{1,2})?$","isRequired":true,"uniqueKey":"data.estimatedReservedUsd.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"data.estimatedReservedUsd.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.estimatedReservedUsd","typeLabel":"string | null"},"valuedSubtotalUsd":{"type":"object","additionalProperties":false,"required":["total","available","reserved"],"properties":{"total":{"type":"string","pattern":"^-?(?:0|[1-9]\\d*)(?:\\.\\d{1,2})?$","description":"Signed estimated USD value for balances that could be valued, rounded to cents.","isRequired":true,"uniqueKey":"data.valuedSubtotalUsd.total","typeLabel":"string"},"available":{"type":"string","pattern":"^-?(?:0|[1-9]\\d*)(?:\\.\\d{1,2})?$","description":"Signed estimated USD value for balances that could be valued, rounded to cents.","isRequired":true,"uniqueKey":"data.valuedSubtotalUsd.available","typeLabel":"string"},"reserved":{"type":"string","pattern":"^-?(?:0|[1-9]\\d*)(?:\\.\\d{1,2})?$","description":"Signed estimated USD value for balances that could be valued, rounded to cents.","isRequired":true,"uniqueKey":"data.valuedSubtotalUsd.reserved","typeLabel":"string"}},"isRequired":true,"uniqueKey":"data.valuedSubtotalUsd","typeLabel":"object"},"balances":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["currency","available","reserved","total","estimatedTotalUsd","estimatedAvailableUsd","estimatedReservedUsd","valuationStatus","rate"],"properties":{"currency":{"type":"string","pattern":"^[A-Z0-9]{2,12}$","isRequired":true,"uniqueKey":"data.balances.items.[INDEX].currency","typeLabel":"string"},"available":{"type":"string","pattern":"^-?(?:0|[1-9]\\d*)(?:\\.\\d{1,18})?$","description":"Exact balance decimal string. Negative balances remain negative in the estimate.","isRequired":true,"uniqueKey":"data.balances.items.[INDEX].available","typeLabel":"string"},"reserved":{"type":"string","pattern":"^-?(?:0|[1-9]\\d*)(?:\\.\\d{1,18})?$","description":"Exact balance decimal string. Negative balances remain negative in the estimate.","isRequired":true,"uniqueKey":"data.balances.items.[INDEX].reserved","typeLabel":"string"},"total":{"type":"string","pattern":"^-?(?:0|[1-9]\\d*)(?:\\.\\d{1,18})?$","description":"Exact balance decimal string. Negative balances remain negative in the estimate.","isRequired":true,"uniqueKey":"data.balances.items.[INDEX].total","typeLabel":"string"},"estimatedTotalUsd":{"oneOf":[{"type":"string","description":"Signed estimated USD value, rounded to cents.","pattern":"^-?(?:0|[1-9]\\d*)(?:\\.\\d{1,2})?$","isRequired":true,"uniqueKey":"data.balances.items.[INDEX].estimatedTotalUsd.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"data.balances.items.[INDEX].estimatedTotalUsd.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.balances.items.[INDEX].estimatedTotalUsd","typeLabel":"string | null"},"estimatedAvailableUsd":{"oneOf":[{"type":"string","description":"Signed estimated USD value, rounded to cents.","pattern":"^-?(?:0|[1-9]\\d*)(?:\\.\\d{1,2})?$","isRequired":true,"uniqueKey":"data.balances.items.[INDEX].estimatedAvailableUsd.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"data.balances.items.[INDEX].estimatedAvailableUsd.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.balances.items.[INDEX].estimatedAvailableUsd","typeLabel":"string | null"},"estimatedReservedUsd":{"oneOf":[{"type":"string","description":"Signed estimated USD value, rounded to cents.","pattern":"^-?(?:0|[1-9]\\d*)(?:\\.\\d{1,2})?$","isRequired":true,"uniqueKey":"data.balances.items.[INDEX].estimatedReservedUsd.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"data.balances.items.[INDEX].estimatedReservedUsd.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.balances.items.[INDEX].estimatedReservedUsd","typeLabel":"string | null"},"valuationStatus":{"type":"string","enum":["available","missing","stale","invalid","ambiguous"],"isRequired":true,"uniqueKey":"data.balances.items.[INDEX].valuationStatus","typeLabel":"enum\u003cstring>"},"rate":{"oneOf":[{"type":"object","required":["baseCurrency","quoteCurrency","bid","asOf","expiresAt"],"properties":{"baseCurrency":{"type":"string","const":"USD","isRequired":true,"uniqueKey":"data.balances.items.[INDEX].rate.oneOf.0.baseCurrency","typeLabel":"string"},"quoteCurrency":{"type":"string","pattern":"^[A-Z0-9]{2,12}$","isRequired":true,"uniqueKey":"data.balances.items.[INDEX].rate.oneOf.0.quoteCurrency","typeLabel":"string"},"bid":{"type":"string","pattern":"^(?!0(?:\\.0+)?$)(?:0|[1-9]\\d{0,39})(?:\\.\\d{1,18})?$","description":"An indicative bid for the returned baseCurrency/quoteCurrency pair, with up to 18 decimal places. Create a quote for an executable rate.","isRequired":true,"uniqueKey":"data.balances.items.[INDEX].rate.oneOf.0.bid","typeLabel":"string"},"asOf":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"data.balances.items.[INDEX].rate.oneOf.0.asOf","typeLabel":"string\u003cdate-time>"},"expiresAt":{"oneOf":[{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"data.balances.items.[INDEX].rate.oneOf.0.expiresAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","isRequired":true,"uniqueKey":"data.balances.items.[INDEX].rate.oneOf.0.expiresAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.balances.items.[INDEX].rate.oneOf.0.expiresAt","typeLabel":"string\u003cdate-time> | null"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"data.balances.items.[INDEX].rate.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"data.balances.items.[INDEX].rate.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.balances.items.[INDEX].rate","typeLabel":"object | null"}},"uniqueKey":"data.balances.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"data.balances","typeLabel":"object[]"},"payoutAllowance":{"type":"object","additionalProperties":false,"required":["scope","segment","transactionLimitUsd","monthlyLimitUsd","usedUsd","reservedUsd","remainingUsd","periodStart","resetsAt","timezone","enforcementEnabled"],"properties":{"scope":{"type":"string","const":"parent_business","isRequired":true,"uniqueKey":"data.payoutAllowance.scope","typeLabel":"string"},"segment":{"type":"string","enum":["standard","institutional"],"isRequired":true,"uniqueKey":"data.payoutAllowance.segment","typeLabel":"enum\u003cstring>"},"transactionLimitUsd":{"oneOf":[{"type":"string","description":"The USD principal cap per payment. Null means unlimited; zero prevents new positive payouts when enforcementEnabled is true.","pattern":"^(?:0|[1-9]\\d{0,27})(?:\\.\\d{1,2})?$","isRequired":true,"uniqueKey":"data.payoutAllowance.transactionLimitUsd.oneOf.0","typeLabel":"string"},{"type":"null","description":"The USD principal cap per payment. Null means unlimited; zero prevents new positive payouts when enforcementEnabled is true.","isRequired":true,"uniqueKey":"data.payoutAllowance.transactionLimitUsd.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.payoutAllowance.transactionLimitUsd","typeLabel":"string | null"},"monthlyLimitUsd":{"oneOf":[{"type":"string","description":"The monthly USD principal cap. Null means unlimited; zero prevents new positive payouts when enforcementEnabled is true.","pattern":"^(?:0|[1-9]\\d{0,27})(?:\\.\\d{1,2})?$","isRequired":true,"uniqueKey":"data.payoutAllowance.monthlyLimitUsd.oneOf.0","typeLabel":"string"},{"type":"null","description":"The monthly USD principal cap. Null means unlimited; zero prevents new positive payouts when enforcementEnabled is true.","isRequired":true,"uniqueKey":"data.payoutAllowance.monthlyLimitUsd.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.payoutAllowance.monthlyLimitUsd","typeLabel":"string | null"},"usedUsd":{"type":"string","pattern":"^(?:0|[1-9]\\d*)(?:\\.\\d{1,2})?$","description":"Exact nonnegative USD decimal string. Use decimal arithmetic for financial calculations.","isRequired":true,"uniqueKey":"data.payoutAllowance.usedUsd","typeLabel":"string"},"reservedUsd":{"type":"string","pattern":"^(?:0|[1-9]\\d*)(?:\\.\\d{1,2})?$","description":"Exact nonnegative USD decimal string. Use decimal arithmetic for financial calculations.","isRequired":true,"uniqueKey":"data.payoutAllowance.reservedUsd","typeLabel":"string"},"remainingUsd":{"oneOf":[{"type":"string","description":"Exact nonnegative USD decimal string. Use decimal arithmetic for financial calculations.","pattern":"^(?:0|[1-9]\\d*)(?:\\.\\d{1,2})?$","isRequired":true,"uniqueKey":"data.payoutAllowance.remainingUsd.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"data.payoutAllowance.remainingUsd.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.payoutAllowance.remainingUsd","typeLabel":"string | null"},"periodStart":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"data.payoutAllowance.periodStart","typeLabel":"string\u003cdate-time>"},"resetsAt":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"data.payoutAllowance.resetsAt","typeLabel":"string\u003cdate-time>"},"timezone":{"type":"string","const":"UTC","isRequired":true,"uniqueKey":"data.payoutAllowance.timezone","typeLabel":"string"},"enforcementEnabled":{"type":"boolean","description":"Whether these USD payout limits are currently applied when creating a payment.","isRequired":true,"uniqueKey":"data.payoutAllowance.enforcementEnabled","typeLabel":"boolean"}},"isRequired":true,"uniqueKey":"data.payoutAllowance","typeLabel":"object"}},"isRequired":true,"uniqueKey":"data","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"status":"success","data":{"profileId":"profile_example","valuationCurrency":"USD","estimated":true,"asOf":"2026-10-26T12:00:00.000Z","balanceScope":"profile","valuationStatus":"complete","estimatedTotalUsd":"1000.00","estimatedAvailableUsd":"900.00","estimatedReservedUsd":"100.00","valuedSubtotalUsd":{"total":"1000.00","available":"900.00","reserved":"100.00"},"balances":[{"currency":"NGN","available":"1350000","reserved":"150000","total":"1500000","estimatedTotalUsd":"1000.00","estimatedAvailableUsd":"900.00","estimatedReservedUsd":"100.00","valuationStatus":"available","rate":{"baseCurrency":"USD","quoteCurrency":"NGN","bid":"1500","asOf":"2026-10-26T11:59:00.000Z","expiresAt":"2026-10-26T12:04:00.000Z"}}],"payoutAllowance":{"scope":"parent_business","segment":"standard","transactionLimitUsd":"10000","monthlyLimitUsd":"100000","usedUsd":"20000","reservedUsd":"5000","remainingUsd":"75000","periodStart":"2026-10-01T00:00:00.000Z","resetsAt":"2026-11-01T00:00:00.000Z","timezone":"UTC","enforcementEnabled":false}}},"examples":{"Example":{"title":"Example","value":{"status":"success","data":{"profileId":"profile_example","valuationCurrency":"USD","estimated":true,"asOf":"2026-10-26T12:00:00.000Z","balanceScope":"profile","valuationStatus":"complete","estimatedTotalUsd":"1000.00","estimatedAvailableUsd":"900.00","estimatedReservedUsd":"100.00","valuedSubtotalUsd":{"total":"1000.00","available":"900.00","reserved":"100.00"},"balances":[{"currency":"NGN","available":"1350000","reserved":"150000","total":"1500000","estimatedTotalUsd":"1000.00","estimatedAvailableUsd":"900.00","estimatedReservedUsd":"100.00","valuationStatus":"available","rate":{"baseCurrency":"USD","quoteCurrency":"NGN","bid":"1500","asOf":"2026-10-26T11:59:00.000Z","expiresAt":"2026-10-26T12:04:00.000Z"}}],"payoutAllowance":{"scope":"parent_business","segment":"standard","transactionLimitUsd":"10000","monthlyLimitUsd":"100000","usedUsd":"20000","reservedUsd":"5000","remainingUsd":"75000","periodStart":"2026-10-01T00:00:00.000Z","resetsAt":"2026-11-01T00:00:00.000Z","timezone":"UTC","enforcementEnabled":false}}}}},"exampleType":"examples"}},"exampleType":"examples"},"2b37d984-393b-41e4-b838-e9089da414e8":{"description":"Invalid request, unknown query parameter or malformed identifier.","headers":{"Cache-Control":{"schema":{"type":"string","const":"private, no-store"}}},"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["status","code","message"],"properties":{"status":{"type":"string","const":"error","isRequired":true,"uniqueKey":"status","typeLabel":"string"},"code":{"type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"example":{"status":"error","code":"BAD_REQUEST","message":"Malformed request, unknown query parameter, invalid identifier, amount, version or justification."},"examples":{"Example":{"title":"Example","value":{"status":"error","code":"BAD_REQUEST","message":"Malformed request, unknown query parameter, invalid identifier, amount, version or justification."}}},"exampleType":"examples"}},"exampleType":"examples"},"64b7fb0e-f544-4eff-a6b6-a9927f224cc5":{"description":"Valid authentication is required.","headers":{"Cache-Control":{"schema":{"type":"string","const":"private, no-store"}}},"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["status","code","message"],"properties":{"status":{"type":"string","const":"error","isRequired":true,"uniqueKey":"status","typeLabel":"string"},"code":{"type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"example":{"status":"error","code":"UNAUTHORIZED","message":"Valid authentication is required."},"examples":{"Example":{"title":"Example","value":{"status":"error","code":"UNAUTHORIZED","message":"Valid authentication is required."}}},"exampleType":"examples"}},"exampleType":"examples"},"ecd97884-288a-4dc5-8ed6-b49a53aa1fa3":{"description":"Your credentials lack balances:read, balance access or permission to view this business or profile.","headers":{"Cache-Control":{"schema":{"type":"string","const":"private, no-store"}}},"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["status","code","message"],"properties":{"status":{"type":"string","const":"error","isRequired":true,"uniqueKey":"status","typeLabel":"string"},"code":{"type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"example":{"status":"error","code":"FORBIDDEN","message":"Missing balances:read permission, balances service access or ownership of the selected business/profile."},"examples":{"Example":{"title":"Example","value":{"status":"error","code":"FORBIDDEN","message":"Missing balances:read permission, balances service access or ownership of the selected business/profile."}}},"exampleType":"examples"}},"exampleType":"examples"},"a7bc7374-65ce-469c-9ca9-6178b64dd4c9":{"description":"The selected business or profile was not found.","headers":{"Cache-Control":{"schema":{"type":"string","const":"private, no-store"}}},"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["status","code","message"],"properties":{"status":{"type":"string","const":"error","isRequired":true,"uniqueKey":"status","typeLabel":"string"},"code":{"type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"example":{"status":"error","code":"NOT_FOUND","message":"The selected profile or parent business was not found."},"examples":{"Example":{"title":"Example","value":{"status":"error","code":"NOT_FOUND","message":"The selected profile or parent business was not found."}}},"exampleType":"examples"}},"exampleType":"examples"},"963388c9-5040-45cd-ac4f-5fc15e441f73":{"description":"Request allowance exhausted.","headers":{"Cache-Control":{"schema":{"type":"string","const":"private, no-store"}},"Retry-After":{"schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["status","code","message"],"properties":{"status":{"type":"string","const":"error","isRequired":true,"uniqueKey":"status","typeLabel":"string"},"code":{"type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"example":{"status":"error","code":"RATE_LIMITED","message":"Request allowance exhausted."},"examples":{"Example":{"title":"Example","value":{"status":"error","code":"RATE_LIMITED","message":"Request allowance exhausted."}}},"exampleType":"examples"}},"exampleType":"examples"},"5adce339-8290-4816-967a-992e6a7a20a8":{"description":"The balance summary could not be retrieved.","headers":{"Cache-Control":{"schema":{"type":"string","const":"private, no-store"}}},"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["status","code","message"],"properties":{"status":{"type":"string","const":"error","isRequired":true,"uniqueKey":"status","typeLabel":"string"},"code":{"type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"example":{"status":"error","code":"INTERNAL_ERROR","message":"An unexpected authoritative-store operation failed."},"examples":{"Example":{"title":"Example","value":{"status":"error","code":"INTERNAL_ERROR","message":"An unexpected authoritative-store operation failed."}}},"exampleType":"examples"}},"exampleType":"examples"},"e696cb45-ccdc-4949-b592-74a02cf4a700":{"description":"The balance summary is temporarily unavailable. RATE_AUTHORITATIVE_STORE_UNAVAILABLE means the indicative rates could not be retrieved; an outage does not mean your balance is zero.","headers":{"Cache-Control":{"schema":{"type":"string","const":"private, no-store"}}},"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["status","code","message"],"properties":{"status":{"type":"string","const":"error","isRequired":true,"uniqueKey":"status","typeLabel":"string"},"code":{"type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"example":{"status":"error","code":"PROVIDER_UNAVAILABLE","message":"An authoritative dependency is unavailable. No successful empty fallback is returned. Indicative rate-store failures use RATE_AUTHORITATIVE_STORE_UNAVAILABLE."},"examples":{"Example":{"title":"Example","value":{"status":"error","code":"PROVIDER_UNAVAILABLE","message":"An authoritative dependency is unavailable. No successful empty fallback is returned. Indicative rate-store failures use RATE_AUTHORITATIVE_STORE_UNAVAILABLE."}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"ddf44ac8-8cf2-475c-b750-f012bf07f2c8":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"A user access token from sign-in. Send Authorization: Bearer followed by the token. Use this only on endpoints that list BearerAuth.","scopes":[],"schemeName":"BearerAuth"}},"bc2e8ece-cca5-4bf2-998c-2fb379bbb126":{"LedigApiKey":{"type":"apiKey","in":"header","name":"x-ledig-key","description":"Your business API key ID. Keep its secret on your server and use that secret to sign each request.","scopes":[],"schemeName":"LedigApiKey"},"LedigTimestamp":{"type":"apiKey","in":"header","name":"x-ledig-timestamp","description":"The current Unix timestamp in seconds, used in the signed request.","scopes":[],"schemeName":"LedigTimestamp"},"LedigSignature":{"type":"apiKey","in":"header","name":"x-ledig-signature","description":"The request's HMAC-SHA256 signature. Use the v1= prefix for supported own-business requests, or v2= when acting for a managed business with signed business-selection headers. Follow the authentication guide to construct and sign the exact request.","scopes":[],"schemeName":"LedigSignature"}}},"servers":{"c1543be6-0781-4dcb-bc86-b1b22b949bd2":{"url":"https://api-sandbox.ledig.io","description":"Sandbox"},"e6ca68e6-66bd-44af-bc94-74b08e2d343a":{"url":"https://api.ledig.io","description":"Live"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"A user access token from sign-in. Send Authorization: Bearer followed by the token. Use this only on endpoints that list BearerAuth.","scopes":[],"schemeName":"BearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"A user access token from sign-in. Send Authorization: Bearer followed by the token. Use this only on endpoints that list BearerAuth.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"BearerAuth","name":"Authorization"}],"title":"BearerAuth"},{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"x-ledig-key","description":"Your business API key ID. Keep its secret on your server and use that secret to sign each request.","scopes":[],"schemeName":"LedigApiKey"},"schema":{"title":"x-ledig-key","type":"string","description":"Your business API key ID. Keep its secret on your server and use that secret to sign each request.","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"LedigApiKey","name":"x-ledig-key"},{"scheme":{"type":"apiKey","in":"header","name":"x-ledig-timestamp","description":"The current Unix timestamp in seconds, used in the signed request.","scopes":[],"schemeName":"LedigTimestamp"},"schema":{"title":"x-ledig-timestamp","type":"string","description":"The current Unix timestamp in seconds, used in the signed request.","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"LedigTimestamp","name":"x-ledig-timestamp"},{"scheme":{"type":"apiKey","in":"header","name":"x-ledig-signature","description":"The request's HMAC-SHA256 signature. Use the v1= prefix for supported own-business requests, or v2= when acting for a managed business with signed business-selection headers. Follow the authentication guide to construct and sign the exact request.","scopes":[],"schemeName":"LedigSignature"},"schema":{"title":"x-ledig-signature","type":"string","description":"The request's HMAC-SHA256 signature. Use the v1= prefix for supported own-business requests, or v2= when acting for a managed business with signed business-selection headers. Follow the authentication guide to construct and sign the exact request.","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"LedigSignature","name":"x-ledig-signature"}],"title":"LedigApiKey \u0026 LedigTimestamp \u0026 LedigSignature"}]},"originalFileLocation":"openapi/public.yaml"},"subdomain":"ledig","siteName":"Ledig Payments","title":"View your USD balance estimate and payout allowance - Ledig Payments","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-15T18:48:55.370Z","originalFileLocation":"api-reference/balances/view-your-usd-balance-estimate-and-payout-allowance.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=\"See estimated USD balances and your business\u0026#x27;s payout allowance.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Ledig Payments\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/ledig/ct3LOdcBUcKida3q/_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/ledig/ct3LOdcBUcKida3q/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/ledig/ct3LOdcBUcKida3q/_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/ledig/ct3LOdcBUcKida3q/_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/ledig/ct3LOdcBUcKida3q/_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/ledig/ct3LOdcBUcKida3q/_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/ledig/ct3LOdcBUcKida3q/_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/ledig/ct3LOdcBUcKida3q/_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/ledig/ct3LOdcBUcKida3q/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"View your USD balance estimate and payout allowance - Ledig Payments\">\u003cmeta data-mint-head property=\"og:description\" content=\"See estimated USD balances and your business\u0026#x27;s payout allowance.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Ledig Payments\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://ledig.mintlify.app/api-reference/balances/view-your-usd-balance-estimate-and-payout-allowance\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://ledig.mintlify.site/_mintlify/api/og/v2?division=Balances\u0026amp;title=View+your+USD+balance+estimate+and+payout+allowance\u0026amp;description=See+estimated+USD+balances+and+your+business%27s+payout+allowance.\u0026amp;theme=b3996c354e84ea128c07e7b6\u0026amp;signature=4cf7fa8a1e7aef0d3026f4e5b399516eb23c4a14eb015127c4d22f8258f63329\">\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=\"View your USD balance estimate and payout allowance - Ledig Payments\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"See estimated USD balances and your business\u0026#x27;s payout allowance.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://ledig.mintlify.site/_mintlify/api/og/v2?division=Balances\u0026amp;title=View+your+USD+balance+estimate+and+payout+allowance\u0026amp;description=See+estimated+USD+balances+and+your+business%27s+payout+allowance.\u0026amp;theme=b3996c354e84ea128c07e7b6\u0026amp;signature=4cf7fa8a1e7aef0d3026f4e5b399516eb23c4a14eb015127c4d22f8258f63329\">\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/ledig/ct3LOdcBUcKida3q/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Ledig Payments\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#4361EE\">\u003clink data-mint-head rel=\"canonical\" href=\"https://ledig.mintlify.app/api-reference/balances/view-your-usd-balance-estimate-and-payout-allowance\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/balances/view-your-usd-balance-estimate-and-payout-allowance.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://ledig.mintlify.app/#organization\",\"name\":\"Ledig Payments\",\"url\":\"https://ledig.mintlify.app\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/ledig/kOFkh89JDbhYVCSA/logo/light.svg?fit=max\u0026auto=format\u0026n=kOFkh89JDbhYVCSA\u0026q=85\u0026s=36e926371f686474be67796eb9056852\"}},{\"@type\":\"WebSite\",\"@id\":\"https://ledig.mintlify.app#website\",\"name\":\"Ledig Payments\",\"url\":\"https://ledig.mintlify.app\",\"publisher\":{\"@id\":\"https://ledig.mintlify.app/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://ledig.mintlify.app/api-reference/balances/view-your-usd-balance-estimate-and-payout-allowance#webpage\",\"url\":\"https://ledig.mintlify.app/api-reference/balances/view-your-usd-balance-estimate-and-payout-allowance\",\"name\":\"View your USD balance estimate and payout allowance\",\"description\":\"See estimated USD balances and your business's payout allowance.\",\"dateModified\":\"2026-11-15T18:48:55.370Z\",\"isPartOf\":{\"@id\":\"https://ledig.mintlify.app#website\"},\"breadcrumb\":{\"@id\":\"https://ledig.mintlify.app/api-reference/balances/view-your-usd-balance-estimate-and-payout-allowance#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://ledig.mintlify.app/api-reference/balances/view-your-usd-balance-estimate-and-payout-allowance#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Balances\",\"item\":\"https://ledig.mintlify.app/api-reference/balances/view-your-balances\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"View your USD balance estimate and payout allowance\",\"item\":\"https://ledig.mintlify.app/api-reference/balances/view-your-usd-balance-estimate-and-payout-allowance\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://ledig.mintlify.app/api-reference/balances/view-your-usd-balance-estimate-and-payout-allowance#apireference\",\"headline\":\"View your USD balance estimate and payout allowance\",\"name\":\"View your USD balance estimate and payout allowance\",\"description\":\"See estimated USD balances and your business's payout allowance.\",\"url\":\"https://ledig.mintlify.app/api-reference/balances/view-your-usd-balance-estimate-and-payout-allowance\",\"mainEntityOfPage\":{\"@id\":\"https://ledig.mintlify.app/api-reference/balances/view-your-usd-balance-estimate-and-payout-allowance#webpage\"},\"dateModified\":\"2026-11-15T18:48:55.370Z\",\"publisher\":{\"@id\":\"https://ledig.mintlify.app/#organization\"},\"isPartOf\":{\"@id\":\"https://ledig.mintlify.app#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Ledig Payments\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Ledig Payments\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/balances/view-your-usd-balance-estimate-and-payout-allowance.md","siteName":"Ledig Payments","nav":{"global":null,"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":""}]},{"tab":"API reference","groups":[{"group":"Overview","pages":[{"title":"API reference","href":"/api-reference/introduction"}]},{"group":"Currencies and rates","pages":[{"title":"List supported currencies","deprecated":null,"version":null,"openapi":"/openapi/public.yaml get /v1/currencies","href":"/api-reference/currencies-and-rates/list-supported-currencies"},{"title":"View indicative exchange rates","deprecated":null,"version":null,"openapi":"/openapi/public.yaml get /v1/rates","href":"/api-reference/currencies-and-rates/view-indicative-exchange-rates"},{"title":"List conversions and limits","deprecated":null,"version":null,"openapi":"/openapi/public.yaml get /v1/liquidity/routes","href":"/api-reference/currencies-and-rates/list-conversions-and-limits"}]},{"group":"Balances","pages":[{"title":"View your balances","description":"See your available and reserved funds in each currency.","deprecated":null,"version":null,"openapi":"/openapi/public.yaml get /v1/balances","href":"/api-reference/balances/view-your-balances"},{"title":"View your USD balance estimate and payout allowance","deprecated":null,"version":null,"openapi":"/openapi/public.yaml get /v1/balances/summary","href":"/api-reference/balances/view-your-usd-balance-estimate-and-payout-allowance"},{"title":"View a currency balance","description":"See your available and reserved funds in one currency.","deprecated":null,"version":null,"openapi":"/openapi/public.yaml get /v1/balances/{currency}","href":"/api-reference/balances/view-a-currency-balance"}]},{"group":"Funding accounts","pages":[{"title":"View a receiving account","deprecated":null,"version":null,"openapi":"/openapi/public.yaml get /v1/virtual-accounts/{currency}","href":"/api-reference/funding-accounts/view-a-receiving-account"},{"title":"Request a receiving account","deprecated":null,"version":null,"openapi":"/openapi/public.yaml post /v1/virtual-accounts","href":"/api-reference/funding-accounts/request-a-receiving-account"}]},{"group":"Deposit wallets","pages":[{"title":"List deposit networks and assets","deprecated":null,"version":null,"openapi":"/openapi/public.yaml get /v1/wallets/options","href":"/api-reference/deposit-wallets/list-deposit-networks-and-assets"},{"title":"Create a network deposit address","deprecated":null,"version":null,"openapi":"/openapi/public.yaml post /v1/wallets/network","href":"/api-reference/deposit-wallets/create-a-network-deposit-address"},{"title":"Check deposit address setup","deprecated":null,"version":null,"openapi":"/openapi/public.yaml get /v1/wallets/network/{requestId}","href":"/api-reference/deposit-wallets/check-deposit-address-setup"},{"title":"List your deposit addresses","deprecated":null,"version":null,"openapi":"/openapi/public.yaml get /v1/wallets","href":"/api-reference/deposit-wallets/list-your-deposit-addresses"},{"title":"Create a crypto deposit address","deprecated":null,"version":null,"openapi":"/openapi/public.yaml post /v1/wallets","href":"/api-reference/deposit-wallets/create-a-crypto-deposit-address"},{"title":"View a deposit address","deprecated":null,"version":null,"openapi":"/openapi/public.yaml get /v1/wallets/{id}","href":"/api-reference/deposit-wallets/view-a-deposit-address"}]},{"group":"Recipients","pages":[{"title":"List crypto recipient networks","deprecated":null,"version":null,"openapi":"/openapi/public.yaml get /v1/recipient-requirements/crypto-networks","href":"/api-reference/recipients/list-crypto-recipient-networks"},{"title":"List your recipients","deprecated":null,"version":null,"openapi":"/openapi/public.yaml get /v1/recipients","href":"/api-reference/recipients/list-your-recipients"},{"title":"Add a payment recipient","deprecated":null,"version":null,"openapi":"/openapi/public.yaml post /v1/recipients","href":"/api-reference/recipients/add-a-payment-recipient"},{"title":"View a recipient","deprecated":null,"version":null,"openapi":"/openapi/public.yaml get /v1/recipients/{id}","href":"/api-reference/recipients/view-a-recipient"},{"title":"Remove a recipient","deprecated":null,"version":null,"openapi":"/openapi/public.yaml delete /v1/recipients/{id}","href":"/api-reference/recipients/remove-a-recipient"}]},{"group":"Ledig businesses","pages":[{"title":"Find a Ledig business","deprecated":null,"version":null,"openapi":"/openapi/public.yaml get /v1/ledig-businesses/{businessId}","href":"/api-reference/ledig-businesses/find-a-ledig-business"}]},{"group":"Payment options","pages":[{"title":"List payment methods","deprecated":null,"version":null,"openapi":"/openapi/public.yaml get /v1/quotes/payment-options","href":"/api-reference/payment-options/list-payment-methods"},{"title":"List payout fees and limits","deprecated":null,"version":null,"openapi":"/openapi/public.yaml get /v1/payouts/catalogue","href":"/api-reference/payment-options/list-payout-fees-and-limits"},{"title":"Estimate a payout fee","deprecated":null,"version":null,"openapi":"/openapi/public.yaml post /v1/payouts/fee-estimate","href":"/api-reference/payment-options/estimate-a-payout-fee"},{"title":"View your payout fee schedule","deprecated":null,"version":null,"openapi":"/openapi/public.yaml get /v1/quotes/payout-fees","href":"/api-reference/quotes/view-your-payout-fee-schedule"}]},{"group":"Quotes","pages":[{"title":"List your quotes","deprecated":null,"version":null,"openapi":"/openapi/public.yaml get /v1/quotes","href":"/api-reference/quotes/list-your-quotes"},{"title":"Create a conversion or payment quote","deprecated":null,"version":null,"openapi":"/openapi/public.yaml post /v1/quotes","href":"/api-reference/quotes/create-a-conversion-or-payment-quote"},{"title":"View a quote","deprecated":null,"version":null,"openapi":"/openapi/public.yaml get /v1/quotes/{id}","href":"/api-reference/quotes/view-a-quote"}]},{"group":"Transfers","pages":[{"title":"Confirm a quote","deprecated":null,"version":null,"openapi":"/openapi/public.yaml post /v1/transfers","href":"/api-reference/transfers/confirm-a-quote"},{"title":"Check a transfer","deprecated":null,"version":null,"openapi":"/openapi/public.yaml get /v1/transfers/{id}","href":"/api-reference/transfers/check-a-transfer"}]},{"group":"Transactions","pages":[{"title":"View your transaction history","deprecated":null,"version":null,"openapi":"/openapi/public.yaml get /v1/transactions","href":"/api-reference/transactions/view-your-transaction-history"},{"title":"View a transaction","deprecated":null,"version":null,"openapi":"/openapi/public.yaml get /v1/transactions/{id}","href":"/api-reference/transactions/view-a-transaction"}]},{"group":"Managed businesses","pages":[{"title":"List your managed businesses","deprecated":null,"version":null,"openapi":"/openapi/public.yaml get /v1/managed-businesses","href":"/api-reference/managed-businesses/list-your-managed-businesses"},{"title":"Start a business application","deprecated":null,"version":null,"openapi":"/openapi/public.yaml post /v1/managed-businesses/applications","href":"/api-reference/managed-businesses/start-a-business-application"},{"title":"View a business application","deprecated":null,"version":null,"openapi":"/openapi/public.yaml get /v1/managed-businesses/{businessId}/onboarding","href":"/api-reference/managed-businesses/view-a-business-application"},{"title":"List application sections","deprecated":null,"version":null,"openapi":"/openapi/public.yaml get /v1/managed-businesses/{businessId}/onboarding/sections","href":"/api-reference/managed-businesses/list-application-sections"},{"title":"View an application section","deprecated":null,"version":null,"openapi":"/openapi/public.yaml get /v1/managed-businesses/{businessId}/onboarding/{section}","href":"/api-reference/managed-businesses/view-an-application-section"},{"title":"Save an application section","deprecated":null,"version":null,"openapi":"/openapi/public.yaml put /v1/managed-businesses/{businessId}/onboarding/{section}","href":"/api-reference/managed-businesses/save-an-application-section"},{"title":"Complete an application section","deprecated":null,"version":null,"openapi":"/openapi/public.yaml post /v1/managed-businesses/{businessId}/onboarding/{section}/complete","href":"/api-reference/managed-businesses/complete-an-application-section"},{"title":"List application answer options","deprecated":null,"version":null,"openapi":"/openapi/public.yaml get /v1/managed-businesses/{businessId}/onboarding/{section}/options","href":"/api-reference/managed-businesses/list-application-answer-options"},{"title":"Add an owner or related person","deprecated":null,"version":null,"openapi":"/openapi/public.yaml post /v1/managed-businesses/{businessId}/onboarding/owners","href":"/api-reference/managed-businesses/add-an-owner-or-related-person"},{"title":"Remove an owner or related person","deprecated":null,"version":null,"openapi":"/openapi/public.yaml delete /v1/managed-businesses/{businessId}/onboarding/owners/{ownerId}","href":"/api-reference/managed-businesses/remove-an-owner-or-related-person"},{"title":"Start an owner's identity check","deprecated":null,"version":null,"openapi":"/openapi/public.yaml post /v1/managed-businesses/{businessId}/onboarding/owners/{ownerId}/verification","href":"/api-reference/managed-businesses/start-an-owners-identity-check"},{"title":"Prepare a document upload","deprecated":null,"version":null,"openapi":"/openapi/public.yaml post /v1/managed-businesses/{businessId}/onboarding/documents","href":"/api-reference/managed-businesses/prepare-a-document-upload"},{"title":"Complete a document upload","deprecated":null,"version":null,"openapi":"/openapi/public.yaml post /v1/managed-businesses/{businessId}/onboarding/documents/{documentId}/complete","href":"/api-reference/managed-businesses/complete-a-document-upload"},{"title":"Submit a business application","deprecated":null,"version":null,"openapi":"/openapi/public.yaml post /v1/managed-businesses/{businessId}/onboarding/submit","href":"/api-reference/managed-businesses/submit-a-business-application"},{"title":"Check an onboarding link","deprecated":null,"version":null,"openapi":"/openapi/public.yaml get /v1/managed-businesses/{businessId}/onboarding/share","href":"/api-reference/managed-businesses/check-an-onboarding-link"},{"title":"Create an onboarding link","deprecated":null,"version":null,"openapi":"/openapi/public.yaml post /v1/managed-businesses/{businessId}/onboarding/share","href":"/api-reference/managed-businesses/create-an-onboarding-link"},{"title":"Revoke an onboarding link","deprecated":null,"version":null,"openapi":"/openapi/public.yaml delete /v1/managed-businesses/{businessId}/onboarding/share/{sessionId}","href":"/api-reference/managed-businesses/revoke-an-onboarding-link"}]},{"group":"System","pages":[{"title":"Check API availability","deprecated":null,"version":null,"openapi":"/openapi/public.yaml get /v1/health","href":"/api-reference/system/check-api-availability"}]}]}]},"basePath":"","title":"View your USD balance estimate and payout allowance - Ledig Payments","deploymentId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","buildId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CiUHMMOm.js","snippetPresets-BgfXU7Bw.js","utils-DWvOwgy_.js","style-to-object-BY3JEAdk.js","utils-BN7RXSMJ.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-CFw8bq89.js","conditional-requirements-CFM0id0Q.js","cloneDeep-CAwdfOU2.js","_Uint8Array-BJr8e-ZL.js","isObject-FP1Yky1u.js","ApiExamples-XX0UgMZK.js","usePlaygroundInputsStore-DXDFSa1V.js","shallow-CdX5aREi.js","isEqual-CoOaxexF.js","CodeSnippets-Cg2wpzWm.js","CodeSnippet-D_HwgQO_.js","getApiPlaygroundDisplay-CmCoerhe.js","Page-CVJ-f_k1.js","DynamicMarkdown-CQM9Bhbv.js","SectionHeading-DpbrP8nQ.js","icon-BPCgijHy.js","MethodPill-GQ8DuY0c.js","getPastedJson-Cb5mT31m.js","Check2Icon-a7bUI6e8.js","axios-CsQoIw0U.js","Markdown-CX2QY19L.js","AssistantPageLink-CY3bFglh.js","dist-Dl6_zDnT.js","lib-DMeTj1gb.js","lib-B8HbPgcC.js","katex-Dbtb6Wk7.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js"]}