Pular para o conteúdo
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Simulador de Crédito

Simulador de Empréstimo

post
/simulations/simulate

Simula um novo empréstimo com base nos parâmetros fornecidos.

Autorizações
AuthorizationstringObrigatório
Corpo
data_emprestimostring · dateObrigatório

Data de solicitação do empréstimo.

taxa_juros_mensalnumber · double · máx: 99.99999999Obrigatório

Taxa de juros ao mês do empréstimo, expressa em percentual.

numero_parcelasinteger · int32 · mín: 1 · máx: 99Obrigatório

Total de parcelas para pagamento.

data_primeiro_vencimento_parcelastring · dateOpcional

Data do primeiro vencimento da parcela.

valor_emprestimonumber · double · mín: 0.01 · máx: 999999999.99Obrigatório

Valor do empréstimo solicitado.

tipo_pessoastring · enumObrigatório

Tipo de pessoa (Física ou Jurídica).

Valores possíveis:
valor_tarifasnumber · double · máx: 999999999.99Opcional

Valor das tarifas a serem aplicadas.

tipo_aliquota_iofstring · enumOpcional

Este campo deve refletir o enquadramento fiscal, considerando regimes como MEI, Simples Nacional ou outros.
As alíquotas de IOF serão aplicadas no cálculo do empréstimo, levando em conta o tipo de pessoa (tipo_pessoa), o enquadramento fiscal e o valor do empréstimo (valor_emprestimo), conforme a regulamentação vigente.
O preenchimento é obrigatório para o tipo_pessoa informado como PJ.

Valores possíveis:
Respostas
200

Empréstimo solicitado com sucesso.

application/json
idstringOpcional

Identificador único do empréstimo.

numero_parcelasinteger · int32 · mín: 1 · máx: 99Opcional

Total de parcelas para pagamento.

data_emprestimostring · dateOpcional

Data de solicitação do empréstimo.

data_primeiro_vencimento_parcelastring · dateOpcional

Data de vencimento da primeira parcela.

data_ultimo_vencimento_parcelastring · dateOpcional

Data de vencimento da última parcela.

taxa_juros_mensalnumber · double · máx: 99.99999999Opcional

Taxa de juros ao mês do empréstimo, expressa em percentual.

taxa_juros_anualnumber · double · máx: 9999.99999999Opcional

Taxa de juros anual aplicada ao empréstimo.

valor_tarifasnumber · double · máx: 999999999.99Opcional

Valor das tarifas a serem aplicadas.

valor_iofnumber · double · máx: 9999999.99Opcional

Valor total do IOF aplicado.

valor_emprestimonumber · double · mín: 0.01 · máx: 999999999.99Opcional

Valor do empréstimo solicitado.

valor_primeira_parcelanumber · double · máx: 999999999.99Opcional

Valor da primeira parcela.

valor_jurosnumber · double · máx: 9999999.99Opcional

Valor total dos juros aplicados.

valor_desembolsonumber · double · máx: 999999999.99Opcional

Valor total do desembolso.

valor_financiadonumber · double · máx: 999999999.99Opcional

Valor total financiado.

saldo_devedornumber · double · máx: 999999999.99Opcional

Saldo devedor total.

custo_efetivo_total_mensalnumber · double · máx: 9999.99Opcional

Custo efetivo total mensal.

custo_efetivo_total_anualnumber · double · máx: 9999.99Opcional

Custo efetivo total anual.

post/simulations/simulate
POST /integration/v3/simulations/simulate HTTP/1.1
Host: api.staging.scd.giro.tech
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 387

{
  "data_emprestimo": "2024-04-23",
  "taxa_juros_mensal": 5,
  "numero_parcelas": 1,
  "data_primeiro_vencimento_parcela": "2024-04-23",
  "valor_emprestimo": 1000,
  "tipo_pessoa": "PESSOA_FISICA",
  "valor_tarifas": 4,
  "calculo": {
    "dias_compensar": "DIAS_CORRIDOS",
    "carencia": "COM_JUROS_A_PARTIR_31_DIAS",
    "limite_iof": "ANO_FECHADO_360_DIAS"
  },
  "financiamento": {
    "iof": "IOF_FINANCIADO",
    "tarifas": "TARIFAS_FINANCIADO"
  }
}
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "numero_parcelas": 1,
  "data_emprestimo": "2024-04-23",
  "data_primeiro_vencimento_parcela": "2024-04-23",
  "data_ultimo_vencimento_parcela": "2025-04-23",
  "taxa_juros_mensal": 5,
  "taxa_juros_anual": 60,
  "valor_tarifas": 4,
  "valor_iof": 3,
  "valor_emprestimo": 1000,
  "valor_primeira_parcela": 85,
  "valor_juros": 60,
  "valor_desembolso": 1060,
  "valor_financiado": 1004,
  "saldo_devedor": 1004,
  "custo_efetivo_total_mensal": 5,
  "custo_efetivo_total_anual": 60,
  "parcelas": [
    {
      "numero_parcela": 1,
      "data_vencimento": "2024-04-23",
      "valor_parcela": 85,
      "valor_amortizacao": 1000,
      "valor_juros": 60,
      "valor_iof": 3,
      "valor_tarifas": 4,
      "saldo_devedor": 0
    }
  ]
}

Atualizado