v1

latestOpenAPI 3.0.0Apache 2.02026-07-263079321.1 MB

Simulations | Simulação

Simulate a loan | Simular um empréstimo

Calculates loan installments and costs based on input parameters | Calcula as parcelas e custos do empréstimo baseado nos parâmetros de entrada

post/simulations

Query parameters

product_idstring required

Product ID | ID do produto

Request body

customer_type'PF' | 'PJ' required

first_due_datestring required

Expecting YYYY-MM-DD

include_iofboolean

interest_ratenumber required

iof_handling_type'FINANCED' | 'DISCOUNTED' required

loan_amountnumber required

number_of_installmentsinteger required

periodicity_intervalinteger

periodicity_unit'MONTH' | 'DAY' | 'WEEK' required

registration_feenumber

registration_fee_handling_type'FINANCED' | 'DISCOUNTED' required

release_datestring required

Expecting YYYY-MM-DD

simulation_type'SAC' | 'PRICE' required

Example request

{
  "customer_type": "PF",
  "first_due_date": "2025-08-04",
  "include_iof": true,
  "interest_rate": 0.015,
  "iof_handling_type": "FINANCED",
  "loan_amount": 20.54,
  "number_of_installments": 3,
  "periodicity_interval": 1,
  "periodicity_unit": "MONTH",
  "registration_fee_handling_type": "FINANCED",
  "release_date": "2025-07-04",
  "simulation_type": "PRICE"
}

Response

Loan simulation successful | Simulação de empréstimo realizada com sucesso

codestring

messagestring

request_idstring

Example response

{
  "code": "success",
  "data": {
    "cet_annual": 53.689564,
    "cet_monthly": 0.395807,
    "customer_type": "PF",
    "first_due_date": "2025-08-04T00:00:00Z",
    "include_iof": true,
    "installments": [
      {
        "balance": 24.91,
        "due_date": "2025-08-04T00:00:00Z",
        "installment_number": 1,
        "interest_amount": 0.56,
        "payment_amount": 12.74,
        "principal_amount": 12.18
      }
    ],
    "interest_rate": 0.015,
    "iof_amount": 0.23,
    "iof_handling_type": "FINANCED",
    "loan_amount": 20,
    "net_amount_released": 20,
    "number_of_installments": 3,
    "periodicity_interval": 1,
    "periodicity_unit": "MONTH",
    "registration_fee_handling_type": "FINANCED",
    "release_date": "2025-07-04T00:00:00Z",
    "simulation_type": "PRICE",
    "total_amount_paid": 38.21,
    "total_financed_amount": 37.09242
  },
  "message": "Loan simulation successful",
  "request_id": "0b04ebd7-fa91-4087-965f-e05021775b38"
}