Looking for the previous documentation?Go to v1.docs.pluggy.ai
GET/loans

List

Recovers all loans collected for the item provided

Parameters

Query Parameters

NameType
itemIdrequired
string (uuid)

Responses

200Retrieve a list of all loans
object
pagenumber (double)
totalnumber (double)
totalPagesnumber (double)
resultsobject[]

List of loans

itemsobject

Response with information related to a loan

Example response

json
{
  "page": 1,
  "total": 1,
  "totalPages": 1,
  "results": [
    {
      "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' \
-H 'Content-Type: application/json' \
-H 'X-API-KEY: YOUR_API_KEY'
Sample response
{
"page": 1,
"total": 1,
"totalPages": 1,
"results": [
{
"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
}
]
}
}
]
}
}
]
}