Simulação da CCB
Nesta etapa, o originador, com base na margem disponível obtida na consulta anterior, realizará a simulação da operação.
A simulação deve apresentar ao tomador:
- As parcelas que serão antecipadas;
- O valor de cada parcela;
- A taxa de cadastro aplicada;
- A taxa de juros do produto;
- A data do primeiro pagamento;
- A data de desembolso do crédito.
Importante
- O valor da antecipação de cada parcela deve ser igual ou superior a R$ 50,00 (regra definida pela CEF).
- A taxa de juros para este produto é sempre anual.
- A taxa de cadastro deverá respeitar os limites previamente configurados no sistema.
POST: https://platform.flowfinance.com.br/banking/originator/products/{id}/preview
{
"interest_rate": 0.12,
"tac_amount": 1000.00,
"tac_rate": 0.1,
"finance_fee": 10.00,
"first_payment_date": "2025-10-01",
"disbursement_date": "2025-08-20",
"additional_installment_fee": 0.00,
"additional_installment_description": "",
"balance_check_id": "cde4b631-969d-4179-a962-4dd13b60cd21",
"periods": [
{
"credit_date": "2025-10-01",
"amount": 1000.00
},
{
"credit_date": "2026-10-01",
"amount": 500.00
},
{
"credit_date": "2029-10-01",
"amount": 500.00
}
]
}
Parâmetros da requisição
| Campo | Descrição | Tipo | Exemplo |
|---|---|---|---|
| interest_rate | Taxa de juros anual | number (decimal) | 0.12 |
| tac_amount | Valor monetário da TAC (Taxa de Abertura de Crédito). Utilizado quando a TAC é informada em valor fixo. | number (decimal) | 1000.00 |
| tac_rate | Percentual da TAC em formato decimal. Utilizado quando a TAC é informada como taxa percentual. | number (decimal) | 0.1 |
| finance_fee | Taxa de financiamento opcional. | number (decimal) | 10.00 |
| first_payment_date | Data prevista para o pagamento da primeira parcela. | YYYY-MM-DD | 2025-10-01 |
| disbursement_date | Data do desembolso do crédito. | YYYY-MM-DD | 2025-10-01 |
| additional_installment_fee | Outro custo opcional a ser incluído na parcela | number (decimal) | 0.00 |
| additional_installment_description | Descrição obrigatória quando o campo additional_installment_fee for maior que zero. | string | "" |
| balance_check_id | Identificador da verificação de saldo, obrigatório, usado para validar os valores informados nos períodos de antecipação. | string | cde4b631-969d-4179-a962-4dd13b60cd21 |
| credit_date | Data do crédito referente ao período | YYYY-MM-DD | 2025-10-01 |
| amount | Valor do crédito no período. Deve ser positivo e estar entre R$ 50,00 e o valor retornado na consulta de margem. | number | 0.00 |
Retorno da simulação:
{
"simulation_id": "8a83a290-ba56-452a-8c4c-19918cab0a2e",
"expires_at": "2025-08-11T21:38:30.654108Z",
"total_processing_cost": 102.78,
"annual_interest_rate": 6.983296,
"annual_effective_interest_rate": 38.927911,
"monthly_effective_interest_rate": 0.359689,
"iof_amount": 3.78,
"finance_fee": 0,
"interest_rate": 0.189000,
"tac_amount": 99,
"discount_amount": 0,
"discount_rate": 0.0,
"total_amount_owed": 599.61,
"financed_amount": 402.78,
"iof_daily_rate": 0.000082,
"iof_base_rate": 0.0038,
"requested_amount": 300,
"payment_amount": 199.87,
"disbursement_amount": 300,
"num_periods": 3,
"first_payment_date": "2025-10-09",
"issue_date": "2025-08-11",
"disbursement_date": "2025-08-29",
"created_at": "2025-08-11T21:38:30.654108Z",
"schedule": [
{
"payment": 199.87,
"iof": 1.13,
"balance": 402.80,
"interest": 41.60,
"principal": 158.27,
"additional_value": 0.00,
"present_value": null,
"status": null,
"period": 1,
"running_day": 41,
"late_day": null,
"paid_value": null,
"payment_date": "2025-10-09"
},
{
"payment": 199.87,
"iof": 1.28,
"balance": 244.52,
"interest": 67.20,
"principal": 132.67,
"additional_value": 0.00,
"present_value": null,
"status": null,
"period": 2,
"running_day": 72,
"late_day": null,
"paid_value": null,
"payment_date": "2025-11-09"
},
{
"payment": 199.87,
"iof": 1.37,
"balance": 111.86,
"interest": 88.01,
"principal": 111.86,
"additional_value": 0.00,
"present_value": null,
"status": null,
"period": 3,
"running_day": 102,
"late_day": null,
"paid_value": null,
"payment_date": "2025-12-09"
}
],
"schedule_type": "MONTHLY",
"borrower_type": null,
"amortization_type": "PRICE",
"interest_compounding_type": "COMPOUND",
"financed_iof": true,
"last_payment_date": "2025-12-09",
"interest_pre_type": "BASE_365",
"amortization_frequency": null,
"grace_period_amortization": null,
"interest_rate_frequency": "MONTHLY"
}
Retorno de erro:
Caso algum parâmetro inválido seja informado na requisição de simulação, a API retornará uma mensagem de erro detalhando as violações encontradas.
{
"message": "Constraint violation error: first_payment_date: The first_payment_date must be after the disbursement_date., firstPaymentDate: Deve ser uma data no presente ou no futuro, : The first_payment_date must be equal or after the disbursement_date."
}
Updated about 13 hours ago