Balance Checks

Get the available balance for an end user's financial accounts

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 Check 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

Quick Links

API Reference

Learn about the full features of the Platform API.

Go to Reference

Account Sample Data

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


_51{
_51  "account": {
_51    "account_number": "****0001",
_51    "apr": null,
_51    "apy": null,
_51    "available_balance": 500000,
_51    "available_credit": null,
_51    "balance": 500000,
_51    "cash_balance": null,
_51    "cash_surrender_value": null,
_51    "created_at": "2020-09-21T19:43:44Z",
_51    "credit_limit": null,
_51    "currency_code": null,
_51    "day_payment_is_due": 12,
_51    "death_benefit": null,
_51    "guid": "ACT-82a93692-f756-534f-9b2e-ad10a0f38462",
_51    "holdings_value": null,
_51    "id": "act-23445745",
_51    "imported_at": "2023-02-24T09:01:25Z",
_51    "institution_code": "mxbank",
_51    "insured_name": null,
_51    "interest_rate": null,
_51    "is_closed": false,
_51    "is_hidden": false,
_51    "last_payment": null,
_51    "last_payment_at": null,
_51    "loan_amount": null,
_51    "matures_on": null,
_51    "member_guid": "MBR-84ca0882-ad6c-4f10-817f-c8c0de7424fa",
_51    "member_id": null,
_51    "member_is_managed_by_user": true,
_51    "metadata": null,
_51    "minimum_balance": null,
_51    "minimum_payment": null,
_51    "name": "Checking",
_51    "nickname": null,
_51    "original_balance": null,
_51    "pay_out_amount": null,
_51    "payment_due_at": "2021-05-12T16:01:00Z",
_51    "payoff_balance": null,
_51    "premium_amount": null,
_51    "routing_number": "005026788",
_51    "started_on": null,
_51    "subtype": null,
_51    "total_account_value": null,
_51    "type": "CHECKING",
_51    "updated_at": "2023-02-24T09:01:25Z",
_51    "user_guid": "USR-11141024-90b3-1bce-cac9-c06ced52ab4c",
_51    "user_id": "partner-2345"
_51  }
_51}