Pular para o conteúdo principal
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
  }
}
Por meio deste endpoint o parceiro executa a simulação e busca de dados referente aos valores de FGTS disponíveis para trabalhador. Após o retorno dos valores, pode realizar empréstimos com garantia do Saque Aniversário, onde posteriormente serão inclusos em uma proposta. Esta ação antecede a inclusão e efetivação da proposta no sistema. Regras:
  • Caso seja informado o campo “Saldo”, não utilizamos o saldo verdadeiro do cliente na Caixa Econômica Federal e o cálculo será com base nos valores da nossa calculadora.
  • Caso o mês de aniversário esteja incorreto, o sistema retorna um erro no momento da simulação.
  • Em caso de preenchimento do campo CPF, a consulta é realizada na Caixa Econômica Federal
Quando o valor do campo ConsultaCache for false, a requisição consultará o saldo do FGTS atualizado diretamente na Caixa Econômica Federal (CEF); quando for true, o saldo será obtido do cache da BMP. Este campo não é obrigatório, caso não seja informado, o sistema assume o valor true como padrão.

​
Mensagens de erro

A tabela abaixo representa as mensagens de erro que podem ser retornadas ao tentar realizar uma requisição.

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