Documentação
DocumentaçãoAPIStatusSuporteFAQscelcoin.com

Simulação da CCB

Suggest Edits

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.

Parâmetros da requisição

CampoDescriçãoExemploObrigatórioTipo
interest_rateTaxa de juros anual0.12✅number (decimal)
tac_amount ou tac_rateValor monetário da TAC (Taxa de Abertura de Crédito). Utilizado quando a TAC é informada em valor fixo.1000 ou 1000.00integer ou decimal
finance_feeTaxa de financiamento opcional.10.00✅number (decimal)
first_payment_dateData prevista para o pagamento da primeira parcela.2025-10-01✅YYYY-MM-DD
disbursement_dateData do desembolso do crédito.2025-10-01✅YYYY-MM-DD
additional_installment_feeOutro custo opcional a ser incluído na parcela0.00number (decimal)
additional_installment_descriptionDescrição obrigatória quando o campo additional_installment_fee for maior que zero.""string
balance_check_idIdentificador da verificação de saldo, obrigatório, usado para validar os valores informados nos períodos de antecipação.cde4b631-969d-4179-a962-4dd13b60cd21✅string
credit_dateData do crédito referente ao período2025-10-01YYYY-MM-DD
amountValor do crédito no período. Deve ser positivo e estar entre R$ 50,00 e o valor retornado na consulta de margem.0.00✅number
periodsPeríodos que serão antecipados. Cada objeto dentro deste array, refere-se a um mês de referência"periods": [ { "credit_date": "YYYY-MM-DD", "amount": }"✅Array de objetos

⚠️

tac_amount x tac_rate

Não é possível utilizar ambos parâmetros simultaneamente. O tac_rate é percentual do amount e o tac_amount é valor absoluto

cURL

curl --location 'https://platform.flowfinance.com.br/banking/originator/products/3e253ab3-0939-4718-90cd-72a65f9ce168/preview' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer ....' \
--data '{
  "interest_rate": 0.12,
  "payment_value": 1000,
	"num_payments": 3,
  "tac_amount": 12,
  "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", // Retornado na Consulta de Margem (Step anterior)
  "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
    }
  ]
}'

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 19 days ago