Simulação de Empréstimo INSS

Sumário #

1. Visão Geral da API
2. Endpoints Disponíveis
3. Simulação – Cálculo do Valor de Crédito
4. Simulação – Cálculo de Parcelas
5. Estruturas de Erro

1. Visão Geral da API #

A API de Simulação é responsável por executar cálculos financeiros de operações de crédito, expondo endpoints de
simulação para cálculo reverso (valor do crédito a partir da parcela) e cálculo direto (parcelas a partir do valor
financiado).

Escopo: #

• Cálculo do valor de crédito (valor financiado/solicitado) a partir do valor de parcela.
• Cálculo de parcelas a partir de um valor financiado.
• Retorno de IOF, taxas efetivas e detalhamento por parcela.

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
/v1/public/simulation/calcular-valor credito	POST	Calcula o valor de crédito com base na taxa de juros, prazo, datas e valor da parcela.
/v1/public/simulation/calcular- parcelas	POST	Calcula as parcelas (fluxo de pagamento) com base na taxa de juros, prazo, datas e valor financiado.

3. Simulação – Cálculo do Valor de Crédito #

POST /v1/public/simulation/calcular-valor-credito #

Descrição #

Calcula o valor financiado e o valor solicitado com base na taxa de juros, prazo, datas da operação e valor da parcela informada.

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 #

{ 
  "contractNumber": "123456", 
  "operationDate": "2025-12-17", 
  "firstDueDate": "2026-01-17", 
  "monthlyTax": 0.00109, 
  "term": 12, 
  "installmentValue": 10000 
} 

#

Campos obrigatórios #

Campo	Tipo	Descrição
contractNumber	string	Número do contrato.
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.: 0.00109 = 0,109% a.m.).*
term	integer	Número de parcelas.
installmentValue	number	Valor da parcela.

*A taxa inserida na API é um decimal, como no exemplo acima.

Resposta – 200 OK (exemplo)

{
  "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 /v1/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.

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 #

{ 
  "contractNumber": "123456", 
  "operationDate": "2025-12-17", 
  "firstDueDate": "2026-01-17", 
  "monthlyTax": 0.00109, 
  "term": 10, 
  "amountFinanced": 5000 
} 

#

Campos obrigatórios #

Campo	Tipo	Descrição
contractNumber	string	Número do contrato.
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.: 0.00109 = 0,109% a.m.).*
term	integer	Número de parcelas.
amountFinanced	number	Valor financiado.

*A taxa inserida na API é um decimal, como no exemplo acima.

Resposta – 200 OK (exemplo)

{
  "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 
}