GET/loans/{id}

Recuperar

Recupera o recurso de empréstimo pelo seu id

Parameters

Path Parameters

NameType
idrequired
string (uuid)

Responses

200Recuperar um empréstimo.
object

Response with information related to a loan

idrequiredstring

Identificador principal

itemIdrequiredstring (uuid)

Identificador do item vinculado ao empréstimo

contractNumberstring

Número do contrato fornecido pela instituição contratante

ipocCodestring

Número do contrato padrão - IPOC (Identificação Padronizada da Operação de Crédito)

productNamerequiredstring

Denominação/Identificação do nome da operação de crédito divulgada ao cliente

typestring

Tipo de empréstimo (https://openbanking-brasil.github.io/openapi/swagger-apis/loans/?urls.primaryName=2.0.1#model-EnumContractProductSubTypeLoans)

kindrequiredstring

Família de operação de crédito à qual este contrato pertence.

LOANFINANCINGINVOICE_FINANCINGUNARRANGED_ACCOUNT_OVERDRAFT
daterequiredstring (date-time) | null

Data em que os dados do empréstimo foram coletados

contractDatestring (date-time)

Data em que o empréstimo foi contratado

disbursementDatesstring[]

Data de liberação do valor contratado

itemsstring (date)
settlementDatestring (date-time)

Data de liquidação do empréstimo

contractAmountnumber

Valor do empréstimo contratado

currencyCoderequiredstring

Código que referencia a moeda do empréstimo

dueDatestring (date-time)

Data de vencimento do empréstimo

installmentPeriodicitystring

Frequência regular de parcelas

WITHOUT_REGULAR_PERIODICITYWEEKLYFORTNIGHTLYMONTHLYBIMONTHLYQUARTERLYSEMESTERLYYEARLYOTHERS
installmentPeriodicityAdditionalInfostring

Campo obrigatório para complementar as informações sobre a frequência de pagamento regular quando installmentPeriodicity tem o valor 'OUTROS'

firstInstallmentDueDatestring (date-time)

Data de vencimento da primeira parcela

CETnumber

CET - Custo Efetivo Total deve ser expresso como uma taxa percentual anual e incorpora todas as cobranças e despesas incorridas nas operações de crédito (taxa de juros, mas também tarifas, impostos, seguros e outras despesas cobradas)

amortizationScheduledstring

Sistema de amortização (https://openbanking-brasil.github.io/openapi/swagger-apis/loans/?urls.primaryName=2.0.1#model-EnumContractAmortizationScheduled)

SACPRICESAMWITHOUT_AMORTIZATION_SYSTEMOTHERS
amortizationScheduledAdditionalInfostring

Campo obrigatório para complementar as informações sobre a amortização programada quando o valor for 'OUTROS'

cnpjConsigneestring

CNPJ do Remetente

interestRatesobject[]
itemsobject

Object that brings the set of information necessary to demonstrate the composition of the remunerative interest rates of the Credit Type

contractedFeesobject[]

Lista que traz as informações das tarifas acordadas no contrato.

itemsobject
contractedFinanceChargesobject[]

Lista que traz as cobranças acordadas no contrato

itemsobject
warrantiesobject[]
itemsobject
installmentsobject
typeNumberOfInstallmentsstring

Tipo de termo total do contrato referente ao tipo de crédito informado

DAYWEEKMONTHYEARWITHOUT_TOTAL_PERIOD
totalNumberOfInstallmentsnumber

Termo total de acordo com o tipo referente ao tipo de crédito informado

typeContractRemainingstring

Tipo de prazo restante do contrato referente ao tipo de crédito informado

DAYWEEKMONTHYEARWITHOUT_TOTAL_PERIODWITHOUT_REMAINING_PERIOD
contractRemainingNumbernumber

Termo restante de acordo com o tipo referente ao tipo de crédito informado

paidInstallmentsnumber

Número de parcelas pagas

dueInstallmentsnumber

Número de parcelas devidas

pastDueInstallmentsnumber

Número de parcelas em atraso

balloonPaymentsobject[]

Lista que traz as datas de vencimento e o valor das parcelas não regulares do contrato do tipo de crédito consultado

paymentsobject

Dados de pagamento do contrato de empréstimo

All of:
part 1object

Example response

json
{}
curl -X GET \
'https://api.pluggy.ai/loans/{id}' \
-H 'Content-Type: application/json' \
-H 'X-API-KEY: YOUR_API_KEY'
Resposta de exemplo
{}