Pular para o conteúdo principal

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": "27dc2ef5-0687-4c60-a4b4-975097f1812a",
  "number_of_installments": 10,
  "eligibility": true,
  "cod_produto": 100,
  "service_type": "string"
}

Observações:​

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

Exemplo :​

	{
	...
	   "service_type": "bmp"
	...
	}

{
  "key": "0a8cf4cc-b4d3-471c-a609-e6a8aa9f0054",
  "iof_amount": 352.13,
  "cet": 0.0189,
  "annual_cet": 0.2526,
  "disbursement_date": "2025-01-31",
  "issue_amount": 11330.33,
  "disbursed_issue_amount": 10978.2,
  "installments": [
    {
      "calendar_days": 182,
      "workdays": 124,
      "business_due_date": "2025-08-01",
      "due_date": "2025-08-01",
      "due_principal": 11330.33,
      "has_interest": true,
      "post_fixed_amount": 0,
      "pre_fixed_amount": 1276.38325902,
      "tax_amount": 29.879441,
      "total_amount": 3278.49,
      "principal_amortization_amount": 2002.10674098,
      "installment_number": 1
    },
    {
      "calendar_days": 365,
      "workdays": 251,
      "business_due_date": "2026-08-03",
      "due_date": "2026-08-01",
      "due_principal": 9328.22325902,
      "has_interest": true,
      "post_fixed_amount": 0,
      "pre_fixed_amount": 2226.83887237,
      "tax_amount": 28.23569645,
      "total_amount": 3170.23,
      "principal_amortization_amount": 943.39112763,
      "installment_number": 2
    }
  ],
  "external_contract_fees": [
  
  ],
  "cod_tabela": "100002"
}
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.