Sign in

v1

latestOpenAPI 3.1.0MIT2026-07-2484155300.5 KB
Loan

Retrieve

Recovers the loan resource by its id

get/loans/{id}

Path parameters

idstring uuid required

loan primary identifier

Response

Retrieve a loan.

idstring required

Primary identifier

itemIdstring uuid required

Identifier of the item linked to the loan

contractNumberstring

Contract number given by the contracting institution

ipocCodestring

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

productNamestring required

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

typestring

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

kind'LOAN' | 'FINANCING' | 'INVOICE_FINANCING' | 'UNARRANGED_ACCOUNT_OVERDRAFT' required

Credit-operation family this contract belongs to.

datestring date-time required

Date when the loan data was collected

contractDatestring date-time

Date when the loan was contracted

disbursementDatesstring[]

Disbursement date of the contracted amount

settlementDatestring date-time

Loan settlement date

contractAmountnumber

Loan contracted value

currencyCodestring required

Code referencing the currency of the loan

dueDatestring date-time

Loan due date

installmentPeriodicity'WITHOUT_REGULAR_PERIODICITY' | 'WEEKLY' | 'FORTNIGHTLY' | 'MONTHLY' | 'BIMONTHLY' | 'QUARTERLY' | 'SEMESTERLY' | 'YEARLY' | 'OTHERS'

Installments regular frequency

installmentPeriodicityAdditionalInfostring

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

firstInstallmentDueDatestring date-time

First installment due date

CETnumber

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'SAC' | 'PRICE' | 'SAM' | 'WITHOUT_AMORTIZATION_SYSTEM' | 'OTHERS'

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

amortizationScheduledAdditionalInfostring

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

cnpjConsigneestring

Consignor CNPJ

Example response

{}