---
title: "Consultar Débitos Boleto Assíncrona"
description: "API Consultar Débitos Boleto - Agilidade na Verificação de Pendências"
lang: pt-BR
canonical: https://doc.apibrasil.io/apis/creditos/b4ba3651-9b06-11f1-9331-bc24118aba26
markdown: https://doc.apibrasil.io/apis/creditos/b4ba3651-9b06-11f1-9331-bc24118aba26.md
source: apibrasil-documentation
---

# Consultar Débitos Boleto Assíncrona

> API Consultar Débitos Boleto - Agilidade na Verificação de Pendências

- **Categoria:** Consultas Assíncronas
- **Cobrança:** por consulta, só com o Bearer Token
- **Preço:** R$ 12,00 por consulta
- **Cadastro:** CPF ou CNPJ
- **Versão:** v2
- **Publicada por:** APIBrasil
- **Especificação OpenAPI:** https://doc.apibrasil.io/apis/creditos/b4ba3651-9b06-11f1-9331-bc24118aba26/openapi.json

## Como chamar

**Endereço base:** `https://gateway.apibrasil.io/api/v2`

Autenticação: cabeçalho `Authorization: Bearer <token>`. 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/veiculos/credits

Dispara a consulta assíncrona de débitos com boleto a partir da placa. A resposta imediata é 202 com o job-id do processamento; o resultado completo — dados da consulta e link do PDF do boleto — é entregue na webhook_url informada quando o fornecedor conclui a emissão (até ~2 minutos para boleto novo). O valor da consulta é reservado na admissão e cobrado apenas na conclusão com sucesso.

- **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": "consultar-debitos-boleto-async",
  "placa": "ABC1234",
  "webhook_url": "https://seu-sistema.com.br/webhook",
  "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":"consultar-debitos-boleto-async","placa":"ABC1234","webhook_url":"https://seu-sistema.com.br/webhook","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": "405,200",
  "balance_before": "405,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": {
    "accepted": true,
    "job-id": "1ef0d359-5919-4fd1-bb6d-432cc4447e2c",
    "msg": "consulta em processamento; resultado sera enviado ao webhook_url"
  }
}
```

### 2. POST /consulta/veiculos/credits

Consulta o andamento e o resultado da consulta assíncrona pelo job-id recebido no disparo. Enquanto processa, retorna o status processing; ao concluir, retorna o payload completo com os dados e o link do PDF do boleto. Consulta de status gratuita — não debita créditos e pode ser repetida à vontade.

- **Método:** `POST`
- **Endereço:** `https://gateway.apibrasil.io/api/v2/consulta/veiculos/credits`
- **Versão da rota:** v2
- **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": "consultar-chave-consultar-debitos-boleto",
  "job-id": "3f2a9c1e-7b44-4d21-9a3f-5c1e8b2d6f90"
}
```

**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":"consultar-chave-consultar-debitos-boleto","job-id":"3f2a9c1e-7b44-4d21-9a3f-5c1e8b2d6f90"}'
```

**Resposta de exemplo, do catálogo**

```json
{
  "job-id": "3f2a9c1e-7b44-4d21-9a3f-5c1e8b2d6f90",
  "status": "completed",
  "resultado": {
    "status": true,
    "consulta": {
      "debitado": true,
      "id": 12345,
      "valor": 12
    },
    "dados": {
      "consulta_id": "67890",
      "placa": "ABC1234",
      "pdf": "https://consultar-debitos-boleto.apiveiculos.com.br/pdf/uuid-do-boleto"
    },
    "msg": "Consulta realizada com sucesso."
  }
}
```

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/b4ba3651-9b06-11f1-9331-bc24118aba26/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/b4ba3651-9b06-11f1-9331-bc24118aba26