6. Simulação

Esta rota permite simular um produto financeiro com base no valor solicitado. O resultado gera o simulation_id, que será usado posteriormente na criação da CCB.

Método: POST

Endpoint

https://sandbox.platform.flowfinance.com.br/banking/originator/products/{{id_produto}}/preview

Headers

ChaveValor
AuthorizationBearer {{originatorAccessToken}}
Content-Typeapplication/json

Payload

{
  "requested_amount": 1000,
  "interest_rate": 0.04,
  "tac_amount": 0,
  "finance_fee": 0,
  "iofType": "PERSON",
  "num_payments": 10,
  "first_payment_date": "2025-11-01",
  "disbursement_date": "2025-10-16",
  "borrower_type": "PERSON",
  "schedule_type": "MONTHLY"
}

Exemplo de Response

{
  "id": "37c9d351-21ce-41cf-8735-9b4ae659225b",
  "expiration_date": "2025-10-29T23:59:59.528422Z",
  "total_processing_cost": 2.93,
  "annual_interest_rate": 0.601032,
  "annual_effective_interest_rate": 0.668083,
  "monthly_effective_interest_rate": 0.043562,
  "iof_amount": 2.93,
  "finance_fee": 0,
  "interest_rate": 0.040000,
  "tac_amount": 0,
  "discount_amount": 0,
  "borrower_id": null,
  "product_id": "760a6c7e-5dea-4a32-afad-8b9413d0aea7",
  "discount_rate": 0.0,
  "total_amount_owed": 241.30,
  "financed_amount": 202.93,
  "iof_daily_rate": 0.000082,
  "iof_base_rate": 0.0038,
  "requested_amount": 200,
  "payment_amount": 24.13,
  "disbursement_amount": 200.00,
  "num_periods": 10,
  "first_payment_date": "2025-11-01",
  "issue_date": "2025-10-29",
  "disbursement_date": "2025-10-29",
  "created_at": "2025-10-29T22:57:09.528399Z",
  "schedule": [
    {
      "payment": 24.13,
      "iof": 0.10,
      "balance": 202.92,
      "interest": 0.09,
      "principal": 24.04,
      "additional_value": 0.00,
      "present_value": null,
      "status": null,
      "period": 1,
      "running_day": 3,
      "late_day": null,
      "paid_value": null,
      "payment_date": "2025-11-01"
    },
    {
      "payment": 24.13,
      "iof": 0.15,
      "balance": 178.88,
      "interest": 1.01,
      "principal": 23.12,
      "additional_value": 0.00,
      "present_value": null,
      "status": null,
      "period": 2,
      "running_day": 33,
      "late_day": null,
      "paid_value": null,
      "payment_date": "2025-12-01"
    }
    // ... restante do schedule omitido para brevidade
  ],
  "schedule_type": "MONTHLY",
  "borrower_type": null,
  "amortization_type": "PRICE",
  "interest_compounding_type": "COMPOUND",
  "financed_iof": true,
  "last_payment_date": "2026-08-01",
  "interest_pre_type": "BASE_365",
  "amortization_frequency": "MONTHLY",
  "grace_period_amortization": [],
  "interest_rate_frequency": "MONTHLY",
  "validation_errors": null,
  "insurance_amount": 0,
  "equated_monthly_installment": 8.44
}

Observações

  • O campo simulation_id do response é necessário para criar a CCB.
  • O schedule detalha cada parcela, incluindo IOF, juros, principal e datas de pagamento.
  • O cálculo considera base 365 (interest_pre_type) e amortização PRICE.