Balance Checks - MX Documentation

NEW TO MX CONNECTIVITY?See the Connectivity Overview to learn about our Connectivity products and integration options.

Integrate using the Connect Widget

Use the Connect Widget and Platform API to let end users connect to their accounts.

Integrate using the Platform API

Use the Platform API to power a non-MX UI connection experience.

With Balance Checks you can connect to an end user’s financial institution and retrieve the available balance for an account, as well as a lot of other information about that account. Unlike Account Aggregation, this product does not pull in transaction data. This makes Balance Checks perfect for use cases like money movement or account opening where such data is not needed.

Diagram flow of the steps to get account statements

Account Sample Data

Read account

Returns the attributes of a specific account.

This sample response shows the kinds of data you can expect to get for financial accounts when using Balance Checks.

{
  "account": {
    "account_number": "5366",
    "apr": 1.0,
    "apy": 1.0,
    "available_balance": 1000.0,
    "available_credit": 1000.0,
    "balance": 1000.0,
    "cash_balance": 1000.0,
    "cash_surrender_value": 1000.0,
    "created_at": "2016-10-13T17:57:37.000Z",
    "credit_limit": 100.0,
    "currency_code": "USD",
    "day_payment_is_due": 20,
    "death_benefit": 1000,
    "guid": "ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1",
    "holdings_value": 1000.0,
    "id": "1040434698",
    "imported_at": "2015-10-13T17:57:37.000Z",
    "institution_code": "chase",
    "interest_rate": 1.0,
    "is_closed": false,
    "is_hidden": false,
    "last_payment": 100.0,
    "last_payment_at": "2015-10-13T17:57:37.000Z",
    "loan_amount": 1000.0,
    "member_guid": "MBR-3bdc7d6b-efd4-1497-a0af-b23501cf9bd0",
    "member_is_managed_by_user": false,
    "metadata": "some metadata",
    "minimum_balance": 100.0,
    "minimum_payment": 10.0,
    "name": "Test account 2",
    "nickname": "My Checking",
    "original_balance": 10.0,
    "payment_due_at": "2015-10-13T17:57:37.000Z",
    "payoff_balance": 10.0,
    "routing_number": "68899990000000",
    "started_on": "2015-10-13T17:57:37.000Z",
    "subtype": "NONE",
    "total_account_value": 1.0,
    "type": "SAVINGS",
    "updated_at": "2016-10-13T18:08:00.000Z",
    "user_guid": "USR-11141024-90b3-1bce-cac9-c06ced52ab4c",
    "user_id": "partner-2345"
  }
}

Integrate using the Connect Widget

Integrate using the Platform API

​Account Sample Data

Read account

Account Sample Data