Accounts - MX Documentation

Accounts webhooks notify you when an account is created, updated, or deleted in the MX system for any user in the client. The payload for this webhook includes an action field that specifies the associated value of created, updated, or deleted.

Field	Data Type	Definition
`account_number`	String	The account number. This is normally a masked or partial account number.
`account_number_set_by`	String	The source that set the data for the account number.
`account_subtype`	String	The account’s subtype.
`account_subtype_set_by`	String	The source that set the data for the account subtype.
`account_type`	String	The specific type of account being received.
`account_type_set_by`	String	The source that set the data for the account type.
`apr`	Decimal	The annual percentage rate. Max length is 10,6.
`apr_set_by`	String	The source that set the data for the annual percentage rate.
`apy`	Decimal	The annual percentage yield. Max length is 10,6.
`apy_set_by`	String	The source that set the data for the annual percentage yield.
`available_balance`	Decimal	The current available account balance. The available balance is normally 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 for the available balance.
`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 for the available credit.
`balance`	Decimal	The current account balance. This is normally a positive value for all account types. An asset account (checking, savings, or investment) has a positive balance unless it’s in an overdraft condition, in which case the balance is negative. A debt account (credit card, loan, line of credit, or mortgage) has a positive balance when the user owes money on the account, and has a negative balance when the account is overpaid. Max length is 14,2.
`balance_set_by`	String	The source that set the data for the account balance.
`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 for the cash balance.
`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 for the cash surrender value.
`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 for the credit limit.
`currency_code`	String	The ISO 4217 currency code.
`currency_code_set_by`	String	The source that set the data for the currency code.
`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 for the payment day.
`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 for the death benefit.
`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 annual percentage rate, as provided by our data feed. Max length is 10,6.
`feed_apy`	Decimal	The annual percentage yield, 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 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 of the last payment, 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 start date of the loan or other debt account, 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 for the holdings value.
`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 for the interest rate.
`is_closed`	Boolean	Whether the account is closed.
`is_hidden`	Boolean	Whether the account has been hidden. If `true`, all linked transactions are also hidden.
`is_manual`	Boolean	Whether the account has been 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 for the last payment date.
`last_payment_set_by`	String	The source that set the data for the last payment amount.
`loan_amount`	Decimal	The amount of the loan. Max length is 14,2.
`loan_amount_set_by`	String	The source that set the data for the loan amount.
`matures_on`	String	The maturity date.
`matures_on_set_by`	String	The source that set the data for the maturity date.
`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	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 normally a positive value. Max length is 14,2.
`minimum_balance_set_by`	String	The source that set the data for the minimum balance.
`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 for the minimum payment.
`name`	String	The text that represents the name 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 for the name of the account.
`nickname`	String	An alternate name for the account.
`original_balance`	Decimal	The original balance. This is normally a positive value. Max length is 14,2.
`original_balance_set_by`	String	The source that set the data for the original balance.
`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 for the payment date and time.
`payoff_balance`	Decimal	The payoff balance. This is normally 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 for the payoff balance.
`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 for the start date of the loan or other debt account.
`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 for the total account value.
`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

JSON

POST /admin/webhooks
HTTP/1.1
content-type: application/json; charset=utf-8
accept: application/json
User-Agent: HTTPClient/1.0 (2.7.1, ruby 2.2.2
(2015-09-02)) Date: Thu, 14 Apr 2016 04:26:04 GMT Content-Length: 231
Host: abc.com
{
  "action": "deleted",
  "account": {
    "account_number": null,
    "account_number_set_by": null,
    "account_subtype": null,
    "account_subtype_set_by": null,
    "account_type": "INVESTMENT",
    "account_type_set_by": "USER",
    "apr": null,
    "apr_set_by": null,
    "apy": null,
    "apy_set_by": null,
    "available_balance": null,
    "available_balance_set_by": null,
    "available_credit": null,
    "available_credit_set_by": null,
    "balance": 1000,
    "balance_set_by": "FEED",
    "cash_balance": null,
    "cash_balance_set_by": null,
    "cash_surrender_value": null,
    "cash_surrender_value_set_by": null,
    "created_at": 1588006057,
    "credit_limit": null,
    "credit_limit_set_by": null,
    "currency_code": null,
    "currency_code_set_by": null,
    "day_payment_is_due": null,
    "day_payment_is_due_set_by": null,
    "death_benefit": null,
    "death_benefit_set_by": null,
    "feed_account_number": null,
    "feed_account_subtype": null,
    "feed_account_type": "INVESTMENT",
    "feed_apr": null,
    "feed_apy": null,
    "feed_available_balance": null,
    "feed_balance": 1000,
    "feed_cash_balance": null,
    "feed_cash_surrender_value": null,
    "feed_credit_limit": null,
    "feed_currency_code": null,
    "feed_day_payment_is_due": null,
    "feed_death_benefit": null,
    "feed_holdings_value": null,
    "feed_interest_rate": null,
    "feed_last_payment": null,
    "feed_last_payment_at": null,
    "feed_loan_amount": null,
    "feed_matures_on": null,
    "feed_minimum_balance": null,
    "feed_minimum_payment": null,
    "feed_name": null,
    "feed_original_balance": null,
    "feed_payment_due_at": null,
    "feed_payoff_balance": null,
    "feed_routing_number": null,
    "feed_started_on": null,
    "feed_total_account_value": null,
    "guid": "ACT-0950f510-a2de-4ea8-903f-494565b19432",
    "holdings_value": null,
    "holdings_value_set_by": null,
    "id": account-189ef902-6a74-4068-8107-fd3f24c8c661,
    "institution_guid": "INS-cb5c-1d48-741c-b30f4ddd1730",
    "interest_rate": null,
    "interest_rate_set_by": null,
    "is_closed": false,
    "is_hidden": false,
    "is_manual": false,
    "last_payment": null,
    "last_payment_at": null,
    "last_payment_at_set_by": null,
    "last_payment_set_by": null,
    "loan_amount": null,
    "loan_amount_set_by": null,
    "matures_on": null,
    "matures_on_set_by": null,
    "member_guid": "MBR-5ac1b3f8-7f76-495e-a4c1-32c4adc93c84",
    "member_id": null,
    "member_is_managed_by_user": true,
    "metadata": null,
    "minimum_balance": null,
    "minimum_balance_set_by": null,
    "minimum_payment": null,
    "minimum_payment_set_by": null,
    "name": "Gringotts Insurance",
    "name_set_by": "USER",
    "nickname": null,
    "original_balance": null,
    "original_balance_set_by": null,
    "payment_due_at": null,
    "payment_due_at_set_by": null,
    "payoff_balance": null,
    "payoff_balance_set_by": null,
    "property_type": null,
    "revision": 2,
    "routing_number": null,
    "started_on": null,
    "started_on_set_by": null,
    "total_account_value": null,
    "total_account_value_set_by": null,
    "updated_at": 1588006082,
    "user_guid": "USR-8b7af430-cb1a-455f-af94-7906926abf95",
    "user_id": "u-1234"
  }
}