Account Endpoints - MX Documentation

Account Fields

Field Name	Data Type	Definition
`account_number`	String	The account number. This will typically be a masked or partial account number.
`apr`	Decimal	Annual Percentage Rate. Max length is 10,6.
`apy`	Decimal	Annual Percentage Yield. Max length is 10,6.
`available_balance`	Decimal	The balance currently available in an account. Max length is 14,2.
`available_credit`	Decimal	The currently available credit balance of an account. This field is for accounts with types `CREDIT CARD` and `LINE OF CREDIT`.
`balance`	Decimal	An account’s current balance. Max length is 14,2.
`cash_balance`	Decimal	The cash balance of the account. Max length is 14,2.
`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.
`created_at`	String	The date and time the account was created.
`credit_card_product_guid`	String	The unique identifier for the `credit_card_product` associated with the account. Defined by MX.
`credit_limit`	Decimal	The credit limit for the account. Max length is 10,2.
`currency_code`	String	The ISO 4217 currency code. For example, `USD`.
`current_reward_level`	String	The current level of reward program associated with the account, such as `silver`, `jade`, or `platinum`.
`day_payment_is_due`	Integer	The day of the month the payment is due. Max length is 2. So, for example, the 14th is passed as `14`).
`death_benefit`	Decimal	Amount paid to the beneficiary of the account upon death of the account owner. Max length is 14,2.
`enrolled_in_rewards_on`	String	The date on which the account was enrolled in a rewards program.
`guid`	String	Unique identifier for the account. Defined by MX.
`holdings_value`	Decimal	The value of the holdings associated with the account.
`institution_code`	String	Unique identifier for the financial institution which holds the account. Defined by MX.
`interest_rate`	Decimal	Interest rate. Max length is 10,6.
`is_closed`	Boolean	If an account is closed, this field will be true. Otherwise, this field will be false.
`last_payment_at`	String	The date and time the last payment toward a debt account was applied.
`last_payment`	Decimal	The amount of the last payment made on a debt account, such as an account of type `CREDIT CARD` or `MORTGAGE`. Max length is 10,2.
`loan_amount`	Decimal	The amount of the loan. Max length is 14,2.
`matures_on`	String	Date on which an account matures.
`member_guid`	String	Unique identifier for the member to which this account belongs. Defined by MX.
`minimum_balance`	Decimal	Minimum required balance for the account. This is normally a positive number. Max length is 14,2.
`minimum_payment`	Decimal	The minimum payment required for an account. This can apply to any debt account. Max length is 10,2.
`name`	String	This must be a human-readable name for the account. It will be visible to the user.
`next_reward_level`	String	The next level of reward program for which the account is eligible, such as `silver`, `jade`, or `platinum`.
`original_balance`	Decimal	The original balance on an account. This will be a positive value. Max length is 14,2.
`payment_due_at`	String	The date and time the next payment on a debt account is due.
`payoff_balance`	Decimal	Payoff Balance (positive value normally). Can apply to any debt account. Max length is 14,2.
`primary_reward_unit`	String	The unit type for the reward program associated with the `account`, for example, `MILES` or `POINTS`.
`started_on`	String	The date on which a debt account was started.
`subtype`	String	The account’s subtype, such as `PLAN_401_K`, `MONEY_MARKET`, or `HOME_EQUITY`.
`total_account_value`	Decimal	The total value of the account. Max length is 14,2.
`type`	String	The main type of the account, such as `INVESTMENT`, `PREPAID`, or `SAVINGS`.
`updated_at`	String	The date and time at which the account was last updated.
`user_guid`	String	A unique identifier for the user to which the account belongs. Defined by MX.

Read An Account

INFOThis section uses the read account endpoint as an example, but rewards-related fields will be returned with any request that returns an account or list of accounts — so long as you’re using the beta accept header.

An account represents a financial account held by a financial institution, like a user’s checking or savings account. An account belongs to a member, which represents the user’s overall relationship with a particular financial institution. A checking account may be just one part of a larger relationship that could also include a car loan and a savings account. It’s important to remember that balance and available_balance will normally be positive numbers — for all account types. But this should be interpreted differently for debt accounts and asset accounts. An asset account (such as savings, checking, or investment) has a positive balance unless it is in an overdraft condition, in which case the balance is negative. On the other hand, a debt account (such as a credit card, loan, or mortgage) has a positive balance when the user owes money on the account and a negative balance when the account has been overpaid. Five fields that are especially important for rewards and credit card products: credit_card_product_guid, enrolled_in_rewards_on, primary_reward_unit, current_reward_level, and next_reward_level. Endpoint: GET /users/{user_guid}/accounts/{account_guid}

$ curl -i -X GET 'https://vestibule.mx.com/users/members/{member_guid}/accounts/{account_guid}' \
  -H 'Accept: application/vnd.mx.atrium.beta+json' \
  -H 'MX-API-Key: {mx_api_key}' \
  -H 'MX-Client-ID: {mx_client_id}'

{
  "account": {
    "account_number": null,
    "apr": null,
    "apy": null,
    "available_balance": 1000,
    "available_credit": null,
    "balance": 1000,
    "cash_balance": null,
    "cash_surrender_value": null,
    "created_at": "2019-06-07T21:16:01Z",
    "credit_card_product_guid": "CCA-b5bcd822-6d01-4e23-b8d6-846a225e714a",
    "credit_limit": null,
    "currency_code": null,
    "current_reward_level": null,
    "day_payment_is_due": null,
    "death_benefit": null,
    "enrolled_in_rewards_on": "2019-06-07",
    "guid": "ACT-481fa472-bb3e-47b5-954d-1cd296261d5d",
    "holdings_value": null,
    "institution_code": "mxbank",
    "interest_rate": null,
    "is_closed": false,
    "last_payment": null,
    "last_payment_at": null,
    "loan_amount": null,
    "matures_on": null,
    "member_guid": "MBR-a4652b66-3ee5-cb9f-295a-72eddef61db5",
    "minimum_balance": null,
    "minimum_payment": null,
    "name": "Test Account 3",
    "next_reward_level": null,
    "original_balance": null,
    "payment_due_at": null,
    "payoff_balance": null,
    "primary_reward_unit": null,
    "started_on": null,
    "subtype": null,
    "total_account_value": null,
    "type": "INVESTMENT",
    "updated_at": "2019-06-07T21:16:01Z",
    "user_guid": "USR-72aba5cc-8c74-b22c-227c-4b1c095fa12e"
  }
}

​Account Fields

​Read An Account

Account Fields

Read An Account