Sua credencial de API no cabeçalho Authorization: Bearer sk_live_.... Crie e revogue credenciais no painel, em Conta → API Keys. O segredo aparece uma única vez, na criação.
A credencial identifica a organização: organization_id não é aceito em nenhuma requisição.
Os envios já reservados por notificações que começaram e ainda não foram confirmadas. A reserva é devolvida quando a entrega se resolve.
Example:
10
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Pombo.Digital","description":"Documentação do Pombo.Digital: notificações extrajudiciais com validade jurídica por e-mail e WhatsApp.","colors":{"primary":"#1F5EF4","light":"#89D4F7","dark":"#1A3A9E"},"logo":{"light":"https://mintcdn.com/pombo-digital/6JDRLMzfLY2oWrjf/logo/light.png?fit=max\u0026auto=format\u0026n=6JDRLMzfLY2oWrjf\u0026q=85\u0026s=4dc120cc1feb87982d48a6449f85555e","dark":"https://mintcdn.com/pombo-digital/6JDRLMzfLY2oWrjf/logo/dark.png?fit=max\u0026auto=format\u0026n=6JDRLMzfLY2oWrjf\u0026q=85\u0026s=0883618911d3fedf824aa4b0ef774080","href":"https://pombo.digital"},"favicon":"https://mintcdn.com/pombo-digital/6JDRLMzfLY2oWrjf/favicon.svg?fit=max\u0026auto=format\u0026n=6JDRLMzfLY2oWrjf\u0026q=85\u0026s=b32aadd6375191ac6e71e5746164403a","api":{"params":{"expanded":"all"},"playground":{"display":"interactive"},"examples":{"defaults":"required","languages":["python","curl","javascript"],"prefill":true}},"appearance":{"default":"light","strict":false},"navbar":{"links":[{"href":"https://pombo.digital/acesso/entrar","label":"Entrar"}],"primary":{"type":"button","label":"Criar conta grátis","href":"https://pombo.digital/acesso/criar-conta?utm_source=docs"}},"footer":{"socials":{"website":"https://pombo.digital"}},"fonts":{"family":"Inter"},"icons":{"library":"lucide"},"contextual":{"options":["copy","view","chatgpt","claude","assistant","cursor","vscode"],"display":"header"},"markdown":{"schema":true},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"pombo-digital","hasAudioNarration":false,"actualSubdomain":"pombo-digital","customDomains":["docs.pombo.digital"],"gitSource":{"type":"github","owner":"avi-2-avi","repo":"docs-pombodigital","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6accf4aeb63dd02de24efa9f","clientVersion":"0.0.4111","searchFilterCounts":[{"language":"default","tag":"Guias","count":30},{"language":"default","tag":"API","count":13},{"language":"default","tag":"Começar","count":6},{"language":"default","tag":"Envios","count":6},{"language":"default","tag":"Modelos","count":6},{"language":"default","tag":"Referência da API","count":5},{"language":"default","tag":"Laudo e validade jurídica","count":5},{"language":"default","tag":"Conta","count":4},{"language":"default","tag":"Notificações","count":4},{"language":"default","tag":"Ajuda","count":2}]},"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":"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}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"#content-area a.link{color:inherit;border-bottom-color:rgb(var(--primary));border-bottom-width:1.5px}#content-area a.link:hover{color:rgb(var(--primary));border-bottom-color:currentColor}.dark #content-area a.link{border-bottom-color:rgb(var(--primary-light))}.dark #content-area a.link:hover{color:rgb(var(--primary-light));border-bottom-color:currentColor}.pombo-hero{position:relative;overflow:hidden;margin:1.5rem 0 2rem;padding:2rem 1.75rem;border-radius:1.25rem;background:linear-gradient(135deg, rgb(var(--primary) / 0.08), rgb(var(--primary-light) / 0.14));border:1px solid rgb(var(--primary) / 0.14)}.dark .pombo-hero{background:linear-gradient(135deg, rgb(var(--primary) / 0.22), rgb(var(--primary-dark) / 0.3));border-color:rgb(var(--primary-light) / 0.18)}.pombo-hero-inner{display:flex;gap:1.25rem;align-items:center;justify-content:space-between}.pombo-hero-copy{min-width:0}.pombo-eyebrow{margin:0 0 0.5rem;font-size:0.8125rem;font-weight:600;letter-spacing:0.04em;text-transform:uppercase;color:rgb(var(--primary))}.dark .pombo-eyebrow{color:rgb(var(--primary-light))}.pombo-hero h2{margin:0 0 0.5rem;font-size:2rem;line-height:1.1;font-weight:700;letter-spacing:-0.02em}.pombo-hero p{margin:0 0 1.5rem;font-size:1.0625rem;opacity:0.8}.pombo-actions{display:flex;flex-wrap:wrap;gap:0.75rem}.pombo-btn,.pombo-btn-ghost{display:inline-flex;align-items:center;gap:0.4rem;padding:0.65rem 1.15rem;border-radius:0.65rem;font-weight:600;font-size:0.9375rem;text-decoration:none;border:1px solid transparent;transition:transform 0.12s ease, background 0.12s ease}.pombo-btn{background:rgb(var(--primary));color:#fff!important}.pombo-btn:hover{background:rgb(var(--primary-dark));transform:translateY(-1px)}.pombo-btn-ghost{background:rgb(255 255 255 / 0.75);color:rgb(var(--primary))!important;border-color:rgb(var(--primary) / 0.25)}.pombo-btn-ghost:hover{background:#fff;transform:translateY(-1px)}.dark .pombo-btn-ghost{background:rgb(255 255 255 / 0.06);color:rgb(var(--primary-light))!important;border-color:rgb(var(--primary-light) / 0.3)}.pombo-hero-art{flex:0 0 46%;min-width:0;max-width:330px}.pombo-hero-art img{display:block;width:100%;border-radius:0.5rem;border:1px solid rgb(var(--primary) / 0.18);box-shadow:0 8px 24px rgb(15 23 42 / 0.1)}.dark .pombo-hero-art img{border-color:rgb(var(--primary-light) / 0.22);box-shadow:0 8px 24px rgb(0 0 0 / 0.35)}@media (max-width: 860px){.pombo-hero{padding:2rem 1.5rem}.pombo-hero h2{font-size:1.75rem}.pombo-hero-inner{flex-direction:column;align-items:stretch}.pombo-hero-art{flex:1 1 auto;max-width:none}}.pombo-strip{display:flex;gap:1.5rem;align-items:center;margin:1.5rem 0 2rem;padding:1.25rem;border-radius:1rem;border:1px solid rgb(var(--default-border-color))}.pombo-strip-body{flex:1 1 auto;min-width:0}.pombo-strip-body h3{margin:0 0 0.4rem;font-size:1.125rem;font-weight:700}.pombo-strip-body p{margin:0 0 1rem;opacity:0.8}@media (max-width: 860px){.pombo-strip{flex-direction:column;align-items:stretch}}.pombo-strip-doc{flex:0 0 34%;max-width:260px}.pombo-strip-doc img{display:block;width:100%;border-radius:0.4rem;border:1px solid rgb(var(--default-border-color))}#body-template-type [data-component-part=\"field-meta\"]{display:inline-flex!important;flex-wrap:wrap;align-items:center;gap:0.5rem}#body-template-type [data-component-part=\"field-meta\"]>div{margin-right:0!important;order:1}#body-template-type [data-component-part=\"field-meta\"]::before{padding:0.125rem 0.5rem;border-radius:0.375rem;font-size:inherit;font-weight:500;line-height:1.25rem;white-space:nowrap}#body-template-type [data-component-part=\"field-meta\"]::before{content:\"só WhatsApp\";order:2;background:rgb(22 163 74 / 0.1);color:#15803d}.dark #body-template-type [data-component-part=\"field-meta\"]::before{background:rgb(74 222 128 / 0.12);color:#4ade80}#body-recipient-phone [data-component-part=\"field-meta\"],#body-recipient-email [data-component-part=\"field-meta\"]{display:inline-flex!important;flex-wrap:wrap;align-items:center;gap:0.5rem}#body-recipient-phone [data-component-part=\"field-meta\"]>div,#body-recipient-email [data-component-part=\"field-meta\"]>div{margin-right:0!important;order:1}#body-recipient-phone [data-component-part=\"field-meta\"]::before,#body-recipient-email [data-component-part=\"field-meta\"]::before,#body-recipient-phone [data-component-part=\"field-meta\"]::after,#body-recipient-email [data-component-part=\"field-meta\"]::after{padding:0.125rem 0.5rem;border-radius:0.375rem;font-size:inherit;font-weight:500;line-height:1.25rem;white-space:nowrap}#body-recipient-phone [data-component-part=\"field-meta\"]::before{content:\"só WhatsApp\";order:2;background:rgb(22 163 74 / 0.1);color:#15803d}#body-recipient-email [data-component-part=\"field-meta\"]::before{content:\"só e-mail\";order:2;background:rgb(37 99 235 / 0.1);color:#1d4ed8}#body-recipient-phone [data-component-part=\"field-meta\"]::after,#body-recipient-email [data-component-part=\"field-meta\"]::after{content:\"required\";order:3;background:rgb(254 226 226 / 0.5);color:#dc2626}.dark #body-recipient-phone [data-component-part=\"field-meta\"]::before{background:rgb(74 222 128 / 0.12);color:#4ade80}.dark #body-recipient-email [data-component-part=\"field-meta\"]::before{background:rgb(96 165 250 / 0.12);color:#60a5fa}.dark #body-recipient-phone [data-component-part=\"field-meta\"]::after,.dark #body-recipient-email [data-component-part=\"field-meta\"]::after{background:rgb(239 68 68 / 0.15);color:#f87171}"}],"page":{"pagePath":"api-reference/saldo/consultar-o-saldo","slug":"/api-reference/saldo/consultar-o-saldo","pageMetadata":{"title":"Consultar o saldo","description":"Devolve o saldo de envios da organização da credencial.\n","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /usage","href":"/api-reference/saldo/consultar-o-saldo","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Devolve o saldo de envios da organização da credencial.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Consultar o saldo","description":"Devolve o saldo de envios da organização da credencial.\n","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /usage","href":"/api-reference/saldo/consultar-o-saldo","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"getUsage","tags":["Saldo"],"summary":"Consultar o saldo","description":"Devolve o saldo de envios da organização da credencial.\n","responses":{"200":"760e14c4-7c81-4019-83d7-b5fbf45d48d2","401":"e8a370a0-ccf7-4da7-afbc-48e20c82fe83","429":"f76acd32-3c87-4168-931c-17522cd8700c","500":"163fab8b-0dff-40fa-9b1f-6d98f090ea9d"},"method":"get","type":"path","servers":["08d165bc-8615-4cf3-87a1-64e91eaf7bd4"],"security":["f5b17345-c161-456e-92b9-13801984e98a"],"path":"/usage","baseUrlOptions":["https://pombo.digital/api/integrations/v1"],"title":"Consultar o saldo","codeSamples":[],"requestExampleLanguages":["python","bash","javascript"],"requiredOnlyExamples":true,"requestExampleType":"generated","responseExampleType":"generated","prefillPlaygroundWithExample":true,"prefillPlaygroundExamples":[]},"dependencies":{"parameters":{},"responses":{"760e14c4-7c81-4019-83d7-b5fbf45d48d2":{"description":"O saldo.","content":{"application/json":{"schema":{"type":"object","required":["send_balance"],"properties":{"send_balance":{"oneOf":[{"type":"object","description":"O saldo de envios, ou `null` quando a organização é cobrada pelo consumo e por isso não tem saldo a informar.\n\n`null` não é saldo zero: uma organização nesse modelo continua enviando normalmente.\n","required":["available","pending"],"properties":{"available":{"type":"integer","description":"Os envios disponíveis agora. É o saldo total menos o que está reservado em `pending`, e é este número que o envio consome.\n","examples":[1240],"isRequired":true,"uniqueKey":"send_balance.oneOf.0.available","typeLabel":"integer"},"pending":{"type":"integer","description":"Os envios já reservados por notificações que começaram e ainda não foram confirmadas. A reserva é devolvida quando a entrega se resolve.\n","examples":[10],"isRequired":true,"uniqueKey":"send_balance.oneOf.0.pending","typeLabel":"integer"}},"isRequired":true,"uniqueKey":"send_balance.oneOf.0","typeLabel":"object"},{"type":"null","description":"O saldo de envios, ou `null` quando a organização é cobrada pelo consumo e por isso não tem saldo a informar.\n\n`null` não é saldo zero: uma organização nesse modelo continua enviando normalmente.\n","isRequired":true,"uniqueKey":"send_balance.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"send_balance","typeLabel":"object | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"com_saldo":{"title":"com_saldo","value":{"send_balance":{"available":1240,"pending":10}}},"sem_saldo_a_informar":{"title":"sem_saldo_a_informar","value":{"send_balance":null}}},"exampleType":"examples"}},"exampleType":"examples"},"e8a370a0-ccf7-4da7-afbc-48e20c82fe83":{"description":"Credencial ausente, inválida ou revogada. A resposta é **idêntica** nos três casos: o Pombo não informa qual deles ocorreu, para que não se possa descobrir por tentativa quais credenciais já existiram.\n","content":{"application/json":{"schema":{"type":"object","description":"O envelope de erro, com quatro campos.\n\n**Ramifique pelo status HTTP e por `error_code`. Nunca por `code`.** O `code` vale `10000 + http_code` em um caminho e uma string arbitrária em outro, então não acrescenta nada ao status e muda de tipo entre operações vizinhas.\n","required":["message"],"properties":{"message":{"type":"string","description":"Descrição da falha, para diagnóstico. Em inglês ou em português. Não é estável.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"code":{"oneOf":[{"type":"integer","title":"Número, na validação genérica","description":"**Não ramifique por este campo.** O tipo muda entre operações vizinhas: um `404` de modelo traz `10404` e um `404` de notificação traz `\"NOT_FOUND\"`. Para tratar erros em código, use o status HTTP.\n","example":10400,"uniqueKey":"code.oneOf.0","typeLabel":"integer"},{"type":"string","title":"Texto, nos erros específicos","description":"**Não ramifique por este campo.** O tipo muda entre operações vizinhas: um `404` de modelo traz `10404` e um `404` de notificação traz `\"NOT_FOUND\"`. Para tratar erros em código, use o status HTTP.\n","example":"IDEMPOTENCY_KEY_REUSED","uniqueKey":"code.oneOf.1","typeLabel":"string"}],"uniqueKey":"code","typeLabel":"integer | string"},"http_code":{"type":"integer","description":"**Opcional.** O status HTTP repetido no corpo. Presente quando o erro é devolvido diretamente, ausente quando é lançado e tratado pelo tratador geral. Nunca exija este campo no cliente.\n","uniqueKey":"http_code","typeLabel":"integer"},"error_code":{"type":"string","enum":["MISSING_REQUIRED_FIELD","INVALID_SENDER","ORGANIZATION_ID_FORBIDDEN","INVALID_RECIPIENT","TEMPLATE_CONSTANT_FORBIDDEN","FILE_TRANSFER_NOT_AVAILABLE_ON_THIS_LANE","IDEMPOTENCY_KEY_REUSED"],"description":"O campo a usar para ramificar. **Opcional na prática:** alguns `400` igualmente específicos não o trazem, como o de `recipient_tax_id_type` fora do enum e o de `Idempotency-Key` mal formado. Quando estiver ausente, use o status HTTP.\n","uniqueKey":"error_code","typeLabel":"enum\u003cstring>"}},"uniqueKey":"","typeLabel":"object"},"examples":{"invalida":{"title":"invalida","value":{"code":10401,"http_code":401,"message":"Invalid API key"}}},"exampleType":"examples"}},"exampleType":"examples"},"f76acd32-3c87-4168-931c-17522cd8700c":{"description":"Limite de requisições excedido. São três contagens independentes, em janelas de um minuto: 50 por credencial, 200 por organização, 300 por IP.\n\n**Espere o que o `Retry-After` manda esperar**, em segundos. Os cabeçalhos `RateLimit-Limit`, `RateLimit-Remaining` e `RateLimit-Reset` vêm em toda resposta, não só no `429`.\n","headers":{"Retry-After":{"description":"Quantos segundos esperar antes de repetir.","schema":{"type":"integer","examples":[43]}},"RateLimit-Limit":{"description":"O teto da janela.","schema":{"type":"integer","examples":[200]}},"RateLimit-Remaining":{"description":"Quantas requisições ainda cabem na janela.","schema":{"type":"integer","examples":[0]}},"RateLimit-Reset":{"description":"Quantos segundos faltam para a janela virar.","schema":{"type":"integer","examples":[43]}}},"content":{"application/json":{"schema":{"type":"object","description":"O envelope de erro, com quatro campos.\n\n**Ramifique pelo status HTTP e por `error_code`. Nunca por `code`.** O `code` vale `10000 + http_code` em um caminho e uma string arbitrária em outro, então não acrescenta nada ao status e muda de tipo entre operações vizinhas.\n","required":["message"],"properties":{"message":{"type":"string","description":"Descrição da falha, para diagnóstico. Em inglês ou em português. Não é estável.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"code":{"oneOf":[{"type":"integer","title":"Número, na validação genérica","description":"**Não ramifique por este campo.** O tipo muda entre operações vizinhas: um `404` de modelo traz `10404` e um `404` de notificação traz `\"NOT_FOUND\"`. Para tratar erros em código, use o status HTTP.\n","example":10400,"uniqueKey":"code.oneOf.0","typeLabel":"integer"},{"type":"string","title":"Texto, nos erros específicos","description":"**Não ramifique por este campo.** O tipo muda entre operações vizinhas: um `404` de modelo traz `10404` e um `404` de notificação traz `\"NOT_FOUND\"`. Para tratar erros em código, use o status HTTP.\n","example":"IDEMPOTENCY_KEY_REUSED","uniqueKey":"code.oneOf.1","typeLabel":"string"}],"uniqueKey":"code","typeLabel":"integer | string"},"http_code":{"type":"integer","description":"**Opcional.** O status HTTP repetido no corpo. Presente quando o erro é devolvido diretamente, ausente quando é lançado e tratado pelo tratador geral. Nunca exija este campo no cliente.\n","uniqueKey":"http_code","typeLabel":"integer"},"error_code":{"type":"string","enum":["MISSING_REQUIRED_FIELD","INVALID_SENDER","ORGANIZATION_ID_FORBIDDEN","INVALID_RECIPIENT","TEMPLATE_CONSTANT_FORBIDDEN","FILE_TRANSFER_NOT_AVAILABLE_ON_THIS_LANE","IDEMPOTENCY_KEY_REUSED"],"description":"O campo a usar para ramificar. **Opcional na prática:** alguns `400` igualmente específicos não o trazem, como o de `recipient_tax_id_type` fora do enum e o de `Idempotency-Key` mal formado. Quando estiver ausente, use o status HTTP.\n","uniqueKey":"error_code","typeLabel":"enum\u003cstring>"}},"uniqueKey":"","typeLabel":"object"},"examples":{"limite":{"title":"limite","value":{"code":"RATE_LIMIT_EXCEEDED","http_code":429,"message":"Too many requests. Please try again later."}}},"exampleType":"examples"}},"exampleType":"examples"},"163fab8b-0dff-40fa-9b1f-6d98f090ea9d":{"description":"Erro interno. Em `POST /notifications`, um `500` **não garante que nada foi enviado**: consulte antes de repetir.\n","content":{"application/json":{"schema":{"type":"object","description":"O corpo do `500` é reduzido e **não** traz `http_code`.","properties":{"code":{"type":"string","examples":["INTERNAL_ERROR"],"uniqueKey":"code","typeLabel":"string"},"message":{"type":"string","examples":["Internal Server Error"],"uniqueKey":"message","typeLabel":"string"},"request_id":{"type":"string","description":"O mesmo valor do cabeçalho `x-request-id`. **Registre-o:** é por ele que o suporte encontra a requisição exata.\n","examples":["req_01M1C5ZKGBGRNW6QHXTP2EM7Y7"],"uniqueKey":"request_id","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"interno":{"title":"interno","value":{"code":"INTERNAL_ERROR","message":"Internal Server Error","request_id":"req_01M1C5ZKGBGRNW6QHXTP2EM7Y7"}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"f5b17345-c161-456e-92b9-13801984e98a":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Sua credencial de API no cabeçalho `Authorization: Bearer sk_live_...`. Crie e revogue credenciais no painel, em Conta → API Keys. O segredo aparece uma única vez, na criação.\n\nA credencial identifica a organização: `organization_id` não é aceito em nenhuma requisição.\n","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"08d165bc-8615-4cf3-87a1-64e91eaf7bd4":{"url":"https://pombo.digital/api/integrations/v1","description":"Produção"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"Sua credencial de API no cabeçalho `Authorization: Bearer sk_live_...`. Crie e revogue credenciais no painel, em Conta → API Keys. O segredo aparece uma única vez, na criação.\n\nA credencial identifica a organização: `organization_id` não é aceito em nenhuma requisição.\n","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Sua credencial de API no cabeçalho `Authorization: Bearer sk_live_...`. Crie e revogue credenciais no painel, em Conta → API Keys. O segredo aparece uma única vez, na criação.\n\nA credencial identifica a organização: `organization_id` não é aceito em nenhuma requisição.\n","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"api-reference/openapi.yaml"},"subdomain":"pombo-digital","siteName":"Pombo.Digital","title":"Consultar o saldo - Pombo.Digital","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-12T14:54:49.797Z","originalFileLocation":"api-reference/saldo/consultar-o-saldo.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=\"light\"}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=\"Devolve o saldo de envios da organização da credencial.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Pombo.Digital\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/pombo-digital/UMb0_KyuiIqUp_kU/_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/pombo-digital/UMb0_KyuiIqUp_kU/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/pombo-digital/UMb0_KyuiIqUp_kU/_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/pombo-digital/UMb0_KyuiIqUp_kU/_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/pombo-digital/UMb0_KyuiIqUp_kU/_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/pombo-digital/UMb0_KyuiIqUp_kU/_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/pombo-digital/UMb0_KyuiIqUp_kU/_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/pombo-digital/UMb0_KyuiIqUp_kU/_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/pombo-digital/UMb0_KyuiIqUp_kU/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Consultar o saldo - Pombo.Digital\">\u003cmeta data-mint-head property=\"og:description\" content=\"Devolve o saldo de envios da organização da credencial.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Pombo.Digital\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.pombo.digital/api-reference/saldo/consultar-o-saldo\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://pombo-digital.mintlify.site/_mintlify/api/og/v2?division=Saldo\u0026amp;title=Consultar+o+saldo\u0026amp;description=Devolve+o+saldo+de+envios+da+organiza%C3%A7%C3%A3o+da+credencial.%0A\u0026amp;theme=0a0c86c88ccc26bfbb751982\u0026amp;signature=42d8121782b78f691cdd4d7084f0ffc570ad37b39cd7bce6aaec2a3b6688f192\">\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 o saldo - Pombo.Digital\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Devolve o saldo de envios da organização da credencial.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://pombo-digital.mintlify.site/_mintlify/api/og/v2?division=Saldo\u0026amp;title=Consultar+o+saldo\u0026amp;description=Devolve+o+saldo+de+envios+da+organiza%C3%A7%C3%A3o+da+credencial.%0A\u0026amp;theme=0a0c86c88ccc26bfbb751982\u0026amp;signature=42d8121782b78f691cdd4d7084f0ffc570ad37b39cd7bce6aaec2a3b6688f192\">\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/pombo-digital/UMb0_KyuiIqUp_kU/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Pombo.Digital\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#1F5EF4\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.pombo.digital/api-reference/saldo/consultar-o-saldo\">\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-o-saldo.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.pombo.digital/#organization\",\"name\":\"Pombo.Digital\",\"url\":\"https://docs.pombo.digital\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/pombo-digital/6JDRLMzfLY2oWrjf/logo/light.png?fit=max\u0026auto=format\u0026n=6JDRLMzfLY2oWrjf\u0026q=85\u0026s=4dc120cc1feb87982d48a6449f85555e\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.pombo.digital#website\",\"name\":\"Pombo.Digital\",\"url\":\"https://docs.pombo.digital\",\"publisher\":{\"@id\":\"https://docs.pombo.digital/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.pombo.digital/api-reference/saldo/consultar-o-saldo#webpage\",\"url\":\"https://docs.pombo.digital/api-reference/saldo/consultar-o-saldo\",\"name\":\"Consultar o saldo\",\"description\":\"Devolve o saldo de envios da organização da credencial.\",\"dateModified\":\"2026-10-12T14:54:49.797Z\",\"isPartOf\":{\"@id\":\"https://docs.pombo.digital#website\"},\"breadcrumb\":{\"@id\":\"https://docs.pombo.digital/api-reference/saldo/consultar-o-saldo#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.pombo.digital/api-reference/saldo/consultar-o-saldo#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Pombo.Digital\",\"item\":\"https://docs.pombo.digital\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Consultar o saldo\",\"item\":\"https://docs.pombo.digital/api-reference/saldo/consultar-o-saldo\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.pombo.digital/api-reference/saldo/consultar-o-saldo#apireference\",\"headline\":\"Consultar o saldo\",\"name\":\"Consultar o saldo\",\"description\":\"Devolve o saldo de envios da organização da credencial.\",\"url\":\"https://docs.pombo.digital/api-reference/saldo/consultar-o-saldo\",\"mainEntityOfPage\":{\"@id\":\"https://docs.pombo.digital/api-reference/saldo/consultar-o-saldo#webpage\"},\"dateModified\":\"2026-10-12T14:54:49.797Z\",\"publisher\":{\"@id\":\"https://docs.pombo.digital/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.pombo.digital#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Pombo.Digital\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Pombo.Digital\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/saldo/consultar-o-saldo.md","siteName":"Pombo.Digital","nav":{"global":null,"tabs":[{"tab":"Guias","pages":[{"title":"Guias","href":""}]},{"tab":"API","groups":[{"group":"Referência da API","pages":[{"title":"Introdução","href":"/api/introducao"},{"title":"Quickstart","href":"/api/quickstart"},{"title":"Idempotência","href":"/api/idempotencia"},{"title":"Erros","href":"/api/erros"},{"title":"Limites de uso","href":"/api/limites-de-uso"}]},{"group":"Modelos","pages":[{"title":"Criar um modelo","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /templates","href":"/api-reference/modelos/criar-um-modelo"},{"title":"Listar modelos","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /templates","href":"/api-reference/modelos/listar-modelos"},{"title":"Consultar um modelo","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /templates/{id}","href":"/api-reference/modelos/consultar-um-modelo"}]},{"group":"Notificações","pages":[{"title":"Enviar uma notificação","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /notifications","href":"/api-reference/notificações/enviar-uma-notificação"},{"title":"Listar notificações","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /notifications","href":"/api-reference/notificações/listar-notificações"},{"title":"Consultar uma notificação","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /notifications/{id}","href":"/api-reference/notificações/consultar-uma-notificação"},{"title":"Baixar o laudo","description":"Devolve o Relatório Técnico de Rastreabilidade, o laudo com carimbo do tempo ICP-Brasil que comprova a notificação.\n","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /notifications/{id}/report/download","href":"/api-reference/notificações/baixar-o-laudo"}]},{"group":"Saldo","pages":[{"title":"Consultar o saldo","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /usage","href":"/api-reference/saldo/consultar-o-saldo"}]}]},{"tab":"Novidades","pages":[{"title":"Novidades","href":"/novidades"}]}]},"basePath":"","title":"Consultar o saldo - Pombo.Digital","buildId":"dpl_DqYu5MPb49gWBBbUGgpHQUmCHY3P","deploymentId":"dpl_DqYu5MPb49gWBBbUGgpHQUmCHY3P","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CybtLBIt.js","utils-BMLj2fvV.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-B6In562Y.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Dr8Mfhp9.js","snippetPresets-2rmQvMVl.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-WMqJYdZj.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CJ-MlPHu.js","shallow-dY3TMRCk.js","getApiPlaygroundDisplay-v-1B2bKm.js","CodeSnippet-BDhiTB7U.js","CodeSnippets-D9hnzQcS.js","Page-C4GwDT3_.js","getPastedJson-Th2V45jI.js","icon-BQXch1W9.js","MethodPill-BCqUneP3.js","DuplicateIcon-Q_-bhurZ.js","createIcon-DUjLHRqp.js","DynamicMarkdown-B-f2cqXQ.js","SectionHeading-Da5NsV4v.js","axios-vUo_bRtp.js","Markdown-D13FWkIM.js","clsx-D3Isdib3.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-C-XZBk9h.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink--qIqmmVG.js"]}