Pular para o conteúdo principal

Realizar Proposta

Após a consulta de CPF obter o status de sucesso, uma proposta é automaticamente criada no banco de dados. O próximo passo é realizar a proposta baseada na solicitação de saldo do usuário. Esse processo envolve buscar a proposta existente pelo balanceSolicitationId e enviar os dados atualizados do usuário para a API.

Buscar Proposta pela Solicitação de Saldo​

Para buscar a proposta, utilize o seguinte endpoint:

  • Método: GET
  • URL: https://bff-dev.granatech.com.br/api/proposal/balance-solicitation/{balanceSolicitationId}

Parâmetros​

  • balanceSolicitationId (string): O ID da solicitação de saldo associado à proposta a ser buscada.

Exemplo de Requisição com curl​

curl -X GET https://bff-dev.granatech.com.br/api/proposal/balance-solicitation/f752a106-95d2-4c19-b31b-0dfe1b229100

Exemplo de Resposta para Buscar Proposta​

A resposta inclui a proposta completa. Abaixo estão os campos principais para o processo de atualização, seguidos por outros dados adicionais que a resposta contém:

{
  "id": "a3cbf181-56ef-4061-a297-ea540b027c86",
  "status": "PENDING_CONFIRMATION",
  "anticipatedYears": 10,
  "annualCET": 0.25352,
  "monthlyCET": 0.01900802830184034,
  "operationDate": "2024-11-01T15:00:00.000Z",
  "NaturalPerson": {
    "document": "01362899160",
    "documentType": "CPF"
  },
  "optionsFinancialInfo": [
    {
      "id": "f45ae70a-6435-4f43-b05b-79a691615bea",
      "iof": 81580,
      "Product": {
        "name": "MAX",
        "type": "LEVEL"
      },
      "Installments": [
        {
          "dueDate": "2024-11-01T15:00:00.000Z",
          "principalAmount": 2668701
        }
      ]
    }
  ],
  ...
}

Nota: optionsFinancialInfo inclui todas as opções financeiras disponíveis para essa proposta. Selecione uma dessas opções para definir o valor de chosenFinancialInfoId, que será utilizado na atualização da proposta.

Nota Importante: Para detalhes completos sobre o objeto de proposta, acesse:
👉 Ver objeto de proposta (proposal) completo aqui

Enviar Dados para Atualizar a Proposta​

Após recuperar a proposta, você pode atualizá-la enviando os dados necessários para a API, alterando somente os campos listados abaixo. Os demais dados da proposta original devem ser mantidos.

Endpoint para Atualizar Proposta​

  • Método: PUT
  • URL: https://bff-dev.granatech.com.br/api/proposal/{proposalId}

Parâmetros​

  • proposalId (string): O ID da proposta a ser atualizada.

Exemplo de Dados da Requisição​

Abaixo está um exemplo de estrutura JSON para atualizar a proposta, com os campos a serem alterados indicados. Mantenha o restante da proposta como está, substituindo pela notação ...proposal para simplificação:

{
  "anticipatedYears": 10,
  "chosenFinancialInfoId": "f45ae70a-6435-4f43-b05b-79a691615bea",
  "NaturalPerson": {
    "name": "Samira",
    "birthDate": "1990-01-01",
    "phoneNumber": "11999999999",
    "motherName": "Maria",
    "address": {
      "addressName": "Rua Exemplo",
      "number": "123",
      "zipCode": "12345-678",
      "district": "Centro",
      "complement": "Apto 101",
      "city": "São Paulo",
      "uf": "SP"
    }
  },
  "BankDetail": {
    "pixKeyType": "CPF",
    "pixKey": "01362899160",
    "account": 12345,
    "agency": "6789",
    "accountDigit": "1"
  },
  ...proposal
}

Nota: Apenas anticipatedYears, chosenFinancialInfoId, e os dados de NaturalPerson e BankDetail precisam ser atualizados conforme necessário. Mantenha os demais dados da proposta original.

Nota Importante: Para detalhes completos sobre o objeto de proposta, acesse:
👉 Ver objeto de proposta (proposal) completo aqui

Este guia mostra como consultar, escolher uma opção financeira e atualizar a proposta focando apenas nos campos essenciais.