API de Parcelamento

Consultar Débitos

Antes de prosseguir, certifique-se que leu todos os tópicos seção Primeiros Passos.

Estrutura

Para consultar os débitos de um veículo é utilizada a estrutura, conforme Tabela 01:

Tabela 01 - Consultar Débitos
Método GET
URL https://app.parcelamentodemultas.com.br
Recurso /api/v1/debts
Endpoint https://app.parcelamentodemultas.com.br/api/v1/debts?{params}

Request URL

Para consultar os débitos de um veículo é preciso enviar o Request com a seguinte URL, conforme exemplo:
(em seguida veja o que cada parâmetro significa). 

https://app.parcelamentodemultas.com.br/api/v1/debts?detran=detran-sp&placa=RMN3C40&renavam=01255859935
                    
curl --location 'https://app.parcelamentodemultas.com.br/api/v1/debts?detran=detran-sp&placa=RMN3C40&renavam=01255859935' \
--header 'asteroide-key: asteroide' \
--header 'asteroide-pass: asteroide-secret-@2024'

Parâmetros

Tabela 02 - Parâmetros Consulta de Débitos
Parâmetro Padrão Descrição
detran:String not null Identificador do Detran (Ex: detran-ba, detran-sp, detran-es, detran-ce)
placa:String not null Placa do veículo que deseja realizar a consulta
renavam:Integer not null Número do renavam do veículo que deseja realizar a consulta
documento:String null Número do documento do proprietário do veículo que deseja realizar a consulta

Retorno JSON

No caso de sucesso você deverá ver algo como:

Importante

O valor do code e dos uuid dos débitos deverão ser usados na requisição de pagar débitos.

O valor do status dentro do body será 200 se a consulta retornar débitos e 400 se não encontrar nenhum débito.

{
    "message": "Consulta retornada com sucesso",
    "http_status": 200,
    "body": {
        "code": "1ed8c126-d00a-412a-9f8f-dd757b826c0b",
        "status": 200,
        "debts": [
            {
                "uuid": "15cb78220fb5424d9043019722d4560e",
                "description": "IPVA 2024 Parcela Única",
                "type": "ipva",
                "value": "2163.27",
                "due_date": "2024-02-26"
            },
            {
                "uuid": "a4c07f10c8444180b267f7ed9f24f4da",
                "description": "IPVA 2024 Parcela 3",
                "type": "ipva",
                "value": "721.09",
                "due_date": "2024-03-25"
            },
            {
                "uuid": "1d0305a658c745d899b752b5a91f1cb5",
                "description": "TAXA DE LICENCIAMENTO  ",
                "type": "licenciamento",
                "value": "160.22",
                "due_date": "2024-03-06"
            }
        ]
    }
}