28 - Consultar

cURL

cURL

curl --request POST \
  --url https://api.example.com/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
  }
}
'

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>",
  "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>"
  }
}

Por meio deste endpoint o parceiro consulta a proposta, obtendo o retorno dos campos principais

​

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

Autorizações

Authorization · string · header · obrigatório

Informe o token

Cabeçalhos

IdempotencyKey · string · obrigatório

Corpo

application/jsontext/jsonapplication/*+json

dto · object

Show child attributes

Resposta

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

propostaLancamentos · object[] | null

Show child attributes

propostaContaPagamento · object

Show child attributes