Account

The account product is the list of bank accounts such as Checking or Savings Account and Credit Card, that were available in the selected connector.

The response will vary depending on the Accounts Type, providing a data object related to its type bankData or creditData.

{
  "id": "a658c848-e475-457b-8565-d1fffba127c4",
  "type": "BANK",
  "subtype": "CHECKING_ACCOUNT",
  "number": "0001/12345-0",
  "name": "Conta Corrente",
  "marketingName": "GOLD Conta Corrente",
  "balance": 120950,
  "itemId": "a0922d6f-2007-4169-a181-b961500608db",
  "taxNumber": "333.333.333-33",
  "owner": "John Doe",
  "currencyCode": "BRL",
  "bankData": {
    "transferNumber": "123/0001/12345-0",
    "closingBalance": 120950,
    "automaticallyInvestedBalance": 100,
    "overdraftContractedLimit": 0,
    "overdraftUsedLimit": 0,
    "unarrangedOverdraftAmount": 0
  }
}

{
  "id": "4f61bd6d-e6fc-44b2-9c4b-5609058de7ab",
  "type": "CREDIT",
  "subtype": "CREDIT_CARD",
  "name": "Itau Uniclass 2.0 Mastercard Platinum",
  "marketingName": "Itau Uniclass 2.0 Mastercard Platinum",
  "taxNumber": "***.***.123-22",
  "owner": "FEDERICO MIRAS",
  "number": "1234",
  "balance": 142.41,
  "itemId": "fc214524-4725-4974-9f7a-0f1b50ea39e0",
  "currencyCode": "BRL",
  "creditData": {
    "level": "PLATINUM",
    "brand": "MASTERCARD",
    "brandAdditionalInfo": null,
    "balanceCloseDate": "2020-07-08",
    "balanceDueDate": "2020-07-17",
    "availableCreditLimit": 51300,
    "creditLimit": 51800,
    "isLimitFlexible": false,
    "balanceForeignCurrency": 500,
    "minimumPayment": 100,
    "status": "ACTIVE",
    "holderType": "MAIN"
  }
}

Balance#

Bank Accounts (Checking & Savings) balances represent the amount the holder currently holds as available to spend. If this value is negative, it represents a debt the holder has with the financial institution, an example of this would be an overdraft.

Credit Cards balances are the amount due to the institution, this would mean the open balance of the user's current month. If the previous invoice was paid with an exceeded amount, the balance would return a negative value.

For Open Finance connectors, Credit Card balance is the used limit for that credit card.

Bank account balances on Open Finance#

For Open Finance connectors, the institution reports the available amount of a bank account and, when it has them, the blocked amount and the automatically invested amount. Not every institution reports the last two, so treat them as optional. Pluggy maps them like this:

The sum in closingBalance is the same for every Open Finance connector. What changes for a few institutions is which amount is used as balance.

Itaú and Banco do Brasil. On Itaú PF (601), Itaú PJ (618), Banco do Brasil PF (611) and Banco do Brasil PJ (662), when the automatically invested amount is greater than zero it is used as balance instead of the available amount, and closingBalance is calculated from it. These institutions report the money held in the automatic investment (Itaú's automatic investment, Banco do Brasil's Rende Fácil) separately from the available amount: some send the same value in both, others send zero as available and the whole amount as automatically invested. In both cases the account holder sees that amount as their balance in the bank's app, so that is what balance returns. automaticallyInvestedBalance still returns the amount exactly as reported.

Overdraft. If balance is zero and the account has overdraft in use (overdraftUsedLimit greater than zero), balance is returned as the negative of the overdraft used. This applies to the balance collected when the item syncs; the real-time real-time balance endpoint returns the institution's amounts without this adjustment.

Bank data#

Credit Data#

Disaggregated Credit Limits#

Some credit cards may have multiple credit lines or different operation modalities. The disaggregatedCreditLimits field provides detailed information about each credit line to help you correctly identify the main card and calculate precise balances.

When to Use Disaggregated Limits#

Use this feature when you encounter:

• Incorrect credit card balances
• Multiple credit lines on the same card
• Different operation modalities with separate limits

Structure#

disaggregatedCreditLimits lives inside creditData and is an array of objects, one per credit line:

{
  "creditData": {
    "disaggregatedCreditLimits": [
      {
        "creditLineLimitType": "LIMITE_CREDITO_TOTAL",
        "consolidationType": "INDIVIDUAL",
        "identificationNumber": "1000",
        "isLimitFlexible": false,
        "usedAmount": 149.84,
        "usedAmountCurrencyCode": "BRL",
        "lineName": "CREDITO_A_VISTA",
        "limitAmount": 1000.0,
        "limitAmountCurrencyCode": "BRL",
        "customizedLimitAmount": 2000.0,
        "customizedLimitAmountCurrencyCode": "BRL",
        "availableAmount": 850.16,
        "availableAmountCurrencyCode": "BRL"
      }
    ]
  }
}

Key Fields#

See AccountsAPI in our API reference for more information.