Read account - MX Documentation

Read account

curl --request GET \
  --url https://int-api.mx.com/users/{user_guid}/accounts/{account_guid} \
  --header 'Accept-Version: <accept-version>' \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://int-api.mx.com/users/{user_guid}/accounts/{account_guid}"

headers = {
    "Accept-Version": "<accept-version>",
    "Authorization": "Basic <encoded-value>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'Accept-Version': '<accept-version>', Authorization: 'Basic <encoded-value>'}
};

fetch('https://int-api.mx.com/users/{user_guid}/accounts/{account_guid}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://int-api.mx.com/users/{user_guid}/accounts/{account_guid}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Accept-Version: <accept-version>",
    "Authorization: Basic <encoded-value>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://int-api.mx.com/users/{user_guid}/accounts/{account_guid}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Accept-Version", "<accept-version>")
	req.Header.Add("Authorization", "Basic <encoded-value>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://int-api.mx.com/users/{user_guid}/accounts/{account_guid}")
  .header("Accept-Version", "<accept-version>")
  .header("Authorization", "Basic <encoded-value>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://int-api.mx.com/users/{user_guid}/accounts/{account_guid}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Accept-Version"] = '<accept-version>'
request["Authorization"] = 'Basic <encoded-value>'

response = http.request(request)
puts response.read_body

{
  "account": {
    "account_number_display": "3331261",
    "subtype": "CHECKING",
    "type": "CHECKING",
    "guid": "ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1",
    "id": "1040434698",
    "name": "Test account 2",
    "nickname": "Swiss Account",
    "self": "/users/USR-11141024-90b3-1bce-cac9-c06ced52ab4c/accounts/ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1",
    "member": {
      "guid": "MBR-7c6f361b-e582-15b6-60c0-358f12466b4b",
      "id": "unique_id",
      "metadata": "some metadata",
      "name": "MX Bank",
      "self": "/users/USR-11141024-90b3-1bce-cac9-c06ced52ab4c/members/MBR-7c6f361b-e582-15b6-60c0-358f12466b4b"
    },
    "user": {
      "guid": "USR-11141024-90b3-1bce-cac9-c06ced52ab4c",
      "id": "unique_id",
      "metadata": "some metadata",
      "self": "/users/USR-11141024-90b3-1bce-cac9-c06ced52ab4c"
    },
    "mx_record": {
      "created_at": "2025-05-10T18:08:00Z",
      "updated_at": "2026-02-12T22:48:21Z"
    }
  }
}

GET

users

{user_guid}

accounts

{account_guid}

Read account

curl --request GET \
  --url https://int-api.mx.com/users/{user_guid}/accounts/{account_guid} \
  --header 'Accept-Version: <accept-version>' \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://int-api.mx.com/users/{user_guid}/accounts/{account_guid}"

headers = {
    "Accept-Version": "<accept-version>",
    "Authorization": "Basic <encoded-value>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'Accept-Version': '<accept-version>', Authorization: 'Basic <encoded-value>'}
};

fetch('https://int-api.mx.com/users/{user_guid}/accounts/{account_guid}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://int-api.mx.com/users/{user_guid}/accounts/{account_guid}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Accept-Version: <accept-version>",
    "Authorization: Basic <encoded-value>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://int-api.mx.com/users/{user_guid}/accounts/{account_guid}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Accept-Version", "<accept-version>")
	req.Header.Add("Authorization", "Basic <encoded-value>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://int-api.mx.com/users/{user_guid}/accounts/{account_guid}")
  .header("Accept-Version", "<accept-version>")
  .header("Authorization", "Basic <encoded-value>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://int-api.mx.com/users/{user_guid}/accounts/{account_guid}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Accept-Version"] = '<accept-version>'
request["Authorization"] = 'Basic <encoded-value>'

response = http.request(request)
puts response.read_body

{
  "account": {
    "account_number_display": "3331261",
    "subtype": "CHECKING",
    "type": "CHECKING",
    "guid": "ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1",
    "id": "1040434698",
    "name": "Test account 2",
    "nickname": "Swiss Account",
    "self": "/users/USR-11141024-90b3-1bce-cac9-c06ced52ab4c/accounts/ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1",
    "member": {
      "guid": "MBR-7c6f361b-e582-15b6-60c0-358f12466b4b",
      "id": "unique_id",
      "metadata": "some metadata",
      "name": "MX Bank",
      "self": "/users/USR-11141024-90b3-1bce-cac9-c06ced52ab4c/members/MBR-7c6f361b-e582-15b6-60c0-358f12466b4b"
    },
    "user": {
      "guid": "USR-11141024-90b3-1bce-cac9-c06ced52ab4c",
      "id": "unique_id",
      "metadata": "some metadata",
      "self": "/users/USR-11141024-90b3-1bce-cac9-c06ced52ab4c"
    },
    "mx_record": {
      "created_at": "2025-05-10T18:08:00Z",
      "updated_at": "2026-02-12T22:48:21Z"
    }
  }
}

Authorizations

Authorization

string

header

required

To authenticate with the Platform API, include your Base64-encoded client_id and api_key in the Authorization header of every request:

-H 'Authorization: Basic BASE_64_ENCODING_OF{client_id:api_key}'

Headers

Accept-Version

string

default:v20260929

required

MX Platform API version.

Example:

"v20260929"

Path Parameters

account_guid

string

required

The unique id for an account.

user_guid

string

required

The unique identifier for a user, beginning with the prefix USR-.

Response

200 - application/json

account

object

The base fields for an account. Returned as the account companion on related resources such as transactions, statements, and rewards, and as the foundation of full account responses.

Hide child attributes

account.account_number_display

string | null

The account number associated with the account. This will typically be a masked or partial account number.

Example:

"3331261"

account.subtype

string | null

The account's subtype, for example, PLAN_401_K, MONEY_MARKET, or HOME_EQUITY. Each subtype belongs to an account type. For a full list of account subtypes and types, see Accounts.

Example:

"CHECKING"

account.type

enum<string> | null

The type of account. Some account types may include subtypes. For a full list of account types and subtypes, see Account Types.

Available options:

ANY,

CASH,

CHECKING,

CHECKING_LINE_OF_CREDIT,

CREDIT_CARD,

LOAN,

LINE_OF_CREDIT,

SAVINGS,

INVESTMENT,

MORTGAGE,

INSURANCE,

PREPAID,

PROPERTY

Example:

"CHECKING"

account.guid

string | null

Unique identifier for the account. Defined by MX.

Example:

"ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1"

account.id

string | null

The unique partner-defined identifier for the account.

Example:

"1040434698"

account.name

string

The human-readable name for the account.

Example:

"Test account 2"

account.nickname

string

An alternate name for the account.

Example:

"Swiss Account"

account.self

string

The API URI path for the account.

Example:

"/users/USR-11141024-90b3-1bce-cac9-c06ced52ab4c/accounts/ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1"

account.member

object

The base fields for a member, which is a user's connection to an institution. Returned as the member companion on related resources such as accounts and transactions, and as the foundation of full member responses.

Hide child attributes

account.member.guid

string

The unique identifier for the member. Defined by MX.

Example:

"MBR-7c6f361b-e582-15b6-60c0-358f12466b4b"

account.member.id

string | null

The unique partner-defined identifier for the member.

Example:

"unique_id"

account.member.metadata

string | null

Additional information you can store about the member.

Example:

"some metadata"

account.member.name

string | null

The name of the member.

Example:

"MX Bank"

account.member.self

string

The API URI path for the member.

Example:

"/users/USR-11141024-90b3-1bce-cac9-c06ced52ab4c/members/MBR-7c6f361b-e582-15b6-60c0-358f12466b4b"

account.user

object

The base fields for a user. Returned as the user companion on related resources such as members, accounts, and transactions, and as the foundation of full user responses.

Hide child attributes

account.user.guid

string

The unique identifier for the user. Defined by MX.

Example:

"USR-11141024-90b3-1bce-cac9-c06ced52ab4c"

account.user.id

string | null

The unique partner-defined identifier for the user.

Example:

"unique_id"

account.user.metadata

string | null

Additional information you can store about the user.

Example:

"some metadata"

account.user.self

string

The API URI path for the user.

Example:

"/users/USR-11141024-90b3-1bce-cac9-c06ced52ab4c"

account.mx_record

object

Timestamps for when MX created and last updated the record. Returned as the mx_record companion on all resources persisted by MX. These describe the MX record, not the underlying resource at the institution.

Hide child attributes

account.mx_record.created_at

string | null

The date and time the resource was created in MX Platform, represented in ISO 8601 format with a timestamp.

Example:

"2025-05-10T18:08:00Z"

account.mx_record.updated_at

string | null

The date and time the resource was last updated in MX Platform, represented in ISO 8601 format with a timestamp.

For categories, this field will always be null when is_default is true.

Example:

"2026-02-12T22:48:21Z"