Skip to main content

Attributes

The information in this table is for the top-level transactions response.
AttributeTypeDescription
countintegerTotal number of transactions
nexturiURL of the next page of results, null if none
previousuriURL of the previous page of results, null if none
accountsarray of objectsList of accounts, see Accounts object
transactionsarray of objectsList of transactions, see Transactions object

Accounts object

Use the table below for reference to the account object values.
AttributeTypeDescription
idstringUnique identifier of account
created_atdate-timeDate and time account was created
updated_atdate-timeDate and time account was most recently updated
typestringParent type of the account
subtypestringAccount subtype
maskstringLast 4 digits of account number
nicknamestringAlternate name for account
balancesobjectBalance information, see Balances object

Balances object

Find information about the balances object values in the table below.
AttributeTypeDescription
currency_codestringCurrency
balancestringBalance amount
available_balancestringAvailable balance amount
credit_limitstringCredit limit

Transactions object

The values in this table have information from the transactions object.
AttributeTypeDescription
idstringUnique identifier of transaction
created_atdate-timeTimestamp when transaction was created in Truv
updated_atdate-timeTimestamp when transaction was last updated in Truv
account_idstringaccount_id
external_idstringExternal system transaction identifier
amountstringMonetary amount of transaction
currency_codestringThree-character ISO 4217 currency code
check_numberstringCheck number for transaction
categoriesarray of stringsList of categories assigned to this transaction
descriptionstringHuman-readable transaction description
statusstringStatus of transaction, one of POSTED, PENDING, AUTHORIZATION, or MEMO
typestringType of transaction, one of CREDIT, DEBIT, or MEMO
posted_atdate-timeTimestamp for movement of funds
transacted_atdate-timeTimestamp when transaction occurred
memostringAdditional descriptive information about transaction
merchant_namestringMerchant name extracted from the transaction description (nullable)
merchant_category_codenumberISO 18245 category code for transaction
locationobjectLocation, see Location object

Location object

The two values in this table are for the location object.
AttributeTypeDescription
latitudefloatLatitude
longitudefloatLongitude

Endpoints

Use the endpoint below for information about transactions in an account.

Example response

The sample below is a JSON response for the endpoint.
{
  "count": 0,
  "next": "string",
  "previous": "string",
  "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": "200.00"
      }
    }
  ],
  "transactions": [
    {
      "id": "24d7e80942ce4ad58a93f70ce4115f5c",
      "created_at": "2022-05-04T11:30:00Z",
      "updated_at": "2022-05-04T12:00:00Z",
      "account_id": "68a7e80942ce4ad58a93f70ce411549a",
      "external_id": "external_key_243901",
      "amount": "100.00",
      "currency_code": "USD",
      "check_number": "123456",
      "categories": [
        "Transfer"
      ],
      "description": "Some transaction",
      "status": "POSTED",
      "type": "DEBIT",
      "posted_at": "2022-05-04T11:30:00Z",
      "transacted_at": "2022-05-04T11:30:00Z",
      "memo": "",
      "merchant_name": "Starbucks",
      "merchant_category_code": 5967,
      "location": {
        "latitude": 40.730610,
        "longitude": -73.935242
      }
    }
  ]
}

Transaction categories

CategorySubcategories
Auto & TransportAuto Insurance, Auto Payment, Gas, Parking, Public Transportation, Service & Parts
Bills & UtilitiesDomain Names, Fraud Protection, Home Phone, Hosting, Internet, Mobile Phone, Television, Utilities
Business ServicesAdvertising, Legal, Office Supplies, Printing, Shipping
EducationBooks & Supplies, Student Loan, Tuition
EntertainmentAmusement, Arts, Movies & DVDs, Music, Newspapers & Magazines
Fees & ChargesATM Fee, Banking Fee, Finance Charge, Late Fee, Service Fee, Trade Commissions
FinancialFinancial Advisor, Life Insurance, BNPL, Payday Loan, EWA Lender, Loan Disbursement
Food & DiningAlcohol & Bars, Coffee Shops, Fast Food, Groceries, Restaurants
Gifts & DonationsCharity, Gift
Health & FitnessDentist, Doctor, Eyecare, Gym, Health Insurance, Pharmacy, Sports
HomeFurnishings, Home Improvement, Home Insurance, Home Services, Home Supplies, Lawn & Garden, Mortgage & Rent
IncomeBonus, Interest Income, Paycheck, Reimbursement, Rental Income, Returned Purchase, EWA Payroll, Retirement, Government Employment, Government Benefits, Private Benefits, Unemployment, Tax credits, Gig Economy
InvestmentsBuy, Deposit, Dividend & Cap Gains, Sell, Withdrawal
KidsAllowance, Baby Supplies, Babysitter & Daycare, Child Support, Kids Activities, Toys
Personal CareHair, Laundry, Spa & Massage
PetsPet Food & Supplies, Pet Grooming, Veterinary
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