--- title: "Débitos V4 Assíncrona" description: "⚠️ Aviso: Esta consulta será debitada assim que o processamento assíncrono for concluído." lang: pt-BR canonical: https://doc.apibrasil.io/apis/creditos/9f74da75-5123b-4f3b-9533-cc7e9a5gf24 markdown: https://doc.apibrasil.io/apis/creditos/9f74da75-5123b-4f3b-9533-cc7e9a5gf24.md source: apibrasil-documentation --- # Débitos V4 Assíncrona > ⚠️ Aviso: Esta consulta será debitada assim que o processamento assíncrono for concluído. - **Categoria:** Consultas Assíncronas - **Cobrança:** por consulta, só com o Bearer Token - **Preço:** R$ 8,00 por consulta - **Limite:** 9.990.000 por mês - **Cadastro:** exige CNPJ - **Versão:** v1 - **Publicada por:** APIBrasil - **Especificação OpenAPI:** https://doc.apibrasil.io/apis/creditos/9f74da75-5123b-4f3b-9533-cc7e9a5gf24/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 (2 endpoints) ### 1. POST /consulta/vehicles/credits ⚠️ Aviso: Esta consulta será debitada assim que o processamento assíncrono for concluído. API Débitos Veiculares - Consulta Ágil e Segura A API Débitos V4 Assíncrona permite que seu sistema consulte rapidamente eventuais débitos veiculares de forma 100% online e segura, trazendo respostas detalhadas e atualizadas via método POST no endpoint /consulta/vehicles/credits. Ideal para empresas de crédito, fintechs, despachantes e plataformas de gestão veicular, a integração é simples e acelera processos internos, agregando valor imediato ao seu negócio. Adote uma solução confiável e automatize a checagem de pendências em veículos para tomada de decisões mais precisas, reduzindo riscos e melhorando a experiência do seu cliente. - **Método:** `POST` - **Endereço:** `https://gateway.apibrasil.io/api/v2/consulta/vehicles/credits` - **Versão da rota:** v1 **Cabeçalhos** | Cabeçalho | Valor | | --- | --- | | `Content-Type` | `application/json` | | `Authorization` | `Bearer $APIBRASIL_TOKEN` | **Corpo da requisição** ```json { "tipo": "debitos-v4-async", "placa": "ABC1234", "webhook_url": "https://seu-webhook.com.br", "homolog": true } ``` **Em cURL** ```bash curl -X POST "https://gateway.apibrasil.io/api/v2/consulta/vehicles/credits" \ -H "Content-Type: application/json" \ -H "Authorization: Bearer $APIBRASIL_TOKEN" \ -d '{"tipo":"debitos-v4-async","placa":"ABC1234","webhook_url":"https://seu-webhook.com.br","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": "514,780", "balance_before": "514,780", "tax": "0,000", "status_code": 200, "error": false, "message": "Dados validos em homologacao! Voce nao foi tarifado e a requisicao nao foi contabilizada.", "valor_consulta": 0, "api_limit_for": "homolog", "homolog": true, "data": { "accepted": true, "job-id": "3309cfc2-3ab5-4dbe-a1bc-5bc2afa6c7d9", "msg": "consulta em processamento; resultado será enviado ao webhook_url" } } ``` ### 2. POST /consulta/vehicles/credits ⚠️ Aviso: A chave para utilizar essa consulta tem validade de 24 horas. API Débitos Veiculares - Consulta Ágil para Decisões Rápidas A API Débitos V4 Assíncrona permite que seu sistema consulte em tempo real os débitos veiculares (multas, impostos e pendências) de maneira prática e totalmente integrada. Com integração rápida via POST no endpoint de consulta/vehicles/credits, você adiciona eficiência ao seu fluxo e aumenta a confiança nas decisões comerciais, como financiamentos, comercialização de veículos e gestão de frota. Receba retornos claros e completos, prontos para serem aproveitados em análises automáticas e conferências instantâneas, tudo acompanhado por robustez técnica e escalabilidade para o seu negócio. - **Método:** `POST` - **Endereço:** `https://gateway.apibrasil.io/api/v2/consulta/vehicles/credits` - **Versão da rota:** v1 - **Preço desta operação:** R$ 0,00 por consulta **Cabeçalhos** | Cabeçalho | Valor | | --- | --- | | `Content-Type` | `application/json` | | `Authorization` | `Bearer $APIBRASIL_TOKEN` | **Corpo da requisição** ```json { "tipo": "consulta-chave", "job-id": "e312f471-b548-43c7-bdea-66f371a02045", "homolog": true } ``` **Em cURL** ```bash curl -X POST "https://gateway.apibrasil.io/api/v2/consulta/vehicles/credits" \ -H "Content-Type: application/json" \ -H "Authorization: Bearer $APIBRASIL_TOKEN" \ -d '{"tipo":"consulta-chave","job-id":"e312f471-b548-43c7-bdea-66f371a02045","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": "234,200", "balance_before": "234,200", "tax": "0,000", "status_code": 200, "error": false, "message": "Consulta assincrona disparada com sucesso! Voce será tarifado somente quando o processamento terminar e tiver sucesso.", "valor_consulta": 0, "api_limit_for": "async", "homolog": true, "data": { "job-id": "e312f471-b548-43c7-bdea-66f371a02045", "job_status": "completed", "payload": { "dados": [ { "dadosDoVeiculo": { "chassi": "9BWAG42N7YT789012", "placa": "ABC1234", "renavam": "98765432100", "totalDebito": 1075.64 }, "debitosDPVAT": { "ocorrencia": null, "totalDebito": 0 }, "debitosIPVA": { "ocorrencia": null, "totalDebito": 0 }, "debitosLicenciamento": { "ocorrencia": null, "totalDebito": 0 }, "debitosMultas": { "ocorrencia": [ { "dataHoraMulta": "2025-02-15 10:45", "dataVencimento": "2025-04-18", "descricao": "Dirigir utilizando telefone celular", "fonte": "DETRAN - MARINGA", "identificador": "HML0004521", "linhaDigitavel": "null", "local": "Av. Brasil, 1500", "uf": "PR", "valor": 293.47 }, { "dataHoraMulta": "2025-05-20 17:30", "dataVencimento": "2025-07-22", "descricao": "Transitar em velocidade superior a maxima permitida em ate 20%", "fonte": "RENAINF", "identificador": "HML0008934", "linhaDigitavel": "null", "local": "BR-376 Km 210", "uf": "PR", "valor": 586.94 }, { "dataHoraMulta": "2025-08-03 22:10", "dataVencimento": "2025-10-05", "descricao": "Estacionar em local e horario de estacionamento rotativo", "fonte": "DETRAN - LONDRINA", "identificador": "HML0002167", "linhaDigitavel": "null", "local": "Rua Sergipe, 450", "uf": "PR", "valor": 195.23 } ], "quantidade": 3, "totalDebito": 1075.64 }, "outrosDebitos": { "ocorrencia": null, "totalDebito": 0 }, "pdf": null, "restricoes": null } ], "msg": "Consulta concluída com sucesso.", "success": true } } } ``` 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/9f74da75-5123b-4f3b-9533-cc7e9a5gf24/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/9f74da75-5123b-4f3b-9533-cc7e9a5gf24