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

  1. Realizar autenticação na API - [API Reference]
  2. Criar pedido de consulta de débitos veiculares - [API Reference]
    1. Receber o webhook com os débitos veiculares. (entity -> vehicledebts-consult)
  3. 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:

CampoDescriçãoTipo
stateEstado onde o veículo está registradoString (2)
licensePlatePlaca do veículoString (10)
renavamRenavam do veículoString (20)
cpfCnpjDocumento do proprietário do veículoString (20)
clientRequestIdIdentificador da transação, pode ser um ID interno da transaçãoString (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

CodeMessage
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.
IVDBE005O campo clientRequestId não pode conter mais de 200 caracteres.
IVDBE006É obrigatório informar o estado.
IVDBE007O estado informado está invalido.
IVDBE008documentNumber está invalido.
IVDBE009Já existe uma consulta com o mesmo clientRequestId.
IVDBE010Placa ou Renavam inválido(s).
IVDBE011O estado informado não está disponível para consulta e pagamento.
IVDBE015Placa do veiculo não pode conter mais de 15 caracteres
IVDBE016Renavam não pode conter mais de 20 caracteres.
IVDIE999Ocorreu 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

CodeMessage
IVDBE005O campo clientRequestId não pode conter mais de 200 caracteres.
IVDBE019O campo idConsult não pode conter mais de 200 caracteres.
IVDBE020Necessário informar o idConsult ou o clientRequestId.
IVDBE022O campo debitId não pode conter mais de 200 caracteres.