Sign in
transactions

List transactions by account

Requests to this endpoint return a list of transactions associated with the specified account. <br /><br /> Enhanced transaction data may be requested using the includes parameter. To use this optional parameter, the value should include the optional metadata requested such as repeating_transactions, merchants, classifications, geolocations. For more information, see the Optional Enhancement Query Parameter guide.

get/users/{user_guid}/accounts/{account_guid}/transactions

Path parameters

account_guidstring required

The unique id for an account.

user_guidstring required

The unique identifier for a user, beginning with the prefix USR-.

Query parameters

pageinteger

Results are paginated. Specify current page.

records_per_pageinteger

This specifies the number of records to be returned on each page. Defaults to 25. The valid range is from 10 to 1000. If the value exceeds 1000, the default value of 25 will be used instead.

from_datestring

Filter transactions from this date. This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Defaults to 120 days ago if not provided.

to_datestring

Filter transactions to this date (at midnight). This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Defaults to 5 days forward from the day the request is made to capture pending transactions.

from_created_atstring

Filter transactions from the date the transaction was created. This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Maximum date range limit is 6 months.

to_created_atstring

Filter transaction to the date in which the transaction was created. This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Maximum date range limit is 6 months.

from_updated_atstring

Filter transactions from the date in which the transaction was updated. This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Maximum date range limit is 6 months.

to_updated_atstring

Filter transactions to the date in which the transaction was updated. This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Maximum date range limit is 6 months.

category_guidstring

Filter transactions belonging to specified category_guid.

For example, ?category_guid=CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874.

category_guid[]string[]

Filter transactions belonging to any specified category_guid[] in url.

For example, ?category_guid[]=CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874.

top_level_category_guidstring

Filter transactions belonging to specified top_level_category_guid. This must be top level category guid, use category_guid for subcategory guid.

For example, ?top_level_category_guid=CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874.

top_level_category_guid[]string[]

Filter transactions belonging to any specified top_level_category_guid[] in url. This must be top level category guid(s), use category_guid for subcategory guid(s).

For example, ?top_level_category_guid[]=CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874.

includesstring

Options for enhanced transactions. This query parameter is optional. Possible additional metadata: repeating_transactions, merchants, classifications, geolocations. The query value is format sensitive. To retrieve all available enhancements, append:

?includes=repeating_transactions,merchants,classifications,geolocations.

The query options may be combined to specific enhancements. For example, to request Repeating Transactions and Geolocation data, use:

?includes=repeating_transactions,geolocations.

  • Repeating Transactions: Identifies transactions with predictable recurrence patterns (e.g., Bill, Income, Subscription).
  • Merchants: Enriches transactions with merchant name.
  • Classifications: Provides more insight into the type of money movement that is occurring on the transaction, whether it be retail or investments.
  • Geolocation: Provides geographic metadata.

Response

OK

Changes

Changed in 1 of the 50 revisions of this API.4312

  • e74cd2b059b54312See the full diff
    • ●

      removed the optional property transactions/items/account_guid from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property transactions/items/account_id from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property transactions/items/amount from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property transactions/items/category from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property transactions/items/category_guid from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property transactions/items/check_number_string from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property transactions/items/created_at from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property transactions/items/currency_code from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property transactions/items/date from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property transactions/items/description from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property transactions/items/extended_transaction_type from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property transactions/items/guid from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property transactions/items/id from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property transactions/items/is_bill_pay from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property transactions/items/is_direct_deposit from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property transactions/items/is_expense from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property transactions/items/is_fee from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property transactions/items/is_income from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property transactions/items/is_international from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property transactions/items/is_overdraft_fee from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property transactions/items/is_payroll_advance from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property transactions/items/is_recurring from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property transactions/items/is_subscription from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property transactions/items/latitude from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property transactions/items/localized_description from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property transactions/items/localized_memo from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property transactions/items/longitude from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property transactions/items/member_guid from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property transactions/items/member_is_managed_by_user from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property transactions/items/memo from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property transactions/items/merchant_category_code from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property transactions/items/merchant_guid from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property transactions/items/merchant_location_guid from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property transactions/items/metadata from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property transactions/items/original_description from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property transactions/items/posted_at from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property transactions/items/status from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property transactions/items/top_level_category from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property transactions/items/transacted_at from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property transactions/items/type from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property transactions/items/updated_at from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property transactions/items/user_guid from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property transactions/items/user_id from the response with the 200 status

      response-optional-property-removed

    • ○

      api tag transactions added

      api-tag-added

    • ○

      api tag mx_platform removed

      api-tag-removed

    • ○

      added the new optional query request parameter category_guid

      new-optional-request-parameter

    • ○

      added the new optional query request parameter category_guid[]

      new-optional-request-parameter

    • ○

      added the new optional query request parameter from_created_at

      new-optional-request-parameter

    • ○

      added the new optional query request parameter from_updated_at

      new-optional-request-parameter

    • ○

      added the new optional query request parameter includes

      new-optional-request-parameter

    • ○

      added the new optional query request parameter to_created_at

      new-optional-request-parameter

    • ○

      added the new optional query request parameter to_updated_at

      new-optional-request-parameter

    • ○

      added the new optional query request parameter top_level_category_guid

      new-optional-request-parameter

    • ○

      added the new optional query request parameter top_level_category_guid[]

      new-optional-request-parameter

    • ○

      added TransactionResponse subschema #2 to the transactions/items/ response property allOf list for the response status 200

      response-property-all-of-added

    This revision also has 10 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Of the 50 revisions, 1 has no diff computed.