Offer

Esta seção descreve parte do retorno da Creditas às chamadas aos endpoints [GET] /simulations (raiz) e [GET] /offers/{id} (item da lista offers:[]), que representa o resultado da Simulação Fria e Quente (Assertiva) respectivamente, ou seja, as condições da oferta de crédito.

Response Body

Exemplo: empréstimo com R$ 30.000,00 líquidos liberados ao cliente (loanAmount), em 48 parcelas (loanTerm), à taxa de 1,99% a.m. (monthlyInterestRate). Sobre a operação incidem R$ 800,00 de tarifas (feeValue), R$ 186,00 de custos adicionais (additionalCostsValue) e R$ 1.014,00 de IOF (iof), que são financiados junto ao principal — resultando em um valor total financiado (total) de R$ 32.000,00.

Sobre esse total, a parcela (installmentAmount) fica em R$ 1.041,14 e o CET (totalEffectiveCost) em 2,31% a.m.

{
    "loanTerm": 48,
    "monthlyInterestRate": 0.0199,
    "totalEffectiveCost": 0.0231,
    "installmentAmount": 1041.14,
    "loanAmount": 30000.00,
    "feeValue": 800.00,
    "additionalCostsValue": 186.00,
    "iof": 1014.00,
    "total": 32000.00
}
{
    "id": "OFR-E06AAC20-D8BF-4E23-A7D0-XXXXXXXXXXXX",
    "scoreFixed": false,
    "approvedStatus": "ANALYSIS_PRE_APPROVED",
    "offers": [
        {
            "loanTerm": 18,
            "monthlyInterestRate": 0.0199,
            "totalEffectiveCost": 0.0269,
            "installmentAmount": 2124.46,
            "loanAmount": 30000.00,
            "feeValue": 800.00,
            "additionalCostsValue": 186.00,
            "iof": 892.00,
            "total": 31878.00
        },
        {
            "loanTerm": 24,
            "monthlyInterestRate": 0.0199,
            "totalEffectiveCost": 0.0255,
            "installmentAmount": 1686.16,
            "loanAmount": 30000.00,
            "feeValue": 800.00,
            "additionalCostsValue": 186.00,
            "iof": 942.00,
            "total": 31928.00
        },
        {
            "loanTerm": 30,
            "monthlyInterestRate": 0.0199,
            "totalEffectiveCost": 0.0246,
            "installmentAmount": 1425.09,
            "loanAmount": 30000.00,
            "feeValue": 800.00,
            "additionalCostsValue": 186.00,
            "iof": 975.00,
            "total": 31961.00
        },
        {
            "loanTerm": 36,
            "monthlyInterestRate": 0.0199,
            "totalEffectiveCost": 0.0239,
            "installmentAmount": 1252.81,
            "loanAmount": 30000.00,
            "feeValue": 800.00,
            "additionalCostsValue": 186.00,
            "iof": 998.00,
            "total": 31984.00
        },
        {
            "loanTerm": 42,
            "monthlyInterestRate": 0.0199,
            "totalEffectiveCost": 0.0235,
            "installmentAmount": 1131.07,
            "loanAmount": 30000.00,
            "feeValue": 800.00,
            "additionalCostsValue": 186.00,
            "iof": 1008.00,
            "total": 31994.00
        },
        {
            "loanTerm": 48,
            "monthlyInterestRate": 0.0199,
            "totalEffectiveCost": 0.0231,
            "installmentAmount": 1041.14,
            "loanAmount": 30000.00,
            "feeValue": 800.00,
            "additionalCostsValue": 186.00,
            "iof": 1014.00,
            "total": 32000.00
        },
        {
            "loanTerm": 54,
            "monthlyInterestRate": 0.0199,
            "totalEffectiveCost": 0.0228,
            "installmentAmount": 972.45,
            "loanAmount": 30000.00,
            "feeValue": 800.00,
            "additionalCostsValue": 186.00,
            "iof": 1019.00,
            "total": 32005.00
        },
        {
            "loanTerm": 60,
            "monthlyInterestRate": 0.0199,
            "totalEffectiveCost": 0.0226,
            "installmentAmount": 918.61,
            "loanAmount": 30000.00,
            "feeValue": 800.00,
            "additionalCostsValue": 186.00,
            "iof": 1023.00,
            "total": 32009.00
        }
    ]
}
CampoTipoDescriçãoObservações
loanTermintegerNúmero de parcelas
Ex: 48
18, 24, 30, 36, 42, 48, 54, 60
monthlyInterestRatedoubleTaxa mensal de juros (caso o retorno seja 0.0199, a taxa é 1,99% ao mês).
Ex: 0.0199
Pode ter até 5 casas
totalEffectiveCostdoubleTaxa que considera todos os encargos e despesas incidentes nas operações de crédito (CET).
Ex: 0.0231
Pode ter até 5 casas
installmentAmountdoubleValor calculado para cada parcela.
Ex: 1041.14
Pode ter até 2 casas
loanAmountdoubleValor líquido do empréstimo liberado ao cliente (creditado em conta).

Não inclui juros, encargos nem IOF.
Ex: 30000.00
Pode ter até 2 casas
feeValuedoubleTarifas cobradas na operação.
Ex: 800.00
Pode ter até 2 casas
additionalCostsValuedoubleCustos adicionais incidentes na operação.
Ex: 186.00
Pode ter até 2 casas
iofdoubleValor do IOF (Imposto sobre Operações Financeiras) incidente na operação.
Ex: 1014.00
Pode ter até 2 casas
totaldoubleValor total financiado (loanAmount + feeValue + additionalCostsValue + iof).
Ex: 32000.00
Pode ter até 2 casas
📘

Como este objeto aparece em cada API

Os campos acima formam o objeto Offer, idêntico nas duas APIs. O que muda é apenas o envelope da resposta:

  • GET /simulations (Simulação Fria): retorna um único objeto Offer no nível raiz.
  • GET /offers/{id} (Simulação Quente): retorna um envelope com id, scoreFixed e approvedStatus, mais uma lista offers[], em que cada item é um objeto Offer (uma condição por prazo).

Use as abas do exemplo acima para ver o formato de cada uma.

Veja também Solicitar e Consultar Simulação Assertiva