Skip to main content

Atrium API

List Account Transactions

This endpoint allows you to see every transaction that belongs to a specific account.

GET
/users/{user_guid}/accounts

Path Parameters

The from_date and to_date parameters can optionally be appended to the request if transactions in a specific date range are required.

FieldRequiredType

from_date

Return transactions occurring within a date range starting on this day. If not set, this defaults to 90 days prior to the day of the request. Must be in ISO 8601 format without a time component.

Optional
String

to_date

Return transactions occurring in a date range ending on this day. If not set, this defaults to 5 days forward from the day of the request so as to capture pending transactions. Must be in ISO 8601 format without a time component.

Optional
String

Request sample

Language:shell

_10
curl -i 'https://vestibule.mx.com/users/{user_guid}/accounts/{account_guid}/transactions' \
_10
-H 'Accept: application/vnd.mx.atrium.v1+json' \
_10
-H 'MX-API-Key: {mx_api_key}' \
_10
-H 'MX-Client-ID: {mx_client_id}'

Response sample

200
Language:json

_78
{
_78
"transactions": [
_78
{
_78
"account_guid": "ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1",
_78
"amount": 61.11,
_78
"category": "Groceries",
_78
"check_number": 15234,
_78
"check_number_string": "00015234",
_78
"created_at": "2016-10-06T09:43:42+00:00",
_78
"currency_code": "USD",
_78
"date": "2013-09-23",
_78
"description": "Whole Foods",
_78
"guid": "TRN-265abee9-889b-af6a-c69b-25157db2bdd9",
_78
"is_bill_pay": false,
_78
"is_direct_deposit": false,
_78
"is_expense": true,
_78
"is_fee": false,
_78
"is_income": false,
_78
"is_international": false,
_78
"is_overdraft_fee": false,
_78
"is_payroll_advance": false,
_78
"latitude": -43.2075,
_78
"longitude": 139.691706,
_78
"member_guid": "MBR-7c6f361b-e582-15b6-60c0-358f12466b4b",
_78
"memo": null,
_78
"merchant_category_code": 5411,
_78
"merchant_guid": "MCH-7ed79542-884d-2b1b-dd74-501c5cc9d25b",
_78
"original_description": "WHOLEFDS TSQ 102",
_78
"posted_at": "2016-10-07T06:00:00+00:00",
_78
"status": "POSTED",
_78
"top_level_category": "Food & Dining",
_78
"transacted_at": "2016-10-06T13:00:00+00:00",
_78
"type": "DEBIT",
_78
"updated_at": "2016-10-07T05:49:12+00:00",
_78
"user_guid": "USR-fa7537f3-48aa-a683-a02a-b18940482f54"
_78
},
_78
{
_78
"account_guid": "ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1",
_78
"amount": 23.4,
_78
"category": "Books",
_78
"check_number": 15234,
_78
"check_number_string": "00015234",
_78
"created_at": "2016-08-26T09:43:42+00:00",
_78
"currency_code": "USD",
_78
"date": "2013-09-23",
_78
"description": "Audible",
_78
"guid": "TRN-265abee9-889b-af6a-c69b-25157db2bdd9",
_78
"is_bill_pay": false,
_78
"is_direct_deposit": false,
_78
"is_expense": true,
_78
"is_fee": false,
_78
"is_income": false,
_78
"is_international": false,
_78
"is_overdraft_fee": false,
_78
"is_payroll_advance": false,
_78
"latitude": -43.2075,
_78
"longitude": 139.691706,
_78
"member_guid": "MBR-7c6f361b-e582-15b6-60c0-358f12466b4b",
_78
"memo": null,
_78
"merchant_category_code": 5411,
_78
"merchant_guid": "MCH-7ed79542-884d-2b1b-dd74-501c5cc9d25b",
_78
"original_description": "AUDIBLEBKS",
_78
"posted_at": "2016-08-27T06:00:00+00:00",
_78
"status": "POSTED",
_78
"top_level_category": "Entertainment",
_78
"transacted_at": "2016-08-26T13:00:00+00:00",
_78
"type": "DEBIT",
_78
"updated_at": "2016-08-27T05:49:12+00:00",
_78
"user_guid": "USR-fa7537f3-48aa-a683-a02a-b18940482f54"
_78
}
_78
],
_78
"pagination": {
_78
"current_page": 1,
_78
"per_page": 25,
_78
"total_entries": 2,
_78
"total_pages": 1
_78
}
_78
}