Simulação de condições financeiras
Este endpoint permite simular as condições financeiras e o fluxo de pagamentos de uma operação
Atenção
O Request Body deve conter uma combinação válida de parâmetros para ser processado. As combinações aceitas são:
- Valor de Emissão/Liberado + Taxa de Juros
- Valor de Emissão/Liberado + Valor por Parcela
- Valor por Parcela + Taxa de Juros
- Valor de Emissão/Liberado + Taxa de Juros + Percentual de Amortização por Parcela.
Request
ENDPOINT
/commercial_paper/simulationMÉTODO
POSTOperação pré-fixada
Valor de emissão + Taxa
{
"interest_type": "pre_price_days",
"financial_base_date": "2025-01-20",
"issue_amount": 1000000,
"number_of_installments": 5,
"prefixed_interest_rate": {
"interest_base": "calendar_days_365",
"monthly_rate": 0.05
},
"fine_delay_rate": {
"interest_base": "calendar_days_365",
"monthly_rate": 0.01
},
"contract_fine_rate": 0.02,
"fees": [
{
"amount": 5,
"amount_type": "percentage",
"fee_type": "structuring_fee",
"type": "external"
}
],
"first_due_date_delay": 60,
}
Valor desembolsado + Taxa
{
"interest_type": "pre_price_days",
"financial_base_date": "2025-01-20",
"released_amount": 1000000,
"number_of_installments": 5,
"prefixed_interest_rate": {
"interest_base": "calendar_days_365",
"monthly_rate": 0.05
},
"fine_delay_rate": {
"interest_base": "calendar_days_365",
"monthly_rate": 0.01
},
"contract_fine_rate": 0.02,
"fees": [
{
"amount": 5,
"amount_type": "percentage",
"fee_type": "bookkeeping_fee",
"type": "external"
}
],
"first_due_date": "2026-01-31"
}
Valor da parcela + taxa de juros
{
"interest_type": "pre_price_days",
"financial_base_date": "2025-01-20",
"number_of_installments": 2,
"installments": [
{
"due_date": "2026-01-01",
"amount": 500000
},
{
"due_date": "2026-02-01",
"amount": 502004.01
}
],
"prefixed_interest_rate": {
"interest_base": "calendar_days_365",
"monthly_rate": 0.05
},
"fine_delay_rate": {
"interest_base": "calendar_days_365",
"monthly_rate": 0.01
},
"contract_fine_rate": 0.02,
"fees": [
{
"amount": 5,
"amount_type": "percentage",
"fee_type": "structuring_fee",
"type": "external"
}
]
}
Valor de emissão + Percentual de amortização da parcela + taxa de juros
{
"interest_type": "pre_sac",
"financial_base_date": "2025-01-20",
"issue_amount": 1000000,
"number_of_installments": 3,
"installments": [
{
"due_date": "2026-01-01",
"principal_amortization_percentage": 0.1
},
{
"due_date": "2026-02-01",
"principal_amortization_percentage": 0.1
},
{
"due_date": "2026-03-01",
"principal_amortization_percentage": 0.8
}
],
"prefixed_interest_rate": {
"interest_base": "calendar_days_365",
"monthly_rate": 0.05
},
"fine_delay_rate": {
"interest_base": "calendar_days_365",
"monthly_rate": 0.01
},
"contract_fine_rate": 0.02,
"fees": [
{
"amount": 5,
"amount_type": "percentage",
"fee_type": "bookkeeping_fee",
"type": "external"
}
]
}
Valor de emissão + Valor das parcelas
{
"interest_type": "pre_price_days",
"financial_base_date": "2025-01-20",
"issue_amount": 700000,
"number_of_installments": 2,
"installments": [
{
"due_date": "2026-01-01",
"amount": 500000
},
{
"due_date": "2026-02-01",
"amount": 502004.01
}
],
"prefixed_interest_rate": {
"interest_base": "calendar_days_365",
},
"fine_delay_rate": {
"interest_base": "calendar_days_365",
"monthly_rate": 0.01
},
"contract_fine_rate": 0.02,
"fees": [
{
"amount": 5,
"amount_type": "percentage",
"fee_type": "structuring_fee",
"type": "external"
}
]
}
Operação pós-fixada
Valor de emissão + Taxa + Pós fixado
{
"interest_type": "post_price_days",
"financial_base_date": "2025-01-20",
"issue_amount": 1000000,
"number_of_installments": 5,
"prefixed_interest_rate": {
"interest_base": "calendar_days_365",
"monthly_rate": 0.05
},
"fine_delay_rate": {
"interest_base": "calendar_days_365",
"monthly_rate": 0.01
},
"contract_fine_rate": 0.02,
"fees": [
{
"amount": 1000,
"amount_type": "absolute",
"fee_type": "structuring_fee",
"type": "external"
}
],
"post_fixed_interest_rate": 100,
"financial_index": "CDI"
}
Valor desembolsado + Taxa + Pós fixado
{
"interest_type": "post_price_days",
"financial_base_date": "2025-01-20",
"released_amount": 1000000,
"number_of_installments": 5,
"prefixed_interest_rate": {
"interest_base": "calendar_days_365",
"monthly_rate": 0.05
},
"fine_delay_rate": {
"interest_base": "calendar_days_365",
"monthly_rate": 0.01
},
"contract_fine_rate": 0.02,
"fees": [
{
"amount": 5,
"amount_type": "percentage",
"fee_type": "bookkeeping_fee",
"type": "external"
}
],
"post_fixed_interest_rate": 100,
"financial_index": "CDI"
}
Valor da parcela + taxa de juros + Pós fixado
{
"interest_type": "post_price_days",
"financial_base_date": "2025-01-20",
"number_of_installments": 2,
"installments": [
{
"due_date": "2026-01-01",
"amount": 500000
},
{
"due_date": "2026-02-01",
"amount": 502004.01
}
],
"prefixed_interest_rate": {
"interest_base": "calendar_days_365",
"monthly_rate": 0.05
},
"fine_delay_rate": {
"interest_base": "calendar_days_365",
"monthly_rate": 0.01
},
"contract_fine_rate": 0.02,
"fees": [
{
"amount": 5,
"amount_type": "percentage",
"fee_type": "structuring_fee",
"type": "external"
}
],
"post_fixed_interest_rate": 100,
"financial_index": "CDI"
}
Valor de emissão + Percentual de amortização da parcela + taxa de juros + Pós fixado
{
"interest_type": "post_sac",
"financial_base_date": "2025-01-20",
"issue_amount": 1000000,
"number_of_installments": 3,
"installments": [
{
"due_date": "2026-01-01",
"principal_amortization_percentage": 0.1
},
{
"due_date": "2026-02-01",
"principal_amortization_percentage": 0.1
},
{
"due_date": "2026-03-01",
"principal_amortization_percentage": 0.8
}
],
"prefixed_interest_rate": {
"interest_base": "calendar_days_365",
"monthly_rate": 0.05
},
"fine_delay_rate": {
"interest_base": "calendar_days_365",
"monthly_rate": 0.01
},
"contract_fine_rate": 0.02,
"fees": [
{
"amount": 5,
"amount_type": "percentage",
"fee_type": "structuring_fee",
"type": "external"
}
],
"post_fixed_interest_rate": 100,
"financial_index": "CDI"
}
Valor de emissão + Valor das parcelas + Pós fixado
{
"interest_type": "post_price_days",
"financial_base_date": "2025-01-20",
"issue_amount": 700000,
"number_of_installments": 2,
"installments": [
{
"due_date": "2026-01-01",
"amount": 500000
},
{
"due_date": "2026-02-01",
"amount": 502004.01
}
],
"prefixed_interest_rate": {
"interest_base": "calendar_days_365",
},
"fine_delay_rate": {
"interest_base": "calendar_days_365",
"monthly_rate": 0.01
},
"contract_fine_rate": 0.02,
"fees": [
{
"amount": 5,
"amount_type": "percentage",
"fee_type": "structuring_fee",
"type": "external"
}
],
"post_fixed_interest_rate": 100,
"financial_index": "CDI"
}
Request Body Params
| Campo | Tipo | Descrição | Caracteres Máx. |
|---|---|---|---|
interest_type * | string | Tipo de juros aplicado. | Enumeradores interest_type |
financial_base_date * | string | Data base da operação (formato "YYYY-MM-DD"). | - |
released_amount | number | Valor total liberado na operação. | - |
issue_amount | number | Valor de emissão da operação. | |
number_of_installments * | integer | Número total de parcelas. | - |
installments | array | Objeto contendo detalhes sobre cada parcela. | Objeto installments |
prefixed_interest_rate * | object | Objeto contendo detalhes da taxa de juros prefixada. | Objeto prefixed_interest_rate |
fine_delay_rate * | object | Objeto contendo detalhes da multa por atraso. | Objeto fine_delay_rate |
contract_fine_rate * | number | Multa contratual aplicada em percentual. | - |
fees | array | Lista de taxas associadas à operação. | Objeto fees |
post_fixed_interest_rate | number | Valor da taxa pós fixada prefixada. | - |
financial_index | string | Tipo de Taxa pós-fixada. | Enumeradores financial_index |
first_due_date | date | Data da primeira parcela | - |
first_due_date_delay | number | Dias para o ínicio do pagamento da primeira parcela. | - |
Objeto installments
| Campo | Tipo | Descrição |
|---|---|---|
due_date * | string | Data de vencimento da parcela (formato "YYYY-MM-DD"). |
amount | number | Valor total da parcela. |
principal_amortization_percentage | number | Valor percentual amortizado do principal. |
Objeto prefixed_interest_rate
| Campo | Tipo | Descrição | Caracteres Máx. |
|---|---|---|---|
interest_base * | string | Base de cálculo para os juros. | Enumeradores interest_base |
daily_rate | number | Taxa de juros diária aplicada. | - |
monthly_rate | number | Taxa de juros mensal aplicada. | - |
annual_rate | number | Taxa de juros anual aplicada. | - |
Objeto fine_delay_rate
| Campo | Tipo | Descrição | Caracteres Máx. |
|---|---|---|---|
interest_base * | string | Base para cálculo da multa. | Enumeradores interest_base |
monthly_rate * | number | Taxa de multa mensal. | - |
Objeto fees
| Campo | Tipo | Descrição | Caracteres Máx. |
|---|---|---|---|
amount * | number | Valor da taxa aplicada. | - |
amount_type * | string | Tipo do valor da taxa. | Enumeradores amount_type |
fee_type * | string | Tipo da taxa. | Enumeradores fee_type |
type * | string | Destinatário da taxa. | Enumeradores fee_recipient |
Enumeradores interest_type
| Enum | Descrição |
|---|---|
pre_price | Juros pré-fixados no modelo Price. |
pre_price_days | Juros pré-fixados no modelo Price por dias corridos. |
pre_sac | Juros pré-fixados no modelo SAC. |
post_sac | Juros pós-fixados no modelo SAC. |
post_price_days | Juros pós-fixados no modelo Price por dias corridos. |
Enumeradores financial_index
| Enum | Descrição |
|---|---|
CDI | Pós fixado de CDI |
IPCA | Pós fixado de IPCA |
IGPM | Pós fixado de IGPM |
Enumeradores interest_base
| Enum | Descrição |
|---|---|
calendar_days | Base de dias corridos. |
calendar_days_365 | Base de 365 dias corridos. |
workdays | Base de dias úteis. |
Enumeradores amount_type
| Enum | Descrição |
|---|---|
percentage | Valor em percentual. |
absolute | Valor absoluto em moeda. |
Enumeradores fee_type
| Enum | Descrição |
|---|---|
bookkeeping_fee | Taxa de escrituração financiada. |
structuring_fee | Taxa de estruturação financiada. |
Enumeradores fee_recipient
| Enum | Descrição |
|---|---|
internal | Taxa paga ao escriturador. |
external | Rebate pago ao originador. |
Response
STATUS
200Response Body
{
"financial_base_date": "2025-01-20",
"issue_amount": 1075268.82,
"released_amount": 1000000.0,
"issue_quantity": 1075268,
"unit_price": 1.00000076,
"cet": 7.7,
"annual_cet": 143.55,
"number_of_installments": 5,
"prefixed_interest_rate": {
"interest_base": "calendar_days_365",
"monthly_rate": 0.05,
"daily_rate": 0.0016053474,
"annual_rate": 0.795856326
},
"fees": [
{
"amount": 2.0,
"fee_amount": 21505.38,
"amount_type": "percentage",
"fee_type": "bookkeeping_fee",
"type": "internal"
},
{
"amount": 5.0,
"fee_amount": 53763.44,
"amount_type": "percentage",
"fee_type": "structuring_fee",
"type": "external"
}
],
"installments": [
{
"installment_number": 1,
"workdays": 23,
"calendar_days": 31,
"principal_amortization_amount": 193292.79655634,
"principal_amortization_unit_price": 0.17976244,
"interest_amount": 54820.37344366,
"amount": 248113.17,
"due_principal": 1075268.82,
"due_interest": 0.0,
"due_date": "2025-02-20",
"has_interest": true
},
{
"installment_number": 2,
"workdays": 18,
"calendar_days": 28,
"principal_amortization_amount": 207597.32873049,
"principal_amortization_unit_price": 0.19306566,
"interest_amount": 40515.84126951,
"amount": 248113.17,
"due_principal": 881976.02344366,
"due_interest": 0.0,
"due_date": "2025-03-20",
"has_interest": true
},
{
"installment_number": 3,
"workdays": 21,
"calendar_days": 33,
"principal_amortization_amount": 211453.91638185,
"principal_amortization_unit_price": 0.19665229,
"interest_amount": 36659.25361815,
"amount": 248113.17,
"due_principal": 674378.69471317,
"due_interest": 0.0,
"due_date": "2025-04-22",
"has_interest": true
},
{
"installment_number": 4,
"workdays": 19,
"calendar_days": 28,
"principal_amortization_amount": 226847.52746545,
"principal_amortization_unit_price": 0.21096836,
"interest_amount": 21265.64253455,
"amount": 248113.17,
"due_principal": 462924.77833132,
"due_interest": 0.0,
"due_date": "2025-05-20",
"has_interest": true
},
{
"installment_number": 5,
"workdays": 22,
"calendar_days": 31,
"principal_amortization_amount": 236077.25086587,
"principal_amortization_unit_price": 0.21955201,
"interest_amount": 12035.91913413,
"amount": 248113.17,
"due_principal": 236077.25086587,
"due_interest": 0.0,
"due_date": "2025-06-20",
"has_interest": true
}
],
"fine_delay_rate": {
"interest_base": "calendar_days_365",
"monthly_rate": 0.01
},
"contract_fine_rate": 0.02
}
Response Body Params
| Campo | Tipo | Descrição | Caracteres Máx. |
|---|---|---|---|
financial_base_date * | string | Data base financeira da operação (formato "YYYY-MM-DD"). | - |
issue_amount * | number | Valor total emitido da operação. | - |
released_amount * | number | Valor líquido liberado na operação. | - |
issue_quantity * | integer | Quantidade total de unidades emitidas. | - |
unit_price * | number | Preço unitário da emissão. | - |
cet * | number | Custo Efetivo Total (CET) em percentual. | - |
annual_cet * | number | CET anual em percentual. | - |
number_of_installments * | integer | Número total de parcelas. | - |
prefixed_interest_rate * | object | Objeto contendo detalhes da taxa de juros prefixada. | Objeto prefixed_interest_rate |
fees | array | Lista de taxas associadas à operação. | Objeto fees |
installments | array | Lista de detalhes das parcelas geradas na operação. | Objeto installments |
fine_delay_rate * | object | Objeto contendo detalhes da multa por atraso. | Objeto fine_delay_rate |
contract_fine_rate * | number | Multa contratual aplicada em percentual. | - |
Objeto Response prefixed_interest_rate
| Campo | Tipo | Descrição | Caracteres Máx. |
|---|---|---|---|
interest_base * | string | Base de cálculo para os juros. | Enumeradores interest_base |
monthly_rate * | number | Taxa de juros mensal aplicada. | - |
daily_rate * | number | Taxa de juros diária aplicada. | - |
annual_rate * | number | Taxa de juros anual aplicada. | - |
Objeto fees
| Campo | Tipo | Descrição | Caracteres Máx. |
|---|---|---|---|
amount * | number | Valor percentual da taxa. | - |
fee_amount * | number | Valor monetário correspondente à taxa. | - |
amount_type * | string | Tipo do valor da taxa. | Enumeradores amount_type |
fee_type * | string | Tipo da taxa. | Enumeradores fee_type |
type * | string | Destinatário da taxa. | Enumeradores fee_recipient |
Objeto Response installments
| Campo | Tipo | Descrição |
|---|---|---|
installment_number * | integer | Número da parcela. |
workdays * | integer | Dias úteis até o vencimento da parcela. |
calendar_days * | integer | Dias corridos até o vencimento da parcela. |
principal_amortization_amount * | number | Valor amortizado do principal. |
principal_amortization_unit_price * | number | Valor amortizado por unidade. |
interest_amount * | number | Valor dos juros aplicados na parcela. |
amount * | number | Valor total da parcela. |
due_date * | string | Data de vencimento da parcela (formato "YYYY-MM-DD"). |