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, 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",
  "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",
  "instalmentPeriodicity": "MONTHLY",
  "instalmentPeriodicityAdditionalInfo": "",
  "firstInstalmentDueDate": "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": [
    {
      "feeName": "Administracao de Operacoes",
      "feeCode": "ADM_OP",
      "feeChargeType": "SINGLE",
      "feeCharge": "MINIMUM",
      "feeAmount": 5.0,
      "feeRate": 0
    }
  ],
  "contractedFinanceCharges": [
    {
      "chargeType": "IOF_POR_ATRASO",
      "chargeAdditionalInfo": "",
      "chargeRate": 0.03
    }
  ],
  "warranties": [
    {
      "currencyCode": "BRL",
      "warrantyType": "SEM_TIPO_GARANTIA",
      "warrantySubType": "ALIENACAO_FIDUCIARIA",
      "warrantyAmount": 500
    }
  ],
  "instalments": {
    "typeNumberOfInstalments": "TOTAL",
    "totalNumberOfInstalments": 120,
    "paidInstalments": 65,
    "dueInstalments": 55,
    "pastDueInstalments": 0,
    "balloonPayments": []
  },
  "payments": {
    "paidInstalments": 65,
    "contractOutstandingBalance": 25000,
    "releases": [
      {
        "isOverParcelPayment": false,
        "instalmentId": "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 principal do empréstimo.
itemId	string	Não	Identificador do Item (conexão) ao qual este empréstimo pertence.
contractNumber	string	Não	Número do contrato do empréstimo.
ipocCode	string	Sim	Código IPOC identificando a operação.
productName	string	Não	Nome do produto de empréstimo.
type	string	Não	Tipo do empréstimo (por exemplo, CREDITO_PESSOAL_COM_CONSIGNACAO).
date	string	Não	Data de referência dos dados do empréstimo.
contractDate	string	Não	Data em que o contrato foi assinado.
disbursementDates	array	Sim	Lista de datas de desembolso.
settlementDate	string	Sim	Data de liquidação.
contractAmount	number	Não	Valor total contratado.
currencyCode	string	Não	Código ISO da moeda (por exemplo, BRL).
dueDate	string	Não	Data final de vencimento do empréstimo.
instalmentPeriodicity	string	Não	Periodicidade das parcelas (por exemplo, MONTHLY).
instalmentPeriodicityAdditionalInfo	string	Sim	Informações adicionais sobre a periodicidade.
firstInstalmentDueDate	string	Sim	Data de vencimento da primeira parcela.
CET	number	Sim	Custo Efetivo Total (CET).
amortizationScheduled	string	Sim	Tipo de amortização (por exemplo, SAC, PRICE).
amortizationScheduledAdditionalInfo	string	Sim	Informações adicionais sobre a amortização.
cnpjConsignee	string	Sim	CNPJ do consignatário (para empréstimos consignados).
interestRates	array	Sim	Lista de taxas de juros aplicadas ao empréstimo.
contractedFees	array	Sim	Lista de taxas contratadas.
contractedFinanceCharges	array	Sim	Lista de encargos financeiros contratados.
warranties	array	Sim	Lista de garantias associadas ao empréstimo.
instalments	object	Sim	Detalhes sobre as parcelas do empréstimo.
payments	object	Sim	Detalhes dos pagamentos, incluindo liberações.

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