provider e withdrawable vêm null quando a consulta ao provedor falha. null não é zero:
zero diria que não há dinheiro, quando o que houve foi uma consulta que não respondeu.
Ver Saldo do vendedor.
Chave secreta do vendedor, criada no painel em Desenvolvedores.
O valor em claro existe uma única vez, na criação. Guardamos só o
hash SHA-256 - nem o suporte consegue recuperá-lo, o que é o ponto:
um dump do nosso banco não permite cobrar em nome de ninguém.
A chave vai no servidor. Colocá-la no navegador do comprador a
entrega a qualquer pessoa que abra a página.
Retido pela reserva rolante, em centavos inteiros. É dinheiro do
vendedor que ainda não pode sair - sem este campo, a diferença
entre balance e available pareceria erro do sistema.
Quanto o vendedor deve, em centavos inteiros. Estado próprio, e
não "saldo zero": as próximas vendas cobrem automaticamente e só
o saque fica bloqueado até lá.
null quando a consulta ao provedor falhou. Diferente de zero.
Show child attributes
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Vext","colors":{"primary":"#1A7A14","light":"#4FFC46","dark":"#14640F"},"logo":{"light":"https://mintcdn.com/vext/kcwCRAttQYaZqJCy/logo/light.svg?fit=max\u0026auto=format\u0026n=kcwCRAttQYaZqJCy\u0026q=85\u0026s=fb9b46dfbd546322b281376800e5d841","dark":"https://mintcdn.com/vext/kcwCRAttQYaZqJCy/logo/dark.svg?fit=max\u0026auto=format\u0026n=kcwCRAttQYaZqJCy\u0026q=85\u0026s=b5d7910037e70bdeaabd3c84a89ba3b8"},"favicon":"https://mintcdn.com/vext/OcFZC8TCCCNiFjKO/favicon.svg?fit=max\u0026auto=format\u0026n=OcFZC8TCCCNiFjKO\u0026q=85\u0026s=e0dfe4ab440758e15218c96ed34fe259","api":{"playground":{"display":"interactive"},"examples":{"defaults":"required","languages":["curl","php","javascript","python"]}},"appearance":{"default":"system"},"navbar":{"links":[{"href":"https://wa.me/5511936185272","label":"Suporte"}]},"footer":{"links":[{"header":"Documentação","items":[{"label":"Primeira cobrança","href":"/quickstart"},{"label":"Referência da API","href":"/api-reference/introducao"},{"label":"Webhooks","href":"/webhooks/visao-geral"}]},{"header":"Vext","items":[{"label":"Suporte","href":"https://wa.me/5511936185272"}]}]},"search":{"prompt":"Buscar na documentação da Vext"},"icons":{"library":"lucide"},"contextual":{"options":["copy","view","claude","chatgpt","mcp"],"display":"header"},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"vext","hasAudioNarration":false,"actualSubdomain":"vext","customDomains":["docs.usevext.com"],"gitSource":{"type":"github","owner":"brendooliveira","repo":"documentation","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6ae0ead2400e864d11faf0ec","clientVersion":"0.0.4094","searchFilterCounts":[{"language":"default","tag":"Referência da API","count":30},{"language":"default","tag":"Guias","count":26},{"language":"default","tag":"Cobranças","count":5},{"language":"default","tag":"Eventos de cobrança","count":5},{"language":"default","tag":"Convenções da API","count":5},{"language":"default","tag":"Cartão","count":5},{"language":"default","tag":"Depois da venda","count":5},{"language":"default","tag":"Cartões","count":4},{"language":"default","tag":"Objetos","count":4},{"language":"default","tag":"Cartão no navegador","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":"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":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"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":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/saldo/consultar","slug":"/api-reference/saldo/consultar","pageMetadata":{"title":"Consultar saldo","description":"Saldo, reservado, disponível e sacável do vendedor.","icon":"wallet","openapi":"api-reference/openapi.yaml GET /v1/balance","href":"/api-reference/saldo/consultar"},"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: \"Saldo, reservado, disponível e sacável do vendedor.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,p:`p`,strong:`strong`,..._provideComponents(),...props.components},{Warning}=_components;if(!Warning)_missingMdxReference(`Warning`,true);return _jsx(Warning,{children:_jsxs(_components.p,{children:[_jsx(_components.code,{children:`provider`}),` e `,_jsx(_components.code,{children:`withdrawable`}),` vêm `,_jsx(_components.code,{children:`null`}),` quando a consulta ao provedor falha. `,_jsxs(_components.strong,{children:[_jsx(_components.code,{children:`null`}),` não é zero`]}),`:\nzero diria que não há dinheiro, quando o que houve foi uma consulta que não respondeu.\nVer `,_jsx(_components.a,{href:`/essenciais/saldo`,children:`Saldo do vendedor`}),`.`]})})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Consultar saldo","description":"Saldo, reservado, disponível e sacável do vendedor.","icon":"wallet","openapi":"api-reference/openapi.yaml GET /v1/balance","href":"/api-reference/saldo/consultar"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Saldo"],"summary":"Consultar saldo","operationId":"getBalance","description":"Saldo, reservado, disponível e sacável do vendedor.","security":["ca3c7e7f-8b57-4430-9c5b-514528bc6719"],"responses":{"200":"073ad383-f1f7-4c57-9d6e-59c13e923210","401":"9572d7e0-61a2-420a-84b2-71adef16c45c","403":"aea69bf8-3753-4fe5-a92f-f34fc145419f","429":"6aca0874-92a2-4026-a7d3-5cc2ebe0b60b","500":"2fc4d2ab-cfab-4931-a733-e89040058fdc"},"method":"get","type":"path","servers":["ed9958ae-3134-4ef6-8d55-2744b0263cea"],"path":"/v1/balance","baseUrlOptions":["https://api.usevext.com"],"title":"Consultar saldo","codeSamples":[],"requestExampleLanguages":["bash","php","javascript","python"],"requiredOnlyExamples":true,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"responses":{"073ad383-f1f7-4c57-9d6e-59c13e923210":{"description":"Saldo da conta.","content":{"application/json":{"schema":{"type":"object","required":["object","currency","balance","available","reserved","debt","withdrawable","provider"],"properties":{"object":{"type":"string","const":"balance","isRequired":true,"uniqueKey":"object","typeLabel":"string"},"currency":{"type":"string","const":"BRL","isRequired":true,"uniqueKey":"currency","typeLabel":"string"},"balance":{"type":"integer","description":"Saldo do extrato, em centavos inteiros. Pode ser NEGATIVO -\nacontece quando um estorno chega depois do saque.\n","format":"int64","isRequired":true,"uniqueKey":"balance","typeLabel":"integer\u003cint64>"},"available":{"type":"integer","description":"O que já pode sair pelo nosso extrato, em centavos inteiros.\nNunca negativo: veja `debt`.\n","format":"int64","isRequired":true,"uniqueKey":"available","typeLabel":"integer\u003cint64>"},"reserved":{"type":"integer","description":"Retido pela reserva rolante, em centavos inteiros. É dinheiro do\nvendedor que ainda não pode sair - sem este campo, a diferença\nentre `balance` e `available` pareceria erro do sistema.\n","format":"int64","isRequired":true,"uniqueKey":"reserved","typeLabel":"integer\u003cint64>"},"debt":{"type":"integer","description":"Quanto o vendedor deve, em centavos inteiros. Estado próprio, e\nnão \"saldo zero\": as próximas vendas cobrem automaticamente e só\no saque fica bloqueado até lá.\n","format":"int64","isRequired":true,"uniqueKey":"debt","typeLabel":"integer\u003cint64>"},"withdrawable":{"oneOf":[{"type":"integer","description":"O que dá para sacar AGORA, em centavos inteiros. `null` quando a\nconsulta ao provedor falhou.\n","format":"int64","isRequired":true,"uniqueKey":"withdrawable.oneOf.0","typeLabel":"integer\u003cint64>"},{"type":"null","description":"O que dá para sacar AGORA, em centavos inteiros. `null` quando a\nconsulta ao provedor falhou.\n","isRequired":true,"uniqueKey":"withdrawable.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"withdrawable","typeLabel":"integer\u003cint64> | null"},"provider":{"oneOf":[{"type":"object","description":"`null` quando a consulta ao provedor falhou. Diferente de zero.\n","required":["available","waiting_funds"],"properties":{"available":{"type":"integer","description":"Disponível na adquirente, em centavos inteiros.","format":"int64","isRequired":true,"uniqueKey":"provider.oneOf.0.available","typeLabel":"integer\u003cint64>"},"waiting_funds":{"type":"integer","description":"A caminho na adquirente, em centavos inteiros.\n","format":"int64","isRequired":true,"uniqueKey":"provider.oneOf.0.waiting_funds","typeLabel":"integer\u003cint64>"}},"isRequired":true,"uniqueKey":"provider.oneOf.0","typeLabel":"object"},{"type":"null","description":"`null` quando a consulta ao provedor falhou. Diferente de zero.\n","isRequired":true,"uniqueKey":"provider.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"provider","typeLabel":"object | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"normal":{"title":"normal","value":{"object":"balance","currency":"BRL","balance":92020,"available":82818,"reserved":9202,"debt":0,"withdrawable":50000,"provider":{"available":50000,"waiting_funds":7000}}},"indisponivel":{"title":"indisponivel","value":{"object":"balance","currency":"BRL","balance":92020,"available":82818,"reserved":9202,"debt":0,"withdrawable":null,"provider":null}},"emDivida":{"title":"emDivida","description":"Acontece quando um estorno chega depois do saque. Não é\nerro: as próximas vendas cobrem a dívida\nautomaticamente, e apenas o saque fica bloqueado até lá.\n","value":{"object":"balance","currency":"BRL","balance":-9301,"available":0,"reserved":0,"debt":9301,"withdrawable":0,"provider":{"available":0,"waiting_funds":0}}}},"exampleType":"examples"}},"exampleType":"examples"},"9572d7e0-61a2-420a-84b2-71adef16c45c":{"description":"Chave ausente, desconhecida, revogada ou expirada. A revogada é\ndistinguida da inexistente na MENSAGEM, nunca no status: quem\nintegra precisa saber que a chave existiu e foi desligada, e quem\nestá adivinhando tokens não aprende nada com isso.\n","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["type","code","message","details"],"properties":{"type":{"type":"string","description":"Família do erro. Responde \"de quem é o problema e o que\nfazer\": `invalid_request_error` se corrige mudando a\nchamada, `authentication_error` trocando a chave, e\n`api_error` é nosso - repita, não reescreva.\n","enum":["authentication_error","permission_error","invalid_request_error","idempotency_error","not_found_error","rate_limit_error","api_error","card_error"],"isRequired":true,"uniqueKey":"error.type","typeLabel":"enum\u003cstring>"},"code":{"type":"string","description":"Código estável do erro. **Trate por ele.** A `message` pode\nser reescrita a qualquer momento; o código, não.\n","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"Explicação em português, para leitura humana.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"type":"object","description":"Sempre objeto, mesmo vazio. Em `validation_failed`, traz os\ncampos recusados e suas mensagens.\n","additionalProperties":true,"isRequired":true,"uniqueKey":"error.details","typeLabel":"object"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"ausente":{"title":"ausente","value":{"error":{"type":"authentication_error","code":"missing_api_key","message":"Envie a chave em Authorization: Bearer sk_live_...","details":{}}}},"invalida":{"title":"invalida","value":{"error":{"type":"authentication_error","code":"invalid_api_key","message":"Chave de API inválida.","details":{}}}},"revogada":{"title":"revogada","value":{"error":{"type":"authentication_error","code":"revoked_api_key","message":"Esta chave de API foi revogada. Gere uma nova em Desenvolvedores.","details":{}}}},"expirada":{"title":"expirada","value":{"error":{"type":"authentication_error","code":"expired_api_key","message":"Esta chave de API expirou. Gere uma nova em Desenvolvedores.","details":{}}}}},"exampleType":"examples"}},"exampleType":"examples"},"aea69bf8-3753-4fe5-a92f-f34fc145419f":{"description":"A chave é válida, mas não tem o escopo do endpoint. `403` e não\n`401` de propósito: `401` diria \"sua chave está errada\" a quem tem\na chave certa.\n","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["type","code","message","details"],"properties":{"type":{"type":"string","description":"Família do erro. Responde \"de quem é o problema e o que\nfazer\": `invalid_request_error` se corrige mudando a\nchamada, `authentication_error` trocando a chave, e\n`api_error` é nosso - repita, não reescreva.\n","enum":["authentication_error","permission_error","invalid_request_error","idempotency_error","not_found_error","rate_limit_error","api_error","card_error"],"isRequired":true,"uniqueKey":"error.type","typeLabel":"enum\u003cstring>"},"code":{"type":"string","description":"Código estável do erro. **Trate por ele.** A `message` pode\nser reescrita a qualquer momento; o código, não.\n","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"Explicação em português, para leitura humana.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"type":"object","description":"Sempre objeto, mesmo vazio. Em `validation_failed`, traz os\ncampos recusados e suas mensagens.\n","additionalProperties":true,"isRequired":true,"uniqueKey":"error.details","typeLabel":"object"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"escopo":{"title":"escopo","value":{"error":{"type":"permission_error","code":"insufficient_scope","message":"Esta chave não tem o escopo [refunds:write].","details":{"required_ability":"refunds:write","abilities":["charges:read","charges:write"]}}}},"umClique":{"title":"umClique","value":{"error":{"type":"permission_error","code":"one_click_requires_three_ds","message":"Esta loja exige autenticação do portador, e o pagamento de um clique não a suporta.","details":{}}}}},"exampleType":"examples"}},"exampleType":"examples"},"6aca0874-92a2-4026-a7d3-5cc2ebe0b60b":{"description":"Requisições demais.\n\nHá três limites, por minuto: um por IP antes da autenticação, e\ndepois um de leitura e um de escrita, ambos por CHAVE - o excesso\nde uma integração não consome a cota das outras do mesmo\nvendedor. A escrita é bem mais apertada porque cada cobrança\ncriada vira uma chamada ao provedor.\n\n`Retry-After` diz em quantos segundos voltar. Os cabeçalhos\n`X-RateLimit-*` vêm em TODA resposta, não só nesta: são eles que\npermitem desacelerar antes de bater no limite.\n","headers":{"Retry-After":{"description":"Segundos até a cota ser reposta.","schema":{"type":"integer"}},"X-RateLimit-Limit":{"description":"Requisições permitidas por minuto neste balde.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Quantas ainda cabem no minuto corrente.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["type","code","message","details"],"properties":{"type":{"type":"string","description":"Família do erro. Responde \"de quem é o problema e o que\nfazer\": `invalid_request_error` se corrige mudando a\nchamada, `authentication_error` trocando a chave, e\n`api_error` é nosso - repita, não reescreva.\n","enum":["authentication_error","permission_error","invalid_request_error","idempotency_error","not_found_error","rate_limit_error","api_error","card_error"],"isRequired":true,"uniqueKey":"error.type","typeLabel":"enum\u003cstring>"},"code":{"type":"string","description":"Código estável do erro. **Trate por ele.** A `message` pode\nser reescrita a qualquer momento; o código, não.\n","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"Explicação em português, para leitura humana.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"type":"object","description":"Sempre objeto, mesmo vazio. Em `validation_failed`, traz os\ncampos recusados e suas mensagens.\n","additionalProperties":true,"isRequired":true,"uniqueKey":"error.details","typeLabel":"object"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"cota":{"title":"cota","value":{"error":{"type":"rate_limit_error","code":"too_many_requests","message":"Muitas requisições. Tente novamente em 42 segundos.","details":{"retry_after":42}}}},"provedor":{"title":"provedor","value":{"error":{"type":"rate_limit_error","code":"provider_rate_limited","message":"Limite de requisições do provedor atingido. Tente novamente em instantes.","details":{}}}}},"exampleType":"examples"}},"exampleType":"examples"},"2fc4d2ab-cfab-4931-a733-e89040058fdc":{"description":"Erro inesperado do nosso lado. Repita com a mesma\n`Idempotency-Key` - ela é o que torna repetir seguro.\n","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["type","code","message","details"],"properties":{"type":{"type":"string","description":"Família do erro. Responde \"de quem é o problema e o que\nfazer\": `invalid_request_error` se corrige mudando a\nchamada, `authentication_error` trocando a chave, e\n`api_error` é nosso - repita, não reescreva.\n","enum":["authentication_error","permission_error","invalid_request_error","idempotency_error","not_found_error","rate_limit_error","api_error","card_error"],"isRequired":true,"uniqueKey":"error.type","typeLabel":"enum\u003cstring>"},"code":{"type":"string","description":"Código estável do erro. **Trate por ele.** A `message` pode\nser reescrita a qualquer momento; o código, não.\n","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"Explicação em português, para leitura humana.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"type":"object","description":"Sempre objeto, mesmo vazio. Em `validation_failed`, traz os\ncampos recusados e suas mensagens.\n","additionalProperties":true,"isRequired":true,"uniqueKey":"error.details","typeLabel":"object"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"interno":{"title":"interno","value":{"error":{"type":"api_error","code":"internal_error","message":"Erro interno. Se persistir, informe o horário da chamada ao suporte.","details":{}}}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"ca3c7e7f-8b57-4430-9c5b-514528bc6719":{"apiKey":{"type":"http","scheme":"bearer","bearerFormat":"sk_live_… | sk_test_…","description":"Chave secreta do vendedor, criada no painel em **Desenvolvedores**.\n\nO valor em claro existe uma única vez, na criação. Guardamos só o\nhash SHA-256 - nem o suporte consegue recuperá-lo, o que é o ponto:\num dump do nosso banco não permite cobrar em nome de ninguém.\n\nA chave vai no **servidor**. Colocá-la no navegador do comprador a\nentrega a qualquer pessoa que abra a página.\n","scopes":["balance:read"],"schemeName":"apiKey"}}},"servers":{"ed9958ae-3134-4ef6-8d55-2744b0263cea":{"url":"https://api.usevext.com","description":"Produção"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"sk_live_… | sk_test_…","description":"Chave secreta do vendedor, criada no painel em **Desenvolvedores**.\n\nO valor em claro existe uma única vez, na criação. Guardamos só o\nhash SHA-256 - nem o suporte consegue recuperá-lo, o que é o ponto:\num dump do nosso banco não permite cobrar em nome de ninguém.\n\nA chave vai no **servidor**. Colocá-la no navegador do comprador a\nentrega a qualquer pessoa que abra a página.\n","scopes":["balance:read"],"schemeName":"apiKey"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Chave secreta do vendedor, criada no painel em **Desenvolvedores**.\n\nO valor em claro existe uma única vez, na criação. Guardamos só o\nhash SHA-256 - nem o suporte consegue recuperá-lo, o que é o ponto:\num dump do nosso banco não permite cobrar em nome de ninguém.\n\nA chave vai no **servidor**. Colocá-la no navegador do comprador a\nentrega a qualquer pessoa que abra a página.\n","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"apiKey","name":"Authorization"}],"title":"apiKey"}]},"originalFileLocation":"api-reference/openapi.yaml"},"subdomain":"vext","siteName":"Vext","title":"Consultar saldo - Vext","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-08-06T13:04:38.699Z","originalFileLocation":"api-reference/saldo/consultar.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=\"Saldo, reservado, disponível e sacável do vendedor.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Vext\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/vext/1ynttjJ_6FW1Z8CJ/_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/vext/1ynttjJ_6FW1Z8CJ/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/vext/1ynttjJ_6FW1Z8CJ/_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/vext/1ynttjJ_6FW1Z8CJ/_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/vext/1ynttjJ_6FW1Z8CJ/_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/vext/1ynttjJ_6FW1Z8CJ/_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/vext/1ynttjJ_6FW1Z8CJ/_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/vext/1ynttjJ_6FW1Z8CJ/_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/vext/1ynttjJ_6FW1Z8CJ/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Consultar saldo - Vext\">\u003cmeta data-mint-head property=\"og:description\" content=\"Saldo, reservado, disponível e sacável do vendedor.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Vext\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.usevext.com/api-reference/saldo/consultar\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://vext.mintlify.site/_mintlify/api/og/v2?division=Saldo\u0026amp;title=Consultar+saldo\u0026amp;description=Saldo%2C+reservado%2C+dispon%C3%ADvel+e+sac%C3%A1vel+do+vendedor.\u0026amp;theme=5fdce344cf730a9d43aa6618\u0026amp;signature=e10d56bd876343c4c3f8002d2a608b7a4b8c11f592c3f678d588055f56746541\">\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=\"Consultar saldo - Vext\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Saldo, reservado, disponível e sacável do vendedor.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://vext.mintlify.site/_mintlify/api/og/v2?division=Saldo\u0026amp;title=Consultar+saldo\u0026amp;description=Saldo%2C+reservado%2C+dispon%C3%ADvel+e+sac%C3%A1vel+do+vendedor.\u0026amp;theme=5fdce344cf730a9d43aa6618\u0026amp;signature=e10d56bd876343c4c3f8002d2a608b7a4b8c11f592c3f678d588055f56746541\">\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/vext/1ynttjJ_6FW1Z8CJ/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Vext\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#1A7A14\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.usevext.com/api-reference/saldo/consultar\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/saldo/consultar.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.usevext.com/#organization\",\"name\":\"Vext\",\"url\":\"https://docs.usevext.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/vext/kcwCRAttQYaZqJCy/logo/light.svg?fit=max\u0026auto=format\u0026n=kcwCRAttQYaZqJCy\u0026q=85\u0026s=fb9b46dfbd546322b281376800e5d841\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.usevext.com#website\",\"name\":\"Vext\",\"url\":\"https://docs.usevext.com\",\"publisher\":{\"@id\":\"https://docs.usevext.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.usevext.com/api-reference/saldo/consultar#webpage\",\"url\":\"https://docs.usevext.com/api-reference/saldo/consultar\",\"name\":\"Consultar saldo\",\"description\":\"Saldo, reservado, disponível e sacável do vendedor.\",\"dateModified\":\"2026-08-06T13:04:38.699Z\",\"isPartOf\":{\"@id\":\"https://docs.usevext.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.usevext.com/api-reference/saldo/consultar#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.usevext.com/api-reference/saldo/consultar#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Vext\",\"item\":\"https://docs.usevext.com\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Consultar saldo\",\"item\":\"https://docs.usevext.com/api-reference/saldo/consultar\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.usevext.com/api-reference/saldo/consultar#apireference\",\"headline\":\"Consultar saldo\",\"name\":\"Consultar saldo\",\"description\":\"Saldo, reservado, disponível e sacável do vendedor.\",\"url\":\"https://docs.usevext.com/api-reference/saldo/consultar\",\"mainEntityOfPage\":{\"@id\":\"https://docs.usevext.com/api-reference/saldo/consultar#webpage\"},\"dateModified\":\"2026-08-06T13:04:38.699Z\",\"publisher\":{\"@id\":\"https://docs.usevext.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.usevext.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Vext\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Vext","nav":{"global":null,"tabs":[{"tab":"Guias","pages":[{"title":"Guias","href":""}]},{"tab":"Referência da API","groups":[{"group":"Visão geral","pages":[{"title":"Visão geral","icon":"terminal","href":"/api-reference/introducao"}]},{"group":"Objetos","pages":[{"title":"Cobrança","icon":"receipt","href":"/api-reference/objetos/cobranca"},{"title":"Cartão guardado","icon":"vault","href":"/api-reference/objetos/cartao-guardado"},{"title":"Comprador","icon":"user","href":"/api-reference/objetos/comprador"},{"title":"Saque","icon":"banknote","href":"/api-reference/objetos/saque"}]},{"group":"Cobranças","pages":[{"title":"Criar cobrança","icon":"circle-dollar-sign","openapi":"api-reference/openapi.yaml POST /v1/charges","href":"/api-reference/cobrancas/criar"},{"title":"Listar cobranças","icon":"list","openapi":"api-reference/openapi.yaml GET /v1/charges","href":"/api-reference/cobrancas/listar"},{"title":"Consultar cobrança","icon":"file-search","openapi":"api-reference/openapi.yaml GET /v1/charges/{code}","href":"/api-reference/cobrancas/consultar"},{"title":"Estornar cobrança","icon":"rotate-ccw","openapi":"api-reference/openapi.yaml POST /v1/charges/{code}/refund","href":"/api-reference/cobrancas/estornar"},{"title":"Grade de parcelas","icon":"table","openapi":"api-reference/openapi.yaml GET /v1/installments","href":"/api-reference/cobrancas/parcelas"}]},{"group":"Cartão no navegador","pages":[{"title":"A biblioteca vext.js","sidebarTitle":"vext.js","icon":"code","openapi":"api-reference/openapi.yaml GET /v1/vext.js","href":"/api-reference/cartao/vext-js"},{"title":"Configuração para o navegador","sidebarTitle":"client_config","icon":"browser","openapi":"api-reference/openapi.yaml GET /v1/client_config","href":"/api-reference/cartao/client-config"},{"title":"Emitir token de autenticação","icon":"shield-check","openapi":"api-reference/openapi.yaml POST /v1/three_ds_tokens","href":"/api-reference/cartao/three-ds-token"}]},{"group":"Cartões","pages":[{"title":"Guardar cartão","icon":"vault","openapi":"api-reference/openapi.yaml POST /v1/cards","href":"/api-reference/cartoes/guardar"},{"title":"Listar cartões guardados","icon":"credit-card","openapi":"api-reference/openapi.yaml GET /v1/cards","href":"/api-reference/cartoes/listar"},{"title":"Consultar cartão guardado","icon":"file-search","openapi":"api-reference/openapi.yaml GET /v1/cards/{code}","href":"/api-reference/cartoes/consultar"},{"title":"Remover cartão guardado","description":"Revoga um cartão do cofre sem apagar o histórico das cobranças que ele pagou.","icon":"trash-2","openapi":"api-reference/openapi.yaml DELETE /v1/cards/{code}","href":"/api-reference/cartoes/remover"}]},{"group":"Saldo","pages":[{"title":"Consultar saldo","icon":"wallet","openapi":"api-reference/openapi.yaml GET /v1/balance","href":"/api-reference/saldo/consultar"}]},{"group":"Saques","pages":[{"title":"Solicitar saque","description":"Tira dinheiro do saldo: PIX para uma chave no bolsão, TED para a conta bancária no split.","icon":"banknote","openapi":"api-reference/openapi.yaml POST /v1/withdrawals","href":"/api-reference/saques/solicitar"},{"title":"Listar saques","icon":"list","openapi":"api-reference/openapi.yaml GET /v1/withdrawals","href":"/api-reference/saques/listar"},{"title":"Consultar saque","icon":"search","openapi":"api-reference/openapi.yaml GET /v1/withdrawals/{code}","href":"/api-reference/saques/consultar"}]},{"group":"Eventos de cobrança","pages":[{"title":"charge.paid","icon":"badge-check","openapi":"api-reference/openapi.yaml webhook charge.paid","href":"/api-reference/webhooks/charge-paid"},{"title":"charge.failed","icon":"circle-x","openapi":"api-reference/openapi.yaml webhook charge.failed","href":"/api-reference/webhooks/charge-failed"},{"title":"charge.in_analysis","icon":"search","openapi":"api-reference/openapi.yaml webhook charge.in_analysis","href":"/api-reference/webhooks/charge-in-analysis"},{"title":"charge.refunded","icon":"undo-2","openapi":"api-reference/openapi.yaml webhook charge.refunded","href":"/api-reference/webhooks/charge-refunded"},{"title":"charge.chargedback","icon":"gavel","openapi":"api-reference/openapi.yaml webhook charge.chargedback","href":"/api-reference/webhooks/charge-chargedback"}]},{"group":"Eventos de contestação (MED)","pages":[{"title":"med.opened","icon":"shield-alert","openapi":"api-reference/openapi.yaml webhook med.opened","href":"/api-reference/webhooks/med-opened"},{"title":"med.approved","icon":"thumbs-down","openapi":"api-reference/openapi.yaml webhook med.approved","href":"/api-reference/webhooks/med-approved"},{"title":"med.rejected","icon":"thumbs-up","openapi":"api-reference/openapi.yaml webhook med.rejected","href":"/api-reference/webhooks/med-rejected"}]},{"group":"Eventos de saque","pages":[{"title":"withdrawal.paid","icon":"banknote","openapi":"api-reference/openapi.yaml webhook withdrawal.paid","href":"/api-reference/webhooks/withdrawal-paid"}]}]}]},"basePath":"","title":"Consultar saldo - Vext","buildId":"dpl_42LwxxU1kGN114H4XzwGYXa9ZDah","deploymentId":"dpl_42LwxxU1kGN114H4XzwGYXa9ZDah","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-C-hEh3I2.js","utils-CnF4QiUD.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-C7PVNbel.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-8ytevL2A.js","snippetPresets-BT1alx3v.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BLXC0i_W.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CyLIGI9_.js","shallow-DC0lGVIW.js","getApiPlaygroundDisplay-CgDQ85tN.js","CodeSnippet-6-I-Gpv9.js","CodeSnippets-BAk1kDdu.js","Page-C945cI-W.js","getPastedJson-B276RuWN.js","icon-BqP8etTm.js","MethodPill-DM6sbxG1.js","DuplicateIcon-PyJglOaE.js","createIcon-CMeOMAc_.js","DynamicMarkdown-BoyYAA8K.js","SectionHeading-DAYv3gvZ.js","axios-vUo_bRtp.js","Markdown-BhTTmazV.js","clsx-CR-RHrVC.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CBUH0-zX.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BmARFYNC.js"]}