Accounts Overview - MX Documentation

The Accounts endpoints represent a user’s checking, savings, mortgage, 401(k), or other types of accounts held by a financial institution. An account belongs to a member, which represents the user’s overall relationship with a particular financial institution.

Accounts Fields

Field	Type	Description
`account_guid`	String	Unique identifier for the account. Defined by MX.
`account_holder_name`	String	The name of the account holder.
`account_number`	String	The account number, as provided by our data feed.
`account_subtype`	Integer	The integer value of the account subtype.
`account_subtype_name`	String	The account subtype (for example, PLAN_401_K, MONEY_MARKET, or HOME_EQUITY).
`account_type`	Integer	The integer value of the account type.
`account_type_name`	String	The account type (for example, CHECKING, SAVINGS, CREDIT_CARD).
`available_balance`	Decimal	The balance that is available for use in asset accounts like checking and savings. `PENDING` transactions are typically taken into account with the available balance, but this may not always be the case. `available_balance` will usually be a positive value for all account types, determined in the same way as the `balance` field.
`balance`	Decimal	The current balance of the account. `PENDING` transactions are typically not taken into account with the current balance, but this may not always be the case. This is the value used for the account balance displayed in MX UIs. The balance will usually be a positive value for all account types. Asset-type accounts (`CHECKING`, `SAVINGS`, `INVESTMENT`) may have a negative balance if they are in overdraft. Debt-type accounts (`CREDIT_CARD`, `LOAN`, `LINE_OF_CREDIT`, `MORTGAGE`) may have a negative balance if they are overpaid.
`created_at`	String	Date and time the account was created, represented in ISO 8601 format with timestamp (for example, 2015-04-13T12:01:23-00:00).
`currency_code`	String	The currency code associated with the account (for example, USD, EUR).
`federal_insurance_status`	String	The federal insurance status of the account. Indicates whether the account is insured by the FDIC (banks) or NCUA (credit unions). See the section on federal insurance status for more information
`federal_insurance_status_set_by`	String	The source that set the data (1 = FEED, 2 = USER, 3 = SYSTEM). See the section on account fields with set by for more information.
`federal_insurance_status_set_by_name`	String	The source that set the data (FEED, USER, or SYSTEM). See the section on account fields with set by for more information.
`feed_account_number`	String	The account number, as provided by our data feed.
`feed_name`	String	The name of the account, as provided by our data feed.
`feed_original_balance`	Decimal	The original balance, as provided by our data feed. Max length is 14,2. See Number Limits.
`feed_payment_due_at`	String	Date and time the payment is due at, as provided by our data feed. Represented in ISO 8601 format with timestamp (e.g. 2015-04-13T12:01:23-00:00).
`feed_payoff_balance`	Decimal	The payoff balance, as provided by our data feed. Max length is 14,2. See Number Limits.
`feed_routing_number`	String	The routing number, as provided by our data feed. See routing_number for more information.
`feed_started_on`	String	The started on date, as provided by our data feed. Represented in ISO 8601 format (e.g. 2011-03-28).
`feed_statement_balance`	Decimal	The account statement balance, as provided by our data feed. Max length is 14,2. See Number Limits.
`feed_total_account_value`	Decimal	The sum of the long and short positions, the sweep account and/or cash balance, and any margin debt associated with a particular account. This amount includes the market value of all positions held in the account and is reduced by any debit balance and the amount of short options positions that are “in the money”. This may sum to a negative value, and it does not represent an account balance. Max length is 14,2. See Number Limits.
`guid`	String	Unique identifier for the account. Defined by MX.
`holdings_value`	Decimal	The value of holdings with this account.
`holdings_value_set_by`	Integer	The source that set the data (1 = FEED, 2 = USER, 3 = SYSTEM). See Account Set By for more information.
`holdings_value_set_by_name`	String	The source that set the data (FEED, USER, or SYSTEM). See Account Set By for more information.
`institution_guid`	String	Unique identifier for the institution the account is attached to. Defined by MX.
`insured_name`	String	The name of the insured individual.
`interest_rate`	Decimal	Interest rate (e.g. 2.99% is passed as 2.99). Max length is 10,6. See Number Limits.
`interest_rate_set_by`	Integer	The source that set the data (1 = FEED, 2 = USER, 3 = SYSTEM). See Account Set By for more information.
`interest_rate_set_by_name`	String	The source that set the data (FEED, USER, or SYSTEM). See Account Set By for more information.
`is_closed`	Boolean	If an account is closed, this field will be true. Otherwise, this field will be false.
`is_hidden`	Boolean	If an account is hidden, this field will be true. Otherwise, this field will be false. All linked transactions will be hidden as well.
`is_manual`	Boolean	If an account was manually created, this field will be true. Otherwise, this field will be false.
`last_payment`	Decimal	Amount of the account’s last payment. Max length is 10,2. See Number Limits.
`last_payment_at`	String	Date and time the account’s last payment was applied, represented in ISO 8601 format with timestamp (e.g. 2015-04-13T12:01:23-00:00).
`last_payment_at_set_by`	Integer	The source that set the data (1 = FEED, 2 = USER, 3 = SYSTEM). See Account Set By for more information.
`last_payment_at_set_by_name`	String	The source that set the data (FEED, USER, or SYSTEM). See Account Set By for more information.
`last_payment_set_by`	Integer	The source that set the data (1 = FEED, 2 = USER, 3 = SYSTEM). See Account Set By for more information.
`last_payment_set_by_name`	String	The source that set the data (FEED, USER, or SYSTEM). See Account Set By for more information.
`loan_amount`	Decimal	Amount of the loan. Max length is 14,2. See Number Limits.
`loan_amount_set_by`	Integer	The source that set the data (1 = FEED, 2 = USER, 3 = SYSTEM). See Account Set By for more information.
`loan_amount_set_by_name`	String	The source that set the data (FEED, USER, or SYSTEM). See Account Set By for more information.
`matures_on`	String	Maturity date. Represented in ISO 8601 format (for example, 2011-03-28).
`matures_on_set_by`	Integer	The source that set the data (1 = FEED, 2 = USER, 3 = SYSTEM). See Account Set By for more information.
`matures_on_set_by_name`	String	The source that set the data (FEED, USER, or SYSTEM). See Account Set By for more information.
`metadata`	String	Additional information or details about the account. This may be overwritten by the data provider when data is refreshed through aggregation.
`minimum_payment`	Decimal	Minimum payment amount. Max length is 10,2. See Number Limits.
`minimum_payment_at`	String	Date and time the minimum payment is due. Represented in ISO 8601 format with timestamp (e.g. 2015-04-13T12:01:23-00:00).
`minimum_payment_at_set_by`	Integer	The source that set the data (1 = FEED, 2 = USER, 3 = SYSTEM). See Account Set By for more information.
`minimum_payment_at_set_by_name`	String	The source that set the data (FEED, USER, or SYSTEM). See Account Set By for more information.
`minimum_payment_set_by`	Integer	The source that set the data (1 = FEED, 2 = USER, 3 = SYSTEM). See Account Set By for more information.
`minimum_payment_set_by_name`	String	The source that set the data (FEED, USER, or SYSTEM). See Account Set By for more information.
`name`	String	The name of the account.
`nickname`	String	The nickname is an alternate name for the account. This value is visible to the user and must be human-readable.
`original_balance`	Decimal	The original balance of the account. Max length is 14,2. See Number Limits.
`original_balance_set_by`	Integer	The source that set the data (1 = FEED, 2 = USER, 3 = SYSTEM). See Account Set By for more information.
`original_balance_set_by_name`	String	The source that set the data (FEED, USER, or SYSTEM). See Account Set By for more information.
`payment_due_at`	String	Date and time the payment is due. Represented in ISO 8601 format with timestamp (e.g. 2015-04-13T12:01:23-00:00).
`payoff_balance`	Decimal	The payoff balance of the account. Max length is 14,2. See Number Limits.
`payoff_balance_set_by`	Integer	The source that set the data (1 = FEED, 2 = USER, 3 = SYSTEM). See Account Set By for more information.
`payoff_balance_set_by_name`	String	The source that set the data (FEED, USER, or SYSTEM). See Account Set By for more information.
`principal_balance`	Decimal	The principal balance of the account. Max length is 14,2. See Number Limits.
`principal_balance_set_by`	Integer	The source that set the data (1 = FEED, 2 = USER, 3 = SYSTEM). See Account Set By for more information.
`principal_balance_set_by_name`	String	The source that set the data (FEED, USER, or SYSTEM). See Account Set By for more information.
`started_on`	String	The started on date. Represented in ISO 8601 format (for example, 2011-03-28).
`started_on_set_by`	Integer	The source that set the data (1 = FEED, 2 = USER, 3 = SYSTEM). See Account Set By for more information.
`started_on_set_by_name`	String	The source that set the data (FEED, USER, or SYSTEM). See Account Set By for more information.
`statement_balance`	Decimal	The account statement balance. Max length is 14,2. See Number Limits.
`statement_balance_set_by`	Integer	The source that set the data (1 = FEED, 2 = USER, 3 = SYSTEM). See Account Set By for more information.
`statement_balance_set_by_name`	String	The source that set the data (FEED, USER, or SYSTEM). See Account Set By for more information.
`total_account_value`	Decimal	The sum of the long and short positions, the sweep account and/or cash balance, and any margin debt associated with a particular account. This amount includes the market value of all positions held in the account and is reduced by any debit balance and the amount of short options positions that are “in the money”. This may sum to a negative value, and it does not represent an account balance. Max length is 14,2. See Number Limits.
`updated_at`	String	Date and time the account was last updated, represented in ISO 8601 format with timestamp (e.g. 2015-04-13T12:01:23-00:00).

Account fields with `set_by` or `set_by_name`

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 Accounts sections in Endpoints for examples.

set_by Integer	set_by String	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.

Account Types

The account_type and feed_account_type fields of the Accounts endpoint return Integers. The account_type_name and feed_account_type_name fields return Strings. See the table below for the meaning behind each value.ß

Account type Integer	Account type String
0	ANY (not provided by data partner or invalid number provided)
1	CHECKING
2	SAVINGS
3	LOAN
4	CREDIT_CARD
5	INVESTMENT
6	LINE_OF_CREDIT
7	MORTGAGE
8	PROPERTY
9	CASH
10	INSURANCE
11	PREPAID
12	CHECKING_LINE_OF_CREDIT
13	DIGITAL_WALLET

Account Subtypes

The account_subtype and feed_account_subtype fields of the Accounts endpoint return Integers. The account_subtype_name and feed_account_subtype_name fields return Strings. See the table below for the meaning behind each value. Some account types have defined subtypes.

Subtype Integer	Subtype String	Parent type String
1	MONEY_MARKET	SAVINGS
2	CERTIFICATE_OF_DEPOSIT	SAVINGS
3	AUTO	LOAN
4	STUDENT	LOAN
5	SMALL_BUSINESS	LOAN
6	PERSONAL	LOAN
7	PERSONAL_WITH_COLLATERAL	LOAN
8	HOME_EQUITY	LOAN
9	PLAN_401_K	INVESTMENT
10	PLAN_403_B	INVESTMENT
11	PLAN_529	INVESTMENT
12	IRA	INVESTMENT
13	ROLLOVER_IRA	INVESTMENT
14	ROTH_IRA	INVESTMENT
15	TAXABLE	INVESTMENT
16	NON_TAXABLE	INVESTMENT
17	BROKERAGE	INVESTMENT
18	TRUST	INVESTMENT
19	UNIFORM_GIFTS_TO_MINORS_ACT	INVESTMENT
20	PLAN_457	INVESTMENT
21	PENSION	INVESTMENT
22	EMPLOYEE_STOCK_OWNERSHIP_PLAN	INVESTMENT
23	SIMPLIFIED_EMPLOYEE_PENSION	INVESTMENT
24	SIMPLE_IRA	INVESTMENT
25	BOAT	LOAN
26	POWERSPORTS	LOAN
27	RV	LOAN
28	HELOC	LOAN
29	PLAN_ROTH_401_K	INVESTMENT
30	FIXED_ANNUITY	INVESTMENT
31	VARIABLE_ANNUITY	INVESTMENT
32	VEHICLE_INSURANCE	INSURANCE
33	DISABILITY	INSURANCE
34	HEALTH	INSURANCE
35	LONG_TERM_CARE	INSURANCE
36	PROPERTY_AND_CASUALTY	INSURANCE
37	UNIVERSAL_LIFE	INSURANCE
38	TERM_LIFE	INSURANCE
39	WHOLE_LIFE	INSURANCE
40	ACCIDENTAL_DEATH_AND_DISMEMBERMENT	INSURANCE
41	VARIABLE_UNIVERSAL_LIFE	INSURANCE
42	HSA	INVESTMENT
43	TAX_FREE_SAVINGS_ACCOUNT	INVESTMENT
44	INDIVIDUAL	INVESTMENT
45	REGISTERED_RETIREMENT_INCOME_FUND	INVESTMENT
46	CASH_MANAGEMENT_ACCOUNT	INVESTMENT
47	EMPLOYEE_STOCK_PURCHASE_PLAN	INVESTMENT
48	REGISTERED_EDUCATION_SAVINGS_PLAN	INVESTMENT
49	PROFIT_SHARING_PLAN	INVESTMENT
50	UNIFORM_TRANSFER_TO_MINORS_ACT	INVESTMENT
51	PLAN_401_A	INVESTMENT
52	SARSEP_IRA	INVESTMENT
53	FIXED_ANNUITY_TRADITIONAL_IRA	INVESTMENT
54	VARIABLE_ANNUITY_TRADITIONAL_IRA	INVESTMENT
55	SEPP_IRA	INVESTMENT
56	INHERITED_TRADITIONAL_IRA	INVESTMENT
57	FIXED_ANNUITY_ROTH_IRA	INVESTMENT
58	VARIABLE_ANNUITY_ROTH_IRA	INVESTMENT
59	INHERITED_ROTH_IRA	INVESTMENT
60	COVERDELL	INVESTMENT
61	ADVISORY_ACCOUNT	INVESTMENT
62	BROKERAGE_MARGIN	INVESTMENT
63	CHARITABLE_GIFT_ACCOUNT	INVESTMENT
64	CHURCH_ACCOUNT	INVESTMENT
65	CONSERVATORSHIP	INVESTMENT
66	CUSTODIAL	INVESTMENT
67	DEFINED_BENEFIT_PLAN	INVESTMENT
68	DEFINED_CONTRIBUTION_PLAN	INVESTMENT
69	EDUCATIONAL	INVESTMENT
70	ESTATE	INVESTMENT
71	EXECUTOR	INVESTMENT
72	GROUP_RETIREMENT_SAVINGS_PLAN	INVESTMENT
73	GUARANTEED_INVESTMENT_CERTIFICATE	INVESTMENT
74	HRA	INVESTMENT
75	INDEXED_ANNUITY	INVESTMENT
76	INVESTMENT_CLUB	INVESTMENT
77	IRREVOCABLE_TRUST	INVESTMENT
78	JOINT_TENANTS_BY_ENTIRITY	INVESTMENT
79	JOINT_TENANTS_COMMUNITY_PROPERTY	INVESTMENT
80	JOINT_TENANTS_IN_COMMON	INVESTMENT
81	JOINT_TENANTS_WITH_RIGHTS_OF_SURVIVORSHIP	INVESTMENT
82	KEOUGH_PLAN	INVESTMENT
83	LIFE_INCOME_FUND	INVESTMENT
84	LIVING_TRUST	INVESTMENT
85	LOCKED_IN_RETIREMENT_ACCOUNT	INVESTMENT
86	LOCKED_IN_RETIREMENT_INVESTMENT_FUND	INVESTMENT
87	LOCKED_IN_RETIREMENT_SAVINGS_ACCOUNT	INVESTMENT
88	MONEY_PURCHASE_PLAN	INVESTMENT
89	PARTNERSHIP	INVESTMENT
90	PLAN_409_A	INVESTMENT
91	PLAN_ROTH_403_B	INVESTMENT
92	REGISTERED_DISABILITY_SAVINGS_PLAN	INVESTMENT
93	REGISTERED_LOCKED_IN_SAVINGS_PLAN	INVESTMENT
94	REGISTERED_PENSION_PLAN	INVESTMENT
95	REGISTERED_RETIREMENT_SAVINGS_PLAN	INVESTMENT
96	REVOCABLE_TRUST	INVESTMENT
97	ROTH_CONVERSION	INVESTMENT
98	SOLE_PROPRIETORSHIP	INVESTMENT
99	SPOUSAL_IRA	INVESTMENT
100	SPOUSAL_ROTH_IRA	INVESTMENT
101	TESTAMENTARY_TRUST	INVESTMENT
102	THRIFT_SAVINGS_PLAN	INVESTMENT
103	INHERITED_ANNUITY	INVESTMENT
104	CORPORATE_ACCOUNT	INVESTMENT
105	LIMITED_LIABILITY_ACCOUNT	INVESTMENT

Federal Insurance Status

The federal_insurance_status and feed_federal_insurance_status fields of the Accounts endpoint return Integers. The federal_insurance_status_name and feed_federal_insurance_status_name fields return Strings.

Federal Insurance Status	Definition
0	UNKNOWN_INSURED
1	INSURED
2	NOT_INSURED

Interest Rate Source

The interest_rate_source field of the Accounts endpoint will return an Integer. See the table below for the meaning behind each Integer:

Interest Rate Source	Definition
0	INTEREST_RATE_SOURCE_SYSTEM
1	INTEREST_RATE_SOURCE_FEED
2	INTEREST_RATE_SOURCE_USER

Property Types

The property_type field of the Accounts endpoint returns an Integer. The property_type_name field returns a String. See the table below for the meaning behind each value.

Property Type Integer	Property Type String
0	REAL_ESTATE
1	VEHICLE
2	ART
3	JEWELRY
4	FURNITURE
5	APPLIANCES
6	COMPUTER
7	ELECTRONICS
8	SPORTS_EQUIPMENT
9	MISCELLANEOUS

​Accounts Fields

​Account fields with set_by or set_by_name

​Account Types

​Account Subtypes

​Federal Insurance Status

​Interest Rate Source

​Property Types