Consulta de situação de contrato

Consultar Status do Contrato (Proposta BMP)

Tipo: Síncrona Por meio deste endpoint, o parceiro pode consultar diretamente na BMP o status do contrato/proposta, obtendo o retorno dos principais campos financeiros, operacionais e de pagamento da operação. Esta consulta é indicada para acompanhamento pontual, conciliação de informações ou validação de status ao longo do ciclo de vida da proposta.

Importante:
Este endpoint reflete exclusivamente o status da proposta na BMP.
Ele não representa o status da operação na DATAPREV, que deve ser acompanhado por meio dos callbacks de averbação e eventos associados.

Endpoint

POST /Proposta/Consultar

Autorizações

Headers Obrigatórios

Header	Tipo	Descrição
`Authorization`	string	Token de autenticação (Bearer Token).
`IdempotencyKey`	string	Identificador idempotente da requisição.

Corpo da Requisição

Content-Type: application/json { "dto": { // Parâmetros conforme integração contratada } }

Resposta — Sucesso

HTTP 200 — OK

Campo	Tipo	Descrição
`msg`	string	Mensagem de retorno.
`hasError`	boolean	Indica se houve erro no processamento.
`messages`	object[]	Lista de mensagens detalhadas (quando aplicável).
`codigo`	uuid	Identificador único da proposta.
`dtInclusao`	string	Data de inclusão da proposta.
`situacao`	int	Status atual da proposta na BMP.
`vlrFinanciado`	number	Valor financiado.
`qtdeParcelas`	int	Quantidade de parcelas.
`vlrParcela`	number	Valor da parcela.
`vlrTAC`	number	Valor da TAC.
`vlrBoleto`	number	Valor de boleto (quando aplicável).
`vlrSeguro`	number	Valor do seguro.
`vlrIOF`	number	Valor do IOF.
`vlrOutrasDespesas`	number	Outras despesas.
`vlrOutrosServicos`	number	Outros serviços.
`vlrTotalCredito`	number	Valor total do crédito.
`vlrTotalDivida`	number	Valor total da dívida.
`vlrDesembolso`	number	Valor desembolsado.
`percCETMensal`	number	CET mensal.
`percCETAnual`	number	CET anual.
`percJurosMensal`	number	Juros mensal.
`percJurosAnual`	number	Juros anual.
`codigoOperacao`	string	Código da operação.
`tipoContrato`	string	Tipo de contrato.
`dtPagamento`	datetime	Data de pagamento.
`codigoProposta`	string	Código da proposta.
`numeroCCB`	string	Número da CCB.
`motivoRejeicao`	string	Motivo de rejeição, quando houver.
`textoRetornoPagamento`	string	Retorno do processamento de pagamento.
`autenticacaoBancaria`	string	Autenticação bancária.
`controleBancario`	string	Controle bancário.
`textoMotivoAnalise`	string	Motivo de análise.
`nomeFavorecido`	string	Nome do favorecido.
`documentoFavorecido`	string	CPF/CNPJ do favorecido.

Estrutura — `propostaLancamentos`

Lista de lançamentos financeiros associados à proposta (ex.: splits, TEDs ou boletos).

Campo	Tipo	Descrição
`campoID`	string	Identificador do lançamento.
`descricaoCampo`	string	Descrição do lançamento.
`vlrTransacao`	number	Valor da transação.
`dtPrevPagto`	datetime	Data prevista de pagamento.
`dtPagamento`	datetime	Data efetiva de pagamento.
`situacao`	int	Situação do lançamento.
`linhaDigitavel`	string	Linha digitável do boleto.
`dtVenctoBoleto`	datetime	Data de vencimento do boleto.
`vlrBoleto`	number	Valor do boleto.
`codigoBanco`	int	Código do banco.
`numeroBanco`	string	Número do banco.
`tipoConta`	int	Tipo da conta.
`agencia`	string	Agência.
`agenciaDig`	string	Dígito da agência.
`conta`	string	Conta.
`contaDig`	string	Dígito da conta.
`documentoFederal`	string	CPF/CNPJ do favorecido.
`nomePagamento`	string	Nome do favorecido.
`textoRetornoPagamento`	string	Retorno do pagamento.
`autenticacaoBancaria`	string	Autenticação bancária.
`controleBancario`	string	Controle bancário.
`descricaoOcorrencia`	string	Descrição da ocorrência.

Estrutura — `propostaContaPagamento`

Campo	Tipo	Obrigatório	Descrição
`tipoConta`	int	Sim	Tipo da conta bancária.
`agencia`	string	Sim	Agência (máx. 4 caracteres).
`conta`	string	Sim	Conta bancária (máx. 20 caracteres).
`codigoBanco`	int	Não	Código do banco.
`agenciaDig`	string	Não	Dígito da agência (máx. 1).
`contaDig`	string	Não	Dígito da conta (máx. 1).
`numeroBanco`	string	Não	Número do banco.
`documentoFederalPagamento`	string	Não	CPF/CNPJ do favorecido, quando diferente do titular.
`nomePagamento`	string	Não	Nome do favorecido, quando diferente do titular.

Mensagens de Erro

Quando a requisição retorna HTTP 400 — Bad Request, podem ser retornadas as seguintes mensagens:

Categoria	Operação	Ação	Código	Código Detalhado	Mensagem
Proposta	ConsultaProposta	Consultar	C0019	V0001	Produto não configurado para esta integração
Proposta	ConsultaProposta	Consultar	C0113	V0001	Proposta não encontrada
Proposta	ConsultaProposta	Consultar	C0113	V0002	A proposta não pertence a esta integração

Mapeamento do Erro

code → Código
context → Código Detalhado
message → Mensagem

Considerações Técnicas

Este endpoint não substitui o uso de callbacks;
O campo situacao representa o estado da proposta dentro da BMP, não refletindo o status na DATAPREV;
Informações de pagamento e lançamentos são retornadas quando disponíveis;
Requisições sem autorização válida ou fora do escopo da integração serão rejeitadas.

Consulta de Proposta

Curl

curl --request POST \
  --url https://api.bmpdigital.moneyp.dev.br/Proposta/Consultar \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'IdempotencyKey: <idempotencykey>' \
  --data '{
    "dto": {
      "codigoProposta": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "codigoOperacao": "<string>",
      "numeroProposta": 123
    }
  }'

Respostas da API

Sucesso — 200

{
  "msg": "<string>",
  "hasError": true,
  "messages": [
    {
      "messageType": 1,
      "code": "<string>",
      "context": "<string>",
      "description": "<string>",
      "field": "<string>"
    }
  ],
  "codigo": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "dtInclusao": "<string>",
  "situacao": 123,
  "vlrFinanciado": 123,
  "qtdeParcelas": 123,
  "vlrParcela": 123,
  "vlrTAC": 123,
  "vlrBoleto": 123,
  "vlrSeguro": 123,
  "vlrIOF": 123,
  "vlrOutrasDespesas": 123,
  "vlrOutrosServicos": 123,
  "vlrTotalCredito": 123,
  "vlrTotalDivida": 123,
  "vlrDesembolso": 123,
  "percCETMensal": 123,
  "percCETAnual": 123,
  "percJurosMensal": 123,
  "percJurosAnual": 123,
  "codigoOperacao": "<string>",
  "tipoContrato": "<string>",
  "dtPagamento": "2023-11-07T05:31:56Z",
  "codigoProposta": "<string>",
  "numeroCCB": "<string>",
  "motivoRejeicao": "<string>",
  "textoRetornoPagamento": "<string>",
  "autenticacaoBancaria": "<string>",
  "controleBancario": "<string>",
  "textoMotivoAnalise": "<string>",
  "nomeFavorecido": "<string>",
  "documentoFavorecido": "<string>",
  "propostaLancamentos": [
    {
      "campoID": "<string>",
      "descricaoCampo": "<string>",
      "vlrTransacao": 123,
      "dtPrevPagto": "2023-11-07T05:31:56Z",
      "dtPagamento": "2023-11-07T05:31:56Z",
      "situacao": 123,
      "linhaDigitavel": "<string>",
      "dtVenctoBoleto": "2023-11-07T05:31:56Z",
      "vlrBoleto": 123,
      "codigoBanco": 123,
      "numeroBanco": "<string>",
      "tipoConta": 123,
      "agencia": "<string>",
      "agenciaDig": "<string>",
      "conta": "<string>",
      "contaDig": "<string>",
      "documentoFederal": "<string>",
      "nomePagamento": "<string>",
      "textoRetornoPagamento": "<string>",
      "autenticacaoBancaria": "<string>",
      "controleBancario": "<string>",
      "descricaoOcorrencia": "<string>"
    }
  ],
  "propostaContaPagamento": {
    "tipoConta": 123,
    "agencia": "<string>",
    "conta": "<string>",
    "codigoBanco": 123,
    "agenciaDig": "<string>",
    "contaDig": "<string>",
    "numeroBanco": "<string>",
    "documentoFederalPagamento": "<string>",
    "nomePagamento": "<string>"
  }
}

Erro — 400

{
  "msg": "<string>",
  "hasError": true,
  "messages": [
    {
      "messageType": 1,
      "code": "<string>",
      "context": "<string>",
      "description": "<string>",
      "field": "<string>"
    }
  ]
}

Tipos de Contratação

Outros

​Consultar Status do Contrato (Proposta BMP)

​Endpoint

​Autorizações

​Headers Obrigatórios

​Corpo da Requisição

​Resposta — Sucesso

​Estrutura — propostaLancamentos

​Estrutura — propostaContaPagamento

​Mensagens de Erro

​Mapeamento do Erro

​Considerações Técnicas

​Consulta de Proposta

​Curl

​Respostas da API

​Sucesso — 200

​Erro — 400