Attributes

The information in this table is for the transactions response.

Attribute	Type	Description
count	integer	Count
next	uri	Next
previous	uri	Previous
accounts	array of objects	List of accounts, see Accounts object
transactions	array of objects	List of transactions, see Transactions object

Accounts object

Use the table below for reference to the account object values.

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 most recently updated
type	string	Parent type of the account
subtype	string	Account subtype
mask	string	Masked banking account number associated with account
nickname	string	Alternate name for account
balances	array of objects	List of balance information, see Balances object

Balances object

Find information about the balances object values in the table below.

Attribute	Type	Description
currency_code	string	Currency
balance	string	Balance amount
available_balance	string	Available balance amount
credit_limit	string	Credit limit

Transactions object

The values in this table have information from the transactions object.

Attribute	Type	Description
id	string	Unique identifier of transaction
created_at	date-time	Timestamp when transaction was created in Truv
updated_at	date-time	Timestamp when transaction was last updated in Truv
account_id	string	account_id
external_id	string	External system transaction identifier
amount	string	Monetary amount of transaction
currency_code	string	Three-character ISO 4217 currency code
check_number	string	Check number for transaction
categories	array of strings	List of categories assigned to this transaction
description	string	Human-readable transaction description
status	string	Status of transaction, either `POSTED` or `PENDING`
type	string	Type of transaction, either `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 about transaction
merchant_category_code	string	ISO 18245 category code for transaction
location	object	Location, see Location object

Location object

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

Attribute	Type	Description
latitude	float	Latitude
longitude	float	Longitude

Endpoints

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

List all bank transactions

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_category_code": 5967,
      "location": {
        "latitude": "40.730610",
        "longitude": "-73.935242"
      }
    }
  ]
}