Débitos + Código de Barras
IPVA, multas e licenciamento em aberto, com código de barras quando a base fornece.
Resumo
| Item | Valor |
|---|---|
| Identificador técnico | debitos |
| Dados exigidos | placa (no catálogo: placa) |
| O que devolve | JSON cru do provedor + PDF |
| Preço vigente | R$ 19,99. Com a sua chave, GET /v1/servicos traz o seu preço. |
| Prazo | Poucos minutos; pode variar conforme a base consultada. |
| Bloco veiculo | Não |
Requisição
Pelo endpoint comum de consultas, POST /v1/consultas. Os valores do exemplo são fictícios.
curl -X POST "https://api.zapcarconsulta.com.br/v1/consultas" \
-H "Authorization: Bearer $ZAPCAR_API_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: pedido-erp-984281-debitos" \
-d '{"servico":"debitos","placa":"ABC1D23"}'Resposta
O POST devolve 201 com o id e status: "processando". O resultado sai em GET /v1/consultas/{id}, que passa por um destes estados:
| status | O que vem |
|---|---|
| processando | Só o envelope. Consulte de novo em 3 a 5 s. |
| concluido | dados e pdf_url. |
| erro | Valor estornado. erro_codigo diz o motivo e retryable se vale criar uma consulta nova. |
Campo dados
No formato da base consultada (camada de espelho): nomes e preenchimento acompanham a fonte. Para dado com forma garantida, use o bloco veiculo quando o serviço tiver.
{
"success": true,
"statusCode": 2,
"msg": "CONSULTA CONCLUIDA COM SUCESSO",
"paid": true,
"uuidRequest": "161461e8-87f4-46b3-85b4",
"registros": [
{
"descricao": "IPVA 2025",
"tipo": "IPVA",
"valor": 1240.55,
"subtotal": 1240.55,
"dataVencimento": "2025-03-31",
"statusPagamento": "EM ABERTO",
"linhaDigitavel": "85800000015-3 35910000...",
"codigoBarra": "858000000153359100...",
"detalhes": [
{ "chave": "Exercício", "grupo": "IPVA", "valor": "2025" }
]
}
]
}Particularidades
- É o serviço de linha digitável e código de barras. Para débitos por categoria na base de cada estado, use debitos-estadual.
No sandbox
Cenários de erro e de espera pela placa (TST0404 não encontrado, TST0503 falha retentável, TST9999 nunca conclui); qualquer outra placa conclui. Como em produção, a resposta não traz bloco veiculo; dados vem reduzido e marcado com _sandbox.
Cobrança
Debitado no POST, antes do processamento, e estornado automaticamente se a consulta terminar em erro. Pedido recusado na validação (400, 402, 409, 422) não cobra. Ler o resultado e baixar o documento são gratuitos. Ver Cobrança e estorno.
Testar no sandbox: abrir no API Explorer. Base da API: https://api.zapcarconsulta.com.br.