Simulation - BNPL Issuance

Summary

At QI Tech, we provide our clients with the ability to simulate the values of a credit operation before it is actually issued. The simulation follows the same pattern as the debt issuance request, but it is not necessary to provide the borrower's registration and disbursement account details.

Request

ENDPOINT

/v2/credit_operation/simulation

METHOD

POST

Test in Playground

Request Body

{
    "credit_operation_type": "ccb",
    "disbursed_issue_amount": 2800,
    "disbursement_date": "2025-09-24",
    "first_due_date": "2025-10-24",
    "force_installments_on_workdays": true,
    "interest_type": "pre_price_days",
    "issuer_person_type": "natural",
    "monthly_interest_rate": 0.04488,
    "number_of_installments": 12,
    "principal_amortization_month_period": 1
}

Request Body Details

Field	Type	Description	Max. Char.
credit_operation_type*	string	Type of credit operation	Credit Operation Type Enumerator
disbursed_issue_amount*	float	The value actually released to the borrower	15,2
disbursement_date*	string	The specific date the loan funds are made available	10
first_due_date*	string	Due date of the first installment	10
force_installments_on_workdays*	boolean	If true, ensures all installment due dates are moved to the next business day	5
interest_type*	string	Amortization method	Interest Type Enumerator
issuer_person_type*	string	Defines whether the issuer is an individual or a legal entity	Person Type Enumerator
monthly_interest_rate*	float	The percentage charged on a principal balance over a one-month period	10,6
number_of_installments*	integer	Number of installments	3
principal_amortization_month_period*	integer	Period, in months, between installments	1

Credit Operation Type Enumerator

Value	Description
ccb	Bank Credit Certificate (Cédula de Crédito Bancário)

Interest Type Enumerator

Value	Description
pre_price_days	Pre-fixed interest with Price amortization by calendar days
pre_price	Pre-fixed interest with Price amortization by months
pre_sac	Pre-fixed interest with SAC amortization

Person Type Enumerator

Value	Description
natural	Individual (natural person)
legal	Legal entity (corporation/business)

Response

STATUS

200

Response Body

{
    "disbursement_date": "2025-09-24",
    "issue_amount": 2821.32,
    "interest_type": "pre_price_days",
    "assignment_amount": 2829.78,
    "base_iof": 10.6,
    "total_iof": 21.32,
    "additional_iof": 10.72,
    "cet": 5.09,
    "annual_cet": 81.39,
    "first_due_date": "2025-10-24",
    "disbursed_amount": 2800,
    "prefixed_interest_rate": {
        "annual_rate": 0.6935459998,
        "daily_rate": 0.0014644728,
        "interest_base": "calendar_days",
        "monthly_rate": 0.04488
    },
    "tax_configuration": {
        "base_rate": 8.2e-05,
        "additional_rate": 0.0038
    },
    "fees": [
        {
            "amount": 0.3,
            "fee_amount": 8.46,
            "amount_type": "percentage",
            "fee_type": "spread",
            "type": "internal"
        }
    ],
    "installments": [
        {
            "due_date": "2025-10-24",
            "amount": 1507.4,
            "due_principal": 2821.32,
            "due_interest": 0,
            "has_interest": true,
            "period": 1,
            "period_workdays": 1.1,
            "calendar_days": 30,
            "workdays": 22,
            "installment_number": 1,
            "period_to_disbursement": 1,
            "prefixed_amount": 126.62083829,
            "period_workdays_to_disbursement": 1.1,
            "calendar_days_to_disbursement": 30,
            "workdays_to_disbursement": 22,
            "tax_amount": 3.39671674,
            "principal_amortization_amount": 1380.77916171
        },
        {
            "due_date": "2025-11-24",
            "amount": 1507.4,
            "due_principal": 1440.54083829,
            "due_interest": 0,
            "has_interest": true,
            "period": 1,
            "period_workdays": 1,
            "calendar_days": 31,
            "workdays": 20,
            "installment_number": 2,
            "period_to_disbursement": 2,
            "prefixed_amount": 66.85916171,
            "period_workdays_to_disbursement": 2.1,
            "calendar_days_to_disbursement": 61,
            "workdays_to_disbursement": 42,
            "tax_amount": 7.20558527,
            "principal_amortization_amount": 1440.54083829
        }
    ]
}

Response Body Details

Field	Type	Description
annual_cet	float	Total effective cost expressed as a decimal per year
assignment_amount	float	Acquisition value of the credit operation
cet	float	Total effective cost expressed as a decimal per month
fees	array	Fees Object - List of QI Tech fees charged on the operation
disbursed_amount	float	Amount disbursed in the credit operation
disbursement_date	string	Disbursement date of the operation
installments	array	Installments Object - Installments of the operation
interest_type	string	Amortization method and interest calculation method
additional_iof	float	A fixed-rate tax applied to the transaction principal
base_iof	float	The taxable amount used as the basis for calculating the Tax on Financial Operations
total_iof	float	The total amount of Tax on Financial Operations applied to the transaction
issue_amount	float	Issue/nominal value of the credit operation
tax_configuration	object	Tax Configuration Object - IOF rate values
first_due_date	string	Due date of the first installment
prefixed_interest_rate	object	Interest Rate Object - Nominal interest rate

Fees Object

Field	Type	Description
amount	float	Fee value or percentage
fee_amount	float	Monetary fee value
amount_type	string	Value type (percentage or fixed)
fee_type	string	Fee type
type	string	Fee classification (internal or external)

Installments Object

Field	Type	Description
due_date	string	Installment due date
amount	float	Total installment amount
due_principal	float	Outstanding balance at the time of the installment
installment_number	integer	Installment number
prefixed_amount	float	Pre-fixed interest amount
tax_amount	float	IOF amount on the installment
principal_amortization_amount	float	Principal amortization amount
calendar_days	integer	Calendar days between installments
workdays	integer	Business days between installments

Tax Configuration Object

Field	Type	Description
base_rate	float	Base IOF rate
additional_rate	float	Additional IOF rate

Interest Rate Object

Field	Type	Description
annual_rate	float	Annual interest rate
daily_rate	float	Daily interest rate
interest_base	string	Interest calculation base
monthly_rate	float	Monthly interest rate