Loan | Pluggy Docs

The Loan entity is recovered from institutions that support this product. It represents a loan contracted by the user, including data like contract number, taxes, interest rates, warranties, installments, 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": []
        }
      }
    ]
  }
}

Property	Type	Optional	Description
id	string	No	Primary identifier of the loan.
itemId	string	No	Identifier of the Item (connection) this loan belongs to.
contractNumber	string	No	Contract number of the loan.
ipocCode	string	Yes	IPOC code identifying the operation.
productName	string	No	Name of the loan product.
type	string	No	Type of the loan (e.g., CREDITO_PESSOAL_COM_CONSIGNACAO).
date	string	No	Reference date of the loan data.
contractDate	string	No	Date the contract was signed.
disbursementDates	array	Yes	List of disbursement dates.
settlementDate	string	Yes	Settlement date.
contractAmount	number	No	Total contracted amount.
currencyCode	string	No	Currency ISO code (e.g., BRL).
dueDate	string	No	Final due date of the loan.
instalmentPeriodicity	string	No	Periodicity of installments (e.g., MONTHLY).
instalmentPeriodicityAdditionalInfo	string	Yes	Additional info about periodicity.
firstInstalmentDueDate	string	Yes	Due date of the first installment.
CET	number	Yes	Total Effective Cost (Custo Efetivo Total).
amortizationScheduled	string	Yes	Amortization type (e.g., SAC, PRICE).
amortizationScheduledAdditionalInfo	string	Yes	Additional info about amortization.
cnpjConsignee	string	Yes	CNPJ of the consignee (for payroll loans).
interestRates	array	Yes	List of interest rates applied to the loan.
contractedFees	array	Yes	List of contracted fees.
contractedFinanceCharges	array	Yes	List of contracted finance charges.
warranties	array	Yes	List of warranties associated with the loan.
instalments	object	Yes	Details about the installments of the loan.
payments	object	Yes	Payment details including releases.

See Loan in our API reference for more information.