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": 300,
"service_type": "QITECH",
"cod_tabela":"800008"
}
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 :
- Principais Respostas (200 OK)
{
"success": true,
"message": "Simulação realizada com sucesso.",
"data": {
"simulation_key": "84ddb36f-d6fd-4bfd-b4c8-b99a4608f296",
"expiration_date": null,
"total_processing_cost": 0.0,
"annual_interest_rate": 0.7917558091,
"annual_effective_interest_rate": 0.8332,
"monthly_effective_interest_rate": 0.0498,
"iof_amount": 16471.0,
"interest_rate": 0.0498,
"tac_amount": 0.0,
"total_amount_owed": 488314.99999999994,
"financed_amount": 488314.99999999994,
"requested_amount": 30000.0,
"disbursement_amount": 471843.99999999994,
"num_periods": 48,
"first_payment_date": "2026-09-28",
"issue_date": "2026-06-22",
"disbursement_date": "2026-06-22",
"created_at": "2026-06-22T13:38:08.400741",
"schedule": [
{
"payment": 30000.0,
"iof": 0.0,
"balance": 488314.99999999994,
"interest": 30000.0,
"principal": 0.0,
"additional_value": 0.0,
"period": 1,
"payment_date": "2026-09-28"
},
{
"payment": 30000.0,
"iof": 0.0,
"balance": 488314.99999999994,
"interest": 30000.0,
"principal": 0.0,
"additional_value": 0.0,
"period": 2,
"payment_date": "2026-10-28"
},
{
"payment": 30000.0,
"iof": 0.0,
"balance": 488314.99999999994,
"interest": 30000.0,
"principal": 0.0,
"additional_value": 0.0,
"period": 3,
"payment_date": "2026-11-28"
},
{
"payment": 30000.0,
"iof": 0.0,
"balance": 488314.99999999994,
"interest": 30000.0,
"principal": 0.0,
"additional_value": 0.0,
"period": 4,
"payment_date": "2026-12-28"
},
{
"payment": 30000.0,
"iof": 0.0,
"balance": 488314.99999999994,
"interest": 30000.0,
"principal": 0.0,
"additional_value": 0.0,
"period": 5,
"payment_date": "2027-01-28"
},
{
"payment": 30000.0,
"iof": 0.0,
"balance": 488314.99999999994,
"interest": 30000.0,
"principal": 0.0,
"additional_value": 0.0,
"period": 6,
"payment_date": "2027-02-28"
},
{
"payment": 30000.0,
"iof": 0.0,
"balance": 488314.99999999994,
"interest": 30000.0,
"principal": 0.0,
"additional_value": 0.0,
"period": 7,
"payment_date": "2027-03-28"
},
{
"payment": 30000.0,
"iof": 0.0,
"balance": 488314.99999999994,
"interest": 30000.0,
"principal": 0.0,
"additional_value": 0.0,
"period": 8,
"payment_date": "2027-04-28"
},
{
"payment": 30000.0,
"iof": 0.0,
"balance": 488314.99999999994,
"interest": 30000.0,
"principal": 0.0,
"additional_value": 0.0,
"period": 9,
"payment_date": "2027-05-28"
},
{
"payment": 30000.0,
"iof": 0.0,
"balance": 488314.99999999994,
"interest": 30000.0,
"principal": 0.0,
"additional_value": 0.0,
"period": 10,
"payment_date": "2027-06-28"
},
{
"payment": 30000.0,
"iof": 0.0,
"balance": 488314.99999999994,
"interest": 30000.0,
"principal": 0.0,
"additional_value": 0.0,
"period": 11,
"payment_date": "2027-07-28"
},
{
"payment": 30000.0,
"iof": 0.0,
"balance": 488314.99999999994,
"interest": 30000.0,
"principal": 0.0,
"additional_value": 0.0,
"period": 12,
"payment_date": "2027-08-28"
},
{
"payment": 30000.0,
"iof": 0.0,
"balance": 488314.99999999994,
"interest": 30000.0,
"principal": 0.0,
"additional_value": 0.0,
"period": 13,
"payment_date": "2027-09-28"
},
{
"payment": 30000.0,
"iof": 0.0,
"balance": 486389.24388499995,
"interest": 28074.243885,
"principal": 1925.7561150000001,
"additional_value": 0.0,
"period": 14,
"payment_date": "2027-10-28"
},
{
"payment": 30000.0,
"iof": 0.0,
"balance": 481087.56432299997,
"interest": 24698.320438,
"principal": 5301.679562,
"additional_value": 0.0,
"period": 15,
"payment_date": "2027-11-28"
},
{
"payment": 30000.0,
"iof": 0.0,
"balance": 474709.602943,
"interest": 23622.03862,
"principal": 6377.96138,
"additional_value": 0.0,
"period": 16,
"payment_date": "2027-12-28"
},
{
"payment": 30000.0,
"iof": 0.0,
"balance": 468814.84382999997,
"interest": 24105.240887,
"principal": 5894.759113,
"additional_value": 0.0,
"period": 17,
"payment_date": "2028-01-28"
},
{
"payment": 30000.0,
"iof": 0.0,
"balance": 462620.75521599996,
"interest": 23805.911386,
"principal": 6194.088614,
"additional_value": 0.0,
"period": 18,
"payment_date": "2028-02-28"
},
{
"payment": 30000.0,
"iof": 0.0,
"balance": 454561.199515,
"interest": 21940.444299000003,
"principal": 8059.555700999999,
"additional_value": 0.0,
"period": 19,
"payment_date": "2028-03-28"
},
{
"payment": 30000.0,
"iof": 0.0,
"balance": 447643.32623899996,
"interest": 23082.126724,
"principal": 6917.873276,
"additional_value": 0.0,
"period": 20,
"payment_date": "2028-04-28"
},
{
"payment": 30000.0,
"iof": 0.0,
"balance": 439623.20833299996,
"interest": 21979.882094,
"principal": 8020.117906,
"additional_value": 0.0,
"period": 21,
"payment_date": "2028-05-28"
},
{
"payment": 30000.0,
"iof": 0.0,
"balance": 431946.799999,
"interest": 22323.591666,
"principal": 7676.408334,
"additional_value": 0.0,
"period": 22,
"payment_date": "2028-06-28"
},
{
"payment": 30000.0,
"iof": 0.0,
"balance": 423155.961799,
"interest": 21209.1618,
"principal": 8790.8382,
"additional_value": 0.0,
"period": 23,
"payment_date": "2028-07-28"
},
{
"payment": 30000.0,
"iof": 0.0,
"balance": 414643.364473,
"interest": 21487.402674,
"principal": 8512.597326,
"additional_value": 0.0,
"period": 24,
"payment_date": "2028-08-28"
},
{
"payment": 30000.0,
"iof": 0.0,
"balance": 405698.50665,
"interest": 21055.142176999998,
"principal": 8944.857823,
"additional_value": 0.0,
"period": 25,
"payment_date": "2028-09-28"
},
{
"payment": 30000.0,
"iof": 0.0,
"balance": 395618.842371,
"interest": 19920.335721,
"principal": 10079.664279,
"additional_value": 0.0,
"period": 26,
"payment_date": "2028-10-28"
},
{
"payment": 30000.0,
"iof": 0.0,
"balance": 385707.93986499996,
"interest": 20089.097494,
"principal": 9910.902505999999,
"additional_value": 0.0,
"period": 27,
"payment_date": "2028-11-28"
},
{
"payment": 30000.0,
"iof": 0.0,
"balance": 374646.712195,
"interest": 18938.77233,
"principal": 11061.22767,
"additional_value": 0.0,
"period": 28,
"payment_date": "2028-12-28"
},
{
"payment": 30000.0,
"iof": 0.0,
"balance": 363670.86757099995,
"interest": 19024.155376,
"principal": 10975.844624,
"additional_value": 0.0,
"period": 29,
"payment_date": "2029-01-28"
},
{
"payment": 30000.0,
"iof": 0.0,
"balance": 352137.681412,
"interest": 18466.813841000003,
"principal": 11533.186159,
"additional_value": 0.0,
"period": 30,
"payment_date": "2029-02-28"
},
{
"payment": 30000.0,
"iof": 0.0,
"balance": 338249.451206,
"interest": 16111.769794,
"principal": 13888.230206,
"additional_value": 0.0,
"period": 31,
"payment_date": "2029-03-28"
},
{
"payment": 30000.0,
"iof": 0.0,
"balance": 325425.392983,
"interest": 17175.941777,
"principal": 12824.058223,
"additional_value": 0.0,
"period": 32,
"payment_date": "2029-04-28"
},
{
"payment": 30000.0,
"iof": 0.0,
"balance": 311404.21216500003,
"interest": 15978.819182000001,
"principal": 14021.180817999999,
"additional_value": 0.0,
"period": 33,
"payment_date": "2029-05-28"
},
{
"payment": 30000.0,
"iof": 0.0,
"balance": 297216.98170000006,
"interest": 15812.769535000001,
"principal": 14187.230464999999,
"additional_value": 0.0,
"period": 34,
"payment_date": "2029-06-28"
},
{
"payment": 30000.0,
"iof": 0.0,
"balance": 281810.73040800006,
"interest": 14593.748708000001,
"principal": 15406.251291999999,
"additional_value": 0.0,
"period": 35,
"payment_date": "2029-07-28"
},
{
"payment": 30000.0,
"iof": 0.0,
"balance": 266120.77490400005,
"interest": 14310.044496,
"principal": 15689.955504,
"additional_value": 0.0,
"period": 36,
"payment_date": "2029-08-28"
},
{
"payment": 30000.0,
"iof": 0.0,
"balance": 249634.10040700005,
"interest": 13513.325502999998,
"principal": 16486.674497,
"additional_value": 0.0,
"period": 37,
"payment_date": "2029-09-28"
},
{
"payment": 30000.0,
"iof": 0.0,
"balance": 231891.46642100005,
"interest": 12257.366014,
"principal": 17742.633986,
"additional_value": 0.0,
"period": 38,
"payment_date": "2029-10-28"
},
{
"payment": 30000.0,
"iof": 0.0,
"balance": 213666.66461200005,
"interest": 11775.198191,
"principal": 18224.801809,
"additional_value": 0.0,
"period": 39,
"payment_date": "2029-11-28"
},
{
"payment": 30000.0,
"iof": 0.0,
"balance": 194157.98173900004,
"interest": 10491.317127,
"principal": 19508.682873,
"additional_value": 0.0,
"period": 40,
"payment_date": "2029-12-28"
},
{
"payment": 30000.0,
"iof": 0.0,
"balance": 174017.11433500005,
"interest": 9859.132596000001,
"principal": 20140.867404,
"additional_value": 0.0,
"period": 41,
"payment_date": "2030-01-28"
},
{
"payment": 30000.0,
"iof": 0.0,
"balance": 152853.51543900004,
"interest": 8836.401103999999,
"principal": 21163.598896,
"additional_value": 0.0,
"period": 42,
"payment_date": "2030-02-28"
},
{
"payment": 30000.0,
"iof": 0.0,
"balance": 129847.20223500003,
"interest": 6993.686796,
"principal": 23006.313204,
"additional_value": 0.0,
"period": 43,
"payment_date": "2030-03-28"
},
{
"payment": 30000.0,
"iof": 0.0,
"balance": 106440.70291200004,
"interest": 6593.500677,
"principal": 23406.499323,
"additional_value": 0.0,
"period": 44,
"payment_date": "2030-04-28"
},
{
"payment": 30000.0,
"iof": 0.0,
"balance": 81667.08285100004,
"interest": 5226.379939,
"principal": 24773.620061,
"additional_value": 0.0,
"period": 45,
"payment_date": "2030-05-28"
},
{
"payment": 30000.0,
"iof": 0.0,
"balance": 55814.04910700004,
"interest": 4146.966256000001,
"principal": 25853.033743999997,
"additional_value": 0.0,
"period": 46,
"payment_date": "2030-06-28"
},
{
"payment": 30000.0,
"iof": 0.0,
"balance": 28554.59307700004,
"interest": 2740.5439699999997,
"principal": 27259.45603,
"additional_value": 0.0,
"period": 47,
"payment_date": "2030-07-28"
},
{
"payment": 30000.0,
"iof": 0.0,
"balance": 4.3655745685100555e-11,
"interest": 1445.406923,
"principal": 28554.593076999998,
"additional_value": 0.0,
"period": 48,
"payment_date": "2030-08-28"
}
],
"last_payment_date": "2030-08-28",
"insurance_amount": 0.0
}
}