Overview

Transaction Fields

Field	Data type	Definition
amount	Decimal	The monetary amount of the transaction.
categorized_by	Integer	The method used to determine the category assigned to the transaction.
category_guid	String	The unique identifier for the category assigned to the transaction.
category	String	The the name of the category assigned to the transaction.
described_by	Integer	The method used to describe the transaction.
description	String	A human-readable version of the original_description field described below, e.g., "Sam's Club," "Johnny's Tavern." This is provided by the MX Platform.
extended_transaction_type	String	The transaction type assigned by the partner.
id	String	The unique partner-defined identifier for the transaction.
is_bill_pay	Boolean	This indicates whether the transaction represents a bill pay.
is_direct_deposit	Boolean	This indicates whether the transaction represents a direct deposit.
is_expense	Boolean	This indicates whether the transaction represents an expense.
is_fee	Boolean	This indicates whether the transaction represents a fee.
is_income	Boolean	This indicates whether the transaction represents income.
is_overdraft_fee	Boolean	This indicates whether the transaction represents an overdraft fee.
is_payroll_advance	Boolean	This indicates whether the transaction represents a payroll advance.
is_subscription	Boolean	This indicates whether the transaction represents a payment for a subscription service such as Netflix or Audible.
memo	String	This field contains additional descriptive information about the transaction.
merchant_category_code	Integer	The ISO 18245 category code for the transaction.
merchant_guid	String	The unique identifier for the merchant associated with this transaction. Defined by MX.
merchant_location_guid	String	The unique identifier for the merchant_location associated with this transaction. Defined by MX.
original_description	String	The original description of the transaction as provided by the MX data feed. See description above for more information.
type	String	The type of transaction. This will be either CREDIT or DEBIT.

Categorized_by values

Integer	Enum	Definition
0	CATEGORIZATION_SOURCE_AUTOCAT	This is obsolete and will no longer assign categories.
1	CATEGORIZATION_SOURCE_USER	The end user assigned a category manually.
2	CATEGORIZATION_SOURCE_FEED	The data feed assigned a category.
3	CATEGORIZATION_SOURCE_LEVENSHTEIN	This is obsolete and will no longer assign categories.
4	CATEGORIZATION_SOURCE_PARSER	A parser created by MX assigned the category based on patterns in the available data.
5	CATEGORIZATION_SOURCE_TRAINER	This is obsolete and will no longer assign categories.
6	CATEGORIZATION_SOURCE_SPHINX	This is obsolete and will no longer assign categories.
7	CATEGORIZATION_SOURCE_NAIVE_BAYES	This is obsolete and will no longer assign categories.
8	CATEGORIZATION_SOURCE_TERMINATION	After other methods failed to assign a category, it was set to 'UNCATEGORIZED'.
9	CATEGORIZATION_SOURCE_KEYWORD_CATEGORIZER	The category was assigned based on keywords appearing in the original description (feed description).
10	CATEGORIZATION_SOURCE_CATCHER	The category was assigned by a catcher based on the available data.
11	CATEGORIZATION_SOURCE_HOPSCOTCH	This is obsolete and will no longer assign categories.
12	CATEGORIZATION_SOURCE_USER_RULE	A transaction rule created by the end user assigned the category.
13	CATEGORIZATION_SOURCE_SYSTEM_RULE	A transaction rule created by MX assigned the category.
14	CATEGORIZATION_SOURCE_CLIENT_RULE	A transaction rule created by the partner assigned the category.
15	CATEGORIZATION_SOURCE_MERCHANT_CATEGORY_CODE	The category was assigned based on the merchant category code.
16	CATEGORIZATION_SOURCE_FLOOR	The transaction was assigned UNCATEGORIZED because it was uncategorizable as such, rather than because other methods failed; for example, the description simply contained withdrawal with no other information.
17	CATEGORIZATION_SOURCE_QUICKVERSE	The category was assigned by a machine-learning model.
18	CATEGORIZATION_SOURCE_MAPPING	The category was assigned by mapping from our new extended category system to legacy categories. This new system has yet to be fully released to clients.
19	CATEGORIZATION_SOURCE_TRANSFER_CATEGORIZER	The category was assigned by a categorizer designed specifically to look for transfers.

Described_by values

Integer	Enum	Definition
0	DESCRIPTION_SOURCE_SCRUBBER	The description is the result of various pattern replacement and other cleansing mechanisms.
1	DESCRIPTION_SOURCE_USER	The end user provided the description.
2	DESCRIPTION_SOURCE_FEED	The data feed provided the description.
3	DESCRIPTION_SOURCE_LEVENSHTEIN	This is obsolete and will no longer provide descriptions.
4	DESCRIPTION_SOURCE_USER_RULE	A transaction rule created by the end user provided the description.
5	DESCRIPTION_SOURCE_TRAINER	This is obsolete and will no longer provide descriptions.
6	DESCRIPTION_SOURCE_SYSTEM_RULE	A transaction rule created by MX provided the description.
7	DESCRIPTION_SOURCE_CLIENT_RULE	A transaction rule created by the partner provided the description.
8	DESCRIPTION_SOURCE_FLOOR	No cleansed description could be provided as such, rather than because other methods failed.