cURL
curl --request POST \
  --url https://api.bmpdigital.moneyp.dev.br/FGTS/BuscarSimulacao \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'IdempotencyKey: <idempotencykey>' \
  --data '{
  "dto": {
    "Saldo": 123,
    "VlrEmprestimo": 123,
    "Periodo": 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
      }
    ]
  }
}'
{
  "Msg": "<string>",
  "HasError": true,
  "Messages": [
    {
      "MessageType": 1,
      "Code": "<string>",
      "Context": "<string>",
      "Description": "<string>",
      "Field": "<string>"
    }
  ],
  "IdentificadorConsulta": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "VlrDispSaque": 123,
  "PeriodoMin": 123,
  "PeriodoMax": 123,
  "Simulacao": {
    "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,
    "VlrSeguro": 123,
    "VlrReserva": 123,
    "VlrAmortizacao": 123,
    "VlrTransferencia": 123,
    "TaxaCCB": 123,
    "SimulacaoParcelas": [
      {
        "VlrRepasse": 123,
        "DtRepasse": "2023-11-07T05:31:56Z",
        "VlrPrincipal": 123,
        "VlrJuros": 123,
        "VlrIOF": 123,
        "VlrIOFAdicional": 123,
        "VlrLiberado": 123
      }
    ]
  },
  "Consulta": {
    "cpfTrabalhador": "<string>",
    "dataSaldo": "<string>",
    "existeSaldoDesconsiderado": true,
    "qtdPedidos": 123,
    "periodos": [
      {
        "dataRepasse": "<string>",
        "valor": 123
      }
    ],
    "Cache": true
  }
}
Through this endpoint, the partner performs the simulation and searches for data regarding the FGTS amounts available to the worker. After the amounts are returned, the borrower can take out loans with the Anniversary Withdrawal guarantee, 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

​
dto
object
required

Response

OK

​
Msg
string | null
​
HasError
boolean
​
Messages
object[] | null
​
IdentificadorConsulta
string<uuid> | null
​
VlrDispSaque
number
​
PeriodoMin
integer
​
PeriodoMax
integer
​
Simulacao
object
​
Consulta
object