Create manual accounts

curl --request POST \
  --url https://int-data.moneydesktop.com/accounts \
  --header 'Content-Type: application/vnd.mx.nexus.v1+json' \
  --header 'MD-SESSION-TOKEN: <api-key>' \
  --data '{}'

{
  "account": {
    "account_number": "4921710685",
    "account_number_set_by": 1,
    "account_number_set_by_name": "FEED",
    "account_subtype": null,
    "account_subtype_name": null,
    "account_subtype_set_by": null,
    "account_subtype_set_by_name": null,
    "account_type": 1,
    "account_type_name": "CHECKING",
    "account_type_set_by": 1,
    "account_type_set_by_name": "FEED",
    "apr": null,
    "apr_set_by": null,
    "apr_set_by_name": null,
    "apy": null,
    "apy_set_by": null,
    "apy_set_by_name": null,
    "available_balance": 500000,
    "available_balance_set_by": 1,
    "available_balance_set_by_name": "FEED",
    "available_credit": null,
    "available_credit_set_by": null,
    "available_credit_set_by_name": null,
    "balance": 500000,
    "balance_set_by": 1,
    "balance_set_by_name": "FEED",
    "calculated_apr": null,
    "cash_balance": null,
    "cash_balance_set_by": null,
    "cash_balance_set_by_name": null,
    "cash_surrender_value": null,
    "cash_surrender_value_set_by": null,
    "cash_surrender_value_set_by_name": null,
    "created_at": "2020-09-21T19:43:44+00:00",
    "credit_limit": null,
    "credit_limit_set_by": null,
    "credit_limit_set_by_name": null,
    "currency_code": null,
    "currency_code_set_by": null,
    "currency_code_set_by_name": null,
    "day_payment_is_due": 12,
    "day_payment_is_due_set_by": 1,
    "day_payment_is_due_set_by_name": "FEED",
    "death_benefit": null,
    "death_benefit_set_by": null,
    "death_benefit_set_by_name": null,
    "external_guid": "23445745",
    "feed_account_number": "4921710685",
    "feed_account_subtype": null,
    "feed_account_subtype_name": null,
    "feed_account_type": 1,
    "feed_account_type_name": "CHECKING",
    "feed_apr": null,
    "feed_apy": null,
    "feed_available_balance": 500000,
    "feed_balance": 500000,
    "feed_cash_balance": null,
    "feed_cash_surrender_value": null,
    "feed_credit_limit": null,
    "feed_currency_code": null,
    "feed_day_payment_is_due": 12,
    "feed_death_benefit": null,
    "feed_holdings_value": null,
    "feed_interest_rate": null,
    "feed_is_closed": 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": "Checking",
    "feed_nickname": null,
    "feed_original_balance": null,
    "feed_payment_due_at": "2021-05-12T16:01:00+00:00",
    "feed_payoff_balance": null,
    "feed_routing_number": null,
    "feed_started_on": null,
    "feed_statement_balance": null,
    "feed_total_account_value": null,
    "guid": "ACT-8e6f92c8-1491-42ce-8bf6-c309e9531530",
    "holdings_value": null,
    "holdings_value_set_by": null,
    "holdings_value_set_by_name": null,
    "institution_guid": "INS-1572a04c-912b-59bf-5841-332c7dfafaef",
    "insured_name": null,
    "interest_rate": null,
    "interest_rate_set_by": null,
    "interest_rate_set_by_name": null,
    "is_business": false,
    "is_closed": false,
    "is_closed_set_by": 3,
    "is_closed_set_by_name": "SYSTEM",
    "is_hidden": false,
    "is_manual": false,
    "last_payment": null,
    "last_payment_at": null,
    "last_payment_at_set_by": null,
    "last_payment_at_set_by_name": null,
    "last_payment_set_by": null,
    "last_payment_set_by_name": null,
    "loan_amount": null,
    "loan_amount_set_by": null,
    "loan_amount_set_by_name": null,
    "matures_on": null,
    "matures_on_set_by": null,
    "matures_on_set_by_name": null,
    "member_guid": "MBR-84ca0882-ad6c-4f10-817f-c8c0de7424fa",
    "member_is_managed_by_user": true,
    "metadata": null,
    "minimum_balance": null,
    "minimum_balance_set_by": null,
    "minimum_balance_set_by_name": null,
    "minimum_payment": null,
    "minimum_payment_set_by": null,
    "minimum_payment_set_by_name": null,
    "name": "Checking",
    "name_set_by": 1,
    "name_set_by_name": "FEED",
    "nickname": null,
    "nickname_set_by": null,
    "nickname_set_by_name": null,
    "original_balance": null,
    "original_balance_set_by": null,
    "original_balance_set_by_name": null,
    "pay_out_amount": null,
    "payment_due_at": "2021-05-12T16:01:00+00:00",
    "payment_due_at_set_by": 1,
    "payment_due_at_set_by_name": "FEED",
    "payoff_balance": null,
    "payoff_balance_set_by": null,
    "payoff_balance_set_by_name": null,
    "premium_amount": null,
    "property_type": null,
    "property_type_name": null,
    "revision": 648,
    "routing_number": null,
    "started_on": null,
    "started_on_set_by": null,
    "started_on_set_by_name": null,
    "statement_balance": null,
    "statement_balance_set_by": null,
    "statement_balance_set_by_name": null,
    "total_account_value": null,
    "total_account_value_set_by": null,
    "total_account_value_set_by_name": null,
    "updated_at": "2022-06-14T21:17:09+00:00",
    "user_guid": "USR-11141024-90b3-1bce-cac9-c06ced52ab4c"
  }
}

POST

accounts

curl --request POST \
  --url https://int-data.moneydesktop.com/accounts \
  --header 'Content-Type: application/vnd.mx.nexus.v1+json' \
  --header 'MD-SESSION-TOKEN: <api-key>' \
  --data '{}'

{
  "account": {
    "account_number": "4921710685",
    "account_number_set_by": 1,
    "account_number_set_by_name": "FEED",
    "account_subtype": null,
    "account_subtype_name": null,
    "account_subtype_set_by": null,
    "account_subtype_set_by_name": null,
    "account_type": 1,
    "account_type_name": "CHECKING",
    "account_type_set_by": 1,
    "account_type_set_by_name": "FEED",
    "apr": null,
    "apr_set_by": null,
    "apr_set_by_name": null,
    "apy": null,
    "apy_set_by": null,
    "apy_set_by_name": null,
    "available_balance": 500000,
    "available_balance_set_by": 1,
    "available_balance_set_by_name": "FEED",
    "available_credit": null,
    "available_credit_set_by": null,
    "available_credit_set_by_name": null,
    "balance": 500000,
    "balance_set_by": 1,
    "balance_set_by_name": "FEED",
    "calculated_apr": null,
    "cash_balance": null,
    "cash_balance_set_by": null,
    "cash_balance_set_by_name": null,
    "cash_surrender_value": null,
    "cash_surrender_value_set_by": null,
    "cash_surrender_value_set_by_name": null,
    "created_at": "2020-09-21T19:43:44+00:00",
    "credit_limit": null,
    "credit_limit_set_by": null,
    "credit_limit_set_by_name": null,
    "currency_code": null,
    "currency_code_set_by": null,
    "currency_code_set_by_name": null,
    "day_payment_is_due": 12,
    "day_payment_is_due_set_by": 1,
    "day_payment_is_due_set_by_name": "FEED",
    "death_benefit": null,
    "death_benefit_set_by": null,
    "death_benefit_set_by_name": null,
    "external_guid": "23445745",
    "feed_account_number": "4921710685",
    "feed_account_subtype": null,
    "feed_account_subtype_name": null,
    "feed_account_type": 1,
    "feed_account_type_name": "CHECKING",
    "feed_apr": null,
    "feed_apy": null,
    "feed_available_balance": 500000,
    "feed_balance": 500000,
    "feed_cash_balance": null,
    "feed_cash_surrender_value": null,
    "feed_credit_limit": null,
    "feed_currency_code": null,
    "feed_day_payment_is_due": 12,
    "feed_death_benefit": null,
    "feed_holdings_value": null,
    "feed_interest_rate": null,
    "feed_is_closed": 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": "Checking",
    "feed_nickname": null,
    "feed_original_balance": null,
    "feed_payment_due_at": "2021-05-12T16:01:00+00:00",
    "feed_payoff_balance": null,
    "feed_routing_number": null,
    "feed_started_on": null,
    "feed_statement_balance": null,
    "feed_total_account_value": null,
    "guid": "ACT-8e6f92c8-1491-42ce-8bf6-c309e9531530",
    "holdings_value": null,
    "holdings_value_set_by": null,
    "holdings_value_set_by_name": null,
    "institution_guid": "INS-1572a04c-912b-59bf-5841-332c7dfafaef",
    "insured_name": null,
    "interest_rate": null,
    "interest_rate_set_by": null,
    "interest_rate_set_by_name": null,
    "is_business": false,
    "is_closed": false,
    "is_closed_set_by": 3,
    "is_closed_set_by_name": "SYSTEM",
    "is_hidden": false,
    "is_manual": false,
    "last_payment": null,
    "last_payment_at": null,
    "last_payment_at_set_by": null,
    "last_payment_at_set_by_name": null,
    "last_payment_set_by": null,
    "last_payment_set_by_name": null,
    "loan_amount": null,
    "loan_amount_set_by": null,
    "loan_amount_set_by_name": null,
    "matures_on": null,
    "matures_on_set_by": null,
    "matures_on_set_by_name": null,
    "member_guid": "MBR-84ca0882-ad6c-4f10-817f-c8c0de7424fa",
    "member_is_managed_by_user": true,
    "metadata": null,
    "minimum_balance": null,
    "minimum_balance_set_by": null,
    "minimum_balance_set_by_name": null,
    "minimum_payment": null,
    "minimum_payment_set_by": null,
    "minimum_payment_set_by_name": null,
    "name": "Checking",
    "name_set_by": 1,
    "name_set_by_name": "FEED",
    "nickname": null,
    "nickname_set_by": null,
    "nickname_set_by_name": null,
    "original_balance": null,
    "original_balance_set_by": null,
    "original_balance_set_by_name": null,
    "pay_out_amount": null,
    "payment_due_at": "2021-05-12T16:01:00+00:00",
    "payment_due_at_set_by": 1,
    "payment_due_at_set_by_name": "FEED",
    "payoff_balance": null,
    "payoff_balance_set_by": null,
    "payoff_balance_set_by_name": null,
    "premium_amount": null,
    "property_type": null,
    "property_type_name": null,
    "revision": 648,
    "routing_number": null,
    "started_on": null,
    "started_on_set_by": null,
    "started_on_set_by_name": null,
    "statement_balance": null,
    "statement_balance_set_by": null,
    "statement_balance_set_by_name": null,
    "total_account_value": null,
    "total_account_value_set_by": null,
    "total_account_value_set_by_name": null,
    "updated_at": "2022-06-14T21:17:09+00:00",
    "user_guid": "USR-11141024-90b3-1bce-cac9-c06ced52ab4c"
  }
}

Creating a manual account will automatically create it under the Manual Institution member. Since a manual account has no credentials tied to the member, the account will never aggregate or include data from a data feed. This endpoint accepts the optional MX-Skip-Webhook header and skip_webhook parameter.

Authorizations

MD-SESSION-TOKEN

string

header

required

MX Session Token

Request an API token using the read API token endpoint in the MX SSO API.
Exchange an API token for a session token.
- A session token is obtained by sending a POST request to /sessions
- The session token will be used in each request made for the user. It should be passed in an MD-SESSION-TOKEN HTTP header as shown below.
- This session token is valid for 30 minutes from the time it was created. The 30 minute expiration counter is refreshed with each call.
- If you send a request with an expired session token you'll receive an error code of 4011.

curl -i https://int-data.moneydesktop.com/accounts \
-H 'MD-SESSION-TOKEN: CWforZl1Vn2vC_v6H4rnQRT1DoWpDouJAV-_5TBmiQRAtA8rsOG_BoajTiOSsL0A3bd-bmHXlA-eQzc9ywItKg' \
-H 'Content-Type: application/vnd.mx.nexus.v1+json' \
-H 'Accept: application/vnd.mx.nexus.v1+json'

In documentation code examples, replace <API_KEY_VALUE> with the session token.

Headers

MD-SESSION-TOKEN

string

required

Body

application/vnd.mx.nexus.v1+json

account

object

Hide child attributes

account.account_type_name

string

required

The name of the account type. Either account_type_name or account_type is required but not both.

Example:

"PROPERTY"

account.account_type

string

required

Account type of the account. Either account_type or account_type_name is required but not both.

Example:

"PROPERTY"

account.name

string

required

The name for the account.

Example:

"Checking"

account.account_subtype_name

string

The name of the account subtype.

Example:

"PERSONAL"

account.available_balance

number

Available balance of the account.

Example:

1000

account.apr

number

Annual Percentage Rate (e.g. 2.99% is passed as 2.99). Max length is 10,6. See Number Limits.

Example:

1

account.apy

number

Annual Percentage Yield (e.g. 2.99% is passed as 2.99). Max length is 10,6. See Number Limits.

Example:

1

account.balance

number

The available amount in the account.

Example:

1000

account.cash_surrender_value

number

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. See Number Limits.

Example:

1000

account.credit_limit

number

The credit limit of the account.

Example:

100

account.currency_code

string

The ISO 4217 three-character currency code.

Example:

"USD"

account.death_benefit

integer

Amount paid to the beneficiary of the account upon death of the account owner. Max length is 14,2. See Number Limits.

Example:

1000

account.interest_rate

number

Interest rate (e.g. 2.99% is passed as 2.99). Max length is 10,6. See Number Limits.

Example:

1

account.is_closed

boolean

Marks the account as closed.

Example:

false

account.is_hidden

boolean

Determines if the account's data is excluded.

Example:

false

account.loan_amount

number

Amount of the loan. Max length is 14,2. See Number Limits.

Example:

1000

account.metadata

string

Additional information a partner can store on the account.

Example:

"some metadata"

account.nickname

string

The Nickname is an alternate name for the account. This value is visible to the user and must be human-readable.

Example:

"Swiss Account"

account.original_balance

number

The original balance of the account.

Example:

10

account.property_type

string

Subtype if the account type is PROPERTY. This field should be ignored unless the account_type is set to PROPERTY.

Example:

"VEHICLE"

account.property_type_name

string

Subtype name if the account type is PROPERTY. This field should be ignored unless the account_type is set to PROPERTY.

Example:

"VEHICLE"

account.skip_webhook

boolean

Example:

true

Response

200 - application/vnd.mx.nexus.v1+json

account

object

Hide child attributes

account.account_number

string

The account number, as provided by our data feed.

Example:

"4921710685"

account.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

account.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"

account.account_subtype

integer

The integer value of the account subtype.

Example:

null

account.account_subtype_name

string

The account subtype (for example, PLAN_401_K, MONEY_MARKET, or HOME_EQUITY).

Example:

null

account.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

account.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

account.account_type

integer

The integer value of the account type.

Example:

1

account.account_type_name

string

The account type (for example, CHECKING, SAVINGS, CREDIT_CARD).

Example:

"CHECKING"

account.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

account.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"

account.apr

number

Example:

null

account.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

account.apr_set_by_name

string

The source that set the data (FEED, USER, or SYSTEM). See Account Set By for more information.

Example:

null

account.apy

number

Example:

null

account.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

account.apy_set_by_name

string

The source that set the data (FEED, USER, or SYSTEM). See Account Set By for more information.

Example:

null

account.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

account.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

account.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"

account.available_credit

number

The amount of credit available for the account. Max length is 14,2. See Number Limits.

Example:

null

account.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

account.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

account.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

account.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

account.balance_set_by_name

string

The source that set the data (FEED, USER, or SYSTEM). See Account Set By for more information.

Example:

"FEED"

account.calculated_apr

number

Example:

null

account.cash_balance

number

The total cash balance for brokerage and investment accounts. Max length is 14,2. See Number Limits.

Example:

null

account.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

account.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

account.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

account.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

account.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

account.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"

account.credit_limit

number

The credit limit of the account.

Example:

null

account.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

account.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

account.currency_code

string

The currency code associated with the account (for example, USD, EUR).

Example:

null

account.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

account.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

account.day_payment_is_due

integer

The day of the month the payment is due.

Example:

12

account.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

account.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"

account.death_benefit

integer

The death benefit amount for the account. Applies primarily to insurance account types.

Example:

null

account.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

account.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

account.external_guid

string

Example:

"23445745"

account.feed_account_number

string

The account number, as provided by our data feed.

Example:

"4921710685"

account.feed_account_subtype

integer

Example:

null

account.feed_account_subtype_name

string

Example:

null

account.feed_account_type

integer

Example:

1

account.feed_account_type_name

string

Example:

"CHECKING"

account.feed_apr

number

Example:

null

account.feed_apy

number

Example:

null

account.feed_available_balance

integer

Example:

500000

account.feed_balance

integer

Example:

500000

account.feed_cash_balance

number

Example:

null

account.feed_cash_surrender_value

number

Example:

null

account.feed_credit_limit

number

Example:

null

account.feed_currency_code

string

Example:

null

account.feed_day_payment_is_due

integer

Example:

12

account.feed_death_benefit

integer

Example:

null

account.feed_holdings_value

number

Example:

null

account.feed_interest_rate

number

Example:

null

account.feed_is_closed

boolean

Example:

null

account.feed_last_payment

number

Example:

null

account.feed_last_payment_at

string

Example:

null

account.feed_loan_amount

number

Example:

null

account.feed_matures_on

string

Example:

null

account.feed_minimum_balance

number

Example:

null

account.feed_minimum_payment

number

Example:

null

account.feed_name

string

The name of the account, as provided by our data feed.

Example:

"Checking"

account.feed_nickname

string

Example:

null

account.feed_original_balance

number

The original balance, as provided by our data feed. Max length is 14,2. See Number Limits.

Example:

null

account.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"

account.feed_payoff_balance

number

The payoff balance, as provided by our data feed. Max length is 14,2. See Number Limits.

Example:

null

account.feed_routing_number

string

The routing number, as provided by our data feed. See routing_number for more information.

Example:

null

account.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

account.feed_statement_balance

number

The account statement balance, as provided by our data feed. Max length is 14,2. See Number Limits.

Example:

null

account.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

account.guid

string

Unique identifier for the account. Defined by MX.

Example:

"ACT-8e6f92c8-1491-42ce-8bf6-c309e9531530"

account.holdings_value

number

The value of holdings with this account.

Example:

null

account.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

account.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

account.institution_guid

string

Unique identifier for the institution the account is attached to. Defined by MX.

Example:

"INS-1572a04c-912b-59bf-5841-332c7dfafaef"

account.insured_name

string

The name of the insured individual.

Example:

null

account.interest_rate

number

Interest rate (e.g. 2.99% is passed as 2.99). Max length is 10,6. See Number Limits.

Example:

null

account.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

account.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

account.is_business

boolean

Example:

false

account.is_closed

boolean

If an account is closed, this field will be true. Otherwise, this field will be false.

Example:

false

account.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

account.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"

account.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

account.is_manual

boolean

If an account was manually created, this field will be true. Otherwise, this field will be false.

Example:

false

account.last_payment

number

Amount of the account's last payment. Max length is 10,2. See Number Limits.

Example:

null

account.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

account.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

account.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

account.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

account.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

account.loan_amount

number

Amount of the loan. Max length is 14,2. See Number Limits.

Example:

null

account.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

account.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

account.matures_on

string

Maturity date. Represented in ISO 8601 format (for example, 2011-03-28).

Example:

null

account.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

account.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

account.member_guid

string

Unique identifier for the member the account is attached to. Defined by MX.

Example:

"MBR-84ca0882-ad6c-4f10-817f-c8c0de7424fa"

account.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

account.metadata

string

Additional information a partner can store on the account.

Example:

null

account.minimum_balance

number

The minimum balance allowed. Max length is 14,2. See Number Limits.

Example:

null

account.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

account.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

account.minimum_payment

number

Minimum payment amount. Max length is 10,2. See Number Limits.

Example:

null

account.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

account.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

account.name

string

The name of the account.

Example:

"Checking"

account.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

account.name_set_by_name

string

The source that set the data (FEED, USER, or SYSTEM). See Account Set By for more information.

Example:

"FEED"

account.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

account.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

account.nickname_set_by_name

string

The source that set the data (FEED, USER, or SYSTEM). See Account Set By for more information.

Example:

null

account.original_balance

number

The original balance of the account. Max length is 14,2. See Number Limits.

Example:

null

account.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

account.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

account.pay_out_amount

string

The payout amount for insurance accounts.

Example:

null

account.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"

account.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

account.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"

account.payoff_balance

number

The payoff balance of the account. Max length is 14,2. See Number Limits.

Example:

null

account.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

account.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

account.premium_amount

string

The premium amount for insurance accounts.

Example:

null

account.property_type

integer

The integer value of the property type. See Property Types for more information.

Example:

null

account.property_type_name

string

The property type name (for example, REAL_ESTATE, VEHICLE). See Property Types for more information.

Example:

null

account.revision

integer

The revision number of this account record.

Example:

648

account.routing_number

string

The routing number for the account.

Example:

null

account.started_on

string

The started on date. Represented in ISO 8601 format (for example, 2011-03-28).

Example:

null

account.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

account.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

account.statement_balance

number

The account statement balance. Max length is 14,2. See Number Limits.

Example:

null

account.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

account.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

account.total_account_value

number

Example:

null

account.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

account.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

account.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"

account.user_guid

string

Unique identifier for the user the account is attached to. Defined by MX.

Example:

"USR-11141024-90b3-1bce-cac9-c06ced52ab4c"

Accounts Overview

List all accounts