22 - Consult

cURL

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
  }
}
'

import requests

url = "https://api.bmpdigital.moneyp.dev.br/Proposta/Consultar"

payload = { "dto": {
        "codigoProposta": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "codigoOperacao": "<string>",
        "numeroProposta": 123
    } }
headers = {
    "IdempotencyKey": "<idempotencykey>",
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    IdempotencyKey: '<idempotencykey>',
    Authorization: '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    dto: {
      codigoProposta: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
      codigoOperacao: '<string>',
      numeroProposta: 123
    }
  })
};

fetch('https://api.bmpdigital.moneyp.dev.br/Proposta/Consultar', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.bmpdigital.moneyp.dev.br/Proposta/Consultar",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'dto' => [
        'codigoProposta' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        'codigoOperacao' => '<string>',
        'numeroProposta' => 123
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json",
    "IdempotencyKey: <idempotencykey>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.bmpdigital.moneyp.dev.br/Proposta/Consultar"

	payload := strings.NewReader("{\n  \"dto\": {\n    \"codigoProposta\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"codigoOperacao\": \"<string>\",\n    \"numeroProposta\": 123\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("IdempotencyKey", "<idempotencykey>")
	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.bmpdigital.moneyp.dev.br/Proposta/Consultar")
  .header("IdempotencyKey", "<idempotencykey>")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"dto\": {\n    \"codigoProposta\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"codigoOperacao\": \"<string>\",\n    \"numeroProposta\": 123\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.bmpdigital.moneyp.dev.br/Proposta/Consultar")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["IdempotencyKey"] = '<idempotencykey>'
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"dto\": {\n    \"codigoProposta\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"codigoOperacao\": \"<string>\",\n    \"numeroProposta\": 123\n  }\n}"

response = http.request(request)
puts response.read_body

200

{
  "msg": "<string>",
  "hasError": true,
  "messages": [
    {
      "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>"
  }
}

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

Through this endpoint, the partner consults the proposal, obtaining the main fields’ response.

Show Messaging - Proposal Consultation

Category	Operation	Action	Code	Detailed Code	Message
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 à esta Integração

Authorizations

Authorization · string · header · required

Informe o token

Headers

IdempotencyKey · string · required

Body

application/jsontext/jsonapplication/*+json

dto · object

Show child attributes

Response

200

text/plain

OK

msg · string | null

hasError · boolean

messages · object[] | null

Show child attributes

codigo · string<uuid>

dtInclusao · string | null

situacao · integer<int32>

vlrFinanciado · number<double> | null

qtdeParcelas · integer<int32> | null

vlrParcela · number<double> | null

vlrTAC · number<double> | null

vlrBoleto · number<double> | null

vlrSeguro · number<double> | null

vlrIOF · number<double> | null

vlrOutrasDespesas · number<double> | null

vlrOutrosServicos · number<double> | null

vlrTotalCredito · number<double> | null

vlrTotalDivida · number<double> | null

vlrDesembolso · number<double> | null

percCETMensal · number<double> | null

percCETAnual · number<double> | null

percJurosMensal · number<double> | null

percJurosAnual · number<double> | null

codigoOperacao · string | null

tipoContrato · string | null

dtPagamento · string<date-time> | null

codigoProposta · string | null

numeroCCB · string | null

motivoRejeicao · string | null

textoRetornoPagamento · string | null

autenticacaoBancaria · string | null

controleBancario · string | null

textoMotivoAnalise · string | null

nomeFavorecido · string | null

documentoFavorecido · string | null

propostaLancamentos · object[] | null

Show child attributes

propostaContaPagamento · object

Show child attributes