7 - Consult Proposal

cURL

cURL

curl --request POST \
  --url https://api.bmpdigital.moneyp.dev.br/FGTS/ConsultaProposta \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'IdempotencyKey: <idempotencykey>' \
  --data '{}'

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,
  "VlrTAC": 123,
  "VlrSeguro": 123,
  "VlrIOF": 123,
  "VlrOutrasDespesas": 123,
  "VlrOutrosServicos": 123,
  "VlrTotalCredito": 123,
  "VlrTotalDivida": 123,
  "PercCETMensal": 123,
  "PercCETAnual": 123,
  "PercJurosMensal": 123,
  "PercJurosAnual": 123,
  "CodigoProposta": "<string>",
  "NumeroCCB": "<string>",
  "MotivoRejeicao": "<string>",
  "MotivoPendencia": "<string>",
  "MotivoCancelamento": "<string>",
  "TextoRetornoPagamento": "<string>",
  "AutenticacaoBancaria": "<string>",
  "ControleBancario": "<string>",
  "StatusProtocoloCEF": "<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>"
    }
  ],
  "CancelamentoFGTS": [
    {
      "Detalhes": "<string>",
      "ContextoEvento": "<string>",
      "TipoEvento": 123,
      "NomeEvento": "<string>",
      "DtEvento": "<string>",
      "NumCodigoBarras": "<string>",
      "NumLinhaDigitavel": "<string>",
      "PixCopiaCola": "<string>",
      "VlrBoleto": 123,
      "DtVencimento": "2023-11-07T05:31:56Z",
      "NumeroBoleto": 123,
      "UrlImpressaoBoleto": "<string>"
    }
  ]
}

Through this endpoint, the partner can consult all the information about an operation, regardless of its status and the time it was included in the system.

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

VlrTAC · 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

PercCETMensal · number<double> | null

PercCETAnual · number<double> | null

PercJurosMensal · number<double> | null

PercJurosAnual · number<double> | null

CodigoProposta · string | null

NumeroCCB · string | null

MotivoRejeicao · string | null

MotivoPendencia · string | null

MotivoCancelamento · string | null

TextoRetornoPagamento · string | null

AutenticacaoBancaria · string | null

ControleBancario · string | null

StatusProtocoloCEF · string | null

PropostaLancamentos · object[] | null

Show child attributes

CancelamentoFGTS · object[] | null

Show child attributes