34 - Registro de Veículo

cURL

curl --request POST \
  --url https://api.bmpdigital.moneyp.dev.br/Proposta/IncluirDadosVeiculo \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'IdempotencyKey: <idempotencykey>' \
  --data '
{
  "dto": {
    "codigoProposta": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "codigoOperacao": "<string>",
    "numeroProposta": 123
  },
  "dadosVeiculoDTO": {
    "placa": "<string>",
    "marca": "<string>",
    "modelo": "<string>",
    "versaoModelo": "<string>",
    "anoFab": 123,
    "anoMod": 123,
    "cor": "<string>",
    "chassis": "<string>",
    "renavam": "<string>",
    "proprietario": "<string>",
    "documentoFederalProprietario": "<string>",
    "financiado": true,
    "saldoFinanciamento": 5000000000000000,
    "tipoPlaca": 123,
    "tipoVeiculo": 123,
    "ufPlaca": "<string>",
    "ufLicenciamento": "<string>",
    "tipoRestricao": 123,
    "tipoChassi": 123,
    "codigoFipe": "<string>",
    "situacaoGravame": 123,
    "descricaoGravame": "<string>",
    "codigoRetornoGravame": 123,
    "dtSituacaoGravame": "2023-11-07T05:31:56Z",
    "origemGravame": 123,
    "nroGravame": 123,
    "nroRegristroGecov": "<string>",
    "vlrFipe": 49999999.995,
    "vlrVeiculo": 49999999.995,
    "zeroKM": true,
    "km": 499999
  }
}
'

{
  "msg": "<string>",
  "hasError": true,
  "messages": [
    {
      "messageType": 1,
      "code": "<string>",
      "context": "<string>",
      "description": "<string>",
      "field": "<string>"
    }
  ],
  "codigo": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "numero": 123
}

cURL

curl --request POST \
  --url https://api.bmpdigital.moneyp.dev.br/Proposta/IncluirDadosVeiculo \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'IdempotencyKey: <idempotencykey>' \
  --data '
{
  "dto": {
    "codigoProposta": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "codigoOperacao": "<string>",
    "numeroProposta": 123
  },
  "dadosVeiculoDTO": {
    "placa": "<string>",
    "marca": "<string>",
    "modelo": "<string>",
    "versaoModelo": "<string>",
    "anoFab": 123,
    "anoMod": 123,
    "cor": "<string>",
    "chassis": "<string>",
    "renavam": "<string>",
    "proprietario": "<string>",
    "documentoFederalProprietario": "<string>",
    "financiado": true,
    "saldoFinanciamento": 5000000000000000,
    "tipoPlaca": 123,
    "tipoVeiculo": 123,
    "ufPlaca": "<string>",
    "ufLicenciamento": "<string>",
    "tipoRestricao": 123,
    "tipoChassi": 123,
    "codigoFipe": "<string>",
    "situacaoGravame": 123,
    "descricaoGravame": "<string>",
    "codigoRetornoGravame": 123,
    "dtSituacaoGravame": "2023-11-07T05:31:56Z",
    "origemGravame": 123,
    "nroGravame": 123,
    "nroRegristroGecov": "<string>",
    "vlrFipe": 49999999.995,
    "vlrVeiculo": 49999999.995,
    "zeroKM": true,
    "km": 499999
  }
}
'

{
  "msg": "<string>",
  "hasError": true,
  "messages": [
    {
      "messageType": 1,
      "code": "<string>",
      "context": "<string>",
      "description": "<string>",
      "field": "<string>"
    }
  ],
  "codigo": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "numero": 123
}

Por meio deste endpoint o parceiro inclui os dados de veículo para uma proposta. O veículo obrigatoriamente deve ter uma placa informada, demais campos são opcionais. Os dados de veículos são validados pelos nossos analistas de crédito e servem como base para aprovar ou rejeitar a proposta. O uso será de acordo com a necessidade da integração. Regras e Validações:

A mesma placa não pode ser incluída mais de uma vez na proposta;
Campos alfanuméricos serão truncados conforme o tamanho definido no manual;
O campo documentoFederalProprietario aceita strings com 11 caracteres para CPF e 14 caracteres para CNPJ (apenas números).

Mensagens de erro

A tabela abaixo representa as mensagens de erro que podem ser retornadas ao tentar realizar uma requisição.

Mostrar Mensagens de requisições com erro

O retorno de uma requisição com status HTTP 400 (Bad Request) pode incluir as seguintes mensagens de erro:

No exemplo de retorno ao lado, o campo code representa a coluna Código desta tabela; o campo context representa a coluna Código Detalhado; e o campo message representa a coluna Mensagem.

Categoria	Operação	Ação	Código	Código Detalhado	Mensagem
Proposta	IncluirPropostaDadosVeiculo	IncluirDadosVeiculo	C0112	V0001	Proposta não encontrada
Proposta	IncluirPropostaDadosVeiculo	IncluirDadosVeiculo	C0112	V0002	A Proposta não pertence à esta Integração
Proposta	IncluirPropostaDadosVeiculo	IncluirDadosVeiculo	T0680	D0001	Proposta não encontrada
Proposta	IncluirPropostaDadosVeiculo	IncluirDadosVeiculo	T0680	D0002	Chassi já cadastrada nessa proposta
Proposta	IncluirPropostaDadosVeiculo	IncluirDadosVeiculo	T0680	D0003	Codigo identificador já cadastrado nessa proposta

Tabela de códigos auxuliares

Mostrar Tabelas

Mostrar TipoVeículo

ID	Descrição
1	Particular
2	Comercial
3	Oficial
4	Diplomático
5	Especial
6	Colecionador

Mostrar Tabela TipoRestrição

ID	Descrição
1	Arredondamento mercantil/leasing
2	Reserva e domínio/outros
3	Alienação fiduciária
4	Penhor

Mostrar Tabela TipoChassi

ID	Descrição
1	Remarcado
2	Normal

Mostrar Tabela SituaçãoGravame

ID	Descrição
2	Significa que existe alguma pendência gravame

Mostrar Tabela OrigemGravame

ID	Descrição
1	Interno
2	Externo
3	Ambos

Authorizations

Authorization

string

header

required

Informe o token

Headers

IdempotencyKey

string

required

Body

dto

object

Mostrar atributos filhos

dto.codigoProposta

string<uuid> | null

Código identificador da proposta

dto.codigoOperacao

string | null

Código da operação do parceiro

dto.numeroProposta

integer<int64> | null

Número sequencial da proposta

dadosVeiculoDTO

object

Mostrar atributos filhos

dadosVeiculoDTO.placa

string | null

required

Placa do veículo

Maximum string length: 10

dadosVeiculoDTO.marca

string | null

Marca do veículo

Maximum string length: 30

dadosVeiculoDTO.modelo

string | null

Modelo do veículo

Maximum string length: 30

dadosVeiculoDTO.versaoModelo

string | null

Caracterização do assinante

Maximum string length: 50

dadosVeiculoDTO.anoFab

integer<int32> | null

Ano de fabricação

dadosVeiculoDTO.anoMod

integer<int32> | null

Ano do modelo

dadosVeiculoDTO.cor

string | null

Cor do veículo

Maximum string length: 30

dadosVeiculoDTO.chassis

string | null

Chassis

Maximum string length: 50

dadosVeiculoDTO.renavam

string | null

Registro Nacional de Veículos Automotores (Renavam)

Maximum string length: 30

dadosVeiculoDTO.proprietario

string | null

Nome do proprietário

Maximum string length: 60

dadosVeiculoDTO.documentoFederalProprietario

string | null

Documento do proprietário

Maximum string length: 20

dadosVeiculoDTO.financiado

boolean | null

Indica se veículo ainda está em financiamento

dadosVeiculoDTO.saldoFinanciamento

number<double> | null

Saldo do financiamento

Intervalo obrigatório: 0 <= x <= 10000000000000000

dadosVeiculoDTO.tipoPlaca

integer<int32> | null

Tipo de placa: 1-Particular, 2-Comercial, 3-Oficial, 4-Diplomático, 5-Especial, 6-Colecionador

dadosVeiculoDTO.tipoVeiculo

integer<int32> | null

Tipo de veículo: 1-Carro, 2-Moto, 3-Caminhão, 4-Van/Utilitário, 5-SUV

dadosVeiculoDTO.ufPlaca

string | null

Unidade Federal (UF) da placa

Maximum string length: 2

dadosVeiculoDTO.ufLicenciamento

string | null

Unidade Federal (UF) do Licenciamento

Maximum string length: 2

dadosVeiculoDTO.tipoRestricao

integer<int32> | null

Tipo de restrição

dadosVeiculoDTO.tipoChassi

integer<int32> | null

Tipo de chassi

dadosVeiculoDTO.codigoFipe

string | null

Código da Fundação Instituto de Pesquisas Econômicas (Fipe)

Maximum string length: 30

dadosVeiculoDTO.situacaoGravame

integer<int32> | null

Situação do Gravame

dadosVeiculoDTO.descricaoGravame

string | null

Descrição do Gravame

Maximum string length: 1000

dadosVeiculoDTO.codigoRetornoGravame

integer<int32> | null

Código Retorno Gravame

dadosVeiculoDTO.dtSituacaoGravame

string<date-time> | null

Data de situação do Gravame

dadosVeiculoDTO.origemGravame

integer<int32> | null

Indica a origem do gravame do veículo (interno, externo ou ambos).

dadosVeiculoDTO.nroGravame

integer<int32> | null

Gravame

dadosVeiculoDTO.nroRegristroGecov

string | null

Número registro do GECOV – Gerenciador de contratos de veículos.

Maximum string length: 50

dadosVeiculoDTO.vlrFipe

number<double> | null

Valor da Fundação Instituto de Pesquisas Econômicas - Fipe.

Intervalo obrigatório: 0 <= x <= 99999999.99

dadosVeiculoDTO.vlrVeiculo

number<double> | null

Valor do veiculo.

Intervalo obrigatório: 0 <= x <= 99999999.99

dadosVeiculoDTO.zeroKM

boolean | null

Indica se o veículo possui zero quilômetros rodados.

dadosVeiculoDTO.km

integer<int32> | null

Valor da quilometragem do veículo.

Intervalo obrigatório: 0 <= x <= 999999

Response

msg

string | null

hasError

boolean

messages

object[] | null

Mostrar atributos filhos

messages.messageType

enum<integer>

Opções disponíveis:

1,

2,

3

messages.code

string | null

messages.context

string | null

messages.description

string | null

messages.field

string | null

codigo

string<uuid>

numero

integer<int64>

33 - Cancelamento de Contrato 35 - Salvar Proposta Garantia Bem Documento

⌘I

Guia Inicial

Métodos de Assinaturas

Guia do Desenvolvedor

Referencias de API

Guias e Casos de Uso

34 - Registro de Veículo

Mensagens de erro

Tabela de códigos auxuliares

Authorizations

Headers

Body

Response

Guia Inicial

Métodos de Assinaturas

Guia do Desenvolvedor

Referencias de API

Guias e Casos de Uso

​Mensagens de erro

​Tabela de códigos auxuliares

Authorizations

Headers

Body

Response

Mensagens de erro

Tabela de códigos auxuliares