Consultar Débitos Veiculares
Essa funcionalidade possibilita aos clientes da Celcoin realizar a consulta completa dos débitos veiculares vinculados a um veículo, incluindo taxas, multas e pendências, de forma prática e simples.
Passos para Integrar
- Realizar autenticação na API - [API Reference]
- Criar pedido de consulta de débitos veiculares - [API Reference]
- Receber o webhook com os débitos veiculares. (entity -> vehicledebts-consult)
- Verificar o status da solicitação de débitos na API - [API Reference]
Fluxo de integração
Criar pedido de consulta de débitos veiculares.
Para obter as informações de um débito veicular é necessário realizar essa consulta na api (Gera um pedido assíncrono de consulta de débitos veiculares) utilizando o método POST, onde precisa ser preenchido no body algumas informações como estado, renavam, placa do veículo, CPF ou CNPJ.
cURL da chamada
curl --location 'https://sandbox.openfinance.celcoin.dev/baas/v2/vehicledebts/consult' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {token}' \
--data '{
"clientRequestId": "58d6faf2-98f5-4cd5-b855-2adac6e2b985",
"documentNumber": "16785961831",
"licensePlate": "JFI8753",
"renavam": "56387604559",
"state": "SP"
}'
Parâmetros do Body:
Campo | Descrição | Tipo |
---|---|---|
state | Estado onde o veículo está registrado | String (2) |
licensePlate | Placa do veículo | String (10) |
renavam | Renavam do veículo | String (20) |
cpfCnpj | Documento do proprietário do veículo | String (20) |
clientRequestId | Identificador da transação, pode ser um ID interno da transação | String (36) |
Exemplo de retorno
Sucesso 200
{
"body": {
"clientRequestId": "58d6faf2-98f5-4cd5-b855-2adac6e2b985",
"documentNumber": "16785961831",
"licensePlate": "JFI8753",
"renavam": "56387604559",
"state": "SP",
"idConsult": "948a333b-2814-44e9-baed-04c2872d154d"
},
"version": "1.0.0",
"status": "PROCESSING"
}
Error 400
{
"version": "1.0.0",
"status": "ERROR",
"error": {
"errorCode": "IVDBE001",
"message": "É obrigatório informar a placa do veículo."
}
}
Tabela de errorCode
Code | Message |
---|---|
IVDBE001 | É obrigatório informar a placa do veículo. |
IVDBE002 | É obrigatório informar o clientRequestId. |
IVDBE003 | É obrigatório informar o renavam do veículo. |
IVDBE004 | É obrigatório informar o documentNumber. |
IVDBE005 | O campo clientRequestId não pode conter mais de 200 caracteres. |
IVDBE006 | É obrigatório informar o estado. |
IVDBE007 | O estado informado está invalido. |
IVDBE008 | documentNumber está invalido. |
IVDBE009 | Já existe uma consulta com o mesmo clientRequestId. |
IVDBE010 | Placa ou Renavam inválido(s). |
IVDBE011 | O estado informado não está disponível para consulta e pagamento. |
IVDBE015 | Placa do veiculo não pode conter mais de 15 caracteres |
IVDBE016 | Renavam não pode conter mais de 20 caracteres. |
IVDIE999 | Ocorreu um erro durante a solicitação de consulta, favor tente novamente. |
Receber o retorno da consulta via Webhook
entity -> vehicledebts-consult
{
"entity": "vehicledebts-consult",
"createTimestamp": "2024-01-25T12:09:39.6491225",
"status": "SUCCESS",
"body": {
"clientRequestId": "00003",
"debts": [
{
"amount": 85.13,
"dependsOn": [],
"description": "I004242123 - Infração de Trânsito",
"distinct": [],
"dueDate": null,
"expirationDate": null,
"hasDiscount": false,
"id": "9547B3A8-05B9-4D1C-8C72-A500BB6D93EF",
"isExpired": true,
"required": false,
"title": "Infração Vencida - I004242123",
"type": "ticket",
"year": null
}
],
"idConsult": "34fee7bc-4d40-4605-9af8-398ed7d0d6b5",
"totalAmount": 12345,
"vehicle": {
"document": "39268450828",
"licensePlate": "DIS9865",
"renavam": "01203988813",
"uf": "DF"
}
}
}
Verificar o status da solicitação de débitos na API.
cURL da chamada
curl --location 'https://sandbox.openfinance.celcoin.dev/baas/v2/vehicledebts/consult?IdConsult=1ae8a57d-b15d-4b4b-b943-4cf76ebabca1&ClientRequestId=58d6faf2-98f5-4cd5-b855-2adac6e2b985&Identificador%20do%20d%C3%A9bito.=cbff1676-1af2-41cd-9169-f1ea58fe59cc' \
--header 'Authorization: Bearer {token}'
Exemplo de retorno
Sucesso 200
{
"version": "1.0.0",
"status": "SUCCESS",
"body": {
"clientRequestId": "58d6faf2-98f5-4cd5-b855-2adac6e2b985",
"idConsult": "1ae8a57d-b15d-4b4b-b943-4cf76ebabca1",
"status": "PENDING",
"debts": [
{
"ait": "string",
"amount": 0,
"debitId": "string",
"description": "string",
"dueDate": "2024-12-09T20:12:40.420Z",
"expirationDate": "2024-12-09T20:12:40.420Z",
"hasDiscount": true,
"isExpired": true,
"required": true,
"title": "string",
"type": "string",
"year": 0,
"distinct": [
"string"
],
"dependsOn": [
"string"
]
}
],
"vehicle": {
"document": "11111111111",
"licensePlate": "JFI8753",
"renavam": "56387604559",
"uf": "SP",
"year": 0
},
"error": [
{
"errorCode": "XXX001",
"message": "Ocorreu um erro interno durante a chamada da api."
}
]
}
}
Error 400
{
"version": "1.0.0",
"status": "ERROR",
"error": {
"errorCode": "IVDBE005",
"message": "O campo clientRequestId não pode conter mais de 200 caracteres."
}
}
Tabela de errorCode
Code | Message |
---|---|
IVDBE005 | O campo clientRequestId não pode conter mais de 200 caracteres. |
IVDBE019 | O campo idConsult não pode conter mais de 200 caracteres. |
IVDBE020 | Necessário informar o idConsult ou o clientRequestId. |
IVDBE022 | O campo debitId não pode conter mais de 200 caracteres. |
Updated 10 days ago