Pular para o conteúdo principal

Simulação

info

Descrição​

Este endpoint permite realizar uma simulação de crédito do trabalhador, utilizando informações como a margem disponível, o tipo de simulação (baseada em valor da parcela ou valor líquido), o valor solicitado, o tipo de serviço da bancarizadora e a tabela de referência. A resposta fornece detalhes da simulação, incluindo taxas de juros, valores totais e um cronograma de pagamentos.

Endpoint​

POST /clt-loan/v1/simulate-loan

Headers​

{
  "Authorization": "Bearer {TOKEN_DO_LOGIN}",
}


Payload​

{
  "margin_key": "string",
  "simulation_type": "Payment",
  "employer_document": "{CNPJ_EMPREGADOR}", (Somente números)
  "requested_amount": 102,
  "service_type": "UY3",
  "cod_tabela":"300003"
}
info

Observações:

  • O campo margin_key pode ser obtido no response daconsulta de margem.
  • O campo employer_document pode ser obtido no response daconsulta de margem.
  • O campo simulation_type pode assumir os valores:
    • Payment: Simulação baseada no Valor da Parcela.
    • Liquid: Simulação baseada no Valor Liberado.
  • O campo requested_amount refere-se ao valor da parcela ou valor liberado conforme o tipo de simulação escolhido.
  • O campo service_type pode ser obtido no response dalistagem de bancarizadora.
  • O campo cod_tabela pode ser obtido no response dalistagem de tabelas CLT.



Exemplo de Resposta :​

  {
    "success": true,
    "message": "Simulação realizada com sucesso.",
    "data": {
      "simulation_key": "744125d0-eba3-4f07-b1a0-496b1b71347d",
      "expiration_date": null,
      "total_processing_cost": 2070.0,
      "annual_interest_rate": 1.2751434339588767,
      "annual_effective_interest_rate": 1.373949999999998,
      "monthly_effective_interest_rate": 0.07470506902136376,
      "iof_amount": 2070.0,
      "interest_rate": 0.0699,
      "tac_amount": 0.0,
      "total_amount_owed": 122400.0,
      "financed_amount": 70435.0,
      "requested_amount": 10200.0,
      "disbursement_amount": 68365.0,
      "num_periods": 12,
      "first_payment_date": "2026-02-27T00:00:00",
      "issue_date": "2025-11-26T12:00:00-03:00",
      "disbursement_date": "2025-11-26T12:00:00-03:00",
      "created_at": "2025-11-26T12:00:00-03:00",
      "schedule": [
        {
          "payment": 0.0,
          "iof": 0.0,
          "balance": 70435.0,
          "interest": 0.0,
          "principal": 0.0,
          "additional_value": 0.0,
          "period": 1,
          "payment_date": "2025-11-26"
        },
        {
          "payment": 0.0,
          "iof": 0.0,
          "balance": 80626.0,
          "interest": 10191.0,
          "principal": 0.0,
          "additional_value": 0.0,
          "period": 2,
          "payment_date": "2026-01-27"
        },
        {
          "payment": 10200.0,
          "iof": 57.0,
          "balance": 76143.0,
          "interest": 5717.0,
          "principal": 4483.0,
          "additional_value": 0.0,
          "period": 3,
          "payment_date": "2026-02-27"
        },
        {
          "payment": 10200.0,
          "iof": 70.0,
          "balance": 71342.0,
          "interest": 5399.0,
          "principal": 4801.0,
          "additional_value": 0.0,
          "period": 4,
          "payment_date": "2026-03-27"
        },
        {
          "payment": 10200.0,
          "iof": 86.0,
          "balance": 66200.0,
          "interest": 5058.0,
          "principal": 5142.0,
          "additional_value": 0.0,
          "period": 5,
          "payment_date": "2026-04-27"
        },
        {
          "payment": 10200.0,
          "iof": 105.0,
          "balance": 60694.0,
          "interest": 4694.0,
          "principal": 5506.0,
          "additional_value": 0.0,
          "period": 6,
          "payment_date": "2026-05-27"
        },
        {
          "payment": 10200.0,
          "iof": 125.0,
          "balance": 54798.0,
          "interest": 4303.0,
          "principal": 5896.0,
          "additional_value": 0.0,
          "period": 7,
          "payment_date": "2026-06-27"
        },
        {
          "payment": 10200.0,
          "iof": 148.0,
          "balance": 48483.0,
          "interest": 3885.0,
          "principal": 6315.0,
          "additional_value": 0.0,
          "period": 8,
          "payment_date": "2026-07-27"
        },
        {
          "payment": 10200.0,
          "iof": 174.0,
          "balance": 41721.0,
          "interest": 3438.0,
          "principal": 6762.0,
          "additional_value": 0.0,
          "period": 9,
          "payment_date": "2026-08-27"
        },
        {
          "payment": 10200.0,
          "iof": 203.0,
          "balance": 34479.0,
          "interest": 2958.0,
          "principal": 7242.0,
          "additional_value": 0.0,
          "period": 10,
          "payment_date": "2026-09-27"
        },
        {
          "payment": 10200.0,
          "iof": 235.0,
          "balance": 26724.0,
          "interest": 2445.0,
          "principal": 7755.0,
          "additional_value": 0.0,
          "period": 11,
          "payment_date": "2026-10-27"
        },
        {
          "payment": 10200.0,
          "iof": 271.0,
          "balance": 18419.0,
          "interest": 1895.0,
          "principal": 8305.0,
          "additional_value": 0.0,
          "period": 12,
          "payment_date": "2026-11-27"
        },
        {
          "payment": 10200.0,
          "iof": 289.0,
          "balance": 9525.0,
          "interest": 1306.0,
          "principal": 8894.0,
          "additional_value": 0.0,
          "period": 13,
          "payment_date": "2026-12-27"
        },
        {
          "payment": 10200.0,
          "iof": 307.0,
          "balance": 0.0,
          "interest": 675.0,
          "principal": 9525.0,
          "additional_value": 0.0,
          "period": 14,
          "payment_date": "2027-01-27"
        }
      ],
      "last_payment_date": "2027-01-27T12:00:00-03:00",
      "insurance_amount": 0.0
    }
  }