Atrium API

Read an Account

Reading an account allows you to get information about a specific account that belongs to a user. That includes the account type — e.g., CHECKING, MONEY_MARKET, or PROPERTY — the balance, the date the account was started, and much more.

There are two endpoints for reading an account. Both will return the same information.

GET

/users/{user_guid}/accounts/{account_guid}

GET

/users/{user_guid}/members/{member_guid}/accounts/{account_guid}

Request sample

Request

Alternate_Request

Language:shell


_10curl -i 'https://vestibule.mx.com/users/{user_guid}/accounts/{account_guid}' \
_10  -H 'Accept: application/vnd.mx.atrium.v1+json' \
_10  -H 'MX-API-Key: {mx_api_key}' \
_10  -H 'MX-Client-ID: {mx_client_id}'

Response sample

200

Language:json


_42{
_42  "account": {
_42    "account_number": null,
_42    "apr": null,
_42    "apy": 1.43,
_42    "available_balance": 1000.23,
_42    "available_credit": 100.23,
_42    "balance": 1000.23,
_42    "cash_balance": 1000.32,
_42    "cash_surrender_value": 1000.23,
_42    "created_at": "2016-10-13T17:57:37+00:00",
_42    "credit_limit": 100.23,
_42    "currency_code": "USD",
_42    "day_payment_is_due": 20,
_42    "death_benefit": 1000.12,
_42    "guid": "ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1",
_42    "holdings_value": 1000.21,
_42    "insured_name": null,
_42    "institution_code": "mxbank",
_42    "interest_rate": null,
_42    "is_closed": false,
_42    "last_payment": null,
_42    "last_payment_at": null,
_42    "loan_amount": null,
_42    "matures_on": null,
_42    "member_guid": "MBR-7c6f361b-e582-15b6-60c0-358f12466b4b",
_42    "minimum_balance": null,
_42    "minimum_payment": null,
_42    "name": "Test Account 2",
_42    "original_balance": null,
_42    "payment_due_at": null,
_42    "payoff_balance": null,
_42    "pay_out_amount": null,
_42    "premium_amount": null,
_42    "started_on": null,
_42    "subtype": null,
_42    "total_account_value": null,
_42    "type": "SAVINGS",
_42    "updated_at": "2016-10-13T18:08:00+00:00",
_42    "user_guid": "USR-fa7537f3-48aa-a683-a02a-b18940482f54"
_42  }
_42}