A user represents an end-user accessing the MX Platform API via your application, be it a mobile app, web app, desktop app, etc.

Read Account

Endpoint: GET /users/:user_guid/accounts/:account_guid

This endpoint returns the specified account resource.

Parameters

For the Request

Example Request

curl -X GET /users/:user_guid/accounts/:account_guid \\
  -H 'Content-Type: application/json' \\
	-H "Authorization: Bearer {access_token}" 

Response

{
  "account": {
    "account_number": "5366",
    "apr": null,
    "apy": null,
    "available_balance": null,
    "available_credit": 327.01,
    "balance": 1872.99,
    "cash_balance": null,
    "cash_surrender_value": null,
    "created_at": "2020-08-04T21:27:47Z",
    "credit_limit": null,
    "currency_code": "USD",
    "day_payment_is_due": null,
    "death_benefit": null,
    "guid": "ACT-82a93692-f756-534f-9b2e-ad10534f9b2e",
    "holdings_value": null,
    "id": "104055120",
    "imported_at": "2021-08-01T12:00:47Z",
    "institution_code": "chase",
    "insured_name": null,
    "interest_rate": null,
    "is_closed": false,
    "is_hidden": false,
    "last_payment": null,
    "last_payment_at": null,
    "loan_amount": null,
    "matures_on": null,
    "member_guid": "MBR-0b2121f5-bf4f-4244-a697-cac64244a697",
    "member_id": "1505009123",
    "member_is_managed_by_user": true,
    "metadata": null,
    "minimum_balance": null,
    "minimum_payment": null,
    "name": "CREDIT CARD",
    "nickname": null,
    "original_balance": null,
    "pay_out_amount": null,
    "payment_due_at": null,
    "payoff_balance": null,
    "premium_amount": null,
    "routing_number": null,
    "started_on": null,
    "subtype": "NONE",
    "total_account_value": null,
    "type": "CREDIT_CARD",
    "updated_at": "2021-01-15T17:09:09Z",
    "user_guid": "USR-11a448aa-5e7b-70db-45d6-d6927092043e",
    "user_id": "U-107895"
  }
}

List account numbers by account

Endpoint: GET /users/:user_guid/accounts/:account_guid/account_numbers

This endpoint returns a list of account numbers associated with the specified account.

Parameters

For the Request

Example Request

curl -X GET /users/:user_guid/accounts/:account_guid/account_numbers \\
  -H 'Content-Type: application/json' \\
	-H "Authorization: Bearer {access_token}" \\

Response