v1

latestOpenAPI 3.0.12026-07-245303882.5 MB

Consultar Débitos de um veículo

Essa API irá retornar informações de um débito veicular a partir dos dados do veículo e proprietário. Basicamente você irá passar as informações e a Celcoin irá realizar a consulta e retornará após alguns segundos via webhook. Para mais informações de como realizar a implementação dessa API criamos o artigo a seguir. Para testes em ambiente de sandbox recomendamos que seja utilizado a massa de teste disponibilizada neste link. Criamos uma tabela que contém todos os erros que essa api pode retornar, recomendamos a leitura do da mesma para realizar a implementação dessa api.

post/vehicledebtsapi/v1/debts

Request body

statestring required

Estado onde o veículo está registrado

licensePlatestring required

Placa do veículo

renavamstring required

Renavam do veículo. Este campo é obrigatório para todos os estados

cpfCnpjstring required

Documento do proprietário do veículo. Obrigatório para os estados PE, PB e RJ

clientRequestIdstring required

Identificador da transação. Pode ser um ID interno da transação e utilizado como idempotência

Response

200

transactionIdinteger

messagestring

errorCodestring

Example response

{
  "transactionId": 999999,
  "message": "Sucesso",
  "errorCode": "000"
}