{
"error": {
"code": 400,
"status": "INVALID_ARGUMENT",
"message": "Filter expression references an unsupported field.",
"details": [
{
"reason": "INVALID_ARGUMENT",
"description": "Field `nonexistent` is not allowed for filtering on this endpoint.",
"metadata": {}
}
]
}
}
{
"error": {
"code": 401,
"status": "SIGNATURE_INVALID",
"message": "Request signature could not be verified.",
"details": [
{
"reason": "SIGNATURE_INVALID",
"description": "The provided signature does not match the canonical request.",
"metadata": {
"decisionId": "acd_9RmKvTpYzH2wN8qJ5b"
}
}
]
}
}
{
"error": {
"code": 403,
"status": "RBAC_DENY",
"message": "The credential is not permitted to perform this action.",
"details": [
{
"reason": "RBAC_DENY",
"description": "Missing required role binding on the target resource.",
"metadata": {
"decisionId": "acd_8PaJvNqLcK3xW5sR4d"
}
}
]
}
}
{
"error": {
"code": 404,
"status": "WALLET_NOT_FOUND",
"message": "Wallet not found.",
"details": [
{
"reason": "WALLET_NOT_FOUND",
"description": "No wallet exists with name `production-main`.",
"metadata": {}
}
]
}
}
{
"error": {
"code": 429,
"status": "RESOURCE_EXHAUSTED",
"message": "Rate limit exceeded for this credential.",
"details": [
{
"reason": "RESOURCE_EXHAUSTED",
"description": "You have exceeded the request quota for this endpoint.",
"metadata": {
"retry_after_seconds": 12
}
}
]
}
}
{
"error": {
"code": 503,
"status": "PROVIDER_UNAVAILABLE",
"message": "Upstream payment provider is unavailable.",
"details": [
{
"reason": "PROVIDER_UNAVAILABLE",
"description": "The provider returned a transient error or did not respond.",
"metadata": {
"id": "exc_5KaHsBxYzW3pM2dV"
}
}
]
}
}
Wallets
Get wallet balance
Returns a real-time balance snapshot for the given wallet — total,
locked, and immediately available amounts. The snapshot is read from
the underlying provider on every call; values are not cached.
{
"error": {
"code": 400,
"status": "INVALID_ARGUMENT",
"message": "Filter expression references an unsupported field.",
"details": [
{
"reason": "INVALID_ARGUMENT",
"description": "Field `nonexistent` is not allowed for filtering on this endpoint.",
"metadata": {}
}
]
}
}
{
"error": {
"code": 401,
"status": "SIGNATURE_INVALID",
"message": "Request signature could not be verified.",
"details": [
{
"reason": "SIGNATURE_INVALID",
"description": "The provided signature does not match the canonical request.",
"metadata": {
"decisionId": "acd_9RmKvTpYzH2wN8qJ5b"
}
}
]
}
}
{
"error": {
"code": 403,
"status": "RBAC_DENY",
"message": "The credential is not permitted to perform this action.",
"details": [
{
"reason": "RBAC_DENY",
"description": "Missing required role binding on the target resource.",
"metadata": {
"decisionId": "acd_8PaJvNqLcK3xW5sR4d"
}
}
]
}
}
{
"error": {
"code": 404,
"status": "WALLET_NOT_FOUND",
"message": "Wallet not found.",
"details": [
{
"reason": "WALLET_NOT_FOUND",
"description": "No wallet exists with name `production-main`.",
"metadata": {}
}
]
}
}
{
"error": {
"code": 429,
"status": "RESOURCE_EXHAUSTED",
"message": "Rate limit exceeded for this credential.",
"details": [
{
"reason": "RESOURCE_EXHAUSTED",
"description": "You have exceeded the request quota for this endpoint.",
"metadata": {
"retry_after_seconds": 12
}
}
]
}
}
{
"error": {
"code": 503,
"status": "PROVIDER_UNAVAILABLE",
"message": "Upstream payment provider is unavailable.",
"details": [
{
"reason": "PROVIDER_UNAVAILABLE",
"description": "The provider returned a transient error or did not respond.",
"metadata": {
"id": "exc_5KaHsBxYzW3pM2dV"
}
}
]
}
}
Returns a real-time balance snapshot for the wallet — total, locked, and immediately available amounts, plus an asset descriptor. The snapshot is read live from the underlying provider on every call; values are not cached.The three balances:
Field
Meaning
amount
Total balance, including funds reserved for in-flight outbound orders.
locked
Funds reserved for outbound orders currently in PENDING or PROCESSING. Not spendable.
available
Funds you can immediately commit to a new outbound order. available = amount - locked.
Before creating an outbound payment order, check available, not amount. An outbound order against insufficient available will finalize as FAILED with errorCode: INSUFFICIENT_FUNDS.
All values are integers in minor units (cents for BRL). See Amounts & currency.
Authorizations
X-Access-Key
string
header
required
Opaque credential identifier provisioned during onboarding. See the
Integration Guide
for the request-signing protocol.
X-Access-Timestamp
string
header
required
Unix epoch timestamp in UTC milliseconds. See the Integration Guide
for skew tolerance.
X-Access-Request-Id
string
header
required
Unique identifier per request (UUID v4 recommended). The
(accessKey, requestId) tuple must be unique within the replay
window defined by the Integration Guide.
X-Access-Signature
string
header
required
Base64-encoded ECDSA signature of the canonical request, computed
with the private key paired to X-Access-Key. See the Integration
Guide for canonicalization rules and reference implementations.
Path Parameters
wallet
string
required
Wallet name (RFC 1035 DNS label).
Required string length: 1 - 63
Pattern: ^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$
Response
The current balance snapshot.
Real-time balance snapshot of a wallet — total, locked, and immediately available amounts, plus the asset descriptor.
amount
object
required
A monetary amount expressed in integer minor units together with its currency and decimal precision.
Show child attributes
locked
object
required
A monetary amount expressed in integer minor units together with its currency and decimal precision.
Show child attributes
available
object
required
A monetary amount expressed in integer minor units together with its currency and decimal precision.
Show child attributes
asset
object
required
Descriptor of a fiat currency or crypto asset, including its display symbol and decimal precision.
Show child attributes
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Bloobank","description":"Bloobank Transactions Engine API — wallets, payment orders (PIX), and webhooks.","colors":{"primary":"#5c83fa","light":"#8DABFF","dark":"#3B5DBF"},"logo":{"light":"https://mintcdn.com/solutsco/uVFX2_9nfUfZo-fT/logo/light.svg?fit=max\u0026auto=format\u0026n=uVFX2_9nfUfZo-fT\u0026q=85\u0026s=3fb00233ac5afd400ef9320c4dc20082","dark":"https://mintcdn.com/solutsco/uVFX2_9nfUfZo-fT/logo/dark.svg?fit=max\u0026auto=format\u0026n=uVFX2_9nfUfZo-fT\u0026q=85\u0026s=1ae8e5f47a71e03557a4ff059c168293","href":"/"},"favicon":"https://mintcdn.com/solutsco/Gt5UU7K6L9qRIsM4/icon/favicon.ico?fit=max\u0026auto=format\u0026n=Gt5UU7K6L9qRIsM4\u0026q=85\u0026s=17e86373d973621bf3bcd2ca7c34e0cf","api":{"openapi":"openapi-v1.yml","playground":{"display":"simple","proxy":false},"mdx":{"auth":{"method":"key","name":"X-Access-Signature"},"server":"https://txengine.bloobank.com/txengine/v1"}},"background":{"decoration":"gradient","color":{"light":"#FFFFFF","dark":"#0B1020"}},"navbar":{"links":[{"href":"https://bloobank.com/support","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://app.bloobank.com"}},"footer":{"socials":{"website":"https://bloobank.com"}},"search":{"prompt":"Search the docs"},"seo":{"metatags":{"theme-color":"#5A81FA","description":"Bloobank Transactions Engine API — wallets, payment orders (PIX), and webhooks.","og:locale":"en-US","og:url":"https://docs.bloobank.com","og:title":"Bloobank API Documentation","og:site_name":"Bloobank","og:description":"Bloobank Transactions Engine API — wallets, payment orders (PIX), and webhooks.","og:image":"https://app.bloobank.com/img/twitter-image.png","og:image:width":"3584","og:image:height":"2062","og:image:type":"image/png","twitter:card":"summary_large_image","twitter:title":"Bloobank API Documentation","twitter:description":"Bloobank Transactions Engine API — wallets, payment orders (PIX), and webhooks.","twitter:image":"https://app.bloobank.com/img/twitter-image.png"}},"fonts":{"family":"Inter"},"styling":{"eyebrows":"section","codeblocks":"dark","latex":false},"contextual":{"options":["copy","chatgpt","claude","mcp","cursor","vscode"],"display":"header"},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"solutsco","hasAudioNarration":false,"actualSubdomain":"solutsco","customDomains":["developers.bloobank.com"],"gitSource":{"type":"github","owner":"exowayco","repo":"bloobank-docs-platform-core","deployBranch":"master","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6ae957a627a0cba11e4a18d0:success","clientVersion":"0.0.4167","searchFilterCounts":[{"language":"default","tag":"Get Started","count":34},{"language":"default","tag":"API Reference","count":18},{"language":"default","tag":"Concepts","count":10},{"language":"default","tag":"Wallets","count":8},{"language":"default","tag":"Payment Orders","count":6},{"language":"default","tag":"Authentication","count":5},{"language":"default","tag":"Payments","count":5},{"language":"default","tag":"Webhooks","count":5},{"language":"default","tag":"Conventions","count":4},{"language":"default","tag":"Introduction","count":4}]},"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":"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":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"#table-of-contents .toc-item{margin-bottom:0.5rem}#table-of-contents .toc a,#table-of-contents a{padding:0.35rem 0!important;line-height:1.6!important;display:block}#table-of-contents .toc{padding-top:0.5rem}article h2,.prose h2{margin-top:3rem!important;margin-bottom:1rem!important;padding-top:0.25rem;letter-spacing:-0.01em}article h3,.prose h3{margin-top:2.25rem!important;margin-bottom:0.75rem!important}article h4,.prose h4{margin-top:1.75rem!important;margin-bottom:0.5rem!important}article p,.prose p{line-height:1.75;margin-bottom:1.25rem}article ul li,article ol li,.prose ul li,.prose ol li{margin-bottom:0.5rem;line-height:1.7}.dark .card:hover,.dark [class*=\"Card_\"]:hover{border-color:rgba(92, 131, 250, 0.4)!important;transform:translateY(-1px);transition:border-color 0.2s, transform 0.2s}#sidebar a{line-height:1.6!important}"}],"page":{"pagePath":"api-reference/wallets/get-balance","slug":"/api-reference/wallets/get-balance","pageMetadata":{"title":"Get wallet balance","openapi":"GET /wallets/{wallet}/balance","description":"Returns a real-time balance snapshot for the given wallet — total,\nlocked, and immediately available amounts. The snapshot is read from\nthe underlying provider on every call; values are not cached.\n","href":"/api-reference/wallets/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: \"Returns a real-time balance snapshot for the given wallet — total,\\nlocked, and immediately available amounts. The snapshot is read from\\nthe underlying provider on every call; values are not cached.\"\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={a:`a`,code:`code`,p:`p`,strong:`strong`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,..._provideComponents(),...props.components},{Table,Warning}=_components;if(!Table)_missingMdxReference(`Table`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`Returns a `,_jsx(_components.strong,{children:`real-time balance snapshot`}),` for the wallet — total, locked, and immediately available amounts, plus an `,_jsx(_components.code,{children:`asset`}),` descriptor. The snapshot is read live from the underlying provider on every call; values are `,_jsx(_components.strong,{children:`not cached`}),`.`]}),`\n`,_jsx(_components.p,{children:`The three balances:`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Field`}),_jsx(_components.th,{children:`Meaning`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`amount`})}),_jsx(_components.td,{children:`Total balance, including funds reserved for in-flight outbound orders.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`locked`})}),_jsxs(_components.td,{children:[`Funds reserved for outbound orders currently in `,_jsx(_components.code,{children:`PENDING`}),` or `,_jsx(_components.code,{children:`PROCESSING`}),`. Not spendable.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`available`})}),_jsxs(_components.td,{children:[`Funds you can immediately commit to a new outbound order. `,_jsx(_components.code,{children:`available = amount - locked`}),`.`]})]})]})]}),`\n`,_jsx(Warning,{children:_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Before creating an outbound payment order`}),`, check `,_jsx(_components.code,{children:`available`}),`, not `,_jsx(_components.code,{children:`amount`}),`. An outbound order against insufficient `,_jsx(_components.code,{children:`available`}),` will finalize as `,_jsx(_components.code,{children:`FAILED`}),` with `,_jsx(_components.code,{children:`errorCode: INSUFFICIENT_FUNDS`}),`.`]})}),`\n`,_jsxs(_components.p,{children:[`All values are integers in `,_jsx(_components.strong,{children:`minor units`}),` (cents for BRL). See `,_jsx(_components.a,{href:`/get-started/concepts/amounts-and-currency`,children:`Amounts \u0026 currency`}),`.`]})]})}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":{"codeStyling":"dark","config":{},"pageMetadata":{"title":"Get wallet balance","openapi":"GET /wallets/{wallet}/balance","description":"Returns a real-time balance snapshot for the given wallet — total,\nlocked, and immediately available amounts. The snapshot is read from\nthe underlying provider on every call; values are not cached.\n","href":"/api-reference/wallets/get-balance"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"getWalletBalance","summary":"Get wallet balance","tags":["Wallets"],"description":"Returns a real-time balance snapshot for the given wallet — total,\nlocked, and immediately available amounts. The snapshot is read from\nthe underlying provider on every call; values are not cached.\n","responses":{"200":"9eac6d5f-f375-4a85-b23b-15bead5973c5","400":"bc89c742-3117-422f-b2ef-50ac3d51c5f0","401":"fa2fc8c0-8fdd-421a-9b20-e43fe052aac4","403":"25db4893-55ee-427e-8952-977d553ab622","404":"bc508b0b-0957-4961-8e0f-5cd412d0bc0c","429":"8c1887e0-3bdd-4928-875a-00092915915a","500":"9b7cf14b-a322-40cf-a29e-49174bcd48f7","503":"018104a8-af0f-49e7-8904-b7632d8a4a1f"},"method":"get","type":"path","servers":["1bb2730f-5e3d-48d3-9a04-553715cf0f27"],"security":["1be67399-e2e9-47e4-8e12-ee5d6d30593a"],"path":"/wallets/{wallet}/balance","baseUrlOptions":["https://txengine.bloobank.com/txengine/v1"],"title":"Get wallet balance","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated","disableProxy":true},"dependencies":{"parameters":{"d680ec49-51f0-4e3e-8e35-a0f1785ab967":{"name":"wallet","in":"path","required":true,"description":"Wallet name (RFC 1035 DNS label).","schema":{"type":"string","pattern":"^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$","minLength":1,"maxLength":63,"isRequired":true,"description":"Wallet name (RFC 1035 DNS label).","uniqueKey":"","typeLabel":"string"},"example":"production-main"}},"responses":{"9eac6d5f-f375-4a85-b23b-15bead5973c5":{"description":"The current balance snapshot.","content":{"application/json":{"schema":{"type":"object","description":"Real-time balance snapshot of a wallet — total, locked, and immediately available amounts, plus the asset descriptor.","required":["amount","locked","available","asset"],"properties":{"amount":{"type":"object","description":"A monetary amount expressed in integer minor units together with its currency and decimal precision.","required":["ccy","decimals","value"],"properties":{"ccy":{"type":"string","description":"Currency or asset code (ISO 4217 for fiat).","example":"BRL","isRequired":true,"uniqueKey":"amount.ccy","typeLabel":"string"},"decimals":{"type":"integer","minimum":0,"description":"Decimal places of `value` to obtain the major-unit number.","example":2,"isRequired":true,"uniqueKey":"amount.decimals","typeLabel":"integer"},"value":{"type":"integer","format":"int64","minimum":0,"description":"Amount in minor units (e.g. cents for BRL).","example":1250075,"isRequired":true,"uniqueKey":"amount.value","typeLabel":"integer\u003cint64>"}},"isRequired":true,"uniqueKey":"amount","typeLabel":"object"},"locked":{"type":"object","description":"A monetary amount expressed in integer minor units together with its currency and decimal precision.","required":["ccy","decimals","value"],"properties":{"ccy":{"type":"string","description":"Currency or asset code (ISO 4217 for fiat).","example":"BRL","isRequired":true,"uniqueKey":"locked.ccy","typeLabel":"string"},"decimals":{"type":"integer","minimum":0,"description":"Decimal places of `value` to obtain the major-unit number.","example":2,"isRequired":true,"uniqueKey":"locked.decimals","typeLabel":"integer"},"value":{"type":"integer","format":"int64","minimum":0,"description":"Amount in minor units (e.g. cents for BRL).","example":1250075,"isRequired":true,"uniqueKey":"locked.value","typeLabel":"integer\u003cint64>"}},"isRequired":true,"uniqueKey":"locked","typeLabel":"object"},"available":{"type":"object","description":"A monetary amount expressed in integer minor units together with its currency and decimal precision.","required":["ccy","decimals","value"],"properties":{"ccy":{"type":"string","description":"Currency or asset code (ISO 4217 for fiat).","example":"BRL","isRequired":true,"uniqueKey":"available.ccy","typeLabel":"string"},"decimals":{"type":"integer","minimum":0,"description":"Decimal places of `value` to obtain the major-unit number.","example":2,"isRequired":true,"uniqueKey":"available.decimals","typeLabel":"integer"},"value":{"type":"integer","format":"int64","minimum":0,"description":"Amount in minor units (e.g. cents for BRL).","example":1250075,"isRequired":true,"uniqueKey":"available.value","typeLabel":"integer\u003cint64>"}},"isRequired":true,"uniqueKey":"available","typeLabel":"object"},"asset":{"type":"object","description":"Descriptor of a fiat currency or crypto asset, including its display symbol and decimal precision.","required":["ccy","type","symbol","decimals","name"],"properties":{"ccy":{"type":"string","example":"BRL","isRequired":true,"uniqueKey":"asset.ccy","typeLabel":"string"},"type":{"type":"string","enum":["fiat","crypto"],"example":"fiat","isRequired":true,"uniqueKey":"asset.type","typeLabel":"enum\u003cstring>"},"symbol":{"type":"string","example":"R$","isRequired":true,"uniqueKey":"asset.symbol","typeLabel":"string"},"decimals":{"type":"integer","minimum":0,"example":2,"isRequired":true,"uniqueKey":"asset.decimals","typeLabel":"integer"},"name":{"type":"string","example":"Brazilian Real","isRequired":true,"uniqueKey":"asset.name","typeLabel":"string"}},"isRequired":true,"uniqueKey":"asset","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"amount":{"ccy":"BRL","decimals":2,"value":1250075},"locked":{"ccy":"BRL","decimals":2,"value":25000},"available":{"ccy":"BRL","decimals":2,"value":1225075},"asset":{"ccy":"BRL","type":"fiat","symbol":"R$","decimals":2,"name":"Brazilian Real"}},"examples":{"Example":{"title":"Example","value":{"amount":{"ccy":"BRL","decimals":2,"value":1250075},"locked":{"ccy":"BRL","decimals":2,"value":25000},"available":{"ccy":"BRL","decimals":2,"value":1225075},"asset":{"ccy":"BRL","type":"fiat","symbol":"R$","decimals":2,"name":"Brazilian Real"}}}},"exampleType":"examples"}},"exampleType":"examples"},"bc89c742-3117-422f-b2ef-50ac3d51c5f0":{"description":"Request contract violation. The request is malformed.","content":{"application/json":{"schema":{"type":"object","description":"Standard error envelope returned by every non-2xx response.","required":["error"],"properties":{"error":{"type":"object","required":["code","status","message","details"],"properties":{"code":{"type":"integer","description":"HTTP status code echo.","example":401,"isRequired":true,"uniqueKey":"error.code","typeLabel":"integer"},"status":{"type":"string","description":"Canonical error identifier. Stable; safe to branch on programmatically.","isRequired":true,"uniqueKey":"error.status","typeLabel":"string"},"message":{"type":"string","description":"Human-readable summary. May vary between releases — do not string-match on it.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","required":["reason"],"properties":{"reason":{"type":"string","description":"Stable code identifying this specific diagnostic.","isRequired":true,"uniqueKey":"error.details.items.[INDEX].reason","typeLabel":"string"},"description":{"type":"string","description":"Human-readable explanation of the specific detail.","uniqueKey":"error.details.items.[INDEX].description","typeLabel":"string"},"metadata":{"type":"object","additionalProperties":true,"description":"Key-value context. For DENY decisions contains `decisionId`.\nFor 5xx errors may contain `id` — the exception record id\n(format `exc_…`) to quote when contacting support.\n","uniqueKey":"error.details.items.[INDEX].metadata","typeLabel":"object"}},"uniqueKey":"error.details.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"error.details","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":400,"status":"INVALID_ARGUMENT","message":"Filter expression references an unsupported field.","details":[{"reason":"INVALID_ARGUMENT","description":"Field `nonexistent` is not allowed for filtering on this endpoint.","metadata":{}}]}},"examples":{"Example":{"title":"Example","value":{"error":{"code":400,"status":"INVALID_ARGUMENT","message":"Filter expression references an unsupported field.","details":[{"reason":"INVALID_ARGUMENT","description":"Field `nonexistent` is not allowed for filtering on this endpoint.","metadata":{}}]}}}},"exampleType":"examples"}},"exampleType":"examples"},"fa2fc8c0-8fdd-421a-9b20-e43fe052aac4":{"description":"Authentication failure.","content":{"application/json":{"schema":{"type":"object","description":"Standard error envelope returned by every non-2xx response.","required":["error"],"properties":{"error":{"type":"object","required":["code","status","message","details"],"properties":{"code":{"type":"integer","description":"HTTP status code echo.","example":401,"isRequired":true,"uniqueKey":"error.code","typeLabel":"integer"},"status":{"type":"string","description":"Canonical error identifier. Stable; safe to branch on programmatically.","isRequired":true,"uniqueKey":"error.status","typeLabel":"string"},"message":{"type":"string","description":"Human-readable summary. May vary between releases — do not string-match on it.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","required":["reason"],"properties":{"reason":{"type":"string","description":"Stable code identifying this specific diagnostic.","isRequired":true,"uniqueKey":"error.details.items.[INDEX].reason","typeLabel":"string"},"description":{"type":"string","description":"Human-readable explanation of the specific detail.","uniqueKey":"error.details.items.[INDEX].description","typeLabel":"string"},"metadata":{"type":"object","additionalProperties":true,"description":"Key-value context. For DENY decisions contains `decisionId`.\nFor 5xx errors may contain `id` — the exception record id\n(format `exc_…`) to quote when contacting support.\n","uniqueKey":"error.details.items.[INDEX].metadata","typeLabel":"object"}},"uniqueKey":"error.details.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"error.details","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":401,"status":"SIGNATURE_INVALID","message":"Request signature could not be verified.","details":[{"reason":"SIGNATURE_INVALID","description":"The provided signature does not match the canonical request.","metadata":{"decisionId":"acd_9RmKvTpYzH2wN8qJ5b"}}]}},"examples":{"Example":{"title":"Example","value":{"error":{"code":401,"status":"SIGNATURE_INVALID","message":"Request signature could not be verified.","details":[{"reason":"SIGNATURE_INVALID","description":"The provided signature does not match the canonical request.","metadata":{"decisionId":"acd_9RmKvTpYzH2wN8qJ5b"}}]}}}},"exampleType":"examples"}},"exampleType":"examples"},"25db4893-55ee-427e-8952-977d553ab622":{"description":"Authenticated, but not authorized for this action on this resource.","content":{"application/json":{"schema":{"type":"object","description":"Standard error envelope returned by every non-2xx response.","required":["error"],"properties":{"error":{"type":"object","required":["code","status","message","details"],"properties":{"code":{"type":"integer","description":"HTTP status code echo.","example":401,"isRequired":true,"uniqueKey":"error.code","typeLabel":"integer"},"status":{"type":"string","description":"Canonical error identifier. Stable; safe to branch on programmatically.","isRequired":true,"uniqueKey":"error.status","typeLabel":"string"},"message":{"type":"string","description":"Human-readable summary. May vary between releases — do not string-match on it.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","required":["reason"],"properties":{"reason":{"type":"string","description":"Stable code identifying this specific diagnostic.","isRequired":true,"uniqueKey":"error.details.items.[INDEX].reason","typeLabel":"string"},"description":{"type":"string","description":"Human-readable explanation of the specific detail.","uniqueKey":"error.details.items.[INDEX].description","typeLabel":"string"},"metadata":{"type":"object","additionalProperties":true,"description":"Key-value context. For DENY decisions contains `decisionId`.\nFor 5xx errors may contain `id` — the exception record id\n(format `exc_…`) to quote when contacting support.\n","uniqueKey":"error.details.items.[INDEX].metadata","typeLabel":"object"}},"uniqueKey":"error.details.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"error.details","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":403,"status":"RBAC_DENY","message":"The credential is not permitted to perform this action.","details":[{"reason":"RBAC_DENY","description":"Missing required role binding on the target resource.","metadata":{"decisionId":"acd_8PaJvNqLcK3xW5sR4d"}}]}},"examples":{"Example":{"title":"Example","value":{"error":{"code":403,"status":"RBAC_DENY","message":"The credential is not permitted to perform this action.","details":[{"reason":"RBAC_DENY","description":"Missing required role binding on the target resource.","metadata":{"decisionId":"acd_8PaJvNqLcK3xW5sR4d"}}]}}}},"exampleType":"examples"}},"exampleType":"examples"},"bc508b0b-0957-4961-8e0f-5cd412d0bc0c":{"description":"The requested resource does not exist.","content":{"application/json":{"schema":{"type":"object","description":"Standard error envelope returned by every non-2xx response.","required":["error"],"properties":{"error":{"type":"object","required":["code","status","message","details"],"properties":{"code":{"type":"integer","description":"HTTP status code echo.","example":401,"isRequired":true,"uniqueKey":"error.code","typeLabel":"integer"},"status":{"type":"string","description":"Canonical error identifier. Stable; safe to branch on programmatically.","isRequired":true,"uniqueKey":"error.status","typeLabel":"string"},"message":{"type":"string","description":"Human-readable summary. May vary between releases — do not string-match on it.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","required":["reason"],"properties":{"reason":{"type":"string","description":"Stable code identifying this specific diagnostic.","isRequired":true,"uniqueKey":"error.details.items.[INDEX].reason","typeLabel":"string"},"description":{"type":"string","description":"Human-readable explanation of the specific detail.","uniqueKey":"error.details.items.[INDEX].description","typeLabel":"string"},"metadata":{"type":"object","additionalProperties":true,"description":"Key-value context. For DENY decisions contains `decisionId`.\nFor 5xx errors may contain `id` — the exception record id\n(format `exc_…`) to quote when contacting support.\n","uniqueKey":"error.details.items.[INDEX].metadata","typeLabel":"object"}},"uniqueKey":"error.details.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"error.details","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":404,"status":"WALLET_NOT_FOUND","message":"Wallet not found.","details":[{"reason":"WALLET_NOT_FOUND","description":"No wallet exists with name `production-main`.","metadata":{}}]}},"examples":{"Example":{"title":"Example","value":{"error":{"code":404,"status":"WALLET_NOT_FOUND","message":"Wallet not found.","details":[{"reason":"WALLET_NOT_FOUND","description":"No wallet exists with name `production-main`.","metadata":{}}]}}}},"exampleType":"examples"}},"exampleType":"examples"},"8c1887e0-3bdd-4928-875a-00092915915a":{"description":"Rate limit exceeded for this credential. Honor the `Retry-After`\nheader, then retry with exponential backoff — see the\n[rate-limiting guide](/get-started/concepts/rate-limiting).\n","headers":{"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer","minimum":0}}},"content":{"application/json":{"schema":{"type":"object","description":"Standard error envelope returned by every non-2xx response.","required":["error"],"properties":{"error":{"type":"object","required":["code","status","message","details"],"properties":{"code":{"type":"integer","description":"HTTP status code echo.","example":401,"isRequired":true,"uniqueKey":"error.code","typeLabel":"integer"},"status":{"type":"string","description":"Canonical error identifier. Stable; safe to branch on programmatically.","isRequired":true,"uniqueKey":"error.status","typeLabel":"string"},"message":{"type":"string","description":"Human-readable summary. May vary between releases — do not string-match on it.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","required":["reason"],"properties":{"reason":{"type":"string","description":"Stable code identifying this specific diagnostic.","isRequired":true,"uniqueKey":"error.details.items.[INDEX].reason","typeLabel":"string"},"description":{"type":"string","description":"Human-readable explanation of the specific detail.","uniqueKey":"error.details.items.[INDEX].description","typeLabel":"string"},"metadata":{"type":"object","additionalProperties":true,"description":"Key-value context. For DENY decisions contains `decisionId`.\nFor 5xx errors may contain `id` — the exception record id\n(format `exc_…`) to quote when contacting support.\n","uniqueKey":"error.details.items.[INDEX].metadata","typeLabel":"object"}},"uniqueKey":"error.details.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"error.details","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":429,"status":"RESOURCE_EXHAUSTED","message":"Rate limit exceeded for this credential.","details":[{"reason":"RESOURCE_EXHAUSTED","description":"You have exceeded the request quota for this endpoint.","metadata":{"retry_after_seconds":12}}]}},"examples":{"Example":{"title":"Example","value":{"error":{"code":429,"status":"RESOURCE_EXHAUSTED","message":"Rate limit exceeded for this credential.","details":[{"reason":"RESOURCE_EXHAUSTED","description":"You have exceeded the request quota for this endpoint.","metadata":{"retry_after_seconds":12}}]}}}},"exampleType":"examples"}},"exampleType":"examples"},"9b7cf14b-a322-40cf-a29e-49174bcd48f7":{"description":"An unexpected error occurred on the server.","content":{"application/json":{"schema":{"type":"object","description":"Standard error envelope returned by every non-2xx response.","required":["error"],"properties":{"error":{"type":"object","required":["code","status","message","details"],"properties":{"code":{"type":"integer","description":"HTTP status code echo.","example":401,"isRequired":true,"uniqueKey":"error.code","typeLabel":"integer"},"status":{"type":"string","description":"Canonical error identifier. Stable; safe to branch on programmatically.","isRequired":true,"uniqueKey":"error.status","typeLabel":"string"},"message":{"type":"string","description":"Human-readable summary. May vary between releases — do not string-match on it.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","required":["reason"],"properties":{"reason":{"type":"string","description":"Stable code identifying this specific diagnostic.","isRequired":true,"uniqueKey":"error.details.items.[INDEX].reason","typeLabel":"string"},"description":{"type":"string","description":"Human-readable explanation of the specific detail.","uniqueKey":"error.details.items.[INDEX].description","typeLabel":"string"},"metadata":{"type":"object","additionalProperties":true,"description":"Key-value context. For DENY decisions contains `decisionId`.\nFor 5xx errors may contain `id` — the exception record id\n(format `exc_…`) to quote when contacting support.\n","uniqueKey":"error.details.items.[INDEX].metadata","typeLabel":"object"}},"uniqueKey":"error.details.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"error.details","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":500,"status":"INTERNAL","message":"An unexpected error occurred.","details":[{"reason":"INTERNAL","description":"Internal server error.","metadata":{"id":"exc_5KaHsBxYzW3pM2dV"}}]}},"examples":{"Example":{"title":"Example","value":{"error":{"code":500,"status":"INTERNAL","message":"An unexpected error occurred.","details":[{"reason":"INTERNAL","description":"Internal server error.","metadata":{"id":"exc_5KaHsBxYzW3pM2dV"}}]}}}},"exampleType":"examples"}},"exampleType":"examples"},"018104a8-af0f-49e7-8904-b7632d8a4a1f":{"description":"A downstream dependency is currently unavailable.","content":{"application/json":{"schema":{"type":"object","description":"Standard error envelope returned by every non-2xx response.","required":["error"],"properties":{"error":{"type":"object","required":["code","status","message","details"],"properties":{"code":{"type":"integer","description":"HTTP status code echo.","example":401,"isRequired":true,"uniqueKey":"error.code","typeLabel":"integer"},"status":{"type":"string","description":"Canonical error identifier. Stable; safe to branch on programmatically.","isRequired":true,"uniqueKey":"error.status","typeLabel":"string"},"message":{"type":"string","description":"Human-readable summary. May vary between releases — do not string-match on it.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","required":["reason"],"properties":{"reason":{"type":"string","description":"Stable code identifying this specific diagnostic.","isRequired":true,"uniqueKey":"error.details.items.[INDEX].reason","typeLabel":"string"},"description":{"type":"string","description":"Human-readable explanation of the specific detail.","uniqueKey":"error.details.items.[INDEX].description","typeLabel":"string"},"metadata":{"type":"object","additionalProperties":true,"description":"Key-value context. For DENY decisions contains `decisionId`.\nFor 5xx errors may contain `id` — the exception record id\n(format `exc_…`) to quote when contacting support.\n","uniqueKey":"error.details.items.[INDEX].metadata","typeLabel":"object"}},"uniqueKey":"error.details.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"error.details","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":503,"status":"PROVIDER_UNAVAILABLE","message":"Upstream payment provider is unavailable.","details":[{"reason":"PROVIDER_UNAVAILABLE","description":"The provider returned a transient error or did not respond.","metadata":{"id":"exc_5KaHsBxYzW3pM2dV"}}]}},"examples":{"Example":{"title":"Example","value":{"error":{"code":503,"status":"PROVIDER_UNAVAILABLE","message":"Upstream payment provider is unavailable.","details":[{"reason":"PROVIDER_UNAVAILABLE","description":"The provider returned a transient error or did not respond.","metadata":{"id":"exc_5KaHsBxYzW3pM2dV"}}]}}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"1be67399-e2e9-47e4-8e12-ee5d6d30593a":{"AccessKey":{"type":"apiKey","in":"header","name":"X-Access-Key","description":"Opaque credential identifier provisioned during onboarding. See the\n[Integration Guide](https://developers.bloobank.com/iam/integration)\nfor the request-signing protocol.\n","scopes":[]},"AccessTimestamp":{"type":"apiKey","in":"header","name":"X-Access-Timestamp","description":"Unix epoch timestamp in UTC milliseconds. See the Integration Guide\nfor skew tolerance.\n","scopes":[]},"AccessRequestId":{"type":"apiKey","in":"header","name":"X-Access-Request-Id","description":"Unique identifier per request (UUID v4 recommended). The\n`(accessKey, requestId)` tuple must be unique within the replay\nwindow defined by the Integration Guide.\n","scopes":[]},"AccessSignature":{"type":"apiKey","in":"header","name":"X-Access-Signature","description":"Base64-encoded ECDSA signature of the canonical request, computed\nwith the private key paired to `X-Access-Key`. See the Integration\nGuide for canonicalization rules and reference implementations.\n","scopes":[]}}},"servers":{"1bb2730f-5e3d-48d3-9a04-553715cf0f27":{"url":"https://txengine.bloobank.com/txengine/v1","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"X-Access-Key","description":"Opaque credential identifier provisioned during onboarding. See the\n[Integration Guide](https://developers.bloobank.com/iam/integration)\nfor the request-signing protocol.\n","scopes":[]},"schema":{"title":"X-Access-Key","type":"string","description":"Opaque credential identifier provisioned during onboarding. See the\n[Integration Guide](https://developers.bloobank.com/iam/integration)\nfor the request-signing protocol.\n","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"AccessKey","name":"X-Access-Key"},{"scheme":{"type":"apiKey","in":"header","name":"X-Access-Timestamp","description":"Unix epoch timestamp in UTC milliseconds. See the Integration Guide\nfor skew tolerance.\n","scopes":[]},"schema":{"title":"X-Access-Timestamp","type":"string","description":"Unix epoch timestamp in UTC milliseconds. See the Integration Guide\nfor skew tolerance.\n","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"AccessTimestamp","name":"X-Access-Timestamp"},{"scheme":{"type":"apiKey","in":"header","name":"X-Access-Request-Id","description":"Unique identifier per request (UUID v4 recommended). The\n`(accessKey, requestId)` tuple must be unique within the replay\nwindow defined by the Integration Guide.\n","scopes":[]},"schema":{"title":"X-Access-Request-Id","type":"string","description":"Unique identifier per request (UUID v4 recommended). The\n`(accessKey, requestId)` tuple must be unique within the replay\nwindow defined by the Integration Guide.\n","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"AccessRequestId","name":"X-Access-Request-Id"},{"scheme":{"type":"apiKey","in":"header","name":"X-Access-Signature","description":"Base64-encoded ECDSA signature of the canonical request, computed\nwith the private key paired to `X-Access-Key`. See the Integration\nGuide for canonicalization rules and reference implementations.\n","scopes":[]},"schema":{"title":"X-Access-Signature","type":"string","description":"Base64-encoded ECDSA signature of the canonical request, computed\nwith the private key paired to `X-Access-Key`. See the Integration\nGuide for canonicalization rules and reference implementations.\n","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"AccessSignature","name":"X-Access-Signature"}],"title":"AccessKey \u0026 AccessTimestamp \u0026 AccessRequestId \u0026 AccessSignature"}]},"originalFileLocation":"openapi-v1.yml"},"subdomain":"solutsco","siteName":"Bloobank","title":"Bloobank API Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-08-06T07:11:42.671Z","originalFileLocation":"api-reference/wallets/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=\"Returns a real-time balance snapshot for the given wallet — total, locked, and immediately available amounts. The snapshot is read from the underlying provider on every call; values are not cached.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Bloobank\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/solutsco/-h8GthN2_cqd1gsr/_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/solutsco/-h8GthN2_cqd1gsr/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/solutsco/-h8GthN2_cqd1gsr/_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/solutsco/-h8GthN2_cqd1gsr/_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/solutsco/-h8GthN2_cqd1gsr/_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/solutsco/-h8GthN2_cqd1gsr/_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/solutsco/-h8GthN2_cqd1gsr/_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/solutsco/-h8GthN2_cqd1gsr/_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/solutsco/-h8GthN2_cqd1gsr/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Bloobank API Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Bloobank Transactions Engine API — wallets, payment orders (PIX), and webhooks.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Bloobank\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://developers.bloobank.com/api-reference/wallets/get-balance\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://app.bloobank.com/img/twitter-image.png\">\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=\"Bloobank API Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Bloobank Transactions Engine API — wallets, payment orders (PIX), and webhooks.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://app.bloobank.com/img/twitter-image.png\">\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/solutsco/-h8GthN2_cqd1gsr/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Bloobank\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#5c83fa\">\u003cmeta data-mint-head name=\"og:locale\" content=\"en-US\">\u003cmeta data-mint-head name=\"theme-color\" content=\"#5A81FA\">\u003cmeta data-mint-head name=\"og:image:type\" content=\"image/png\">\u003clink data-mint-head rel=\"canonical\" href=\"https://developers.bloobank.com/api-reference/wallets/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/wallets/get-balance.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://developers.bloobank.com/#organization\",\"name\":\"Bloobank\",\"url\":\"https://developers.bloobank.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/solutsco/uVFX2_9nfUfZo-fT/logo/light.svg?fit=max\u0026auto=format\u0026n=uVFX2_9nfUfZo-fT\u0026q=85\u0026s=3fb00233ac5afd400ef9320c4dc20082\"}},{\"@type\":\"WebSite\",\"@id\":\"https://developers.bloobank.com#website\",\"name\":\"Bloobank\",\"url\":\"https://developers.bloobank.com\",\"publisher\":{\"@id\":\"https://developers.bloobank.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://developers.bloobank.com/api-reference/wallets/get-balance#webpage\",\"url\":\"https://developers.bloobank.com/api-reference/wallets/get-balance\",\"name\":\"Get wallet balance\",\"description\":\"Returns a real-time balance snapshot for the given wallet — total, locked, and immediately available amounts. The snapshot is read from the underlying provider on every call; values are not cached.\",\"dateModified\":\"2026-08-06T07:11:42.671Z\",\"isPartOf\":{\"@id\":\"https://developers.bloobank.com#website\"},\"breadcrumb\":{\"@id\":\"https://developers.bloobank.com/api-reference/wallets/get-balance#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://developers.bloobank.com/api-reference/wallets/get-balance#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Wallets\",\"item\":\"https://developers.bloobank.com/api-reference/wallets/overview\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get wallet balance\",\"item\":\"https://developers.bloobank.com/api-reference/wallets/get-balance\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://developers.bloobank.com/api-reference/wallets/get-balance#apireference\",\"headline\":\"Get wallet balance\",\"name\":\"Get wallet balance\",\"description\":\"Returns a real-time balance snapshot for the given wallet — total, locked, and immediately available amounts. The snapshot is read from the underlying provider on every call; values are not cached.\",\"url\":\"https://developers.bloobank.com/api-reference/wallets/get-balance\",\"mainEntityOfPage\":{\"@id\":\"https://developers.bloobank.com/api-reference/wallets/get-balance#webpage\"},\"image\":\"https://app.bloobank.com/img/twitter-image.png\",\"dateModified\":\"2026-08-06T07:11:42.671Z\",\"publisher\":{\"@id\":\"https://developers.bloobank.com/#organization\"},\"isPartOf\":{\"@id\":\"https://developers.bloobank.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Bloobank\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Bloobank\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/wallets/get-balance.md","siteName":"Bloobank","nav":{"global":null,"tabs":[{"tab":"Get Started","pages":[{"title":"Get Started","href":"/get-started/overview"}]},{"tab":"API Reference","groups":[{"group":"Introduction","pages":[{"title":"API Reference","icon":"code","href":"/api-reference/introduction"}]},{"group":"Conventions","pages":[{"title":"HTTP","icon":"globe","href":"/api-reference/conventions/http"},{"title":"Errors","icon":"bug","href":"/api-reference/conventions/errors"},{"title":"Pagination","icon":"arrow-down","href":"/api-reference/conventions/pagination"},{"title":"Filtering (SFS-1)","icon":"filter","href":"/api-reference/conventions/filtering"}]},{"group":"Wallets","pages":[{"title":"Wallets","icon":"wallet","href":"/api-reference/wallets/overview"},{"title":"List wallets","openapi":"GET /wallets","href":"/api-reference/wallets/list"},{"title":"Create wallet","openapi":"POST /wallets","href":"/api-reference/wallets/create"},{"title":"Get wallet","openapi":"GET /wallets/{wallet}","href":"/api-reference/wallets/get"},{"title":"Update wallet","openapi":"PUT /wallets/{wallet}","description":"Updates the mutable fields of a wallet. Only `status` is mutable;\n`name` is immutable after creation and any attempt to change it\nreturns `LABEL_IMMUTABLE`.\n","href":"/api-reference/wallets/update"},{"title":"Get wallet balance","openapi":"GET /wallets/{wallet}/balance","href":"/api-reference/wallets/get-balance"}]},{"group":"Payment Orders","pages":[{"title":"Payment Orders","description":"The PaymentOrder resource — inbound and outbound payments routed through provider networks.","icon":"money-bill-transfer","href":"/api-reference/payment-orders/overview"},{"title":"List payment orders","openapi":"GET /wallets/{wallet}/paymentOrders","href":"/api-reference/payment-orders/list"},{"title":"Create payment order","openapi":"POST /wallets/{wallet}/paymentOrders","href":"/api-reference/payment-orders/create"},{"title":"Get payment order","openapi":"GET /wallets/{wallet}/paymentOrders/{paymentOrder}","href":"/api-reference/payment-orders/get"},{"title":"Approve payment order","openapi":"PUT /wallets/{wallet}/paymentOrders/{paymentOrder}/approve","href":"/api-reference/payment-orders/approve"},{"title":"Cancel payment order","openapi":"PUT /wallets/{wallet}/paymentOrders/{paymentOrder}/cancel","href":"/api-reference/payment-orders/cancel"}]},{"group":"Utilities","pages":[{"title":"Check Server Time","openapi":"GET /time","href":"/api-reference/server-time/check-server-time"}]}]}]},"basePath":"","title":"Bloobank API Documentation","buildId":"dpl_9RFrWkXdFTJCytfx6jAofvAaEXr6","deploymentId":"dpl_9RFrWkXdFTJCytfx6jAofvAaEXr6","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-BgGj2PGS.js","utils-BhNOqRKb.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-BAgRNUZo.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-CGkb0TPw.js","snippetPresets-ChLkL1a6.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-Ef10Jrbx.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-DlVCnjU8.js","shallow-BA55zJxQ.js","getApiPlaygroundDisplay-DR09dKtp.js","CodeSnippet-BZ8J8Kll.js","CodeSnippets-CcguVheG.js","Page-C7x-eUfk.js","getPastedJson-D5UqeqBp.js","icon-DpD0l99C.js","MethodPill-Wg2NXsp_.js","DuplicateIcon-CCSyX8lh.js","createIcon-C4Ukv9HX.js","DynamicMarkdown-RhjEuCHC.js","SectionHeading-DL1MykRq.js","axios-vUo_bRtp.js","Markdown-BwQ4RMdp.js","dist-CiVXVcSh.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","katex-YMM-FMeD.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js","AssistantPageLink-Dic2Jtb2.js"]}