Accounts

A partner subscribed to accounts will be notified when an account is created, updated, or deleted in the MX system for any user on that partner's client.

Field	Data Type	Definition
account_number	String	The account number. This will typically be a masked or partial account number.
account_number_set_by	String	The source that set the data.
account_subtype	String	The account's subtype.
account_subtype_set_by	String	The source that set the data.
account_type	String	The specific type of account being received.
account_type_set_by	String	The source that set the data.
apr	Decimal	The annual percentage rate. Max length is 10,6.
apr_set_by	String	The source that set the data.
apy	Decimal	The annual percentage yield. Max length is 10,6.
apy_set_by	String	The source that set the data.
available_balance	Decimal	The current available account balance. The available balance will normally be a positive value for all account types. The sign of the balance is determined with the same rules that apply to the balance field. Max length is 14,2.
available_balance_set_by	String	The source that set the data.
available_credit	Decimal	The current available credit balance of the account. This field is for credit card accounts or accounts with a line of credit.
available_credit_set_by	String	The source that set the data.
balance	Decimal	The current account balance. The balance will normally be a positive value for all account types. An asset account (Checking, Savings, Investment) would have a positive balance unless it was in an overdraft condition, in which case the balance would be negative. A debt account (Credit Card, Loan, Line Of Credit, Mortgage) would have a positive balance when the user owes money on the account. It would have a negative balance if the account was overpaid. Max length is 14,2.
balance_set_by	String	The source that set the data.
cash_balance	Decimal	The cash balance of the account. Max length is 14,2.
cash_balance_set_by	String	The source that set the data.
cash_surrender_value	Decimal	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. Max length is 14,2.
cash_surrender_value_set_by	String	The source that set the data.
created_at	Integer	The date and time the account was created.
credit_limit	Decimal	The credit limit for the account. Max length is 10,2.
credit_limit_set_by	String	The source that set the data.
currency_code	String	The ISO 4217 three-character currency code.
currency_code_set_by	String	The source that set the data.
day_payment_is_due	Integer	The day of the month the payment is due.
day_payment_is_due_set_by	String	The source that set the data.
death_benefit	Decimal	The amount paid to the beneficiary of the account upon death of the account owner. Max length is 14,2.
death_benefit_set_by	String	The source that set the data.
id	String	The unique partner-defined identifier for the account.
feed_account_number	String	The account number, as provided by our data feed. See account_number for more information.
feed_account_subtype	String	The account subtype, as provided by our data feed. See account_subtypes for more information.
feed_account_type	String	The account type, as provided by our data feed. See account_types for more information.
feed_apr	Decimal	The APR, as provided by our data feed. Max length is 10,6.
feed_apy	Decimal	The APY, as provided by our data feed. Max length is 10,6.
feed_available_balance	Decimal	The available balance, as provided by our data feed. Max length is 14,2.
feed_balance	Decimal	The balance, as provided by our data feed. Max length is 14,2.
feed_cash_balance	Decimal	The cash balance, as provided by our data feed. Max length is 14,2.
feed_cash_surrender_value	Decimal	The cash surrender value, as provided by our data feed. Max length is 14,2.
feed_credit_limit	Decimal	The credit limit, as provided by our data feed. Max length is 10,2.
feed_currency_code	String	The ISO 4217 three-character currency code, as provided by our data feed.
feed_day_payment_is_due	Integer	The day of the month the payment is due, as provided by our data feed.
feed_death_benefit	Decimal	The death benefit, as provided by our data feed. Max length is 14,2.
feed_holdings_value	Decimal	The holdings value, as as provided by our data feed. Max length is 14,2.
feed_interest_rate	Decimal	The interest rate, as provided by our data feed. Max length is 10,6.
feed_last_payment	Decimal	The amount of the last payment, as provided by our data feed. Max length is 10,2.
feed_last_payment_at	Integer	The date and time the last payment was at, as provided by our data feed.
feed_loan_amount	Decimal	The amount of the loan, as provided by our data feed. Max length is 14,2.
feed_matures_on	String	The maturity date, as provided by our data feed.
feed_minimum_balance	Decimal	The minimum balance, as provided by our data feed. Max length is 14,2.
feed_minimum_payment	Decimal	The minimum payment, as provided by our data feed. Max length is 10,2.
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.
feed_payment_due_at	Integer	The date and time the payment is due, as provided by our data feed.
feed_payoff_balance	Decimal	The payoff balance, as provided by our data feed. Max length is 14,2.
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.
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.
guid	String	The unique identifier for the account. Defined by MX.
holdings_value	Decimal	The value of holdings with this account.
holdings_value_set_by	String	The source that set the data.
institution_guid	String	The unique identifier for the institution the account is attached to. Defined by MX.
interest_rate	Decimal	The interest rate. For example, 2.99% is passed as 2.99). Max length is 10,6.
interest_rate_set_by	String	The source that set the data.
is_closed	Boolean	This indicates whether the account is closed.
is_hidden	Boolean	This indicates whether the account has been hidden. If true, all linked transactions will be hidden as well.
is_manual	Boolean	This indicates whether the account was manually created.
last_payment	Decimal	The amount of the account’s last payment. Max length is 10,2.
last_payment_at	Integer	The date and time the account’s last payment was applied.
last_payment_at_set_by	String	The source that set the data.
last_payment_set_by	String	The source that set the data.
loan_amount	Decimal	The amount of the loan. Max length is 14,2.
loan_amount_set_by	String	The source that set the data.
matures_on	String	The maturity date.
matures_on_set_by	String	The source that set the data.
member_guid	String	The unique identifier for the member this account is attached to. Defined by MX.
member_id	String	The unique, partner-defined identifier for the member.
member_is_managed_by_user	Boolean	This indicates whether the account is managed by the user.
metadata	String	Additional information a partner can store on the account.
minimum_balance	Decimal	The minimum required balance. This is typically a positive value. Max length is 14,2.
minimum_balance_set_by	String	The source that set the data.
minimum_payment	Decimal	The minimum payment. This field applies to debt accounts. Max length is 10,2.
minimum_payment_set_by	String	The source that set the data.
name	String	The Account Name is the textual representation of the account. This value is visible to the user and must be human-readable.
name_set_by	String	The source that set the data.
nickname	String	An alternate name for the account.
original_balance	Decimal	The original balance. This is typically a positive value. Max length is 14,2.
original_balance_set_by	String	The source that set the data.
payment_due_at	Integer	The date and time the account’s next payment is due.
payment_due_at_set_by	String	The source that set the data.
payoff_balance	Decimal	They payoff balance. Typically this is a positive value. This field applies to debt accounts. Max length is 14,2.
payoff_balance_set_by	String	The source that set the data.
property_type	String	The subtype if the account type is PROPERTY. This field should be ignored unless the account_type is set to PROPERTY.
revision	Integer	The revision number for the account.
routing_number	String	The routing number for the account.
started_on	String	The date the loan or other debt account started.
started_on_set_by	String	The source that set the data.
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.
total_account_value_set_by	String	The source that set the data.
updated_at	Integer	The date and time the account was last updated.
user_guid	String	The unique identifier for the user the account is attached to. Defined by MX.
user_id	String	The unique partner-defined identifier for the user.

Account Types

Parent Types
ANY (not provided by data partner or invalid number provided)
CASH
CHECKING
CREDIT_CARD
INSURANCE
INVESTMENT
LINE_OF_CREDIT
LOAN
MORTGAGE
PREPAID
PROPERTY
SAVINGS

Account Subtypes

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

Example Payload

Payload

Language:json

_114

POST /admin/webhooks

_114

HTTP/1.1

_114

content-type: application/json; charset=utf-8

_114

accept: application/json

_114

User-Agent: HTTPClient/1.0 (2.7.1, ruby 2.2.2

_114

(2015-09-02)) Date: Thu, 14 Apr 2016 04:26:04 GMT Content-Length: 231

_114

Host: abc.com

_114

{

_114

"action": "deleted",

_114

"account": {

_114

"account_number": null,

_114

"account_number_set_by": null,

_114

"account_subtype": null,

_114

"account_subtype_set_by": null,

_114

"account_type": "INVESTMENT",

_114

"account_type_set_by": "USER",

_114

"apr": null,

_114

"apr_set_by": null,

_114

"apy": null,

_114

"apy_set_by": null,

_114

"available_balance": null,

_114

"available_balance_set_by": null,

_114

"available_credit": null,

_114

"available_credit_set_by": null,

_114

"balance": 1000,

_114

"balance_set_by": "FEED",

_114

"cash_balance": null,

_114

"cash_balance_set_by": null,

_114

"cash_surrender_value": null,

_114

"cash_surrender_value_set_by": null,

_114

"created_at": 1588006057,

_114

"credit_limit": null,

_114

"credit_limit_set_by": null,

_114

"currency_code": null,

_114

"currency_code_set_by": null,

_114

"day_payment_is_due": null,

_114

"day_payment_is_due_set_by": null,

_114

"death_benefit": null,

_114

"death_benefit_set_by": null,

_114

"feed_account_number": null,

_114

"feed_account_subtype": null,

_114

"feed_account_type": "INVESTMENT",

_114

"feed_apr": null,

_114

"feed_apy": null,

_114

"feed_available_balance": null,

_114

"feed_balance": 1000,

_114

"feed_cash_balance": null,

_114

"feed_cash_surrender_value": null,

_114

"feed_credit_limit": null,

_114

"feed_currency_code": null,

_114

"feed_day_payment_is_due": null,

_114

"feed_death_benefit": null,

_114

"feed_holdings_value": null,

_114

"feed_interest_rate": null,

_114

"feed_last_payment": null,

_114

"feed_last_payment_at": null,

_114

"feed_loan_amount": null,

_114

"feed_matures_on": null,

_114

"feed_minimum_balance": null,

_114

"feed_minimum_payment": null,

_114

"feed_name": null,

_114

"feed_original_balance": null,

_114

"feed_payment_due_at": null,

_114

"feed_payoff_balance": null,

_114

"feed_routing_number": null,

_114

"feed_started_on": null,

_114

"feed_total_account_value": null,

_114

"guid": "ACT-0950f510-a2de-4ea8-903f-494565b19432",

_114

"holdings_value": null,

_114

"holdings_value_set_by": null,

_114

"id": account-189ef902-6a74-4068-8107-fd3f24c8c661,

_114

"institution_guid": "INS-cb5c-1d48-741c-b30f4ddd1730",

_114

"interest_rate": null,

_114

"interest_rate_set_by": null,

_114

"is_closed": false,

_114

"is_hidden": false,

_114

"is_manual": false,

_114

"last_payment": null,

_114

"last_payment_at": null,

_114

"last_payment_at_set_by": null,

_114

"last_payment_set_by": null,

_114

"loan_amount": null,

_114

"loan_amount_set_by": null,

_114

"matures_on": null,

_114

"matures_on_set_by": null,

_114

"member_guid": "MBR-5ac1b3f8-7f76-495e-a4c1-32c4adc93c84",

_114

"member_id": null,

_114

"member_is_managed_by_user": true,

_114

"metadata": null,

_114

"minimum_balance": null,

_114

"minimum_balance_set_by": null,

_114

"minimum_payment": null,

_114

"minimum_payment_set_by": null,

_114

"name": "Gringotts Insurance",

_114

"name_set_by": "USER",

_114

"nickname": null,

_114

"original_balance": null,

_114

"original_balance_set_by": null,

_114

"payment_due_at": null,

_114

"payment_due_at_set_by": null,

_114

"payoff_balance": null,

_114

"payoff_balance_set_by": null,

_114

"property_type": null,

_114

"revision": 2,

_114

"routing_number": null,

_114

"started_on": null,

_114

"started_on_set_by": null,

_114

"total_account_value": null,

_114

"total_account_value_set_by": null,

_114

"updated_at": 1588006082,

_114

"user_guid": "USR-8b7af430-cb1a-455f-af94-7906926abf95",

_114

"user_id": "u-1234"

_114

}

_114

}