TRtruv
Transactions

List all bank transactions

Changed on

The endpoint allows developers to receive user-authorized transaction data.

get/v1/links/{link_id}/transactions/

Request

  • Base URL
    https://prod.truv.com
  • URL
    https://prod.truv.com/v1/links/{link_id}/transactions/
  • Auth
    API key in header X-Access-Client-Id and API key in header X-Access-Secret

Query parameters

account_idsstring

Comma-separated list of account IDs to filter transactions

categoriesstring

Comma-separated list of categories to filter transactions

account_typesstring

Comma-separated list of account types to filter transactions (e.g., CHECKING, SAVINGS)

account_subtypesstring

Comma-separated list of account subtypes to filter transactions

transacted_at_fromstring

Filter transacted_at greater than or equal (ISO-8601)

transacted_at_tostring

Filter transacted_at less than or equal (ISO-8601)

pageinteger

A page number within the paginated result set.

page_sizeinteger

Number of results to return per page. Default is 100, maximum is 500.

Response

countinteger required
nextstring uri nullable required
previousstring uri nullable required

Example response

{
  "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",
      "merchant_name": "Starbucks",
      "merchant_category_code": 5967,
      "location": {
        "latitude": 40.73061,
        "longitude": -73.935242
      }
    }
  ]
}

Changes

  • f7c013875516Revision changes
    • info

      the /// response's property pattern ^-?\d{1,10}\.\d{2}$ was added for the status

    • info

      the /// response's property pattern ^-?\d{1,10}\.\d{2}$ was added for the status

    • info

      the /// response's property pattern ^-?\d{1,10}\.\d{2}$ was added for the status

    • info

      the // response's property pattern ^-?\d{1,10}\.\d{2}$ was added for the status

  • e58688835e25Revision changes
    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property // became nullable for the status