The Loan entity is recovered from institutions that support this product
{ " 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 " : [] } } ] } } Property Type Optional Description idstringNo Primary identifier itemIdstringNo Identifier of the item linked to the loan contractNumberstringYes Contract number given by the contracting institution ipocCodestringYes Standard contract number - IPOC (Identificação Padronizada da Operação de Crédito) productNamestringNo Denomination/Identification of the name of the credit operation disclosed to the customer typestringYes Loan type (Open Finance definition ) kindstringNo Credit-operation family this contract belongs to. One of LOAN, FINANCING, INVOICE_FINANCING, UNARRANGED_ACCOUNT_OVERDRAFT. datestringNo Date when the loan data was collected contractDatestringYes Date when the loan was contracted disbursementDatesstring[]Yes Disbursement date of the contracted amount settlementDatestringYes Loan settlement date contractAmountnumberYes Loan contracted value currencyCodestringNo Code referencing the currency of the loan dueDatestringYes Loan due date installmentPeriodicitystringYes Installments regular frequency. One of the installment periodicity values. installmentPeriodicityAdditionalInfostringYes Mandatory field to complement the information regarding the regular payment frequency when installmentPeriodicity has value 'OTHERS' firstInstallmentDueDatestringYes First installment due date CETnumberYes CET - 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) amortizationScheduledstringYes Amortization system (Open Finance definition ). One of the amortization system values. amortizationScheduledAdditionalInfostringYes Mandatory field to complement the information regarding the scheduled amortization when it has value 'OTHERS' cnpjConsigneestringYes Consignor CNPJ interestRatesarray of LoanInterestRate Yes Interest rates applied to the contract. contractedFeesarray of LoanContractedFee Yes List that brings the information of the tariffs agreed in the contract. contractedFinanceChargesarray of LoanContractedFinanceCharge Yes List that brings the charges agreed in the contract warrantiesarray of LoanWarranty Yes Warranties that guarantee the credit operation. installmentsLoanInstallments Yes Remaining term and installments of the operation. paymentsLoanPayments Yes Loan contract payment data
See LoanAPI in our API reference for more information.
Installments regular frequency
WITHOUT_REGULAR_PERIODICITYWEEKLYFORTNIGHTLYMONTHLYBIMONTHLYQUARTERLYSEMESTERLYYEARLYOTHERS
Amortization system (Open Finance definition )
SACPRICESAMWITHOUT_AMORTIZATION_SYSTEMOTHERS
Property Type Optional Description taxTypestringYes Tax type. One of the tax type values. interestRateTypestringYes Interest rate type. One of the interest rate type values. taxPeriodicitystringYes Tax periodicity. One of the tax periodicity values. calculationstringYes Calculation basis referentialRateIndexerTypestringYes Types of benchmark rates or indexers (Open Finance definition ) referentialRateIndexerSubTypestringYes Subtypes of benchmark rates or indexers (Open Finance definition ) referentialRateIndexerAdditionalInfostringYes Free field to complement the information regarding the Type of reference rate or indexer preFixedRatenumberYes Pre-fixed rate applied under the credit modality contract. 1 = 100% postFixedRatenumberYes Post-fixed rate applied under the credit modality contract. 1 = 100% additionalInfostringYes Text with additional information on the composition of agreed interest rates
Property Type Optional Description namestringYes Agreed rate denomination codestringYes Acronym identifying the agreed rate chargeTypestringYes Charge type for the rate agreed in the contract. One of the charge type values. chargestringYes Billing method related to the tariff agreed in the contract. One of the charge values. amountnumberYes Monetary value of the tariff agreed in the contract ratenumberYes Rate value in percentage agreed in the contract
Charge type for the rate agreed in the contract
Billing method related to the tariff agreed in the contract
MINIMUMMAXIMUMFIXEDPERCENTAGE
Property Type Optional Description typestringYes Charge type agreed in the contract (Open Finance definition ) additionalInfostringYes Field for additional information ratenumberYes Charge value in percentage agreed in the contract
Property Type Optional Description currencyCodestringYes Code referencing the currency of the warranty typestringYes Denomination / Identification of the type of warranty that guarantees the Type of Credit Operation contracted (Open Finance definition ) subtypestringYes Denomination / Identification of the subtype of warranty that guarantees the Type of Credit Operation contracted (Open Finance definition ) amountnumberYes Warranty original value
Property Type Optional Description typeNumberOfInstallmentsstringYes Type of total term of the contract referring to the type of credit informed. One of the number of installments values. totalNumberOfInstallmentsnumberYes Total term according to the type referring to the type of credit informed typeContractRemainingstringYes Type of remaining term of the contract referring to the type of credit informed. One of the type contract remaining values. contractRemainingNumbernumberYes Remaining term according to the type referring to the credit type informed paidInstallmentsnumberYes Number of paid installments dueInstallmentsnumberYes Number of due installments pastDueInstallmentsnumberYes Number of overdue installments balloonPaymentsarray of LoanInstallmentBalloonPayment Yes List that brings the due dates and value of the non-regular installments of the contract of the type of credit consulted
Type of total term of the contract referring to the type of credit informed
DAYWEEKMONTHYEARWITHOUT_TOTAL_PERIOD
Type of remaining term of the contract referring to the type of credit informed
DAYWEEKMONTHYEARWITHOUT_TOTAL_PERIODWITHOUT_REMAINING_PERIOD
Property Type Optional Description dueDatestringYes Expiration date of the non-regular installment to expire from the contract of the consulted credit modality amountLoanInstallmentBalloonPaymentAmount Yes
Property Type Optional Description valuenumberYes Monetary value of the non-regular installment due currencyCodestringYes Code referencing the currency of the installment
Property Type Optional Description contractOutstandingBalancenumberYes Amount required for the customer to settle the debt releasesarray of LoanPaymentRelease Yes List of payments made in the period
Property Type Optional Description isOverParcelPaymentbooleanYes Identifies whether it is an agreed payment (false) or a one-time payment (true) installmentIdstringYes Installment identifier, responsibility of each transmitting Institution paidDatestringYes Effective date of payment referring to the contract of the credit modality consulted currencyCodestringYes Code referencing the currency of the payment paidAmountnumberYes Payment amount referring to the contract of the credit modality consulted overParcelLoanPaymentReleaseOverParcel Yes
Property Type Optional Description namestringYes Denomination of the agreed rate codestringYes Acronym identifying the agreed rate amountnumberYes Monetary value of the tariff agreed in the contract
Property Type Optional Description typestringYes Charge type agreed in the contract (Open Finance definition ) additionalInfostringYes Free field to fill in additional information regarding the charge amountnumberYes Payment amount of the charge paid outside the installment
