--- title: "Débitos Resumidos" description: "API Débitos Resumidos - Débitos do veículo por placa, com o total de cada tipo" lang: pt-BR canonical: https://doc.apibrasil.io/apis/creditos/32dc9033-3a12-4e9e-b3c5-6aa8cb6d50e7 markdown: https://doc.apibrasil.io/apis/creditos/32dc9033-3a12-4e9e-b3c5-6aa8cb6d50e7.md source: apibrasil-documentation --- # Débitos Resumidos > API Débitos Resumidos - Débitos do veículo por placa, com o total de cada tipo - **Categoria:** Segurança Veicular - **Cobrança:** por consulta, só com o Bearer Token - **Preço:** R$ 3,78 por consulta - **Limite:** 990.000 por mês - **Cadastro:** exige CNPJ - **Versão:** v2 - **Publicada por:** APIBrasil - **Especificação OpenAPI:** https://doc.apibrasil.io/apis/creditos/32dc9033-3a12-4e9e-b3c5-6aa8cb6d50e7/openapi.json ## Como chamar **Endereço base:** `https://gateway.apibrasil.io/api/v2` Autenticação: cabeçalho `Authorization: Bearer `. Nada além disso. Com `homolog: true` no corpo, o gateway responde de uma base fixa, com a forma real da resposta, e não cobra. O CPF 00000000000 é dessa base e não é de ninguém: use-o nos testes, nunca em produção. ## Endpoints (1 endpoint) ### 1. POST /consulta/veiculos/credits ⚠️ Aviso: a consulta só é cobrada quando os débitos do veículo são apurados. Placa não encontrada ou fonte indisponível não geram cobrança. API Débitos Resumidos - Débitos do veículo por placa, com o total de cada tipo Envie um POST com tipo=consulta-debitos e a placa (ABC1234 ou ABC1D23). A resposta vem em data e traz: veiculo (placa, marca_modelo, ano_fabricacao, ano_modelo, cor, municipio, uf, situacao); debitos.ipva, debitos.multas, debitos.licenciamento e debitos.dpvat, cada um com possui_debito (true/false) e valor (total em reais); resumo (possui_debitos, valor_total e valor_total_completo); e restricoes (roubo_furto, renajud, baixado e financiamento). Quando o órgão não divulga o valor de um débito, possui_debito vem true e valor vem null; nesse caso valor_total soma só os valores conhecidos e valor_total_completo vem false. Os valores são totais por tipo de débito: não há lista item a item, vencimentos nem guias de pagamento (para isso, use a Débitos V4). Placa ausente ou inválida é recusada com HTTP 400, sem cobrança. Placa não encontrada responde HTTP 404 e fonte indisponível responde HTTP 502 ou 504, também sem cobrança. A consulta pode levar até cerca de 1 minuto. Em homologação (homolog=true) a resposta é uma amostra fictícia, sem cobrança, para qualquer placa válida. - **Método:** `POST` - **Endereço:** `https://gateway.apibrasil.io/api/v2/consulta/veiculos/credits` - **Versão da rota:** v2 **Cabeçalhos** | Cabeçalho | Valor | | --- | --- | | `Content-Type` | `application/json` | | `Authorization` | `Bearer $APIBRASIL_TOKEN` | **Corpo da requisição** ```json { "tipo": "consulta-debitos", "placa": "ABC1D23", "homolog": true } ``` **Em cURL** ```bash curl -X POST "https://gateway.apibrasil.io/api/v2/consulta/veiculos/credits" \ -H "Content-Type: application/json" \ -H "Authorization: Bearer $APIBRASIL_TOKEN" \ -d '{"tipo":"consulta-debitos","placa":"ABC1D23","homolog":true}' ``` Este endpoint aceita `homolog: true` no corpo: a resposta volta com dados válidos, `api_limit_for` igual a `homolog` e sem tarifação. **Resposta de exemplo, do catálogo** ```json { "user": { "first_name": "[omitido]", "email": "[omitido]", "cellphone": "[omitido]", "notification": "yes" }, "balance": "96,220", "balance_before": "100,000", "tax": "3,780", "status_code": 200, "error": false, "message": "Dados validos! Voce foi tarifado em R$ 3,78.", "valor_consulta": 3.78, "api_limit_for": "credit", "homolog": false, "data": { "veiculo": { "placa": "ABC1D23", "marca_modelo": "MARCA EXEMPLO / MODELO EXEMPLO 1.0", "ano_fabricacao": 2020, "ano_modelo": 2021, "cor": "BRANCA", "municipio": "CIDADE EXEMPLO", "uf": "SP", "situacao": "CIRCULACAO" }, "debitos": { "ipva": { "possui_debito": true, "valor": 987.65 }, "multas": { "possui_debito": true, "valor": null }, "licenciamento": { "possui_debito": false, "valor": 0 }, "dpvat": { "possui_debito": false, "valor": 0 } }, "resumo": { "possui_debitos": true, "valor_total": 987.65, "valor_total_completo": false }, "restricoes": { "roubo_furto": false, "renajud": false, "baixado": false, "financiamento": { "possui": false, "tipo_informado": null } } } } ``` Nos exemplos de resposta, os campos da conta que gerou o exemplo (`user.first_name`, `user.email`, `user.cellphone`) saem como `[omitido]`. O resto é o que o catálogo publica. ## Armadilhas: o que uma integração erra sem avisar Apuradas nas respostas que o próprio catálogo publica. Em todas elas o código funciona no caminho feliz e falha em silêncio no resto: 1. **O erro chega no CORPO, com HTTP 200.** A resposta traz um campo `error` booleano e uma `message`. Checar só `response.ok` ou o status HTTP deixa passar falha como sucesso. Confira SEMPRE `error === false` antes de ler `data`. 2. **`balance`, `tax` e `extra_charges.total` são STRING em formato brasileiro — e o formato varia entre APIs.** Valores observados no catálogo: `"154,380"`, `"497,84"`, `"0,000"` e `"0.19"`. Vírgula em umas, ponto em outra; três casas decimais em umas, duas em outra. Em JavaScript, `parseFloat("154,380")` devolve `154` e perde os centavos sem erro nenhum, e `Number("154,380")` devolve `NaN`. Escreva um conversor que trate os dois separadores, e nunca use esses campos numa decisão financeira sem convertê-los. 3. **Cada chamada custa dinheiro.** Retry cego multiplica a conta. Nunca repita automaticamente um 4xx: parâmetro errado repetido continua errado e continua cobrando. Repita só tempo esgotado e 5xx, com recuo exponencial e um teto pequeno de tentativas. 4. **HTTP 402 é saldo insuficiente, e repetir não resolve.** É o único status que exige ação humana — recarregar. Trate-o como erro terminal, com mensagem própria, e não o jogue no mesmo balde dos 4xx genéricos. 5. **`extra_charges` cobra à parte do preço da consulta.** Quando o corpo pede serviços adicionais, a resposta traz cada um com o preço e um `total` que NÃO está incluso no valor base. Se você mostra custo a quem usa, some os dois. ## Ver também - Especificação OpenAPI: https://doc.apibrasil.io/apis/creditos/32dc9033-3a12-4e9e-b3c5-6aa8cb6d50e7/openapi.json - Catálogo de APIs: [Catálogo de APIs](https://doc.apibrasil.io/apis.md) - SDKs oficiais: [SDKs oficiais](https://doc.apibrasil.io/sdks.md) - Índice da documentação: https://doc.apibrasil.io/llms.txt - Versão HTML desta página: https://doc.apibrasil.io/apis/creditos/32dc9033-3a12-4e9e-b3c5-6aa8cb6d50e7