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": "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",
    "balanceCloseDate": "2020-07-08",
    "balanceDueDate": "2020-07-17",
    "availableCreditLimit": 51300,
    "creditLimit": 51800,
    "isLimitFlexible": false,
    "balanceForeignCurrency": 500,
    "minimumPayment": 100
  }
}
{
  "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": "416.799.495-00",
  "owner": "John Doe",
  "currencyCode": "BRL",
  "bankData": {
    "transferNumber": "0001/12345-0",
    "closingBalance": 120950
  }
}

Property

Description

type

Type of account.

subtype

The subtype of account.

number

The number of the account, ie xx-41234/02.

balance

The current available balance of the account.

currencyCode

Currency ISO code of the account, ie USD or EUR

name

Name of the account, ie. Saving Account 1234 or Mastercard Gold.

marketingName

The extra name provided for some accounts that are related to the level of the account. Not always provided.

owner

Name of the owner of the account.

taxNumber

Tax number of the owner of the account.

transactions

List of transactions of the account.

bankData

Specific data for bank account types.

creditData

Specific data for credit account types.

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 last closed invoice that is pending payment. If the last closed invoice has been paid, it will return 0.

 

Bank data

Property

Description

transferNumber

Unique account number for the country, IBAN / CBU / other. Format: agency/accountNumber-checkDigit

closingBalance

Current balance of the account.

 

Credit Data

Property

Description

minimumPayment

Balance minimum payment for the current period.

balanceForeignCurrency

Balance in foreign currency for the current period.

availableCreditLimit

The available credit limit for the account.

creditLimit

The credit limit for the account.

isLimitFlexible

Whether the credit card is unlimited.

balanceDueDate

Due Date for the credit. (yyyy-mm-dd)

balanceCloseDate

Close date when the balance was calculated. (yyyy-mm-dd)

level

Card type level (Black, Signature, etc).

brand

Card Brand (Mastercard, Visa, Elo, etc).

📘

See Accounts in our API reference for more information.