Procurando a documentação anterior?Acesse v1.docs.pluggy.ai
PluggyDocs
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

Resposta com informações relacionadas a um empréstimo

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

Objeto que traz o conjunto de informações necessárias para demonstrar a composição das taxas de juros remuneratórias do Tipo de Crédito

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
{
  "id": "05c693bf-c196-47ea-a28c-8251d6bb8a06",
  "kind": "LOAN",
  "itemId": "5e9f8f8f-f8f8-4f8f-8f8f-8f8f8f8f8f8f",
  "contractNumber": "000000721792794",
  "ipocCode": "92792126019929279212650822221989319252576",
  "productName": "Crédito Pessoal Consignado",
  "type": "CREDITO_PESSOAL_COM_CONSIGNACAO",
  "date": "2023-07-20T00:00:00",
  "contractDate": "2022-08-01T00:00:00",
  "disbursementDates": [
    "2018-01-15T00:00:00"
  ],
  "settlementDate": "2018-01-15T00:00:00",
  "contractAmount": 50000,
  "currencyCode": "BRL",
  "dueDate": "2028-01-15T00:00:00",
  "installmentPeriodicity": "MONTHLY",
  "installmentPeriodicityAdditionalInfo": "",
  "firstInstallmentDueDate": "2018-02-15T00:00:00",
  "CET": 0.29,
  "amortizationScheduled": "SAC",
  "amortizationScheduledAdditionalInfo": "",
  "cnpjConsignee": "55.555.555/0001-55",
  "interestRates": [
    {
      "taxType": "EFETIVA",
      "interestRateType": "SIMPLES",
      "taxPeriodicity": "AA",
      "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": "UNICA",
      "charge": "MINIMO",
      "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": "MES",
    "totalNumberOfInstallments": 130632,
    "typeContractRemaining": "DIA",
    "contractRemainingNumber": 14600,
    "paidInstallments": 73,
    "dueInstallments": 57,
    "pastDueInstallments": 73,
    "balloonPayments": [
      {
        "dueDate": "2021-05-21T00:00:00",
        "amount": {
          "value": 1000.04,
          "currencyCode": "BRL"
        }
      }
    ]
  },
  "payments": {
    "contractOutstandingBalance": 1000.04,
    "releases": [
      {
        "isOverParcelPayment": true,
        "installmentId": "WGx0aExYcEJMVm93TFRsZFcyRXRla0V0V2pBdE9Wd3RYWH",
        "paidDate": "2021-05-21T00:00:00",
        "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
            }
          ]
        }
      }
    ]
  }
}
curl -X GET \
  'https://api.pluggy.ai/loans/{id}' \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY'
Resposta de exemplo
{
  "id": "05c693bf-c196-47ea-a28c-8251d6bb8a06",
  "kind": "LOAN",
  "itemId": "5e9f8f8f-f8f8-4f8f-8f8f-8f8f8f8f8f8f",
  "contractNumber": "000000721792794",
  "ipocCode": "92792126019929279212650822221989319252576",
  "productName": "Crédito Pessoal Consignado",
  "type": "CREDITO_PESSOAL_COM_CONSIGNACAO",
  "date": "2023-07-20T00:00:00",
  "contractDate": "2022-08-01T00:00:00",
  "disbursementDates": [
    "2018-01-15T00:00:00"
  ],
  "settlementDate": "2018-01-15T00:00:00",
  "contractAmount": 50000,
  "currencyCode": "BRL",
  "dueDate": "2028-01-15T00:00:00",
  "installmentPeriodicity": "MONTHLY",
  "installmentPeriodicityAdditionalInfo": "",
  "firstInstallmentDueDate": "2018-02-15T00:00:00",
  "CET": 0.29,
  "amortizationScheduled": "SAC",
  "amortizationScheduledAdditionalInfo": "",
  "cnpjConsignee": "55.555.555/0001-55",
  "interestRates": [
    {
      "taxType": "EFETIVA",
      "interestRateType": "SIMPLES",
      "taxPeriodicity": "AA",
      "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": "UNICA",
      "charge": "MINIMO",
      "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": "MES",
    "totalNumberOfInstallments": 130632,
    "typeContractRemaining": "DIA",
    "contractRemainingNumber": 14600,
    "paidInstallments": 73,
    "dueInstallments": 57,
    "pastDueInstallments": 73,
    "balloonPayments": [
      {
        "dueDate": "2021-05-21T00:00:00",
        "amount": {
          "value": 1000.04,
          "currencyCode": "BRL"
        }
      }
    ]
  },
  "payments": {
    "contractOutstandingBalance": 1000.04,
    "releases": [
      {
        "isOverParcelPayment": true,
        "installmentId": "WGx0aExYcEJMVm93TFRsZFcyRXRla0V0V2pBdE9Wd3RYWH",
        "paidDate": "2021-05-21T00:00:00",
        "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
            }
          ]
        }
      }
    ]
  }
}