curl -i 'https://vestibule.mx.com/users/{user_guid}/accounts/{account_guid}' \ -H 'Accept: application/vnd.mx.atrium.v1+json' \ -H 'MX-API-Key: {mx_api_key}' \ -H 'MX-Client-ID: {mx_client_id}'
{
"account": {
"account_number": null,
"apr": null,
"apy": 1.43,
"available_balance": 1000.23,
"available_credit": 100.23,
"balance": 1000.23,
"cash_balance": 1000.32,
"cash_surrender_value": 1000.23,
"created_at": "2016-10-13T17:57:37+00:00",
"credit_limit": 100.23,
"currency_code": "USD",
"day_payment_is_due": 20,
"death_benefit": 1000.12,
"guid": "ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1",
"holdings_value": 1000.21,
"insured_name": 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-7c6f361b-e582-15b6-60c0-358f12466b4b",
"minimum_balance": null,
"minimum_payment": null,
"name": "Test Account 2",
"original_balance": null,
"payment_due_at": null,
"payoff_balance": null,
"pay_out_amount": null,
"premium_amount": null,
"started_on": null,
"subtype": null,
"total_account_value": null,
"type": "SAVINGS",
"updated_at": "2016-10-13T18:08:00+00:00",
"user_guid": "USR-fa7537f3-48aa-a683-a02a-b18940482f54"
}
}
Accounts
Read an Account
This endpoint returns information about a specific account.
GET
/
users
/
{user_guid}
/
accounts
/
{account_guid}
curl -i 'https://vestibule.mx.com/users/{user_guid}/accounts/{account_guid}' \ -H 'Accept: application/vnd.mx.atrium.v1+json' \ -H 'MX-API-Key: {mx_api_key}' \ -H 'MX-Client-ID: {mx_client_id}'
{
"account": {
"account_number": null,
"apr": null,
"apy": 1.43,
"available_balance": 1000.23,
"available_credit": 100.23,
"balance": 1000.23,
"cash_balance": 1000.32,
"cash_surrender_value": 1000.23,
"created_at": "2016-10-13T17:57:37+00:00",
"credit_limit": 100.23,
"currency_code": "USD",
"day_payment_is_due": 20,
"death_benefit": 1000.12,
"guid": "ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1",
"holdings_value": 1000.21,
"insured_name": 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-7c6f361b-e582-15b6-60c0-358f12466b4b",
"minimum_balance": null,
"minimum_payment": null,
"name": "Test Account 2",
"original_balance": null,
"payment_due_at": null,
"payoff_balance": null,
"pay_out_amount": null,
"premium_amount": null,
"started_on": null,
"subtype": null,
"total_account_value": null,
"type": "SAVINGS",
"updated_at": "2016-10-13T18:08:00+00:00",
"user_guid": "USR-fa7537f3-48aa-a683-a02a-b18940482f54"
}
}
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.
curl -i 'https://vestibule.mx.com/users/{user_guid}/accounts/{account_guid}' \ -H 'Accept: application/vnd.mx.atrium.v1+json' \ -H 'MX-API-Key: {mx_api_key}' \ -H 'MX-Client-ID: {mx_client_id}'
{
"account": {
"account_number": null,
"apr": null,
"apy": 1.43,
"available_balance": 1000.23,
"available_credit": 100.23,
"balance": 1000.23,
"cash_balance": 1000.32,
"cash_surrender_value": 1000.23,
"created_at": "2016-10-13T17:57:37+00:00",
"credit_limit": 100.23,
"currency_code": "USD",
"day_payment_is_due": 20,
"death_benefit": 1000.12,
"guid": "ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1",
"holdings_value": 1000.21,
"insured_name": 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-7c6f361b-e582-15b6-60c0-358f12466b4b",
"minimum_balance": null,
"minimum_payment": null,
"name": "Test Account 2",
"original_balance": null,
"payment_due_at": null,
"payoff_balance": null,
"pay_out_amount": null,
"premium_amount": null,
"started_on": null,
"subtype": null,
"total_account_value": null,
"type": "SAVINGS",
"updated_at": "2016-10-13T18:08:00+00:00",
"user_guid": "USR-fa7537f3-48aa-a683-a02a-b18940482f54"
}
}
⌘I