Overview

The Activity object gives you access to account activity in one of your direct-typed activated connection’s accounts.

Permission Required

Getting account activity requires the activity permission from the selected account connection.


Methods

GET  /account-connection/:id/activity/:account
Get account activity for an account connection’s debit or savings account. Transactions will be ordered with the newest transactions first.

Path Parameters

id
string
required

ID of the account connection to get activity for.

account
string
required

Type of account. Allowed values: debit or savings.

Query Parameters

page
integer

The page number to return. Default is 1.

page_size
integer

The number of items to return per page. Default is 10.

Example

{
    "data": [
        {
            "id": "txn_CCCCC",
            "status": "pending",
            "date": "2024-01-24",
            "amount_in_cents": -6535,
            "description": "Exxon Mobil",
            "original_description": "EXXONMOBIL 823456 - AUTH CLEARING",
        },
        {
            "id": "txn_BBBBB",
            "status": "posted"
            "date": "2024-01-23",
            "amount_in_cents": -84423,
            "description": "Guitar Center",
            "original_description": "GUITARCENTER AUSTIN - 3456XXX",
        },
        {
            "id": "txn_AAAAA",
            "status": "posted"
            "date": "2024-01-21",
            "amount_in_cents": 146783,
            "description": "January Payout from Triangle",
            "original_description": "January Payout from Triangle",
        },  	
    ],
    "pagination": {
        "page": 1,
        "page_size": 10,
        "total": 3
    }
}

Properties

Each returned transaction contains the following properties:

id
string

Identifier for this transaction.

date
string

YYYY-MM-DD formatted date of the transaction.

status
string

Status of this transaction. Either pending or posted.

amount_in_cents
number

Amount of the transaction. Negative numbers indicate withdrawals, positive numbers indicate a deposit.

description
string

Cleaned or user-edited description for the transaction.

original_description
string

Original description given to the transaction by the various banking systems.