Skip to main content

Accounts

Account Fields​

FieldData TypeDescription
account_numberStringThe account number associated with the account. This will typically be a masked or partial account number.
aprDecimalThe annual percentage rate associated with the account.
apyDecimalThe annual percentage yield associated with the account.
available_balanceDecimalThe 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_creditDecimalThe 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.
balanceDecimalThe 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_balanceDecimalThe cash balance of the account.
cash_surrender_valueDecimalThe 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.
created_atStringThe date and time at which the account was created on the MX Platform.
credit_limitDecimalThe credit limit associated with the account.
currency_codeStringThe three-character ISO 4217 currency code.
day_payment_is_dueIntegerThe day of the month the payment is due. For example, the 14th is passed as 14.
death_benefitIntegerThe amount paid to the beneficiary of the account upon death of the account owner.
feed_is_businessBooleanThe value provided to MX to determine is_business.
guidStringThe unique identifier for the account. Defined by MX.
holdings_valueDecimalThe value of the holdings associated with the account.
idStringThe unique partner-defined identifier for the account
imported_atStringThe date and time at which the account was last successfully aggregated and received data.
institution_codeStringA unique identifier for the institution associated with this account. Defined by MX.
insured_nameStringThe name of the insured individual.
interest_rateDecimalThe interest rate associated with the account.
is_businessBooleanThis indicates whether the account is for business or personal purposes. Defaults to false.

When set to true, all past and future transactions associated with the account will be set to "is_business": "true".

This field only appears in the response when the business suite has been enabled.
is_closedBooleanThis indicates whether an account has been closed.
is_hiddenBooleanThis indicates whether the account is hidden. Defaults to false.
last_payment_atStringThe date and time of the most recent payment on the account.
last_paymentDecimalThe amount of the most recent payment on the account.
loan_amountDecimalThe amount of the loan associated with the account.
matures_onStringThe date on which the account matures.
member_guidStringThe unique identifier for the member associated with the account. Defined by MX.
member_idStringThe unique, partner-defined, identifier for the member associated with this account.
member_is_managed_by_userBooleanThis indicates whether the associated member is managed by the user or the MX partner. Members created with the managed member feature will have this field set to false.
metadata StringAdditional information a partner can store on the account.
minimum_balanceDecimalThe minimum balance associated with the account.
minimum_paymentDecimalThe minimum payment required for an account. This can apply to any debt account.
nameStringThe human-readable name for the account.
nicknameStringAn alternate name for the account.
original_balanceDecimalThe original balance associated with the account. This will always be positive.
pay_out_amountDecimalThe amount paid out to the insured individual or beneficiary under the conditions of the insurance policy.
payment_due_atStringThe date and time at which the next payment is due on the account.
payoff_balanceDecimalThe payoff balance for a debt account. This will normally be a positive number.
premium_amountDecimalThe insurance policy's premium amount.
routing_numberStringThe routing number for the account.
started_onStringThe date on which a debt account was started.
subtypeStringThe account's subtype, e.g., PLAN_401_K, MONEY_MARKET, or HOME_EQUITY.
total_account_valueDecimalThe 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.
typeStringThe general or parent type of the account.
updated_atStringThe date and time at which the account was most recently updated.
user_guidStringThe unique identifier for the user associated with the account. Defined by MX.
user_idStringThe unique, partner-defined, identifier for the user associated with this account.

Account Types and Subtypes​

Parent types
ANY (not provided by data partner or invalid number provided)
CHECKING
SAVINGS
LOAN
CREDIT_CARD
INVESTMENT
LINE_OF_CREDIT
MORTGAGE
PROPERTY
CASH
INSURANCE
PREPAID
SubtypeParent Type
MONEY_MARKETSAVINGS
CERTIFICATE_OF_DEPOSITSAVINGS
AUTOLOAN
STUDENTLOAN
SMALL_BUSINESSLOAN
PERSONALLOAN
PERSONAL_WITH_COLLATERALLOAN
HOME_EQUITYLOAN
PLAN_401_KINVESTMENT
PLAN_403_BINVESTMENT
PLAN_529INVESTMENT
IRAINVESTMENT
ROLLOVER_IRAINVESTMENT
ROTH_IRAINVESTMENT
TAXABLEINVESTMENT
NON_TAXABLEINVESTMENT
BROKERAGEINVESTMENT
TRUSTINVESTMENT
UNIFORM_GIFTS_TO_MINORS_ACTINVESTMENT
PLAN_457INVESTMENT
PENSIONINVESTMENT
EMPLOYEE_STOCK_OWNERSHIP_PLANINVESTMENT
SIMPLIFIED_EMPLOYEE_PENSIONINVESTMENT
SIMPLE_IRAINVESTMENT
BOATLOAN
POWERSPORTSLOAN
RVLOAN
HELOCLOAN
PLAN_ROTH_401_KINVESTMENT
FIXED_ANNUITYINVESTMENT
VARIABLE_ANNUITYINVESTMENT
VEHICLE_INSURANCEINSURANCE
DISABILITYINSURANCE
HEALTHINSURANCE
LONG_TERM_CAREINSURANCE
PROPERTY_AND_CASUALTYINSURANCE
UNIVERSAL_LIFEINSURANCE
TERM_LIFEINSURANCE
WHOLE_LIFEINSURANCE
ACCIDENTAL_DEATH_AND_DISMEMBERMENTINSURANCE
VARIABLE_UNIVERSAL_LIFEINSURANCE
HSAINVESTMENT
TAX_FREE_SAVINGS_ACCOUNTINVESTMENT
INDIVIDUALINVESTMENT
REGISTERED_RETIREMENT_INCOME_FUNDINVESTMENT
CASH_MANAGEMENT_ACCOUNTINVESTMENT
EMPLOYEE_STOCK_PURCHASE_PLANINVESTMENT
REGISTERED_EDUCATION_SAVINGS_PLANINVESTMENT
PROFIT_SHARING_PLANINVESTMENT
UNIFORM_TRANSFER_TO_MINORS_ACTINVESTMENT
PLAN_401_AINVESTMENT
SARSEP_IRAINVESTMENT
FIXED_ANNUITY_TRADITIONAL_IRAINVESTMENT
VARIABLE_ANNUITY_TRADITIONAL_IRAINVESTMENT
SEPP_IRAINVESTMENT
INHERITED_TRADITIONAL_IRAINVESTMENT
FIXED_ANNUITY_ROTH_IRAINVESTMENT
VARIABLE_ANNUITY_ROTH_IRAINVESTMENT
INHERITED_ROTH_IRAINVESTMENT
COVERDELLINVESTMENT
ADVISORY_ACCOUNTINVESTMENT
BROKERAGE_MARGININVESTMENT
CHARITABLE_GIFT_ACCOUNTINVESTMENT
CHURCH_ACCOUNTINVESTMENT
CONSERVATORSHIPINVESTMENT
CUSTODIALINVESTMENT
DEFINED_BENEFIT_PLANINVESTMENT
DEFINED_CONTRIBUTION_PLANINVESTMENT
EDUCATIONALINVESTMENT
ESTATEINVESTMENT
EXECUTORINVESTMENT
GROUP_RETIREMENT_SAVINGS_PLANINVESTMENT
GUARANTEED_INVESTMENT_CERTIFICATEINVESTMENT
HRAINVESTMENT
INDEXED_ANNUITYINVESTMENT
INVESTMENT_CLUBINVESTMENT
IRREVOCABLE_TRUSTINVESTMENT
JOINT_TENANTS_BY_ENTIRITYINVESTMENT
JOINT_TENANTS_COMMUNITY_PROPERTYINVESTMENT
JOINT_TENANTS_IN_COMMONINVESTMENT
JOINT_TENANTS_WITH_RIGHTS_OF_SURVIVORSHIPINVESTMENT
KEOUGH_PLANINVESTMENT
LIFE_INCOME_FUNDINVESTMENT
LIVING_TRUSTINVESTMENT
LOCKED_IN_RETIREMENT_ACCOUNTINVESTMENT
LOCKED_IN_RETIREMENT_INVESTMENT_FUNDINVESTMENT
LOCKED_IN_RETIREMENT_SAVINGS_ACCOUNTINVESTMENT
MONEY_PURCHASE_PLANINVESTMENT
PARTNERSHIPINVESTMENT
PLAN_409_AINVESTMENT
PLAN_ROTH_403_BINVESTMENT
REGISTERED_DISABILITY_SAVINGS_PLANINVESTMENT
REGISTERED_LOCKED_IN_SAVINGS_PLANINVESTMENT
REGISTERED_PENSION_PLANINVESTMENT
REGISTERED_RETIREMENT_SAVINGS_PLANINVESTMENT
REVOCABLE_TRUSTINVESTMENT
ROTH_CONVERSIONINVESTMENT
SOLE_PROPRIETORSHIPINVESTMENT
SPOUSAL_IRAINVESTMENT
SPOUSAL_ROTH_IRAINVESTMENT
TESTAMENTARY_TRUSTINVESTMENT
THRIFT_SAVINGS_PLANINVESTMENT
INHERITED_ANNUITYINVESTMENT
CORPORATE_ACCOUNTINVESTMENT
LIMITED_LIABILITY_ACCOUNTINVESTMENT

List All Accounts for a User​

This endpoint returns a list of all the accounts associated with the specified user.

Endpoint: GET /users/{user_guid}/accounts

Request
Response
Language:shell

_10
curl -X GET https://int-api.mx.com/users/USR-11141024-90b3-1bce-cac9-c06ced52ab4c/accounts \
_10
-H 'Accept: application/vnd.mx.api.v1+json' \
_10
-u 'client_id:api_key'

Read an Account​

This endpoint returns the specified account resource.

Endpoint: GET /users/{user_guid}/accounts/{account_guid}

Request
Response
Language:shell

_10
curl -X GET https://int-api.mx.com/users/USR-11141024-90b3-1bce-cac9-c06ced52ab4c/accounts/ACT-3ed84c78-97f6-4574-9f92-318b88d482d1 \
_10
-H 'Accept: application/vnd.mx.api.v1+json' \
_10
-u 'client_id:api_key'

Update an Account​

This endpoint allows you to update certain attributes of an account resource.

Parameters

FieldData TypeRequired?
is_hiddenBooleanNo
is_businessBooleanNo

Endpoint: PUT /users/{user_guid}/members/{member_guid}/accounts/{account_guid}

Request
Response
Language:shell

_10
curl -i -X PUT 'https://int-api.mx.com/users/USR-11141024-90b3-1bce-cac9-c06c11141024/members/MBR-3bdc7d6b-efd4-1497-a0af-b23501cf9bd0/accounts/ACT-3ed84c78-97f6-4574-9f92-318b88d482d1' \
_10
-u 'client_id:api_key' \
_10
-H 'Accept: application/vnd.mx.api.v1+json' \
_10
-H 'Content-Type: application/json' \
_10
-d '{
_10
"account": {
_10
"is_hidden": true
_10
}
_10
}'

On this page