Accounts object
| Attribute | Type | Description |
|---|---|---|
| id | string | Unique identifier of account |
| created_at | date-time | Date and time account was created |
| updated_at | date-time | Date and time account was last updated |
| type | string | Account type (CHECKING, SAVINGS, CREDIT_CARD, etc.) |
| subtype | string | Account subtype (MONEY_MARKET, etc.) |
| mask | string | Masked account number |
| nickname | string | Alternate name for account |
| balances | object | Balance information, see Balances object |
Balances object
| Attribute | Type | Description |
|---|---|---|
| currency_code | string | ISO 4217 currency code |
| balance | string | Current balance amount |
| available_balance | string | Available balance amount |
| credit_limit | string | Credit limit (for credit accounts) |
Transactions object
| Attribute | Type | Description |
|---|---|---|
| id | string | Unique identifier of transaction |
| created_at | date-time | Timestamp when transaction was created |
| updated_at | date-time | Timestamp when transaction was last updated |
| account_id | string | ID of the associated account |
| external_id | string | External system transaction identifier |
| amount | string | Monetary amount of transaction |
| currency_code | string | ISO 4217 currency code |
| check_number | string | Check number (if applicable) |
| categories | array of strings | Categories assigned to this transaction |
| description | string | Human-readable transaction description |
| merchant_name | string | Merchant name |
| status | string | POSTED or PENDING |
| type | string | CREDIT or DEBIT |
| posted_at | date-time | Timestamp for movement of funds |
| transacted_at | date-time | Timestamp when transaction occurred |
| memo | string | Additional descriptive information |
| merchant_category_code | number | ISO 18245 category code |
| location | object | Location, see Location object |
Location object
| Attribute | Type | Description |
|---|---|---|
| latitude | number | Latitude |
| longitude | number | Longitude |
Daily totals object
| Attribute | Type | Description |
|---|---|---|
| date | string | Date (YYYY-MM-DD) |
| net_total | string | Net total for the day |
| transaction_count | integer | Number of transactions |
Pagination
The transactions endpoint supports page-based pagination. See Pagination for details.| Field | Type | Description |
|---|---|---|
| count | integer | Total number of transactions |
| next | string | URL to next page (null if last page) |
| previous | string | URL to previous page (null if first page) |
Endpoints
Example response
{
"count": 42,
"next": null,
"previous": null,
"accounts": [
{
"id": "24d7e80942ce4ad58a93f70ce4115f5c",
"created_at": "2022-05-04T11:30:00Z",
"updated_at": "2022-05-04T12:00:00Z",
"type": "CHECKING",
"subtype": "MONEY_MARKET",
"mask": "6789",
"nickname": "My account",
"balances": {
"currency_code": "USD",
"balance": "100.00",
"available_balance": "50.99",
"credit_limit": "0.00"
}
}
],
"transactions": [
{
"id": "b3f1a92c58d74e6f8901234567890abc",
"created_at": "2022-05-04T11:30:00Z",
"updated_at": "2022-05-04T12:00:00Z",
"account_id": "24d7e80942ce4ad58a93f70ce4115f5c",
"external_id": "external_key_243901",
"amount": "-4.75",
"currency_code": "USD",
"check_number": "",
"categories": ["Food & Dining", "Coffee Shops"],
"description": "Starbucks #1234",
"merchant_name": "Starbucks",
"status": "POSTED",
"type": "DEBIT",
"posted_at": "2022-05-04T11:30:00Z",
"transacted_at": "2022-05-04T11:30:00Z",
"memo": "",
"merchant_category_code": 5814,
"location": {
"latitude": 40.730610,
"longitude": -73.935242
}
}
],
"daily_totals": [
{
"date": "2022-05-04",
"net_total": "-4.75",
"transaction_count": 1
}
]
}
Transaction categories
| Category | Subcategories |
|---|---|
| Auto & Transport | Auto Insurance, Auto Payment, Gas, Parking, Public Transportation, Service & Parts |
| Bills & Utilities | Home Phone, Internet, Mobile Phone, Television, Utilities |
| Education | Books & Supplies, Student Loan, Tuition |
| Entertainment | Arts, Movies & DVDs, Music, Newspapers & Magazines |
| Fees & Charges | ATM Fee, Banking Fee, Finance Charge, Late Fee, Service Fee |
| Financial | Financial Advisor, Life Insurance, BNPL, Loan Disbursement |
| Food & Dining | Alcohol & Bars, Coffee Shops, Fast Food, Groceries, Restaurants |
| Gifts & Donations | Charity, Gift |
| Health & Fitness | Dentist, Doctor, Gym, Health Insurance, Pharmacy |
| Home | Furnishings, Home Improvement, Home Insurance, Mortgage & Rent |
| Income | Bonus, Interest Income, Paycheck, Reimbursement, Rental Income |
| Investments | Buy, Deposit, Dividend & Cap Gains, Sell, Withdrawal |
| Personal Care | Hair, Laundry, Spa & Massage |
| Shopping | Books, Clothing, Hobbies, Sporting Goods |
| Taxes | Federal Tax, Local Tax, Property Tax, Sales Tax, State Tax |
| Transfer | Credit Card Payment, Transfer for Cash Spending, Mortgage Payment, P2P |
| Travel | Air Travel, Hotel, Rental Car & Taxi, Vacation |
| Uncategorized | Cash, Check |