Transactions Overview - MX Documentation

Transactions represent individual financial activities such as purchases, deposits, withdrawals, and transfers across user accounts.

Transaction Fields

Field Name	Data type	Description
`account_guid`	String	Unique identifier for the account. Defined by MX.
`amount`	Decimal	The transaction amount. This will always be a positive value. The Transaction Type determines how the transaction affects the account.
`amount_set_by`	Integer	The source that set the data ( 1 = FEED, 2 = USER, 3 = SYSTEM ). See Transaction Set By for more information.
`amount_set_by_name`	String	The source that set the data ( FEED, USER, or SYSTEM ). See Transaction Set By for more information.
`category_guid`	String	Unique identifier for the transaction category. Defined by MX.
`category_name`	String	The name of the transaction category.
`category_set_by`	Integer	The source that set the data ( 1 = FEED, 2 = USER, 3 = SYSTEM ). See Transaction Set By for more information.
`category_set_by_name`	String	The source that set the data ( FEED, USER, or SYSTEM ). See Transaction Set By for more information.
`check_number`	Integer	The check number for the transaction. (Deprecated).
`check_number_set_by`	Integer	The source that set the data ( 1 = FEED, 2 = USER, 3 = SYSTEM ). See Transaction Set By for more information.
`check_number_set_by_name`	String	The source that set the data ( FEED, USER, or SYSTEM ). See Transaction Set By for more information.
`check_number_string`	String	The check number for the transaction.
`created_at`	String	Date and time the transaction was created, represented in ISO 8601 format with timestamp (e.g. 2015-04-13T12:01:23-00:00).
`currency_code`	String	The ISO 4217 three-character currency code (e.g. USD).
`currency_code_set_by`	Integer	The source that set the data ( 1 = FEED, 2 = USER, 3 = SYSTEM ). See Transaction Set By for more information.
`currency_code_set_by_name`	String	The source that set the data ( FEED, USER, or SYSTEM ). See Transaction Set By for more information.
`date`	String	Date the transaction was created, represented in ISO 8601 format (e.g. 2011-03-28).
`date_set_by`	Integer	The source that set the data ( 1 = FEED, 2 = USER, 3 = SYSTEM ). See Transaction Set By for more information.
`date_set_by_name`	String	The source that set the data ( FEED, USER, or SYSTEM ). See Transaction Set By for more information.
`description`	String	A human-readable description of the transaction.
`description_set_by`	Integer	The source that set the data ( 1 = FEED, 2 = USER, 3 = SYSTEM ). See Transaction Set By for more information.
`description_set_by_name`	String	The source that set the data ( FEED, USER, or SYSTEM ). See Transaction Set By for more information.
`external_guid`	String	Partner created identifier for the transaction.
`feed_amount`	Decimal	Transaction amount, as provided by our data feed. See amount for more information.
`feed_check_number`	Integer	Check number, as provided by our data feed. See check_number for more information.
`feed_check_number_string`	String	Check number, as provided by our data feed. See check_number_string for more information.
`feed_currency_code`	String	Currency code, as provided by our data feed. See currency_code for more information.
`feed_description`	String	Description of the transaction, as provided by our data feed. See description for more information.
`feed_is_international`	Boolean	Whether the transaction is international, as provided by our data feed. See is_international for more information.
`feed_latitude`	Decimal	Latitude for the transaction, as provided by our data feed. See latitude for more information.
`feed_longitude`	Decimal	Longitude for the transaction, as provided by our data feed. See longitude for more information.
`feed_memo`	String	The transaction memo, as provided by our data feed. See memo for more information.
`feed_posted_at`	String	Date and time the transaction was posted, as provided by our data feed. See posted_at for more information.
`feed_posted_on`	String	Date the transaction was posted, as provided by our data feed. See posted_on for more information.
`feed_status`	Integer	Status of the transaction, as provided by our data feed. See status for more information.
`feed_transacted_at`	String	Date and time the transaction took place, as provided by our data feed. See transacted_at for more information.
`feed_transacted_on`	String	Date the transaction took place, as provided by our data feed.
`feed_transaction_type`	Integer	The type of transaction, as provided by our data feed. See transaction_type for more information.
`feed_transaction_type_name`	String	The type of transaction, as provided by our data feed. See transaction_type_name for more information.
`guid`	String	Unique identifier for the transaction. Defined by MX.
`has_been_split`	Boolean	If the transaction is a split, this field will be true. Otherwise, this field will be false.
`has_been_viewed`	Boolean	If the transaction has been viewed, this field will be true. Otherwise, this field will be false.
`is_bill_pay`	Boolean	If the transaction is a bill pay, this field will be true. Otherwise, this field will be false.
`is_direct_deposit`	Boolean	If the transaction is a direct deposit, this field will be true. Otherwise, this field will be false.
`is_expense`	Boolean	If the transaction is an expense, this field will be true. Otherwise, this field will be false.
`is_fee`	Boolean	If the transaction is a fee, this field will be true. Otherwise, this field will be false.
`is_flagged`	Boolean	If the transaction has been flagged, this field will be true. Otherwise, this field will be false.
`is_hidden`	Boolean	If the transaction is hidden, this field will be true. Otherwise, this field will be false.
`is_income`	Boolean	If the transaction is income, this field will be true. Otherwise, this field will be false.
`is_international`	Boolean	If the transaction is international, as defined by the data provider, this field will be true. If the data provider determines it is not international, then it will be false. It will be null if the data provider does not provide this information.
`is_international_set_by`	Integer	The source that set the data ( 1 = FEED, 2 = USER, 3 = SYSTEM ). See Transaction Set By for more information.
`is_international_set_by_name`	String	The source that set the data ( 1 = FEED, 2 = USER, 3 = SYSTEM ). See Transaction Set By for more information.
`is_overdraft_fee`	Boolean	If the transaction is an overdraft fee, this field will be true. Otherwise, this field will be false.
`is_payroll_advance`	Boolean	If the transaction is a payroll advance, this field will be true. Otherwise, this field will be false.
`is_recurring`	Boolean	This field should be ignored. If this information is required, please reach out to MX to discuss an alternative.
`is_subscription`	Boolean	If the transaction represents a payment for a subscription service such as Netflix or Audible, this field will be true. Otherwise it will be false.
`latitude`	Decimal	The latitude of the location where the transaction occurred. The number is a signed decimal (e.g. Rio de Janeiro’s latitude is -22.9027800 and Tokyo’s latitude is 35.689488).
`latitude_set_by`	Integer	The source that set the data ( 1 = FEED, 2 = USER, 3 = SYSTEM ). See Transaction Set By for more information.
`latitude_set_by_name`	String	The source that set the data ( FEED, USER, or SYSTEM ). See Transaction Set By for more information.
`localized_description`	String	A human-readable description of the transaction, provided in a local language.
`localized_memo`	String	Additional descriptive information about the transaction, provided in a local language.
`longitude`	Decimal	The longitude of the location where the transaction occurred. The number is a signed decimal (e.g. Rio de Janeiro’s longitude is -43.2075000 and Tokyo’s longitude is 139.691706).
`longitude_set_by`	Integer	The source that set the data ( 1 = FEED, 2 = USER, 3 = SYSTEM ). See Transaction Set By for more information.
`longitude_set_by_name`	String	The source that set the data ( FEED, USER, or SYSTEM ). See Transaction Set By for more information.
`memo`	String	The memo is additional descriptive information about the transaction.
`memo_set_by`	Integer	The source that set the data ( 1 = FEED, 2 = USER, 3 = SYSTEM ). See Transaction Set By for more information.
`memo_set_by_name`	String	The source that set the data ( FEED, USER, or SYSTEM ). See Transaction Set By for more information.
`member_is_managed_by_user`	Boolean	If the member the transaction belongs to is managed by the user, this field will be true. Otherwise, the member is managed by the MX partner and this field will be false. Members created with Nexus are considered to be managed by the user.
`merchant_category_code`	Integer	The merchant category code.
`merchant_guid`	String	Unique identifier for the merchant identified in the transaction. Defined by MX.
`merchant_location_guid`	String	The unique identifier for the merchant location associated with the transaction. Defined by MX.
`metadata`	String	Additional information a partner can store on the transaction. NOTE: this field may potentially be overwritten by the data provider when data is refreshed through aggregation. See the FAQs for more information.
`parent_guid`	String	The parent guid of the transaction.
`posted_at`	String	Date and time the transaction was posted, represented in ISO 8601 format with timestamp (e.g. 2015-04-13T12:01:23-00:00).
`posted_at_set_by`	Integer	The source that set the data ( 1 = FEED, 2 = USER, 3 = SYSTEM ). See Transaction Set By for more information.
`posted_at_set_by_name`	String	The source that set the data ( FEED, USER, or SYSTEM ). See Transaction Set By for more information.
`revision`	Integer	The revision number of this transaction record.
`scheduled_payment_guid`	String	The unique identifier for the scheduled payment associated with this transaction. Defined by MX.
`status`	Integer	The status of the transaction (1 = POSTED, 2 = PENDING). See Status for more information.
`status_name`	String	The status of the transaction (POSTED or PENDING). See Status for more information.
`status_set_by`	Integer	The source that set the data ( 1 = FEED, 2 = USER, 3 = SYSTEM ). See Transaction Set By for more information.
`status_set_by_name`	String	The source that set the data ( FEED, USER, or SYSTEM ). See Transaction Set By for more information.
`top_level_category_guid`	String	Unique identifier of the parent category that this transaction’s category is assigned to.
`transacted_at`	String	Date and time the transaction took place, represented in ISO 8601 format with timestamp (e.g. 2015-04-13T12:01:23-00:00).
`transacted_at_set_by`	Integer	The source that set the data ( 1 = FEED, 2 = USER, 3 = SYSTEM ). See Transaction Set By for more information.
`transacted_at_set_by_name`	String	The source that set the data ( FEED, USER, or SYSTEM ). See Transaction Set By for more information.
`transaction_type`	Integer	The type of transaction (1 = CREDIT, 2 = DEBIT). See Transaction Types for more information.
`transaction_type_name`	String	The type of transaction (CREDIT or DEBIT). See Transaction Types for more information.
`transaction_type_set_by`	Integer	The source that set the data ( 1 = FEED, 2 = USER, 3 = SYSTEM ). See Transaction Set By for more information.
`transaction_type_set_by_name`	String	The source that set the data ( FEED, USER, or SYSTEM ). See Transaction Set By for more information.
`updated_at`	String	Date and time the transaction was updated, represented in ISO 8601 format with timestamp (e.g. 2015-04-13T12:01:23-00:00).
`user_guid`	String	Unique identifier for the user. Defined by MX.
`user_transaction_rule_guid`	String	The unique identifier for the transaction_rule associated with the transaction. Defined by MX.

`categorized_by` Fields

The categorized_by fields of the Transactions endpoint will return integers. See the table below for the meaning behind each integer:

Integer	String	Definition
0	`MONEY_DESKTOP`	One of MX’s systems categorized this transaction.
1	`CATEGORIZATION_SOURCE_USER`	This was categorized by the user, not by MX.
2	`CATEGORIZATION_SOURCE_FEED`	The category was supplied by the feed for this transaction.
3	`USER_PREFERENCE`	Historically, the user categorized this transaction to this category. We keep history of preferred categorizations and apply them to transactions.
4 and above	`MONEY_DESKTOP`	One of MX’s systems categorized this transaction.

Described By Fields

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.

Status Fields

The status field of the transactions endpoint will return an integer or a null status. If the aggregation source doesn’t supply the status, null will be the response.

Status	Definition
null	null
1	POSTED
2	PENDING

Transaction Categories

AUTO_TRANSPORT
- AUTO_INSURANCE
- AUTO_PAYMENT
- GAS
- PARKING
- PUBLIC_TRANSPORTATION
- SERVICE_PARTS
BILLS_UTILITIES
- DOMAIN_NAMES
- FRAUD_PROTECTION
- HOME_PHONE
- HOSTING
- INTERNET
- MOBILE_PHONE
- TELEVISION
- UTILITIES
BUSINESS_SERVICES
- ADVERTISING
- LEGAL
- OFFICE_SUPPLIES
- PRINTING
- SHIPPING
EDUCATION
- BOOKS_SUPPLIES
- STUDENT_LOAN
- TUITION
ENTERTAINMENT
- AMUSEMENT
- ARTS
- MOVIES_DVDS
- MUSIC
- NEWSPAPERS_MAGAZINES
FEES_CHARGES
- ATM_FEE
- BANKING_FEE
- FINANCE_CHARGE
- LATE_FEE
- SERVICE_FEE
- TRADE_COMMISSIONS
FINANCIAL
- FINANCIAL_ADVISOR
- LIFE_INSURANCE
FOOD_DINING
- ALCOHOL_BARS
- COFFEE_SHOPS
- FAST_FOOD
- GROCERIES
- RESTAURANTS
GIFTS_DONATIONS
- CHARITY
- GIFT
HEALTH_FITNESS
- DENTIST
- DOCTOR
- EYECARE
- GYM
- HEALTH_INSURANCE
- PHARMACY
- SPORTS
HOME
- FURNISHINGS
- HOME_IMPROVEMENT
- HOME_INSURANCE
- HOME_SERVICES
- HOME_SUPPLIES
- LAWN_GARDEN
- MORTGAGE_RENT
INCOME
- BONUS
- INTEREST_INCOME
- PAYCHECK
- REIMBURSEMENT
- RENTAL_INCOME
- RETURNED_PURCHASE
INVESTMENTS
- BUY
- DEPOSIT
- DIVIDEND_CAP_GAINS
- SELL
- WITHDRAWAL
KIDS
- ALLOWANCE
- BABY_SUPPLIES
- BABYSITTER_DAYCARE
- CHILD_SUPPORT
- KIDS_ACTIVITIES
- TOYS
PERSONAL_CARE
- HAIR
- LAUNDRY
- SPA_MASSAGE
PETS
- PET_FOOD_SUPPLIES
- PET_GROOMING
- VETERINARY
SHOPPING
- BOOKS
- CLOTHING
- ELECTRONICS_SOFTWARE
- HOBBIES
- SPORTING_GOODS
TAXES
- FEDERAL_TAX
- LOCAL_TAX
- PROPERTY_TAX
- SALES_TAX
- STATE_TAX
TRANSFER
- CREDIT_CARD_PAYMENT
- TRANSFER_FOR_CASH_SPENDING
- MORTGAGE_PAYMENT
TRAVEL
- AIR_TRAVEL
- HOTEL
- RENTAL_CAR_TAXI
- VACATION
UNCATEGORIZED
- CASH
- CHECK

Transaction Classifier Fields

The transaction fields below are considered “classifiers.” These indicate that the transaction represents a particular class of transaction such as an overdraft fee or a direct deposit. All are booleans.

is_bill_pay
is_direct_deposit
is_expense
is_fee
is_income
is_overdraft_fee
is_payroll_advance
is_subscription

Transaction set_by

The set_by fields return an integer and the set_by_name fields return a string. The table below shows the meaning of each value and how the integers map to the strings. See the Transactions sections in Endpoints for examples.

Date Source	Definition	Information
1	FEED	Information provided from the MX data feed.
2	USER	Information provided from the user.
3	SYSTEM	Information provided from the MX system.

Transaction Types

The transaction type is either a CREDIT or a DEBIT. A CREDIT increases the user’s net worth. A DEBIT decreases the user’s net worth. This applies to all account types.

Value	Transaction Type	Definition
1	CREDIT	Increases the user’s net worth, such as a deposit in a checking account or a payment applied to a credit card account.
2	DEBIT	Decreases the user’s net worth, such as a withdrawal in a checking account or a purchase charged to a credit card

​Transaction Fields

​categorized_by Fields

​Described By Fields

​Status Fields

​Transaction Categories

​Transaction Classifier Fields

​Transaction set_by

​Transaction Types