2 - Search Multiperiod Simulation

cURL

cURL

curl --request POST \
  --url https://api.bmpdigital.moneyp.dev.br/FGTS/BuscarSimulacaoMultiPeriodo \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'IdempotencyKey: <idempotencykey>' \
  --data '
{
  "dto": {
    "Saldo": 123,
    "VlrEmprestimo": 123,
    "TaxaMensal": 123,
    "VlrTAC": 123,
    "PercTAC": 123,
    "DtAniversario": "2023-11-07T05:31:56Z",
    "CpfTrabalhador": "<string>",
    "ConsultaCache": true,
    "Periodos": [
      {
        "DataRepasse": "2023-11-07T05:31:56Z",
        "VlrRepasse": 123
      }
    ]
  }
}
'

200

{
  "Msg": "<string>",
  "HasError": true,
  "Messages": [
    {
      "Code": "<string>",
      "Context": "<string>",
      "Description": "<string>",
      "Field": "<string>"
    }
  ],
  "VlrDispSaque": 123,
  "PeriodoMin": 123,
  "PeriodoMax": 123,
  "Simulacoes": [
    {
      "Saldo": 123,
      "Periodo": 123,
      "DtInicio": "2023-11-07T05:31:56Z",
      "DtFim": "2023-11-07T05:31:56Z",
      "TaxaMensal": 123,
      "TaxaCETMensal": 123,
      "TaxaCETAnual": 123,
      "TaxaJurosAnual": 123,
      "VlrEmprestimoCliente": 123,
      "VlrJuros": 123,
      "VlrIOF": 123,
      "VlrIOFAdicional": 123,
      "VlrLiberado": 123,
      "VlrOperacao": 123,
      "VlrTAC": 123,
      "VlrReserva": 123,
      "VlrAmortizacao": 123,
      "VlrTransferencia": 123,
      "VlrOutrasDespesas": 123,
      "TaxaCCB": 123,
      "SimulacaoParcelas": [
        {
          "VlrRepasse": 123,
          "DtRepasse": "2023-11-07T05:31:56Z",
          "VlrPrincipal": 123,
          "VlrIOF": 123,
          "VlrIOFAdicional": 123,
          "VlrLiberado": 123,
          "VlrJuros": 123
        }
      ]
    }
  ],
  "SimulacoesErro": [
    {
      "Msg": "<string>",
      "HasError": true,
      "Messages": [
        {
          "Code": "<string>",
          "Context": "<string>",
          "Description": "<string>",
          "Field": "<string>"
        }
      ],
      "Periodo": 123
    }
  ],
  "Consulta": {
    "cpfTrabalhador": "<string>",
    "dataSaldo": "<string>",
    "existeSaldoDesconsiderado": true,
    "qtdPedidos": 123,
    "periodos": [
      {
        "dataRepasse": "<string>",
        "valor": 123
      }
    ],
    "Cache": true
  }
}

Through this endpoint, the partner searches for and simulates data regarding the FGTS amounts available to the worker.

After the amounts are returned, the employee can take out loans with the guarantee of the Anniversary Withdrawal, which will later be included in a proposal.

This action precedes the inclusion and implementation of the proposal in the system.

Rules:

• If the “Balance” field is entered, we do not use the customer’s real balance at Caixa Econômica Federal and the calculation will be based on the values ​​from our calculator.
• If the birthday month is incorrect, the system returns an error at the time of the simulation.
• If the CPF field is filled in, the query is performed at Caixa Econômica Federal

When the value of the ConsultaCache field is false, the request will query the updated FGTS balance directly at Caixa Econômica Federal (CEF); when it is true, the balance will be obtained from the BMP cache. This field is not mandatory. If it is not provided, the system assumes the value true as default.

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

VlrDispSaque · number<double>

PeriodoMin · integer<int32>

PeriodoMax · integer<int32>

Simulacoes · object[] | null

Show child attributes

SimulacoesErro · object[] | null

Show child attributes

Consulta · object

Show child attributes