Simular Valor Presente da Amortização Extraordinária
Este endpoint simula uma amortização extraordinária do tipo present_amount sem criar nenhum evento — é um cálculo puro, sem efeitos colaterais. A partir das parcelas informadas em installment_list, o serviço calcula e devolve o amount total (Valor Presente) do evento extraordinário que seria criado, além do Valor Presente de cada event_conciliation (tipo extraordinary) por parcela — o integrador não calcula Valor Presente no seu lado.
O amortization_type não é enviado na requisição: por se tratar de uma simulação de Valor Presente, o tipo é sempre present_amount. O amount também não é enviado — ele é o resultado do cálculo. A reference_date é fornecida pelo chamador e é a única referência temporal usada pelo serviço na classificação de vencidos e no desconto pro-rata; na simulação, a due_date é assumida igual à reference_date.
O response é o payload de criação pronto para uso: basta remover o campo event_conciliation_list — que é apenas informativo — e enviá-lo como body do Criar Amortização Extraordinária para efetivar a amortização simulada.
Request
Request Body
{
"security_key": "971380d4-469e-48f6-a64b-3afb8a88109e",
"investment_key": "<investment_key>",
"reference_date": "2026-04-24",
"installment_list": [1, 2]
}
Request Body Params
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
security_key | string (UUID) | Sim | Chave única do ativo (security) sobre o qual a amortização será simulada. |
investment_key | string (UUID) | Sim | Chave do investimento alvo. Usada como base proporcional no cálculo do Valor Presente. |
reference_date | string (date) | Sim | Data de referência em formato YYYY-MM-DD. Fornecida pelo chamador — o serviço a usa como "hoje" para classificar parcelas vencidas e aplicar o desconto pro-rata do Valor Presente. Na simulação, também é usada como due_date. |
installment_list | array de inteiros (≥ 1) | Sim | Lista de installment_number (não UUIDs) das parcelas-alvo, com minItems: 1. O serviço resolve cada número contra installment_number da security; números inexistentes retornam EVC000007. |
Diferente da criação, amortization_type, amount e due_date não são enviados: o tipo é sempre present_amount, o amount é calculado pelo serviço e a due_date é assumida igual à reference_date.
Response
Response Body
{
"security_key": "971380d4-469e-48f6-a64b-3afb8a88109e",
"investment_key": "<investment_key>",
"amortization_type": "present_amount",
"amount": 4750.00,
"reference_date": "2026-04-24",
"due_date": "2026-04-24",
"installment_list": [1, 2],
"event_conciliation_list": [
{
"installment_number": 1,
"amount": 2400.00
},
{
"installment_number": 2,
"amount": 2350.00
}
]
}
Response Body Params
| Campo | Tipo | Descrição |
|---|---|---|
security_key | string (UUID) | Chave do ativo — ecoa o valor enviado. |
investment_key | string (UUID) | Chave do investimento alvo — ecoa o valor enviado. |
amortization_type | string | Sempre present_amount — preenchido pelo serviço para compor o payload de criação. |
amount | number | Valor Presente total calculado para o evento extraordinário (soma dos amount de event_conciliation_list). |
reference_date | string (date) | Data de referência — ecoa o valor enviado. |
due_date | string (date) | Data alvo de liquidação — igual à reference_date enviada. |
installment_list | array de inteiros | Parcelas-alvo — ecoa o valor enviado. |
event_conciliation_list | array | Valor Presente por parcela dos event_conciliation (tipo extraordinary) que seriam gerados. Apenas para visualização — não entra no payload de criação. Objeto event_conciliation_list. |
O campo event_conciliation_list é apenas para visualização da simulação de cada parcela — ele não deve ser incluído no payload de criação do evento extraordinário. Para efetivar a amortização simulada, envie o response sem event_conciliation_list como body do Criar Amortização Extraordinária.
Objeto event_conciliation_list
| Campo | Tipo | Descrição |
|---|---|---|
installment_number | integer | Número da parcela (installment_number) a que este evento de conciliação se refere. |
amount | number | Valor Presente calculado para o event_conciliation (tipo extraordinary) desta parcela. |
Erros
| Código | HTTP | Significado |
|---|---|---|
| EVC100002 | 400 | installment_list é obrigatório e não pode ser vazio. |
| EVC100004 | 400 | Alguma parcela informada não pertence à security alvo. |
| EVC000007 | 404 | Algum inteiro em installment_list não corresponde a nenhum installment_number da security (InstallmentNumberNotFound). |
| QIT000001 | 400 | Falha de schema — por exemplo, item de installment_list que não é inteiro ≥ 1. |
| EVC100008 | 400 | Já existe uma amortização extraordinária pendente para a parcela — cancele-a antes de simular/criar outra. |
| EVC100013 | 424 | Dependência temporariamente indisponível (Failed Dependency). Transitório — repita após o restabelecimento. |
O EVC100005 (amount insuficiente) não se aplica à simulação — o amount é calculado pelo serviço, não enviado.
Consulte o Catálogo de erros para resolução completa.