---
title: "Consultar Débitos Boleto Assíncrona"
description: "API Consultar Débitos Boleto - Agilidade na Verificação de Pendências"
lang: en
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

- **Category:** Asynchronous Lookups
- **Billing:** per query, with the Bearer Token only
- **Price:** R$12.00 per query
- **Registration:** CPF or CNPJ
- **Version:** v2
- **Published by:** APIBrasil
- **OpenAPI specification:** https://doc.apibrasil.io/apis/creditos/b4ba3651-9b06-11f1-9331-bc24118aba26/openapi.json

## How to call

**Base address:** `https://gateway.apibrasil.io/api/v2`

Authentication: the `Authorization: Bearer <token>` header. Nothing else.

With `homolog: true` in the body, the gateway answers from a fixed base, with the real shape of the response, and does not charge. The CPF 00000000000 belongs to that base and to nobody: use it in tests, never in production.

## 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.

- **Method:** `POST`
- **Address:** `https://gateway.apibrasil.io/api/v2/consulta/veiculos/credits`
- **Route version:** v2

**Headers**

| Header | Value |
| --- | --- |
| `Content-Type` | `application/json` |
| `Authorization` | `Bearer $APIBRASIL_TOKEN` |

**Request body**

```json
{
  "tipo": "consultar-debitos-boleto-async",
  "placa": "ABC1234",
  "webhook_url": "https://seu-sistema.com.br/webhook",
  "homolog": true
}
```

**In 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}'
```

This endpoint accepts `homolog: true` in the body: the response comes back with valid data, `api_limit_for` equal to `homolog` and no charge.

**Sample response, from the catalog**

```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.

- **Method:** `POST`
- **Address:** `https://gateway.apibrasil.io/api/v2/consulta/veiculos/credits`
- **Route version:** v2
- **Price of this operation:** R$0.00 per query

**Headers**

| Header | Value |
| --- | --- |
| `Content-Type` | `application/json` |
| `Authorization` | `Bearer $APIBRASIL_TOKEN` |

**Request body**

```json
{
  "tipo": "consultar-chave-consultar-debitos-boleto",
  "job-id": "3f2a9c1e-7b44-4d21-9a3f-5c1e8b2d6f90"
}
```

**In 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"}'
```

**Sample response, from the catalog**

```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."
  }
}
```

In the sample responses, the fields of the account that generated the sample (`user.first_name`, `user.email`, `user.cellphone`) come out as `[omitido]`. The rest is what the catalog publishes.

## Pitfalls: what an integration gets wrong without warning

Established from the responses the catalog itself publishes. In every one of them the code works on the happy path and fails silently everywhere else:

1. **The error arrives in the BODY, with HTTP 200.**
   The response carries a boolean `error` field and a `message`. Checking only `response.ok` or the HTTP status lets a failure through as a success. ALWAYS check `error === false` before reading `data`.

2. **`balance`, `tax` and `extra_charges.total` are STRINGS in Brazilian format — and the format varies between APIs.**
   Values seen in the catalog: `"154,380"`, `"497,84"`, `"0,000"` and `"0.19"`. Comma in some, dot in another; three decimal places in some, two in another. In JavaScript, `parseFloat("154,380")` returns `154` and drops the cents with no error at all, and `Number("154,380")` returns `NaN`. Write a converter that handles both separators, and never use these fields in a financial decision without converting them.

3. **Every call costs money.**
   Blind retries multiply the bill. Never automatically repeat a 4xx: a bad parameter repeated is still bad, and still charged. Retry only timeouts and 5xx, with exponential backoff and a small attempt ceiling.

4. **HTTP 402 means insufficient balance, and retrying does not fix it.**
   It is the one status that needs a human — a top-up. Treat it as a terminal error with its own message, and do not lump it in with generic 4xx.

5. **`extra_charges` bills on top of the lookup price.**
   When the body asks for add-on services, the response lists each one with its price plus a `total` that is NOT included in the base amount. If you show cost to an end user, add both.

## See also

- OpenAPI specification: https://doc.apibrasil.io/apis/creditos/b4ba3651-9b06-11f1-9331-bc24118aba26/openapi.json
- API catalog: [API catalog](https://doc.apibrasil.io/apis.md)
- Official SDKs: [Official SDKs](https://doc.apibrasil.io/sdks.md)
- Documentation index: https://doc.apibrasil.io/llms.txt
- HTML version of this page: https://doc.apibrasil.io/apis/creditos/b4ba3651-9b06-11f1-9331-bc24118aba26