Sumário #
- Visão Geral da API
- Endpoints Disponíveis
- Multissimulação – Cálculo do Valor de Crédito
- Multissimulação – Cálculo de Parcelas
- Estruturas de Erro
1. Visão Geral da API #
A API de Multissimulação é responsável por executar cálculos financeiros de operações de crédito, expondo endpoints que retornam múltiplas simulações utilizando as mesmas regras da API de Simulação. Para cada operationDate informado, são geradas três simulações: uma para a data informada e duas para os dias subsequentes.
Escopo: #
- Cálculo de múltiplos valores de crédito (valor financiado e valor solicitado) a partir do valor da parcela, retornando simulações para a data de operação informada (operationDate) e para os dois dias subsequentes.
- Cálculo de múltiplos fluxos de pagamento (parcelas) a partir de um valor financiado, retornando simulações para a data de operação informada (operationDate) e para os dois dias subsequentes.
- Retorno do IOF, das taxas efetivas e do detalhamento das parcelas para cada simulação gerada.
URL de homologação #
- Homologação: https://api2.bancosemear.com.br/oauth/access-token
2. Endpoints Disponíveis #
A API possui dois endpoints principais:
| Endpoint | Método | Função |
|---|---|---|
| https://hmlapi2.bancosemear.com.br/api-simulation/v2/public/simulation/calcular-valor-credito | POST | Calcula múltiplas simulações de crédito com base na taxa de juros, prazo, datas e valor da parcela, retornando os resultados para a data de operação informada (operationDate) e para os dois dias subsequentes. |
| https://hmlapi2.bancosemear.com.br/api-simulation/v2/public/simulation/calcular-parcelas | POST | Calcula múltiplas parcelas (fluxos de pagamento) com base na taxa de juros, prazo, datas e valor financiado, retornando os resultados para a data de operação informada (operationDate) e para os dois dias subsequentes. |
3. Multissimulação – Cálculo do Valor de Crédito #
POST /v2/public/simulation/calcular-valor-credito #
Descrição #
Calcula os valores financiado e solicitado com base na taxa de juros, prazo, datas da operação e valor da parcela informada, retornando múltiplas simulações para a data de operação informada (operationDate) e para os dois dias subsequentes.
Parâmetros considerados:
- Valor da parcela (installmentValue)
- Prazo (term)
- Taxa mensal (monthlyTax)
- Datas da operação e do primeiro vencimento (operationDate / firstDueDate)
Headers Parameters #
client_id
access_token
Payload – CreateCreditCommand #
{
"operationDate": "2025-12-17",
"firstDueDate": "2026-01-17",
"monthlyTax": 1.09,
"term": 12,
"installmentValue": 10000
}
#
Campos obrigatórios #
| Campo | Tipo | Descrição |
|---|---|---|
| operationDate | string (date) | Data da operação (formato YYYY-MM-DD). |
| firstDueDate | string (date) | Data do primeiro vencimento (formato YYYY-MM-DD). |
| monthlyTax | number | Taxa nominal mensal (ex.: 1.09 = 1,09% a.m.).* |
| term | integer | Número de parcelas. |
| installmentValue | number | Valor da parcela. |
*A taxa inserida na API é conforme taxa simulada sem o percentual, conforme exemplo acima.
Resposta – 200 OK (exemplo)
{
"multiSimulationId": "00000000-0000-0000-0000-000000000000",
"simulations": [
{
"id": "00000000-0000-0000-0000-000000000000",
"financedAmount": null,
"requestedAmount": null,
"installmentAmount": null,
"annualRate": null,
"monthlyRate": null,
"dailyRate": null,
"operationIOF": null,
"annualCET": null,
"monthlyCET": null,
"installments": [
{
"installmentNumber": 1073741824,
"dueDate": null,
"installmentAmount": null,
"installmentAmountCET": null,
"termDays": 0,
"cumulativeTermDays": 0,
"installmentOutstandingBalance": null,
"installmentAmortizationAmount": null,
"installmentInterestAmount": null,
"installmentDailyIOF": null,
"installmentAdditionalIOF": null,
"totalIOF": null
}
]
},
{
"id": "00000000-0000-0000-0000-000000000000",
"financedAmount": null,
"requestedAmount": null,
"installmentAmount": null,
"annualRate": null,
"monthlyRate": null,
"dailyRate": null,
"operationIOF": null,
"annualCET": null,
"monthlyCET": null,
"installments": [
{
"installmentNumber": 1073741824,
"dueDate": null,
"installmentAmount": null,
"installmentAmountCET": null,
"termDays": 0,
"cumulativeTermDays": 0,
"installmentOutstandingBalance": null,
"installmentAmortizationAmount": null,
"installmentInterestAmount": null,
"installmentDailyIOF": null,
"installmentAdditionalIOF": null,
"totalIOF": null
}
]
},
{
"id": "00000000-0000-0000-0000-000000000000",
"financedAmount": null,
"requestedAmount": null,
"installmentAmount": null,
"annualRate": null,
"monthlyRate": null,
"dailyRate": null,
"operationIOF": null,
"annualCET": null,
"monthlyCET": null,
"installments": [
{
"installmentNumber": 1073741824,
"dueDate": null,
"installmentAmount": null,
"installmentAmountCET": null,
"termDays": 0,
"cumulativeTermDays": 0,
"installmentOutstandingBalance": null,
"installmentAmortizationAmount": null,
"installmentInterestAmount": null,
"installmentDailyIOF": null,
"installmentAdditionalIOF": null,
"totalIOF": null
}
]
}
]
}
Principais saídas: #
- financedAmount (valor financiado)
- requestedAmount (valor solicitado)
- operationIOF (IOF da operação)
- annualCET / monthlyCET (CET anual e mensal)
- installments (detalhamento de parcelas)
4. Simulação – Cálculo de Parcelas #
POST /v2/public/simulation/calcular-parcelas #
Descrição #
Calcula o fluxo de parcelas (incluindo IOF e CET) com base no valor financiado, taxa de juros, prazo e datas da operação, retornando três simulações para a data de operação informada (operationDate) e para os dois dias subsequentes.
Parâmetros considerados:
- Valor financiado (amountFinanced)
- Prazo (term)
- Taxa mensal (monthlyTax)
- Datas da operação e do primeiro vencimento (operationDate / firstDueDate)
Headers Parameters #
client_id
access_token
Payload – CreateInstallmentsCommand #
{
"operationDate": "2025-12-17",
"firstDueDate": "2026-01-17",
"monthlyTax": 1.09,
"term": 10,
"amountFinanced": 5000
}
#
Campos obrigatórios #
| Campo | Tipo | Descrição |
|---|---|---|
| operationDate | string (date) | Data da operação (formato YYYY-MM-DD). |
| firstDueDate | string (date) | Data do primeiro vencimento (formato YYYY-MM-DD). |
| monthlyTax | number | Taxa nominal mensal em decimal (ex.: 1.09 = 1,09% a.m.).* |
| term | integer | Número de parcelas. |
| amountFinanced | number | Valor financiado. |
*A taxa inserida na API é conforme taxa simulada sem o percentual, conforme exemplo acima.
Resposta – 200 OK (exemplo)
{
"multiSimulationId": "00000000-0000-0000-0000-000000000000",
"simulations": [
{
"id": "00000000-0000-0000-0000-000000000000",
"financedAmount": null,
"requestedAmount": null,
"installmentAmount": null,
"annualRate": null,
"monthlyRate": null,
"dailyRate": null,
"operationIOF": null,
"annualCET": null,
"monthlyCET": null,
"installments": [
{
"installmentNumber": 1073741824,
"dueDate": null,
"installmentAmount": null,
"installmentAmountCET": null,
"termDays": 0,
"cumulativeTermDays": 0,
"installmentOutstandingBalance": null,
"installmentAmortizationAmount": null,
"installmentInterestAmount": null,
"installmentDailyIOF": null,
"installmentAdditionalIOF": null,
"totalIOF": null
}
]
},
{
"id": "00000000-0000-0000-0000-000000000000",
"financedAmount": null,
"requestedAmount": null,
"installmentAmount": null,
"annualRate": null,
"monthlyRate": null,
"dailyRate": null,
"operationIOF": null,
"annualCET": null,
"monthlyCET": null,
"installments": [
{
"installmentNumber": 1073741824,
"dueDate": null,
"installmentAmount": null,
"installmentAmountCET": null,
"termDays": 0,
"cumulativeTermDays": 0,
"installmentOutstandingBalance": null,
"installmentAmortizationAmount": null,
"installmentInterestAmount": null,
"installmentDailyIOF": null,
"installmentAdditionalIOF": null,
"totalIOF": null
}
]
},
{
"id": "00000000-0000-0000-0000-000000000000",
"financedAmount": null,
"requestedAmount": null,
"installmentAmount": null,
"annualRate": null,
"monthlyRate": null,
"dailyRate": null,
"operationIOF": null,
"annualCET": null,
"monthlyCET": null,
"installments": [
{
"installmentNumber": 1073741824,
"dueDate": null,
"installmentAmount": null,
"installmentAmountCET": null,
"termDays": 0,
"cumulativeTermDays": 0,
"installmentOutstandingBalance": null,
"installmentAmortizationAmount": null,
"installmentInterestAmount": null,
"installmentDailyIOF": null,
"installmentAdditionalIOF": null,
"totalIOF": null
}
]
}
]
}
Principais saídas: #
- installmentAmount – resultado principal
- operationIOF – cálculo completo conforme norma
- annualCET – CET anual
- monthlyCET – CET mensal
- annualRate, monthlyRate, dailyRate – Taxas efetivas (anual, mensal, diária)
- installments – Parcelas detalhadas
5. Estruturas de Erro #
Este passo tem por finalidade atualizar uma cobrança PIX imediato.
400 – Bad Request
[
{
"code": 1073741824,
"title": null,
"detail": null
}
]
500 – Internal Server Error
{
"code": 1073741824,
"title": null,
"detail": null
}