Empréstimo

A entidade Empréstimo é recuperada de instituições que suportam este produto. Ela representa um empréstimo contratado pelo usuário, incluindo dados como número do contrato, taxas, taxas de juros, garantias, parcelas, etc.

{
  "id": "658f07f1-8349-44cc-9590-e10fe9337060",
  "itemId": "a9e42ebd-bddc-4d59-8895-140d8a809799",
  "contractNumber": "000000721792794",
  "ipocCode": "92792126019929279212650822221989319252576",
  "productName": "Credito Pessoal Consignado",
  "type": "CREDITO_PESSOAL_COM_CONSIGNACAO",
  "kind": "LOAN",
  "date": "2023-07-20T00:00:00.000Z",
  "contractDate": "2022-08-01T00:00:00.000Z",
  "disbursementDates": ["2018-01-15T00:00:00.000Z"],
  "settlementDate": "2018-01-15T00:00:00.000Z",
  "contractAmount": 50000,
  "currencyCode": "BRL",
  "dueDate": "2028-01-15T00:00:00.000Z",
  "installmentPeriodicity": "MONTHLY",
  "installmentPeriodicityAdditionalInfo": "",
  "firstInstallmentDueDate": "2018-02-15T00:00:00.000Z",
  "CET": 0.29,
  "amortizationScheduled": "SAC",
  "amortizationScheduledAdditionalInfo": "",
  "cnpjConsignee": "60.500.998/0001-35",
  "interestRates": [
    {
      "taxType": "EFFECTIVE",
      "interestRateType": "SIMPLE",
      "taxPeriodicity": "YEARLY",
      "calculation": "21/252",
      "referentialRateIndexerType": "PRE_FIXADO",
      "referentialRateIndexerSubType": "TJLP",
      "referentialRateIndexerAdditionalInfo": "",
      "preFixedRate": 0.6,
      "postFixedRate": 0.55,
      "additionalInfo": ""
    }
  ],
  "contractedFees": [
    {
      "name": "Administracao de Operacoes",
      "code": "ADM_OP",
      "chargeType": "UNIQUE",
      "charge": "MINIMUM",
      "amount": 5,
      "rate": 0
    }
  ],
  "contractedFinanceCharges": [
    {
      "type": "IOF_POR_ATRASO",
      "additionalInfo": "",
      "rate": 0.03
    }
  ],
  "warranties": [
    {
      "currencyCode": "BRL",
      "type": "SEM_TIPO_GARANTIA",
      "subtype": "ALIENACAO_FIDUCIARIA",
      "amount": 500
    }
  ],
  "installments": {
    "typeNumberOfInstallments": "MONTH",
    "totalNumberOfInstallments": 120,
    "typeContractRemaining": "MONTH",
    "contractRemainingNumber": 55,
    "paidInstallments": 65,
    "dueInstallments": 55,
    "pastDueInstallments": 0,
    "balloonPayments": []
  },
  "payments": {
    "contractOutstandingBalance": 25000,
    "releases": [
      {
        "isOverParcelPayment": false,
        "installmentId": "b1f0a5b4-1234-5678-9abc-def012345678",
        "paidDate": "2023-07-15T00:00:00.000Z",
        "currencyCode": "BRL",
        "paidAmount": 680.5,
        "overParcel": {
          "fees": [],
          "charges": []
        }
      }
    ]
  }
}

Propriedade	Tipo	Opcional	Descrição
`id`	`string`	Não	Identificador primário
`itemId`	`string`	Não	Identificador do item vinculado ao empréstimo
`contractNumber`	`string`	Sim	Número do contrato fornecido pela instituição contratante
`ipocCode`	`string`	Sim	Número do contrato padrão - IPOC (Identificação Padronizada da Operação de Crédito)
`productName`	`string`	Não	Denominação/Identificação do nome da operação de crédito divulgada ao cliente
`type`	`string`	Sim	Tipo de empréstimo (definição Open Finance)
`kind`	`string`	Não	Família da operação de crédito à qual este contrato pertence. Um dos `LOAN`, `FINANCING`, `INVOICE_FINANCING`, `UNARRANGED_ACCOUNT_OVERDRAFT`.
`date`	`string`	Não	Data em que os dados do empréstimo foram coletados
`contractDate`	`string`	Sim	Data em que o empréstimo foi contratado
`disbursementDates`	`string[]`	Sim	Data de liberação do valor contratado
`settlementDate`	`string`	Sim	Data de liquidação do empréstimo
`contractAmount`	`number`	Sim	Valor contratado do empréstimo
`currencyCode`	`string`	Não	Código que referencia a moeda do empréstimo
`dueDate`	`string`	Sim	Data de vencimento do empréstimo
`installmentPeriodicity`	`string`	Sim	Frequência regular das parcelas. Um dos valores de periodicidade das parcelas.
`installmentPeriodicityAdditionalInfo`	`string`	Sim	Campo obrigatório para complementar as informações sobre a frequência de pagamento regular quando a periodicidade das parcelas tem valor 'OUTROS'
`firstInstallmentDueDate`	`string`	Sim	Data de vencimento da primeira parcela
`CET`	`number`	Sim	CET - Custo Efetivo Total deve ser expresso como uma taxa percentual anual e incorpora todas as cobranças e despesas incorridas nas operações de crédito (taxa de juros, mas também tarifas, impostos, seguros e outras despesas cobradas)
`amortizationScheduled`	`string`	Sim	Sistema de amortização (definição Open Finance). Um dos valores de sistema de amortização.
`amortizationScheduledAdditionalInfo`	`string`	Sim	Campo obrigatório para complementar as informações sobre a amortização programada quando tem valor 'OUTROS'
`cnpjConsignee`	`string`	Sim	CNPJ do consignatário
`interestRates`	array of LoanInterestRate	Sim	Taxas de juros aplicadas ao contrato.
`contractedFees`	array of LoanContractedFee	Sim	Lista que traz as informações das tarifas acordadas no contrato.
`contractedFinanceCharges`	array of LoanContractedFinanceCharge	Sim	Lista que traz as cobranças acordadas no contrato
`warranties`	array of LoanWarranty	Sim	Garantias que garantem a operação de crédito.
`installments`	LoanInstallments	Sim	Prazo restante e parcelas da operação.
`payments`	LoanPayments	Sim	Dados de pagamento do contrato de empréstimo

Veja EmpréstimoAPI em nossa referência de API para mais informações.

Periodicidade das parcelas do empréstimo #

Frequência regular das parcelas

WITHOUT_REGULAR_PERIODICITY
WEEKLY
FORTNIGHTLY
MONTHLY
BIMONTHLY
QUARTERLY
SEMESTERLY
YEARLY
OTHERS

Sistema de amortização do empréstimo #

Sistema de amortização (definição Open Finance)

SAC
PRICE
SAM
WITHOUT_AMORTIZATION_SYSTEM
OTHERS

Taxa de juros do empréstimo #

Propriedade	Tipo	Opcional	Descrição
`taxType`	`string`	Sim	Tipo de taxa. Um dos valores de tipo de taxa.
`interestRateType`	`string`	Sim	Tipo de taxa de juros. Um dos valores de tipo de taxa de juros.
`taxPeriodicity`	`string`	Sim	Periodicidade da taxa. Um dos valores de periodicidade da taxa.
`calculation`	`string`	Sim	Base de cálculo
`referentialRateIndexerType`	`string`	Sim	Tipos de taxas de referência ou indexadores (definição Open Finance)
`referentialRateIndexerSubType`	`string`	Sim	Subtipos de taxas de referência ou indexadores (definição Open Finance)
`referentialRateIndexerAdditionalInfo`	`string`	Sim	Campo livre para complementar as informações sobre o Tipo de taxa de referência ou indexador
`preFixedRate`	`number`	Sim	Taxa pré-fixada aplicada sob o contrato da modalidade de crédito. 1 = 100%
`postFixedRate`	`number`	Sim	Taxa pós-fixada aplicada sob o contrato da modalidade de crédito. 1 = 100%
`additionalInfo`	`string`	Sim	Texto com informações adicionais sobre a composição das taxas de juros acordadas

Tipo de taxa do empréstimo #

NOMINAL
EFFECTIVE

Tipo de taxa de juros do empréstimo #

SIMPLE
COMPOUND

Periodicidade da taxa do empréstimo #

MONTHLY
YEARLY

Taxa contratada do empréstimo #

Propriedade	Tipo	Opcional	Descrição
`name`	`string`	Sim	Denominação da taxa acordada
`code`	`string`	Sim	Acrônimo identificando a taxa acordada
`chargeType`	`string`	Sim	Tipo de cobrança para a taxa acordada no contrato. Um dos valores de tipo de cobrança.
`charge`	`string`	Sim	Método de cobrança relacionado à tarifa acordada no contrato. Um dos valores de cobrança.
`amount`	`number`	Sim	Valor monetário da tarifa acordada no contrato
`rate`	`number`	Sim	Valor da taxa em percentual acordado no contrato

Tipo de cobrança da taxa contratada #

Tipo de cobrança para a taxa acordada no contrato

UNIQUE
BY_INSTALLMENT

Método de cobrança da taxa contratada #

Método de cobrança relacionado à tarifa acordada no contrato

MINIMUM
MAXIMUM
FIXED
PERCENTAGE

Cobrança contratada do empréstimo #

Propriedade	Tipo	Opcional	Descrição
`type`	`string`	Sim	Tipo de cobrança acordada no contrato (definição Open Finance)
`additionalInfo`	`string`	Sim	Campo para informações adicionais
`rate`	`number`	Sim	Valor da cobrança em percentual acordado no contrato

Garantia do empréstimo #

Propriedade	Tipo	Opcional	Descrição
`currencyCode`	`string`	Sim	Código que referencia a moeda da garantia
`type`	`string`	Sim	Denominação / Identificação do tipo de garantia que garante o Tipo de Operação de Crédito contratado (definição Open Finance)
`subtype`	`string`	Sim	Denominação / Identificação do subtipo de garantia que garante o Tipo de Operação de Crédito contratado (definição Open Finance)
`amount`	`number`	Sim	Valor original da garantia

Parcelas do empréstimo #

Propriedade	Tipo	Opcional	Descrição
`typeNumberOfInstallments`	`string`	Sim	Tipo de prazo total do contrato referente ao tipo de crédito informado. Um dos valores de número de parcelas.
`totalNumberOfInstallments`	`number`	Sim	Prazo total de acordo com o tipo referente ao tipo de crédito informado
`typeContractRemaining`	`string`	Sim	Tipo de prazo restante do contrato referente ao tipo de crédito informado. Um dos valores de tipo de contrato restante.
`contractRemainingNumber`	`number`	Sim	Prazo restante de acordo com o tipo referente ao tipo de crédito informado
`paidInstallments`	`number`	Sim	Número de parcelas pagas
`dueInstallments`	`number`	Sim	Número de parcelas em aberto
`pastDueInstallments`	`number`	Sim	Número de parcelas vencidas
`balloonPayments`	array of LoanInstallmentBalloonPayment	Sim	Lista que traz as datas de vencimento e valor das parcelas não regulares do contrato do tipo de crédito consultado

Número de parcelas #

Tipo de prazo total do contrato referente ao tipo de crédito informado

DAY
WEEK
MONTH
YEAR
WITHOUT_TOTAL_PERIOD

Tipo de contrato restante #

Tipo de prazo restante do contrato referente ao tipo de crédito informado

DAY
WEEK
MONTH
YEAR
WITHOUT_TOTAL_PERIOD
WITHOUT_REMAINING_PERIOD

Pagamento de balão do empréstimo #

Propriedade	Tipo	Opcional	Descrição
`dueDate`	`string`	Sim	Data de expiração da parcela não regular a vencer do contrato da modalidade de crédito consultada
`amount`	LoanInstallmentBalloonPaymentAmount	Sim

Valor do pagamento de balão #

Propriedade	Tipo	Opcional	Descrição
`value`	`number`	Sim	Valor monetário da parcela não regular devida
`currencyCode`	`string`	Sim	Código que referencia a moeda da parcela

Pagamentos do empréstimo #

Propriedade	Tipo	Opcional	Descrição
`contractOutstandingBalance`	`number`	Sim	Valor necessário para que o cliente quite a dívida
`releases`	array of LoanPaymentRelease	Sim	Lista de pagamentos realizados no período

Liberação de pagamento do empréstimo #

Propriedade	Tipo	Opcional	Descrição
`isOverParcelPayment`	`boolean`	Sim	Identifica se é um pagamento acordado (falso) ou um pagamento único (verdadeiro)
`installmentId`	`string`	Sim	Identificador da parcela, responsabilidade de cada Instituição transmissora
`paidDate`	`string`	Sim	Data efetiva do pagamento referente ao contrato da modalidade de crédito consultada
`currencyCode`	`string`	Sim	Código que referencia a moeda do pagamento
`paidAmount`	`number`	Sim	Valor do pagamento referente ao contrato da modalidade de crédito consultada
`overParcel`	LoanPaymentReleaseOverParcel	Sim

Pagamento sobre parcela do empréstimo #

Propriedade	Tipo	Opcional	Descrição
`fees`	array of LoanPaymentReleaseOverParcelFee	Sim	Lista de taxas que foram pagas fora da parcela, apenas para pagamento único
`charges`	array of LoanPaymentReleaseOverParcelCharge	Sim	Lista de cobranças que foram pagas fora da parcela

Taxa sobre parcela do empréstimo #

Propriedade	Tipo	Opcional	Descrição
`name`	`string`	Sim	Denominação da taxa acordada
`code`	`string`	Sim	Acrônimo identificando a taxa acordada
`amount`	`number`	Sim	Valor monetário da tarifa acordada no contrato

Cobrança sobre parcela do empréstimo #

Propriedade	Tipo	Opcional	Descrição
`type`	`string`	Sim	Tipo de cobrança acordada no contrato (definição Open Finance)
`additionalInfo`	`string`	Sim	Campo livre para preencher informações adicionais sobre a cobrança
`amount`	`number`	Sim	Valor do pagamento da cobrança paga fora da parcela