Simulação

---

info

Descrição

Esse serviço possibilita a simulação de um saque ou operação financeira relacionada ao FGTS, apresentando os valores estimados para saque e as condições aplicáveis.

Endpoint

POST /nossa/v1/simulation

Headers

{
  "Authorization": "Bearer {TOKEN_DO_LOGIN}",
  "Content-Type": "application/json"
}

Payload (Body)

{
  "cpf": "12345678909",
  "key": "ab8782dc-e812-4352-ac78-9204a9e67c90",
  "number_of_installments": 4,
  "eligibility": true,
  "cod_produto": 302,
  "service_type": "string"
}

Observações:

É necessário definir dentro de "service_type": "j17", "bmp" ou "qi".

Exemplo :

	{
	...
	   "service_type": "j17"
	...
	}

Resposta de Sucesso (200 OK)

{
  "key": "j17_12345678909_20260624083753",
  "iof_amount": 3.5,
  "cet": 0.026099999999999998,
  "annual_cet": 0.36229999999999996,
  "disbursement_date": "2026-06-24",
  "issue_amount": 103.88,
  "disbursed_issue_amount": 64.02,
  "installments": [
    {
      "installment_number": 1,
      "due_date": "2031-06-23",
      "total_amount": 301.2,
      "principal_amount": 103.88,
      "interest_amount": 197.31
    }
  ],
  "cod_tabela": "302001",
  "number_of_valid_installments": 1,
  "external_contract_fees": [
    {
      "fee_type": "tac",
      "fee_amount": 36.36
    }
  ],
  "service_type": "j17"
}

---

info

Comentários

• A key utilizada no payload, é a chave gerada na consulta de saldo.
• number_of_installments define o número de parcelas desejadas.
• eligibility indica se a digitação sera feita com TAC, (Taxa de Contrato) ou com SEGURO. Se for true, usamos tabelas com TAC, e se for false, usamos tabelas com SEGURO.
• cod_produto identifica o código do produto, da tabela de Rebates e pode ser encontrado em listar tabelas.
• A key gerada na reposta da simulação, deve ser utilizada posteriormente para criação da proposta, a mesma deve ser adicionada ao payload da requisição com a variavel "simulation_key".
• O service_type tem como objetivo aprimorar o direcionamento das operações conforme a instituição responsável.