accounts

List account transactions

For paginated data resulting in multiple pages, each page will need to be requested separately to retrieve the data on that page. The total_pages field returns an integer representing the total pages to be requested.

get/accounts/{account_guid}/transactions

Request

  • Base URL
    http://{baseurl}
  • Auth
    HTTP basic

Path parameters

account_guidstring required

The unique identifier for the account. Defined by MX.

Query parameters

from_datestring

Return transactions starting from this day, based on the transaction date. Defaults to 120 days ago if not provided. Format should be ISO 8601 format (2013-05-28).

to_datestring

Return transactions ending with this day, based on the transaction date. Defaults to 5 days forward from the day the request is made so as to capture pending transactions. Format should be ISO 8601 format (2013-05-28).

pageinteger

Results are returned in paginated sets, this is the page of the results you would like to view. Defaults to page 1 if no page is specified.

records_per_pageinteger

Requests to all list endpoints that return multiple transactions (e.g. list transactions) should specify the desired records_per_page. The supported range is from 10 to 1000. If the records_per_page parameter is not specified or is outside this range, a default of 25 records per page will be used.

Response

OK

Example response

{
  "transactions": [
    {
      "account_guid": "ACT-8e6f92c8-1491-42ce-8bf6-c309e9531530",
      "amount": 33.88,
      "amount_set_by": 1,
      "amount_set_by_name": "FEED",
      "category_guid": "CAT-97a2b899-5a32-4196-b87c-a8e65d8a9849",
      "category_name": "Office Supplies",
      "category_set_by": 3,
      "category_set_by_name": "SYSTEM",
      "created_at": "2022-06-14T21:17:10+00:00",
      "currency_code": "USD",
      "currency_code_set_by": 1,
      "currency_code_set_by_name": "FEED",
      "date": "2022-06-14",
      "date_set_by": 1,
      "date_set_by_name": "FEED",
      "description": "Office Depot",
      "description_set_by": 3,
      "description_set_by_name": "SYSTEM",
      "external_guid": "transfer-0bc9936d-6761-4aed-af7f-a94e7a0f7e7e",
      "feed_amount": 33.88,
      "feed_currency_code": "USD",
      "feed_description": "Office Depot",
      "feed_posted_at": "2022-06-15T12:00:00+00:00",
      "feed_posted_on": "2022-06-15",
      "feed_status": 1,
      "feed_transacted_at": "2022-06-14T12:00:00+00:00",
      "feed_transacted_on": "2022-06-14",
      "feed_transaction_type": 2,
      "feed_transaction_type_name": "DEBIT",
      "guid": "TRN-24af807c-66b5-416c-a84e-d18f1003809e",
      "is_expense": true,
      "member_is_managed_by_user": true,
      "merchant_guid": "MCH-8f595f23-43fb-2c82-429e-56313bb6dada",
      "metadata": "some hard coded transaction metadata",
      "posted_at": "2022-06-15T12:00:00+00:00",
      "posted_at_set_by": 1,
      "posted_at_set_by_name": "FEED",
      "revision": 1,
      "status": 1,
      "status_name": "POSTED",
      "status_set_by": 1,
      "status_set_by_name": "FEED",
      "top_level_category_guid": "CAT-94b11142-e97b-941a-f67f-6e18d246a23f",
      "transacted_at": "2022-06-14T12:00:00+00:00",
      "transacted_at_set_by": 1,
      "transacted_at_set_by_name": "FEED",
      "transaction_type": 2,
      "transaction_type_name": "DEBIT",
      "transaction_type_set_by": 1,
      "transaction_type_set_by_name": "FEED",
      "updated_at": "2022-06-14T21:17:10+00:00",
      "user_guid": "USR-11141024-90b3-1bce-cac9-c06ced52ab4c"
    }
  ],
  "pagination": {
    "current_page": 1,
    "per_page": 25,
    "total_entries": 1,
    "total_pages": 1
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.