Skip to main content
The Transactions response includes account records, individual transactions, and daily totals. It supports pagination for large result sets.

​
Accounts object

AttributeTypeDescription
idstringUnique identifier of account
created_atdate-timeDate and time account was created
updated_atdate-timeDate and time account was last updated
typestringAccount type (CHECKING, SAVINGS, CREDIT_CARD, etc.)
subtypestringAccount subtype (MONEY_MARKET, etc.)
maskstringMasked account number
nicknamestringAlternate name for account
balancesobjectBalance information, see Balances object

​
Balances object

AttributeTypeDescription
currency_codestringISO 4217 currency code
balancestringCurrent balance amount
available_balancestringAvailable balance amount
credit_limitstringCredit limit (for credit accounts)

​
Transactions object

AttributeTypeDescription
idstringUnique identifier of transaction
created_atdate-timeTimestamp when transaction was created
updated_atdate-timeTimestamp when transaction was last updated
account_idstringID of the associated account
external_idstringExternal system transaction identifier
amountstringMonetary amount of transaction
currency_codestringISO 4217 currency code
check_numberstringCheck number (if applicable)
categoriesarray of stringsCategories assigned to this transaction
descriptionstringHuman-readable transaction description
merchant_namestringMerchant name
statusstringPOSTED or PENDING
typestringCREDIT or DEBIT
posted_atdate-timeTimestamp for movement of funds
transacted_atdate-timeTimestamp when transaction occurred
memostringAdditional descriptive information
merchant_category_codenumberISO 18245 category code
locationobjectLocation, see Location object

​
Location object

AttributeTypeDescription
latitudenumberLatitude
longitudenumberLongitude

​
Daily totals object

AttributeTypeDescription
datestringDate (YYYY-MM-DD)
net_totalstringNet total for the day
transaction_countintegerNumber of transactions

​
Pagination

The transactions endpoint supports page-based pagination. See Pagination for details.
FieldTypeDescription
countintegerTotal number of transactions
nextstringURL to next page (null if last page)
previousstringURL 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

CategorySubcategories
Auto & TransportAuto Insurance, Auto Payment, Gas, Parking, Public Transportation, Service & Parts
Bills & UtilitiesHome Phone, Internet, Mobile Phone, Television, Utilities
EducationBooks & Supplies, Student Loan, Tuition
EntertainmentArts, Movies & DVDs, Music, Newspapers & Magazines
Fees & ChargesATM Fee, Banking Fee, Finance Charge, Late Fee, Service Fee
FinancialFinancial Advisor, Life Insurance, BNPL, Loan Disbursement
Food & DiningAlcohol & Bars, Coffee Shops, Fast Food, Groceries, Restaurants
Gifts & DonationsCharity, Gift
Health & FitnessDentist, Doctor, Gym, Health Insurance, Pharmacy
HomeFurnishings, Home Improvement, Home Insurance, Mortgage & Rent
IncomeBonus, Interest Income, Paycheck, Reimbursement, Rental Income
InvestmentsBuy, Deposit, Dividend & Cap Gains, Sell, Withdrawal
Personal CareHair, Laundry, Spa & Massage
ShoppingBooks, Clothing, Hobbies, Sporting Goods
TaxesFederal Tax, Local Tax, Property Tax, Sales Tax, State Tax
TransferCredit Card Payment, Transfer for Cash Spending, Mortgage Payment, P2P
TravelAir Travel, Hotel, Rental Car & Taxi, Vacation
UncategorizedCash, Check