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": "Crédito 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": [
    {
      "name": "Renovação de cadastro",
      "code": "CADASTRO",
      "chargeType": "UNIQUE",
      "charge": "MINIMUM",
      "amount": 100000.04,
      "rate": 0.062
    }
  ],
  "contractedFinanceCharges": [
    {
      "type": "JUROS_REMUNERATORIOS_POR_ATRASO",
      "additionalInfo": "",
      "rate": 0.07
    }
  ],
  "warranties": [
    {
      "currencyCode": "BRL",
      "type": "CESSAO_DIREITOS_CREDITORIOS",
      "subtype": "NOTAS_PROMISSORIAS_OUTROS_DIREITOS_CREDITO",
      "amount": 1000.04
    }
  ],
  "installments": {
    "typeNumberOfInstallments": "MONTH",
    "totalNumberOfInstallments": 130632,
    "typeContractRemaining": "DAY",
    "contractRemainingNumber": 14600,
    "paidInstallments": 73,
    "dueInstallments": 57,
    "pastDueInstalments": 73,
    "balloonPayments": [
      {
        "dueDate": "2021-05-21T00:00:00.000Z",
        "amount": {
          "value": 1000.04,
          "currencyCode": "BRL"
        }
      }
    ]
  },
  "payments": {
    "contractOutstandingBalance": 1000.04,
    "releases": [
      {
        "providerId": "XlthLXpBLVowLTldW2EtekEtWjAtOVwtXXswLDk5fSQ",
        "isOverParcelPayment": true,
        "instalmentId": "WGx0aExYcEJMVm93TFRsZFcyRXRla0V0V2pBdE9Wd3RYWH",
        "paidDate": "2021-05-21T00:00:00.000Z",
        "currencyCode": "BRL",
        "paidAmount": 1000.04,
        "overParcel": {
          "fees": [
            {
              "name": "Reavaliação periódica do bem",
              "code": "aval_bem",
              "amount": 100000.04
            }
          ],
          "charges": [
            {
              "type": "JUROS_REMUNERATORIOS_POR_ATRASO",
              "additionalInfo": "",
              "amount": 1000.04
            }
          ]
        }
      }
    ]
  }
}
PropertyTypeOptionalDescription
idstringNoUnique identifier of the Loan model
itemIdstringNoId of the item related to this loan
contractNumberstringYesContract number given by the contracting institution
ipocCodestringYesStandard contract number - IPOC (Identificação Padronizada da Operação de Crédito)
productNamestringNoDenomination/Identification of the name of the credit operation disclosed to the customer
providerIdstringYesLoan identifier under the responsibility of each transmitting Institution
typestringYesLoan type (More info)
datestringNoDate when the loan data was collected
contractDatestringYesDate when the loan was contracted
disbursementDatesstring[]YesDisbursement date of the contracted amount
settlementDatestringYesLoan settlement date
contractAmountnumberYesLoan contracted value
currencyCodestringNoCurrency ISO code of the loan, ie BRL, USD.
dueDatestringYesLoan due date
installmentPeriodicitystringYesInstallmentPeriodicityType
installmentPeriodicityAdditionalInfostringYesMandatory field to complement the information regarding the regular payment frequency when installmentPeriodicity has value 'OTHERS'
firstInstallmentDueDatestringYesFirst installment due date
CETnumberYesCET - Custo Efetivo Total must be expressed as an annual percentage rate and incorporates all charges and expenses incurred in credit operations (interest rate, but also tariffs, taxes, insurance and other expenses charged)
amortizationScheduledstringYesLoanAmortizationSystemType
amortizationScheduledAdditionalInfostringYesMandatory field to complement the information regarding the scheduled amortization when it has value 'OTHERS'
cnpjConsigneestringYesConsignor CNPJ
interestRatesarrayYesLoanInterestRateType
contractedFeesarrayYesList that brings the information of the tariffs agreed in the contract.

LoanContractedFeeType
contractedFinanceChargesarrayYesList that brings the charges agreed in the contract

LoanContractedFinanceChargeType
warrantiesarrayYesLoanWarrantyType
installmentsobjectYesLoanInstallmentsType
paymentsobjectYesLoanPaymentsType

Loan installment periodicity

Installments regular frequency

  • WITHOUT_REGULAR_PERIODICITY
  • WEEKLY
  • FORTNIGHTLY
  • MONTHLY
  • BIMONTHLY
  • QUARTERLY
  • SEMESTERLY
  • YEARLY
  • OTHERS

Loan amortization system

Amortization system (Open Finance definition)

  • SAC
  • PRICE
  • SAM
  • WITHOUT_AMORTIZATION_SYSTEM
  • OTHERS

Loan interest rate

PropertyTypeOptionalDescription
taxTypestringYesLoanTaxType
interestRateTypestringYesLoanInterestRateType
taxPeriodicitystringYesLoanTaxPeriodicityType
calculationstringYesCalculation basis
referentialRateIndexerTypestringYesTypes of benchmark rates or indexers (More Info)
referentialRateIndexerSubTypestringYesSubtypes of benchmark rates or indexers (More Info)
referentialRateIndexerAdditionalInfostringYesFree field to complement the information regarding the Type of reference rate or indexer
preFixedRatenumberYesPre-fixed rate applied under the credit modality contract. 1 = 100%
postFixedRatenumberYesPost-fixed rate applied under the credit modality contract. 1 = 100%
additionalInfostringYesText with additional information on the composition of agreed interest rates

Loan tax type

  • NOMINAL
  • EFFECTIVE

Loan interest rate type

  • SIMPLE
  • COMPOUND

Loan tax periodicity

  • MONTHLY
  • YEARLY

Loan contracted fee

PropertyTypeOptionalDescription
namestringYesAgreed rate denomination
codestringYesAcronym identifying the agreed rate
chargeTypestringYesContractedFeeChargeType
chargestringYesContractedFeeCharge
amountnumberYesMonetary value of the tariff agreed in the contract
ratenumberYesRate value in percentage agreed in the contract

Contracted fee charge type

Charge type for the rate agreed in the contract

  • UNIQUE
  • BY_INSTALLMENT

Contracted fee charge

Billing method related to the tariff agreed in the contract

  • MINIMUM
  • MAXIMUM
  • FIXED
  • PERCENTAGE

Loan contracted finance charge

PropertyTypeOptionalDescription
typestringYesCharge type agreed in the contract (More Info)
additionalInfostringYesField for additional information
ratenumberYesCharge value in percentage agreed in the contract

Loan warranty

PropertyTypeOptionalDescription
currencyCodestringYesCode referencing the currency of the warranty
typestringYesDenomination / Identification of the type of warranty that guarantees the Type of Credit Operation contracted (More Info)
subtypestringYesDenomination / Identification of the subtype of warranty that guarantees the Type of Credit Operation contracted (More Info)
amountnumberYesWarranty original value

Loan installments

Set of information regarding the remaining term and the installments of a loan credit operation

PropertyTypeOptionalDescription
typeNumberOfInstallmentsstringYesNumberOfInstallmentsType
totalNumberOfInstallmentsnumberYesTotal term according to the type referring to the type of credit informed
typeContractRemainingstringYesTypeContractRemaining
contractRemainingNumbernumberYesRemaining term according to the type referring to the credit type informed
paidInstallmentsnumberYesNumber of paid installments
dueInstallmentsnumberYesNumber of due installments
pastDueInstallmentsnumberYesNumber of overdue installments
balloonPaymentsarrayYesList that brings the due dates and value of the non-regular installments of the contract of the type of credit consulted

BalloonPaymentType

Number of installments

Type of total term of the contract referring to the type of credit informed

  • DAY
  • WEEK
  • MONTH
  • YEAR
  • WITHOUT_TOTAL_PERIOD

Type contract remaining

Type of remaining term of the contract referring to the type of credit informed

  • DAY
  • WEEK
  • MONTH
  • YEAR
  • WITHOUT_TOTAL_PERIOD
  • WITHOUT_REMAINING_PERIOD

Loan balloon payment

PropertyTypeOptionalDescription
dueDatestringYesExpiration date of the non-regular installment to expire from the contract of the consulted credit modality
amountobjectYesBalloonPaymentAmountType

Balloon payment amount

PropertyTypeOptionalDescription
valuenumberYesMonetary value of the non-regular installment due
currencyCodestringYesCode referencing the currency of the installment

Loan payments

Loan contract payment data

PropertyTypeOptionalDescription
contractOutstandingBalancenumberYesAmount required for the customer to settle the debt
releasesarrayYesList of payments made in the period

LoanPaymentReleaseType

Loan payment release

PropertyTypeOptionalDescription
providerIdstringYesPayment identifier under the responsibility of each transmitting Institution
isOverParcelPaymentbooleanYesIdentifies whether it is an agreed payment (false) or a one-time payment (true)
installmentIdstringYesInstallment identifier, responsibility of each transmitting Institution
paidDatestringYesEffective date of payment referring to the contract of the credit modality consulted
currencyCodestringYesCode referencing the currency of the payment
paidAmountnumberYesPayment amount referring to the contract of the credit modality consulted
overParcelobjectYesLoanPaymentOverParcelType

Loan payment over parcel

Object of fees and charges that were paid outside the installment

PropertyTypeOptionalDescription
feesarrayYesList of fees that were paid outside the installment, only for single paymentPayment identifier under the responsibility of each transmitting Institution

OverParcelFeeType
chargesarrayYesList of charges that were paid out of installment

OverParcelChargeType

Over parcel fee

PropertyTypeOptionalDescription
namestringYesDenomination of the agreed rate
codestringYesAcronym identifying the agreed rate
amountnumberYesMonetary value of the tariff agreed in the contract

Over parcel charge

PropertyTypeOptionalDescription
typestringYesCharge type agreed in the contract (Details)
additionalInfostringYesFree field to fill in additional information regarding the charge
amountnumberYesPayment amount of the charge paid outside the installment