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.
JSON example, if the account's type is CREDIT
.
{
"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,
"balanceForeignCurrency": 500,
"minimumPayment": 100
}
}
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. |
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. |
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.
Updated 12 days ago