In documentation code examples, replace <API_KEY_VALUE> with the session token.
Query Parameters
use_case
string
The use case associated with the member to which the account belongs. Accounts returned will correspond to the specified use cases of their respective members. Valid values are PFM and MONEY_MOVEMENT. For example, if you're using the List Members request you can append either ?use_case=PFM or ?use_case=MONEY_MOVEMENT.
Response
200 - application/vnd.mx.nexus.v1+json
OK
accounts
object[]
Hide child attributes
accounts.account_number
string
The account number, as provided by our data feed.
Example:
"4921710685"
accounts.account_number_set_by
integer
The source that set the data (1 = FEED, 2 = USER, 3 = SYSTEM). See Account Set By for more information.
Example:
1
accounts.account_number_set_by_name
string
The source that set the data (FEED, USER, or SYSTEM). See Account Set By for more information.
Example:
"FEED"
accounts.account_subtype
integer
The integer value of the account subtype.
Example:
null
accounts.account_subtype_name
string
The account subtype (for example, PLAN_401_K, MONEY_MARKET, or HOME_EQUITY).
Example:
null
accounts.account_subtype_set_by
integer
The source that set the data (1 = FEED, 2 = USER, 3 = SYSTEM). See Account Set By for more information.
Example:
null
accounts.account_subtype_set_by_name
string
The source that set the data (FEED, USER, or SYSTEM). See Account Set By for more information.
Example:
null
accounts.account_type
integer
The integer value of the account type.
Example:
1
accounts.account_type_name
string
The account type (for example, CHECKING, SAVINGS, CREDIT_CARD).
Example:
"CHECKING"
accounts.account_type_set_by
integer
The source that set the data (1 = FEED, 2 = USER, 3 = SYSTEM). See Account Set By for more information.
Example:
1
accounts.account_type_set_by_name
string
The source that set the data (FEED, USER, or SYSTEM). See Account Set By for more information.
Example:
"FEED"
accounts.apr
number
Example:
null
accounts.apr_set_by
integer
The source that set the data (1 = FEED, 2 = USER, 3 = SYSTEM). See Account Set By for more information.
Example:
null
accounts.apr_set_by_name
string
The source that set the data (FEED, USER, or SYSTEM). See Account Set By for more information.
Example:
null
accounts.apy
number
Example:
null
accounts.apy_set_by
integer
The source that set the data (1 = FEED, 2 = USER, 3 = SYSTEM). See Account Set By for more information.
Example:
null
accounts.apy_set_by_name
string
The source that set the data (FEED, USER, or SYSTEM). See Account Set By for more information.
Example:
null
accounts.available_balance
integer
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.
Example:
500000
accounts.available_balance_set_by
integer
The source that set the data (1 = FEED, 2 = USER, 3 = SYSTEM). See Account Set By for more information.
Example:
1
accounts.available_balance_set_by_name
string
The source that set the data (FEED, USER, or SYSTEM). See Account Set By for more information.
Example:
"FEED"
accounts.available_credit
number
The amount of credit available for the account. Max length is 14,2. See Number Limits.
Example:
null
accounts.available_credit_set_by
integer
The source that set the data (1 = FEED, 2 = USER, 3 = SYSTEM). See Account Set By for more information.
Example:
null
accounts.available_credit_set_by_name
string
The source that set the data (FEED, USER, or SYSTEM). See Account Set By for more information.
Example:
null
accounts.balance
integer
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.
Example:
500000
accounts.balance_set_by
integer
The source that set the data (1 = FEED, 2 = USER, 3 = SYSTEM). See Account Set By for more information.
Example:
1
accounts.balance_set_by_name
string
The source that set the data (FEED, USER, or SYSTEM). See Account Set By for more information.
Example:
"FEED"
accounts.calculated_apr
number
Example:
null
accounts.cash_balance
number
The total cash balance for brokerage and investment accounts. Max length is 14,2. See Number Limits.
Example:
null
accounts.cash_balance_set_by
integer
The source that set the data (1 = FEED, 2 = USER, 3 = SYSTEM). See Account Set By for more information.
Example:
null
accounts.cash_balance_set_by_name
string
The source that set the data (FEED, USER, or SYSTEM). See Account Set By for more information.
Example:
null
accounts.cash_surrender_value
number
The cash surrender value for the account. Applies primarily to insurance account types. Max length is 14,2. See Number Limits.
Example:
null
accounts.cash_surrender_value_set_by
integer
The source that set the data (1 = FEED, 2 = USER, 3 = SYSTEM). See Account Set By for more information.
Example:
null
accounts.cash_surrender_value_set_by_name
string
The source that set the data (FEED, USER, or SYSTEM). See Account Set By for more information.
Example:
null
accounts.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).
Example:
"2020-09-21T19:43:44+00:00"
accounts.credit_limit
number
The credit limit of the account.
Example:
null
accounts.credit_limit_set_by
integer
The source that set the data (1 = FEED, 2 = USER, 3 = SYSTEM). See Account Set By for more information.
Example:
null
accounts.credit_limit_set_by_name
string
The source that set the data (FEED, USER, or SYSTEM). See Account Set By for more information.
Example:
null
accounts.currency_code
string
The currency code associated with the account (for example, USD, EUR).
Example:
null
accounts.currency_code_set_by
integer
The source that set the data (1 = FEED, 2 = USER, 3 = SYSTEM). See Account Set By for more information.
Example:
null
accounts.currency_code_set_by_name
string
The source that set the data (FEED, USER, or SYSTEM). See Account Set By for more information.
Example:
null
accounts.day_payment_is_due
integer
The day of the month the payment is due.
Example:
12
accounts.day_payment_is_due_set_by
integer
The source that set the data (1 = FEED, 2 = USER, 3 = SYSTEM). See Account Set By for more information.
Example:
1
accounts.day_payment_is_due_set_by_name
string
The source that set the data (FEED, USER, or SYSTEM). See Account Set By for more information.
Example:
"FEED"
accounts.death_benefit
integer
The death benefit amount for the account. Applies primarily to insurance account types.
Example:
null
accounts.death_benefit_set_by
integer
The source that set the data (1 = FEED, 2 = USER, 3 = SYSTEM). See Account Set By for more information.
Example:
null
accounts.death_benefit_set_by_name
string
The source that set the data (FEED, USER, or SYSTEM). See Account Set By for more information.
Example:
null
accounts.external_guid
string
Example:
"23445745"
accounts.feed_account_number
string
The account number, as provided by our data feed.
Example:
"4921710685"
accounts.feed_account_subtype
integer
Example:
null
accounts.feed_account_subtype_name
string
Example:
null
accounts.feed_account_type
integer
Example:
1
accounts.feed_account_type_name
string
Example:
"CHECKING"
accounts.feed_apr
number
Example:
null
accounts.feed_apy
number
Example:
null
accounts.feed_available_balance
integer
Example:
500000
accounts.feed_balance
integer
Example:
500000
accounts.feed_cash_balance
number
Example:
null
accounts.feed_cash_surrender_value
number
Example:
null
accounts.feed_credit_limit
number
Example:
null
accounts.feed_currency_code
string
Example:
null
accounts.feed_day_payment_is_due
integer
Example:
12
accounts.feed_death_benefit
integer
Example:
null
accounts.feed_holdings_value
number
Example:
null
accounts.feed_interest_rate
number
Example:
null
accounts.feed_is_closed
boolean
Example:
null
accounts.feed_last_payment
number
Example:
null
accounts.feed_last_payment_at
string
Example:
null
accounts.feed_loan_amount
number
Example:
null
accounts.feed_matures_on
string
Example:
null
accounts.feed_minimum_balance
number
Example:
null
accounts.feed_minimum_payment
number
Example:
null
accounts.feed_name
string
The name of the account, as provided by our data feed.
Example:
"Checking"
accounts.feed_nickname
string
Example:
null
accounts.feed_original_balance
number
The original balance, as provided by our data feed. Max length is 14,2. See Number Limits.
Example:
null
accounts.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).
Example:
"2021-05-12T16:01:00+00:00"
accounts.feed_payoff_balance
number
The payoff balance, as provided by our data feed. Max length is 14,2. See Number Limits.
Example:
null
accounts.feed_routing_number
string
The routing number, as provided by our data feed. See routing_number for more information.
Example:
null
accounts.feed_started_on
string
The started on date, as provided by our data feed. Represented in ISO 8601 format (e.g. 2011-03-28).
Example:
null
accounts.feed_statement_balance
number
The account statement balance, as provided by our data feed. Max length is 14,2. See Number Limits.
Example:
null
accounts.feed_total_account_value
number
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.
Example:
null
accounts.guid
string
Unique identifier for the account. Defined by MX.
Example:
"ACT-8e6f92c8-1491-42ce-8bf6-c309e9531530"
accounts.holdings_value
number
The value of holdings with this account.
Example:
null
accounts.holdings_value_set_by
integer
The source that set the data (1 = FEED, 2 = USER, 3 = SYSTEM). See Account Set By for more information.
Example:
null
accounts.holdings_value_set_by_name
string
The source that set the data (FEED, USER, or SYSTEM). See Account Set By for more information.
Example:
null
accounts.institution_guid
string
Unique identifier for the institution the account is attached to. Defined by MX.
Example:
"INS-1572a04c-912b-59bf-5841-332c7dfafaef"
accounts.insured_name
string
The name of the insured individual.
Example:
null
accounts.interest_rate
number
Interest rate (e.g. 2.99% is passed as 2.99). Max length is 10,6. See Number Limits.
Example:
null
accounts.interest_rate_set_by
integer
The source that set the data (1 = FEED, 2 = USER, 3 = SYSTEM). See Account Set By for more information.
Example:
null
accounts.interest_rate_set_by_name
string
The source that set the data (FEED, USER, or SYSTEM). See Account Set By for more information.
Example:
null
accounts.is_business
boolean
Example:
false
accounts.is_closed
boolean
If an account is closed, this field will be true. Otherwise, this field will be false.
Example:
false
accounts.is_closed_set_by
integer
The source that set the data (1 = FEED, 2 = USER, 3 = SYSTEM). See Account Set By for more information.
Example:
3
accounts.is_closed_set_by_name
string
The source that set the data (FEED, USER, or SYSTEM). See Account Set By for more information.
Example:
"SYSTEM"
accounts.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.
Example:
false
accounts.is_manual
boolean
If an account was manually created, this field will be true. Otherwise, this field will be false.
Example:
false
accounts.last_payment
number
Amount of the account's last payment. Max length is 10,2. See Number Limits.
Example:
null
accounts.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).
Example:
null
accounts.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.
Example:
null
accounts.last_payment_at_set_by_name
string
The source that set the data (FEED, USER, or SYSTEM). See Account Set By for more information.
Example:
null
accounts.last_payment_set_by
integer
The source that set the data (1 = FEED, 2 = USER, 3 = SYSTEM). See Account Set By for more information.
Example:
null
accounts.last_payment_set_by_name
string
The source that set the data (FEED, USER, or SYSTEM). See Account Set By for more information.
Example:
null
accounts.loan_amount
number
Amount of the loan. Max length is 14,2. See Number Limits.
Example:
null
accounts.loan_amount_set_by
integer
The source that set the data (1 = FEED, 2 = USER, 3 = SYSTEM). See Account Set By for more information.
Example:
null
accounts.loan_amount_set_by_name
string
The source that set the data (FEED, USER, or SYSTEM). See Account Set By for more information.
Example:
null
accounts.matures_on
string
Maturity date. Represented in ISO 8601 format (for example, 2011-03-28).
Example:
null
accounts.matures_on_set_by
integer
The source that set the data (1 = FEED, 2 = USER, 3 = SYSTEM). See Account Set By for more information.
Example:
null
accounts.matures_on_set_by_name
string
The source that set the data (FEED, USER, or SYSTEM). See Account Set By for more information.
Example:
null
accounts.member_guid
string
Unique identifier for the member the account is attached to. Defined by MX.
Example:
"MBR-84ca0882-ad6c-4f10-817f-c8c0de7424fa"
accounts.member_is_managed_by_user
boolean
If the member the account 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.
Example:
true
accounts.metadata
string
Additional information a partner can store on the account.
Example:
null
accounts.minimum_balance
number
The minimum balance allowed. Max length is 14,2. See Number Limits.
Example:
null
accounts.minimum_balance_set_by
integer
The source that set the data (1 = FEED, 2 = USER, 3 = SYSTEM). See Account Set By for more information.
Example:
null
accounts.minimum_balance_set_by_name
string
The source that set the data (FEED, USER, or SYSTEM). See Account Set By for more information.
Example:
null
accounts.minimum_payment
number
Minimum payment amount. Max length is 10,2. See Number Limits.
Example:
null
accounts.minimum_payment_set_by
integer
The source that set the data (1 = FEED, 2 = USER, 3 = SYSTEM). See Account Set By for more information.
Example:
null
accounts.minimum_payment_set_by_name
string
The source that set the data (FEED, USER, or SYSTEM). See Account Set By for more information.
Example:
null
accounts.name
string
The name of the account.
Example:
"Checking"
accounts.name_set_by
integer
The source that set the data (1 = FEED, 2 = USER, 3 = SYSTEM). See Account Set By for more information.
Example:
1
accounts.name_set_by_name
string
The source that set the data (FEED, USER, or SYSTEM). See Account Set By for more information.
Example:
"FEED"
accounts.nickname
string
The nickname is an alternate name for the account. This value is visible to the user and must be human-readable.
Example:
null
accounts.nickname_set_by
integer
The source that set the data (1 = FEED, 2 = USER, 3 = SYSTEM). See Account Set By for more information.
Example:
null
accounts.nickname_set_by_name
string
The source that set the data (FEED, USER, or SYSTEM). See Account Set By for more information.
Example:
null
accounts.original_balance
number
The original balance of the account. Max length is 14,2. See Number Limits.
Example:
null
accounts.original_balance_set_by
integer
The source that set the data (1 = FEED, 2 = USER, 3 = SYSTEM). See Account Set By for more information.
Example:
null
accounts.original_balance_set_by_name
string
The source that set the data (FEED, USER, or SYSTEM). See Account Set By for more information.
Example:
null
accounts.pay_out_amount
string
The payout amount for insurance accounts.
Example:
null
accounts.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).
Example:
"2021-05-12T16:01:00+00:00"
accounts.payment_due_at_set_by
integer
The source that set the data (1 = FEED, 2 = USER, 3 = SYSTEM). See Account Set By for more information.
Example:
1
accounts.payment_due_at_set_by_name
string
The source that set the data (FEED, USER, or SYSTEM). See Account Set By for more information.
Example:
"FEED"
accounts.payoff_balance
number
The payoff balance of the account. Max length is 14,2. See Number Limits.
Example:
null
accounts.payoff_balance_set_by
integer
The source that set the data (1 = FEED, 2 = USER, 3 = SYSTEM). See Account Set By for more information.
Example:
null
accounts.payoff_balance_set_by_name
string
The source that set the data (FEED, USER, or SYSTEM). See Account Set By for more information.
Example:
null
accounts.premium_amount
string
The premium amount for insurance accounts.
Example:
null
accounts.property_type
integer
The integer value of the property type. See Property Types for more information.
Example:
null
accounts.property_type_name
string
The property type name (for example, REAL_ESTATE, VEHICLE). See Property Types for more information.
Example:
null
accounts.revision
integer
The revision number of this account record.
Example:
648
accounts.routing_number
string
The routing number for the account.
Example:
null
accounts.started_on
string
The started on date. Represented in ISO 8601 format (for example, 2011-03-28).
Example:
null
accounts.started_on_set_by
integer
The source that set the data (1 = FEED, 2 = USER, 3 = SYSTEM). See Account Set By for more information.
Example:
null
accounts.started_on_set_by_name
string
The source that set the data (FEED, USER, or SYSTEM). See Account Set By for more information.
Example:
null
accounts.statement_balance
number
The account statement balance. Max length is 14,2. See Number Limits.
Example:
null
accounts.statement_balance_set_by
integer
The source that set the data (1 = FEED, 2 = USER, 3 = SYSTEM). See Account Set By for more information.
Example:
null
accounts.statement_balance_set_by_name
string
The source that set the data (FEED, USER, or SYSTEM). See Account Set By for more information.
Example:
null
accounts.total_account_value
number
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.
Example:
null
accounts.total_account_value_set_by
integer
The source that set the data (1 = FEED, 2 = USER, 3 = SYSTEM). See Account Set By for more information.
Example:
null
accounts.total_account_value_set_by_name
string
The source that set the data (FEED, USER, or SYSTEM). See Account Set By for more information.
Example:
null
accounts.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).
Example:
"2022-06-14T21:17:09+00:00"
accounts.user_guid
string
Unique identifier for the user the account is attached to. Defined by MX.