List

get https://api.pluggy.ai/loans

Recovers all loans collected for the item provided

Response

Response body

object

page

double

total

double

totalPages

double

results

array of objects

List of loans

results

object

string

required

Primary identifier

itemId

string

required

Identifier of the item linked to the loan

contractNumber

string

Contract number given by the contracting institution

ipocCode

string

Standard contract number - IPOC (Identificação Padronizada da Operação de Crédito)

productName

string

required

Denomination/Identification of the name of the credit operation disclosed to the customer

type

string

Loan type (https://openbanking-brasil.github.io/openapi/swagger-apis/loans/?urls.primaryName=2.0.1#model-EnumContractProductSubTypeLoans)

date

date-time

required

Date when the loan data was collected

contractDate

date-time

Date when the loan was contracted

disbursementDates

array of dates

Disbursement date of the contracted amount

disbursementDates

settlementDate

date-time

Loan settlement date

contractAmount

number

Loan contracted value

currencyCode

string

required

Code referencing the currency of the loan

dueDate

date-time

Loan due date

installmentPeriodicity

string

Installments regular frequency

WITHOUT_REGULAR_PERIODICITY WEEKLY FORTNIGHTLY MONTHLY BIMONTHLY QUARTERLY SEMESTERLY YEARLY OTHERS

installmentPeriodicityAdditionalInfo

string

Mandatory field to complement the information regarding the regular payment frequency when installmentPeriodicity has value 'OTHERS'

firstInstallmentDueDate

date-time

First installment due date

CET

number

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)

amortizationScheduled

string

Amortization system (https://openbanking-brasil.github.io/openapi/swagger-apis/loans/?urls.primaryName=2.0.1#model-EnumContractAmortizationScheduled)

SAC PRICE SAM WITHOUT_AMORTIZATION_SYSTEM OTHERS

amortizationScheduledAdditionalInfo

string

Mandatory field to complement the information regarding the scheduled amortization when it has value 'OTHERS'

cnpjConsignee

string

Consignor CNPJ

interestRates

array of objects

interestRates

object

taxType

string

Tax type

NOMINAL EFFECTIVE

interestRateType

string

Interest rate type

SIMPLE COMPOUND

taxPeriodicity

string

Tax periodicity

MONTHLY YEARLY

calculation

string

Calculation basis

referentialRateIndexerType

string

Types of benchmark rates or indexers (https://openbanking-brasil.github.io/openapi/swagger-apis/loans/?urls.primaryName=2.0.1#model-EnumContractReferentialRateIndexerType)

referentialRateIndexerSubType

string

Subtypes of benchmark rates or indexers (https://openbanking-brasil.github.io/openapi/swagger-apis/loans/?urls.primaryName=2.0.1#model-EnumContractReferentialRateIndexerSubType)

referentialRateIndexerAdditionalInfo

string

Free field to complement the information regarding the Type of reference rate or indexer

preFixedRate

number

Pre-fixed rate applied under the credit modality contract. 1 = 100%

postFixedRate

number

Post-fixed rate applied under the credit modality contract. 1 = 100%

additionalInfo

string

Text with additional information on the composition of agreed interest rates

contractedFees

array of objects

List that brings the information of the tariffs agreed in the contract.

contractedFees

object

name

string

Agreed rate denomination

code

string

Acronym identifying the agreed rate

chargeType

string

Charge type for the rate agreed in the contract

UNIQUE BY_INSTALLMENT

charge

string

Billing method related to the tariff agreed in the contract

MINIMUM MAXIMUM FIXED PERCENTAGE

amount

number

Monetary value of the tariff agreed in the contract

rate

number

Rate value in percentage agreed in the contract

contractedFinanceCharges

array of objects

List that brings the charges agreed in the contract

contractedFinanceCharges

object

type

string

Charge type agreed in the contract (https://openbanking-brasil.github.io/openapi/swagger-apis/loans/?urls.primaryName=2.0.1#model-EnumContractFinanceChargeType)

additionalInfo

string

Field for additional information

rate

number

Charge value in percentage agreed in the contract

warranties

array of objects

warranties

object

currencyCode

string

Code referencing the currency of the warranty

type

string

Denomination / Identification of the type of warranty that guarantees the Type of Credit Operation contracted (https://openbanking-brasil.github.io/openapi/swagger-apis/loans/?urls.primaryName=2.0.1#model-EnumWarrantyType)

subtype

string

Denomination / Identification of the subtype of warranty that guarantees the Type of Credit Operation contracted (https://openbanking-brasil.github.io/openapi/swagger-apis/loans/?urls.primaryName=2.0.1#model-EnumWarrantySubType)

amount

number

Warranty original value

installments

object

payments

object

Loan contract payment data

Language

Credentials

Header


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api.pluggy.ai/loans \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Retrieve a list of all loans