Account Fields

Field Name	Data Type (Max)	Description
`account_number`	String	The account number. In some cases this may be a partial or masked value.
`apr`	Decimal (10,6)	Annual percentage rate.
`apy`	Decimal (10,6)	Annual Percentage yield.
`available_balance`	Decimal (14,2)	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.
`available_credit`	Decimal (14,2)	The amount of credit available for use in liability accounts like credit cards and lines of credit. `PENDING` transactions are typically taken into account with available credit, but this may not always be the case. `available_credit` will usually be a positive value for all account types, determined in the same way as the `balance` field.
`balance`	Decimal (14,2)	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.
`cash_advance_apr`	Decimal (10,6)	APR values for cash advances.
`cash_surrender_value`	Decimal (10,2)	The sum of money paid to the policyholder or annuity holder in the event the policy is voluntarily terminated before it matures, or the insured event occurs.
`credit_limit`	Decimal (14,2)	The credit limit on this account. Can apply to any liability account.
`currency_code`	String	The three-character ISO 4217 currency code.
`daily_deposit_limit_current`	Decimal (10,2)	The current daily deposit limit for the user. This gets updated after each deposit.
`daily_deposit_limit_total`	Decimal (10,2)	The total daily deposit limit for the user.
`day_payment_is_due`	Integer	The day of the month a payment is due. Use `payment_due_at` or `payment_due_on` instead of `day_payment_is_due` if the full date is available.
`death_benefit`	Decimal (10,0)	The amount paid to the beneficiary of the account upon death of the account owner.
`guid`	String	The unique identifier for the account. Defined by MX.
`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 Account Federal Insurance Statuses for available account federal insurance statuses.
`has_monthly_transfer_limit`	Boolean	This account limits the number of transfers each month. This is associated with government regulation D.
`hold_total`	Decimal (14,2)	The total monetary amount of holds on the account.
`id`	String (1024)	The unique partner-provided identifier for the account. The `id` cannot begin with `ACT-` as this is reserved for the system. It must be unique for all accounts belonging to a member. The account ID is used for matching purposes within MX's PFM product (widgets) and must be returned as the same value in all subsequent account synchronizations. It can include numbers, letters, dashes, and underscores.
`insured_name`	String	The name of the insured individual as provided by the data provider.
`interest_paid_previous_year`	Decimal (10,2)	The amount of interest paid in the previous year. Can apply to any liability account.
`interest_paid_ytd`	Decimal (10,2)	The amount of interest paid in the current year to date. Can apply to any liability account.
`interest_rate`	Decimal (10,2)	The interest rate percentage.
`is_closed`	Boolean	This identifies if an account is closed.
`is_hidden`	Boolean	This indicates whether the account has been hidden. Defaults to `false`.
`last_payment`	Decimal (10,2)	The amount of the account’s last payment.
`last_payment_at`	Integer	The date and time of the account's last payment.
`last_payment_on`	String	The date of the account's last payment.
`loan_amount`	Decimal (14,2)	The original amount of the loan.
`matures_at`	Integer	The date and time the account matures.
`matures_on`	String	This is the maturity date for this account.
`member_guid`	String	The unique identifier for the member associated with this account. Defined by MX.
`member_id`	String	The unique, partner-provided identifier for the member associated with this account.
`metadata`	String	Additional information a partner can store on the account. Metadata will not be displayed to a user unless specific arrangements are made.
`minimum_balance`	Decimal (14,2)	The minimum required balance, normally a positive value.
`monthly_deposit_limit_current`	Decimal (10,2)	The current monthly deposit limit for the user. This gets updated after each deposit.
`monthly_deposit_limit_total`	Decimal(10,2)	The total monthly deposit limit for the user.
`minimum_payment`	Decimal (10,2)	The minimum payment for the current payment cycle. Can apply to any liability account.
`monthly_transfer_count`	Decimal	This is an optional field indicating the number of limited transfers that have occurred this month. Typically users will incur a fee for going over six transfers from a limited transfer account per month. This is associated with government regulation D.
`name`	String (1024)	The account name is the textual representation of the account. This value is visible to the user and must be human-readable. WARNING: Unescaped XML or JSON characters will break your integration. See the section on escaped characters for more information.
`next_payment`	Decimal (10,2)	The amount due for next payment. This can apply to any liability account.
`nickname`	String (1024)	The user-provided nickname for the account. This may be displayed to the user in place of the account `name`.
`original_balance`	Decimal (14,2)	This is the original balance for this account, normally a positive value.
`past_due_amount`	Decimal (10,2)	The amount that is delinquent after the `past_due_on` / `past_due_at` date.
`past_due_at`	Integer	The date and time after which payment is delinquent. Applies to any liability account.
`past_due_on`	String	The date after which payment is delinquent. Applies to any liability account.
`payment_due_at`	Integer	The date and time for the current payment cycle.
`payment_due_on`	String	The due date for the current payment cycle.
`payoff_balance`	Decimal (14,2)	The payoff balance, normally a positive value. Can apply to any liability account.
`pay_out_amount`	Decimal (10,2)	The amount paid out to the insured individual or beneficiary under the conditions of the insurance policy.
`pending_balance`	Decimal (14,2)	The available balance after accounting for pending transactions.
`pending_transactions_total`	Decimal (14,2)	The total monetary amount of pending transactions on the account.
`premium_amount`	Decimal (10,2)	The insurance policy’s premium amount.
`principal_balance`	Decimal (10,2)	The principal balance. This applies to loan accounts, unlike `current_balance` which is for credit card accounts.
`routing_number`	String	The routing number for this account. In some cases this may be a partial or masked value.
`started_at`	Integer	The date and time the loan or other debt account was started.
`started_on`	String	The date the loan or other liability account started.
`statement_balance`	Decimal (14,2)	The balance at the end of the account's last statement period.
`statement_closed_on`	String	The closing date — i.e. the statement compilation date — of the account's last billing cycle.
`statement_late_charges`	Decimal (10,2)	Late charges that were applied to the account for the statement period. This can apply to any liability account.
`subtype`	String	The account subtype represents additional type information on the account being returned. See the section on account subype definitions for available account subtypes.
`type`	String	The account type represents the specific type of account being returned. See the section on account type definitions for available account types.
`user_guid`	String	The unique identifier for the user associated with this account. Defined by MX.
`user_id`	String	The unique, partner-provided identifier for the user associated with this account.

Account Types

Type	Supertype	Notes
`ANY`	`UNKNOWN`	Default if not provided by data partner or invalid number provided.
`CHECKING`	`ASSET`
`SAVINGS`	`ASSET`
`LOAN`	`LIABILITY`
`CREDIT_CARD`	`LIABILITY`
`INVESTMENT`	`ASSET`
`LINE_OF_CREDIT`	`LIABILITY`
`MORTGAGE`	`LIABILITY`
`PROPERTY`	`ASSET`
`CASH`	`ASSET`
`INSURANCE`	`LIABILITY`	Optional type. This is enabled for specific clients when needed.
`PREPAID`	`LIABILITY`	Optional type. This is enabled for specific clients when needed.

Account Subtypes

Subtype	Parent Type
`MONEY_MARKET`	`SAVINGS`
`CERTIFICATE_OF_DEPOSIT`	`SAVINGS`
`AUTO`	`LOAN`
`STUDENT`	`LOAN`
`SMALL_BUSINESS`	`LOAN`
`PERSONAL`	`LOAN`
`PERSONAL_WITH_COLLATERAL`	`LOAN`
`HOME_EQUITY`	`LOAN`
`PLAN_401_K`	`INVESTMENT`
`PLAN_403_B`	`INVESTMENT`
`PLAN_529`	`INVESTMENT`
`IRA`	`INVESTMENT`
`ROLLOVER_IRA`	`INVESTMENT`
`ROTH_IRA`	`INVESTMENT`
`TAXABLE`	`INVESTMENT`
`NON_TAXABLE`	`INVESTMENT`
`BROKERAGE`	`INVESTMENT`
`TRUST`	`INVESTMENT`
`UNIFORM_GIFTS_TO_MINORS_ACT`	`INVESTMENT`
`PLAN_457`	`INVESTMENT`
`PENSION`	`INVESTMENT`
`EMPLOYEE_STOCK_OWNERSHIP_PLAN`	`INVESTMENT`
`SIMPLIFIED_EMPLOYEE_PENSION`	`INVESTMENT`
`SIMPLE_IRA`	`INVESTMENT`
`BOAT`	`LOAN`
`POWERSPORTS`	`LOAN`
`RV`	`LOAN`
`HELOC`	`LOAN`
`PLAN_ROTH_401_K`	`INVESTMENT`
`FIXED_ANNUITY`	`INVESTMENT`
`VARIABLE_ANNUITY`	`INVESTMENT`
`VEHICLE_INSURANCE`	`INSURANCE`
`DISABILITY`	`INSURANCE`
`HEALTH`	`INSURANCE`
`LONG_TERM_CARE`	`INSURANCE`
`PROPERTY_AND_CASUALTY`	`INSURANCE`
`UNIVERSAL_LIFE`	`INSURANCE`
`TERM_LIFE`	`INSURANCE`
`WHOLE_LIFE`	`INSURANCE`
`ACCIDENTAL_DEATH_AND_DISMEMBERMENT`	`INSURANCE`
`VARIABLE_UNIVERSAL_LIFE`	`INSURANCE`
`HSA`	`INVESTMENT`
`TAX_FREE_SAVINGS_ACCOUNT`	`INVESTMENT`
`INDIVIDUAL`	`INVESTMENT`
`REGISTERED_RETIREMENT_INCOME_FUND`	`INVESTMENT`
`CASH_MANAGEMENT_ACCOUNT`	`INVESTMENT`
`EMPLOYEE_STOCK_PURCHASE_PLAN`	`INVESTMENT`
`REGISTERED_EDUCATION_SAVINGS_PLAN`	`INVESTMENT`
`PROFIT_SHARING_PLAN`	`INVESTMENT`
`UNIFORM_TRANSFER_TO_MINORS_ACT`	`INVESTMENT`
`PLAN_401_A`	`INVESTMENT`
`SARSEP_IRA`	`INVESTMENT`
`FIXED_ANNUITY_TRADITIONAL_IRA`	`INVESTMENT`
`VARIABLE_ANNUITY_TRADITIONAL_IRA`	`INVESTMENT`
`SEPP_IRA`	`INVESTMENT`
`INHERITED_TRADITIONAL_IRA`	`INVESTMENT`
`FIXED_ANNUITY_ROTH_IRA`	`INVESTMENT`
`VARIABLE_ANNUITY_ROTH_IRA`	`INVESTMENT`
`INHERITED_ROTH_IRA`	`INVESTMENT`
`COVERDELL`	`INVESTMENT`
`ADVISORY_ACCOUNT`	`INVESTMENT`
`BROKERAGE_MARGIN`	`INVESTMENT`
`CHARITABLE_GIFT_ACCOUNT`	`INVESTMENT`
`CHURCH_ACCOUNT`	`INVESTMENT`
`CONSERVATORSHIP`	`INVESTMENT`
`CUSTODIAL`	`INVESTMENT`
`DEFINED_BENEFIT_PLAN`	`INVESTMENT`
`DEFINED_CONTRIBUTION_PLAN`	`INVESTMENT`
`EDUCATIONAL`	`INVESTMENT`
`ESTATE`	`INVESTMENT`
`EXECUTOR`	`INVESTMENT`
`GROUP_RETIREMENT_SAVINGS_PLAN`	`INVESTMENT`
`GUARANTEED_INVESTMENT_CERTIFICATE`	`INVESTMENT`
`HRA`	`INVESTMENT`
`INDEXED_ANNUITY`	`INVESTMENT`
`INVESTMENT_CLUB`	`INVESTMENT`
`IRREVOCABLE_TRUST`	`INVESTMENT`
`JOINT_TENANTS_BY_ENTIRITY`	`INVESTMENT`
`JOINT_TENANTS_COMMUNITY_PROPERTY`	`INVESTMENT`
`JOINT_TENANTS_IN_COMMON`	`INVESTMENT`
`JOINT_TENANTS_WITH_RIGHTS_OF_SURVIVORSHIP`	`INVESTMENT`
`KEOUGH_PLAN`	`INVESTMENT`
`LIFE_INCOME_FUND`	`INVESTMENT`
`LIVING_TRUST`	`INVESTMENT`
`LOCKED_IN_RETIREMENT_ACCOUNT`	`INVESTMENT`
`LOCKED_IN_RETIREMENT_INVESTMENT_FUND`	`INVESTMENT`
`LOCKED_IN_RETIREMENT_SAVINGS_ACCOUNT`	`INVESTMENT`
`MONEY_PURCHASE_PLAN`	`INVESTMENT`
`PARTNERSHIP`	`INVESTMENT`
`PLAN_409_A`	`INVESTMENT`
`PLAN_ROTH_403_B`	`INVESTMENT`
`REGISTERED_DISABILITY_SAVINGS_PLAN`	`INVESTMENT`
`REGISTERED_LOCKED_IN_SAVINGS_PLAN`	`INVESTMENT`
`REGISTERED_PENSION_PLAN`	`INVESTMENT`
`REGISTERED_RETIREMENT_SAVINGS_PLAN`	`INVESTMENT`
`REVOCABLE_TRUST`	`INVESTMENT`
`ROTH_CONVERSION`	`INVESTMENT`
`SOLE_PROPRIETORSHIP`	`INVESTMENT`
`SPOUSAL_IRA`	`INVESTMENT`
`SPOUSAL_ROTH_IRA`	`INVESTMENT`
`TESTAMENTARY_TRUST`	`INVESTMENT`
`THRIFT_SAVINGS_PLAN`	`INVESTMENT`
`INHERITED_ANNUITY`	`INVESTMENT`
`CORPORATE_ACCOUNT`	`INVESTMENT`
`LIMITED_LIABILITY_ACCOUNT`	`INVESTMENT`
`HSA_SAVINGS`	`INVESTMENT`
`HSA_CHECKING`	`INVESTMENT`

Account Supertypes

Supertype	Notes
`UNKNOWN`
`ASSET`	Accounts that are generally considered to be an asset to the user.
`LIABILITY`	Accounts that are generally considered to be a liability to the user.

Account Fields

Account Types​

Account Subtypes​

Account Supertypes​

Account Types

Account Subtypes

Account Supertypes