Merge accounts

curl --request POST \
  --url https://int-api.mx.com/users/{user_guid}/accounts/merge \
  --header 'Accept-Version: <accept-version>' \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "account_guids": [
    "ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1",
    "ACT-e1b1e9e7-9436-4720-a1b5-f02373433bd4"
  ]
}
'

import requests

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

payload = { "account_guids": ["ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1", "ACT-e1b1e9e7-9436-4720-a1b5-f02373433bd4"] }
headers = {
    "Accept-Version": "<accept-version>",
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'Accept-Version': '<accept-version>',
    Authorization: 'Basic <encoded-value>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    account_guids: [
      'ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1',
      'ACT-e1b1e9e7-9436-4720-a1b5-f02373433bd4'
    ]
  })
};

fetch('https://int-api.mx.com/users/{user_guid}/accounts/merge', 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/merge",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'account_guids' => [
        'ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1',
        'ACT-e1b1e9e7-9436-4720-a1b5-f02373433bd4'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Accept-Version: <accept-version>",
    "Authorization: Basic <encoded-value>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

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

	payload := strings.NewReader("{\n  \"account_guids\": [\n    \"ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1\",\n    \"ACT-e1b1e9e7-9436-4720-a1b5-f02373433bd4\"\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Accept-Version", "<accept-version>")
	req.Header.Add("Authorization", "Basic <encoded-value>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://int-api.mx.com/users/{user_guid}/accounts/merge")
  .header("Accept-Version", "<accept-version>")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/json")
  .body("{\n  \"account_guids\": [\n    \"ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1\",\n    \"ACT-e1b1e9e7-9436-4720-a1b5-f02373433bd4\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["Accept-Version"] = '<accept-version>'
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"account_guids\": [\n    \"ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1\",\n    \"ACT-e1b1e9e7-9436-4720-a1b5-f02373433bd4\"\n  ]\n}"

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

{
  "account": {
    "account_number": "3331261",
    "account_number_set_by": 1,
    "account_ownership": "INDIVIDUAL",
    "annuity_policy_to_date": "2025-12-31",
    "annuity_provider": "Metlife",
    "annuity_term_year": 30,
    "apr": 1,
    "apr_set_by": 1,
    "apy": 2.35,
    "apy_set_by": 1,
    "available_balance": 1000,
    "available_balance_set_by": 1,
    "available_credit": 4000,
    "available_credit_set_by": 1,
    "balance": 1000,
    "balance_set_by": 1,
    "calculated_apr": 19.99,
    "cash_balance": 2500,
    "cash_balance_set_by": 1,
    "cash_surrender_value": 1000,
    "cash_surrender_value_set_by": 1,
    "created_at": "2025-02-13T18:08:00+00:00",
    "credit_limit": 5000,
    "credit_limit_set_by": 1,
    "currency_code": "USD",
    "currency_code_set_by": 1,
    "day_payment_is_due": 14,
    "day_payment_is_due_set_by": 1,
    "death_benefit": 1000,
    "death_benefit_set_by": 1,
    "federal_insurance_status": "INSURED",
    "feed_account_number": "**** 1234",
    "feed_account_subtype": 2,
    "feed_account_type": 2,
    "feed_apr": 19.99,
    "feed_apy": 1.25,
    "feed_available_balance": 1000.23,
    "feed_balance": 1000.23,
    "feed_cash_balance": 50.5,
    "feed_cash_surrender_value": 1200,
    "feed_credit_limit": 5000,
    "feed_currency_code": "USD",
    "feed_day_payment_is_due": 15,
    "feed_death_benefit": 100000,
    "feed_holdings_value": 3000,
    "feed_interest_rate": 3.5,
    "feed_is_closed": false,
    "feed_last_payment": 200,
    "feed_last_payment_at": "2024-01-01T12:00:00.000Z",
    "feed_loan_amount": 20000,
    "feed_matures_on": "2034-01-15",
    "feed_minimum_balance": 100,
    "feed_minimum_payment": 35,
    "feed_name": "Savings",
    "feed_nickname": "Savings nickname",
    "feed_original_balance": 25000,
    "feed_payment_due_at": "2024-02-01T12:00:00.000Z",
    "feed_payoff_balance": 18000,
    "feed_routing_number": "091000019",
    "feed_started_on": "2024-01-15",
    "feed_statement_balance": 950,
    "feed_total_account_value": 4000,
    "guid": "ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1",
    "holdings_value": 3000,
    "holdings_value_set_by": 1,
    "id": "1040434698",
    "imported_at": "2015-10-13T17:57:37.000Z",
    "institution_code": "3af3685e-05d9-7060-359f-008d0755e993",
    "institution_guid": "INS-1572a04c-912b-59bf-5841-332c7dfafaef",
    "insured_name": "Tommy Shelby",
    "interest_rate": 3.25,
    "interest_rate_set_by": 1,
    "is_closed": false,
    "is_closed_set_by": 1,
    "is_hidden": false,
    "is_manual": false,
    "last_payment": 100,
    "last_payment_at": "2023-07-25T17:14:46Z",
    "last_payment_at_set_by": 1,
    "last_payment_set_by": 1,
    "loan_amount": 1000,
    "loan_amount_set_by": 1,
    "margin_balance": 1000,
    "matures_on": "2015-10-13T17:57:37.000Z",
    "matures_on_set_by": 1,
    "member_guid": "MBR-7c6f361b-e582-15b6-60c0-358f12466b4b",
    "member_id": "member123",
    "member_is_managed_by_user": false,
    "metadata": "some metadata",
    "minimum_balance": 100,
    "minimum_balance_set_by": 1,
    "minimum_payment": 10,
    "minimum_payment_set_by": 1,
    "name": "Test account 2",
    "name_set_by": 1,
    "nickname": "My Checking",
    "nickname_set_by": 1,
    "original_balance": 10,
    "original_balance_set_by": 1,
    "pay_out_amount": 10,
    "payment_due_at": "2015-10-13T17:57:37.000Z",
    "payment_due_at_set_by": 1,
    "payoff_balance": 10,
    "payoff_balance_set_by": 1,
    "premium_amount": 1,
    "property_type": "VEHICLE",
    "routing_number": "68899990000000",
    "started_on": "2025-10-13T17:57:37.000Z",
    "started_on_set_by": 1,
    "statement_balance": 1000.5,
    "statement_balance_set_by": 1,
    "subtype": "MONEY_MARKET",
    "subtype_set_by": 1,
    "today_ugl_amount": 1000.5,
    "today_ugl_percentage": 6.9,
    "total_account_value": 1,
    "total_account_value_set_by": 1,
    "total_account_value_ugl": 1,
    "type": "CHECKING",
    "type_set_by": 1,
    "updated_at": "2025-02-13T18:09:00+00:00",
    "user_guid": "USR-fa7537f3-48aa-a683-a02a-b18940482f54",
    "user_id": "u-1234",
    "feed_is_business": false,
    "is_business": false
  }
}

POST

users

{user_guid}

accounts

merge

Merge accounts

curl --request POST \
  --url https://int-api.mx.com/users/{user_guid}/accounts/merge \
  --header 'Accept-Version: <accept-version>' \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "account_guids": [
    "ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1",
    "ACT-e1b1e9e7-9436-4720-a1b5-f02373433bd4"
  ]
}
'

import requests

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

payload = { "account_guids": ["ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1", "ACT-e1b1e9e7-9436-4720-a1b5-f02373433bd4"] }
headers = {
    "Accept-Version": "<accept-version>",
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'Accept-Version': '<accept-version>',
    Authorization: 'Basic <encoded-value>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    account_guids: [
      'ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1',
      'ACT-e1b1e9e7-9436-4720-a1b5-f02373433bd4'
    ]
  })
};

fetch('https://int-api.mx.com/users/{user_guid}/accounts/merge', 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/merge",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'account_guids' => [
        'ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1',
        'ACT-e1b1e9e7-9436-4720-a1b5-f02373433bd4'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Accept-Version: <accept-version>",
    "Authorization: Basic <encoded-value>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

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

	payload := strings.NewReader("{\n  \"account_guids\": [\n    \"ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1\",\n    \"ACT-e1b1e9e7-9436-4720-a1b5-f02373433bd4\"\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Accept-Version", "<accept-version>")
	req.Header.Add("Authorization", "Basic <encoded-value>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://int-api.mx.com/users/{user_guid}/accounts/merge")
  .header("Accept-Version", "<accept-version>")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/json")
  .body("{\n  \"account_guids\": [\n    \"ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1\",\n    \"ACT-e1b1e9e7-9436-4720-a1b5-f02373433bd4\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["Accept-Version"] = '<accept-version>'
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"account_guids\": [\n    \"ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1\",\n    \"ACT-e1b1e9e7-9436-4720-a1b5-f02373433bd4\"\n  ]\n}"

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

{
  "account": {
    "account_number": "3331261",
    "account_number_set_by": 1,
    "account_ownership": "INDIVIDUAL",
    "annuity_policy_to_date": "2025-12-31",
    "annuity_provider": "Metlife",
    "annuity_term_year": 30,
    "apr": 1,
    "apr_set_by": 1,
    "apy": 2.35,
    "apy_set_by": 1,
    "available_balance": 1000,
    "available_balance_set_by": 1,
    "available_credit": 4000,
    "available_credit_set_by": 1,
    "balance": 1000,
    "balance_set_by": 1,
    "calculated_apr": 19.99,
    "cash_balance": 2500,
    "cash_balance_set_by": 1,
    "cash_surrender_value": 1000,
    "cash_surrender_value_set_by": 1,
    "created_at": "2025-02-13T18:08:00+00:00",
    "credit_limit": 5000,
    "credit_limit_set_by": 1,
    "currency_code": "USD",
    "currency_code_set_by": 1,
    "day_payment_is_due": 14,
    "day_payment_is_due_set_by": 1,
    "death_benefit": 1000,
    "death_benefit_set_by": 1,
    "federal_insurance_status": "INSURED",
    "feed_account_number": "**** 1234",
    "feed_account_subtype": 2,
    "feed_account_type": 2,
    "feed_apr": 19.99,
    "feed_apy": 1.25,
    "feed_available_balance": 1000.23,
    "feed_balance": 1000.23,
    "feed_cash_balance": 50.5,
    "feed_cash_surrender_value": 1200,
    "feed_credit_limit": 5000,
    "feed_currency_code": "USD",
    "feed_day_payment_is_due": 15,
    "feed_death_benefit": 100000,
    "feed_holdings_value": 3000,
    "feed_interest_rate": 3.5,
    "feed_is_closed": false,
    "feed_last_payment": 200,
    "feed_last_payment_at": "2024-01-01T12:00:00.000Z",
    "feed_loan_amount": 20000,
    "feed_matures_on": "2034-01-15",
    "feed_minimum_balance": 100,
    "feed_minimum_payment": 35,
    "feed_name": "Savings",
    "feed_nickname": "Savings nickname",
    "feed_original_balance": 25000,
    "feed_payment_due_at": "2024-02-01T12:00:00.000Z",
    "feed_payoff_balance": 18000,
    "feed_routing_number": "091000019",
    "feed_started_on": "2024-01-15",
    "feed_statement_balance": 950,
    "feed_total_account_value": 4000,
    "guid": "ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1",
    "holdings_value": 3000,
    "holdings_value_set_by": 1,
    "id": "1040434698",
    "imported_at": "2015-10-13T17:57:37.000Z",
    "institution_code": "3af3685e-05d9-7060-359f-008d0755e993",
    "institution_guid": "INS-1572a04c-912b-59bf-5841-332c7dfafaef",
    "insured_name": "Tommy Shelby",
    "interest_rate": 3.25,
    "interest_rate_set_by": 1,
    "is_closed": false,
    "is_closed_set_by": 1,
    "is_hidden": false,
    "is_manual": false,
    "last_payment": 100,
    "last_payment_at": "2023-07-25T17:14:46Z",
    "last_payment_at_set_by": 1,
    "last_payment_set_by": 1,
    "loan_amount": 1000,
    "loan_amount_set_by": 1,
    "margin_balance": 1000,
    "matures_on": "2015-10-13T17:57:37.000Z",
    "matures_on_set_by": 1,
    "member_guid": "MBR-7c6f361b-e582-15b6-60c0-358f12466b4b",
    "member_id": "member123",
    "member_is_managed_by_user": false,
    "metadata": "some metadata",
    "minimum_balance": 100,
    "minimum_balance_set_by": 1,
    "minimum_payment": 10,
    "minimum_payment_set_by": 1,
    "name": "Test account 2",
    "name_set_by": 1,
    "nickname": "My Checking",
    "nickname_set_by": 1,
    "original_balance": 10,
    "original_balance_set_by": 1,
    "pay_out_amount": 10,
    "payment_due_at": "2015-10-13T17:57:37.000Z",
    "payment_due_at_set_by": 1,
    "payoff_balance": 10,
    "payoff_balance_set_by": 1,
    "premium_amount": 1,
    "property_type": "VEHICLE",
    "routing_number": "68899990000000",
    "started_on": "2025-10-13T17:57:37.000Z",
    "started_on_set_by": 1,
    "statement_balance": 1000.5,
    "statement_balance_set_by": 1,
    "subtype": "MONEY_MARKET",
    "subtype_set_by": 1,
    "today_ugl_amount": 1000.5,
    "today_ugl_percentage": 6.9,
    "total_account_value": 1,
    "total_account_value_set_by": 1,
    "total_account_value_ugl": 1,
    "type": "CHECKING",
    "type_set_by": 1,
    "updated_at": "2025-02-13T18:09:00+00:00",
    "user_guid": "USR-fa7537f3-48aa-a683-a02a-b18940482f54",
    "user_id": "u-1234",
    "feed_is_business": false,
    "is_business": false
  }
}

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

user_guid

string

required

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

Body

application/json

account_guids

string[]

required

A list of account GUIDs to merge. Must include at least two GUIDs belonging to the same user.

Minimum array length: 2

Example:

[
  "ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1",
  "ACT-e1b1e9e7-9436-4720-a1b5-f02373433bd4"
]

Response

200 - application/json

account

object

required

Hide child attributes

account.account_number

string | null

required

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

Example:

"3331261"

account.account_number_set_by

integer | null

required

Who last set account_number, as the raw Atlas::SetBy enum number (0 unspecified, 1 feed, 2 user, 3 system).

Example:

1

account.account_ownership

enum<string> | null

required

The type of ownership associated with the account. NULL is returned if not received in the data feed.

Available options:

UNKNOWN,

INDIVIDUAL,

JOINT,

MULTIPLE,

null

Example:

"INDIVIDUAL"

account.annuity_policy_to_date

string | null

required

The date until which the policy is in effect.

Example:

"2025-12-31"

account.annuity_provider

string | null

required

The provider of the insurance policy.

Example:

"Metlife"

account.annuity_term_year

integer | null

required

The effective duration of an insurance policy (one year, five years, etc.).

Example:

30

account.apr

number | null

required

The annual percentage rate associated with the account.

Example:

1

account.apr_set_by

integer | null

required

Who last set apr, as the raw Atlas::SetBy enum number (0 unspecified, 1 feed, 2 user, 3 system).

Example:

1

account.apy

number | null

required

The annual percentage yield associated with the account.

Example:

2.35

account.apy_set_by

integer | null

required

Who last set apy, as the raw Atlas::SetBy enum number (0 unspecified, 1 feed, 2 user, 3 system).

Example:

1

account.available_balance

number | null

required

The balance that is available for use in asset accounts like checking and savings.

PENDING transactions are typically (not always) taken into account with the available balance.

available_balance will usually be a positive value for all account types, determined in the same way as the balance field.

Example:

1000

account.available_balance_set_by

integer | null

required

Who last set available_balance, as the raw Atlas::SetBy enum number (0 unspecified, 1 feed, 2 user, 3 system).

Example:

1

account.available_credit

number | null

required

The amount of credit available for use in liability accounts like credit cards and lines of credit.

PENDING transactions are typically (not always) taken into account with available credit.

available_credit will usually be a positive value for all account types, determined in the same way as the balance field.

Example:

4000

account.available_credit_set_by

integer | null

required

Who last set available_credit, as the raw Atlas::SetBy enum number (0 unspecified, 1 feed, 2 user, 3 system).

Example:

1

account.balance

number | null

required

The current balance of the account.

PENDING transactions are typically not taken into account with the current balance, but this may not always be the case.

The balance will usually be a positive value for all account types. Asset-type accounts (CHECKING, SAVINGS, INVESTMENT) may have a negative balance if they are in overdraft.

Debt-type accounts (CREDIT_CARD, LOAN, LINE_OF_CREDIT, MORTGAGE) may have a negative balance if they are overpaid.

Example:

1000

account.balance_set_by

integer | null

required

Who last set balance, as the raw Atlas::SetBy enum number (0 unspecified, 1 feed, 2 user, 3 system).

Example:

1

account.calculated_apr

number | null

required

The APR calculated by MX from the account's data.

Example:

19.99

account.cash_balance

number | null

required

The cash balance of the account.

Example:

2500

account.cash_balance_set_by

integer | null

required

Who last set cash_balance, as the raw Atlas::SetBy enum number (0 unspecified, 1 feed, 2 user, 3 system).

Example:

1

account.cash_surrender_value

number | null

required

The sum of money paid to the policyholder or annuity holder in the event the policy is voluntarily terminated before it matures, or the insured event occurs.

Example:

1000

account.cash_surrender_value_set_by

integer | null

required

Who last set cash_surrender_value, as the raw Atlas::SetBy enum number (0 unspecified, 1 feed, 2 user, 3 system).

Example:

1

account.created_at

string

required

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

Example:

"2025-02-13T18:08:00+00:00"

account.credit_limit

number | null

required

The credit limit associated with the account.

Example:

5000

account.credit_limit_set_by

integer | null

required

Who last set credit_limit, as the raw Atlas::SetBy enum number (0 unspecified, 1 feed, 2 user, 3 system).

Example:

1

account.currency_code

string | null

required

The three-character ISO 4217 currency code, for example, USD.

Example:

"USD"

account.currency_code_set_by

integer | null

required

Who last set currency_code, as the raw Atlas::SetBy enum number (0 unspecified, 1 feed, 2 user, 3 system).

Example:

1

account.day_payment_is_due

integer | null

required

The day of the month the payment is due. For example, the 14th is passed as 14.

Example:

14

account.day_payment_is_due_set_by

integer | null

required

Who last set day_payment_is_due, as the raw Atlas::SetBy enum number (0 unspecified, 1 feed, 2 user, 3 system).

Example:

1

account.death_benefit

integer | null

required

The amount paid to the beneficiary of the account upon death of the account owner.

Example:

1000

account.death_benefit_set_by

integer | null

required

Who last set death_benefit, as the raw Atlas::SetBy enum number (0 unspecified, 1 feed, 2 user, 3 system).

Example:

1

account.federal_insurance_status

enum<string> | null

required

The federal insurance status of the account. Indicates whether the account is insured by the FDIC (banks) or NCUA (credit unions).

Returns an integer (UNKNOWN_INSURED = 0, INSURED = 1, NOT_INSURED = 2).

Available options:

UNKNOWN_INSURED,

INSURED,

NOT_INSURED,

null

Example:

"INSURED"

account.feed_account_number

string | null

required

The account_number value reported by the data feed.

Example:

"**** 1234"

account.feed_account_subtype

integer | null

required

The account subtype reported by the data feed, as the raw Atlas enum number.

Example:

2

account.feed_account_type

integer | null

required

The account type reported by the data feed, as the raw Atlas enum number.

Example:

2

account.feed_apr

number | null

required

The apr value reported by the data feed.

Example:

19.99

account.feed_apy

number | null

required

The apy value reported by the data feed.

Example:

1.25

account.feed_available_balance

number | null

required

The available_balance value reported by the data feed.

Example:

1000.23

account.feed_balance

number | null

required

The balance value reported by the data feed.

Example:

1000.23

account.feed_cash_balance

number | null

required

The cash_balance value reported by the data feed.

Example:

50.5

account.feed_cash_surrender_value

number | null

required

The cash_surrender_value value reported by the data feed.

Example:

1200

account.feed_credit_limit

number | null

required

The credit_limit value reported by the data feed.

Example:

5000

account.feed_currency_code

string | null

required

The currency_code value reported by the data feed.

Example:

"USD"

account.feed_day_payment_is_due

integer | null

required

The day_payment_is_due value reported by the data feed.

Example:

15

account.feed_death_benefit

integer | null

required

The death_benefit value reported by the data feed.

Example:

100000

account.feed_holdings_value

number | null

required

The holdings_value value reported by the data feed.

Example:

3000

account.feed_interest_rate

number | null

required

The interest_rate value reported by the data feed.

Example:

3.5

account.feed_is_closed

boolean | null

required

The is_closed value reported by the data feed.

Example:

false

account.feed_last_payment

number | null

required

The last_payment value reported by the data feed.

Example:

200

account.feed_last_payment_at

string | null

required

The last_payment_at value reported by the data feed, in ISO 8601 format with a timestamp.

Example:

"2024-01-01T12:00:00.000Z"

account.feed_loan_amount

number | null

required

The loan_amount value reported by the data feed.

Example:

20000

account.feed_matures_on

string | null

required

The matures_on value reported by the data feed, in ISO 8601 format without a timestamp.

Example:

"2034-01-15"

account.feed_minimum_balance

number | null

required

The minimum_balance value reported by the data feed.

Example:

100

account.feed_minimum_payment

number | null

required

The minimum_payment value reported by the data feed.

Example:

35

account.feed_name

string | null

required

The name value reported by the data feed.

Example:

"Savings"

account.feed_nickname

string | null

required

The nickname value reported by the data feed.

Example:

"Savings nickname"

account.feed_original_balance

number | null

required

The original_balance value reported by the data feed.

Example:

25000

account.feed_payment_due_at

string | null

required

The payment_due_at value reported by the data feed, in ISO 8601 format with a timestamp.

Example:

"2024-02-01T12:00:00.000Z"

account.feed_payoff_balance

number | null

required

The payoff_balance value reported by the data feed.

Example:

18000

account.feed_routing_number

string | null

required

The routing_number value reported by the data feed.

Example:

"091000019"

account.feed_started_on

string | null

required

The started_on value reported by the data feed, in ISO 8601 format without a timestamp.

Example:

"2024-01-15"

account.feed_statement_balance

number | null

required

The statement_balance value reported by the data feed.

Example:

950

account.feed_total_account_value

number | null

required

The total_account_value value reported by the data feed.

Example:

4000

account.guid

string | null

required

Unique identifier for the account. Defined by MX.

Example:

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

account.holdings_value

number | null

required

The total value of the account's holdings.

Example:

3000

account.holdings_value_set_by

integer | null

required

Who last set holdings_value, as the raw Atlas::SetBy enum number (0 unspecified, 1 feed, 2 user, 3 system).

Example:

1

account.id

string | null

required

The unique partner-defined identifier for the account.

Example:

"1040434698"

account.imported_at

string | null

required

The date and time at which the account was last successfully aggregated and received data.

Example:

"2015-10-13T17:57:37.000Z"

account.institution_code

string | null

required

The code identifying a financial institution.

Example:

"3af3685e-05d9-7060-359f-008d0755e993"

account.institution_guid

string | null

required

The unique identifier for the institution associated with the account. Defined by MX.

Example:

"INS-1572a04c-912b-59bf-5841-332c7dfafaef"

account.insured_name

string | null

required

The name of the insured person.

Example:

"Tommy Shelby"

account.interest_rate

number | null

required

The interest rate associated with the account.

Example:

3.25

account.interest_rate_set_by

integer | null

required

Who last set interest_rate, as the raw Atlas::SetBy enum number (0 unspecified, 1 feed, 2 user, 3 system).

Example:

1

account.is_closed

boolean

required

Indicates whether an account has been closed. Closed accounts will no longer update balance or transaction information.

Example:

false

account.is_closed_set_by

integer | null

required

Who last set is_closed, as the raw Atlas::SetBy enum number (0 unspecified, 1 feed, 2 user, 3 system).

Example:

1

account.is_hidden

boolean | null

required

Indicates whether the account is hidden. Hidden accounts can still have an active balance and receive transactions. Defaults to false.

Example:

false

account.is_manual

boolean | null

required

Indicates whether the transaction was manually created or belongs to a manual account.

Example:

false

account.last_payment

number | null

required

The amount of the most recent payment on the account.

Example:

100

account.last_payment_at

string | null

required

The date and time when the last payment was made, represented in ISO 8601 format with a timestamp.

Example:

"2023-07-25T17:14:46Z"

account.last_payment_at_set_by

integer | null

required

Who last set last_payment_at, as the raw Atlas::SetBy enum number (0 unspecified, 1 feed, 2 user, 3 system).

Example:

1

account.last_payment_set_by

integer | null

required

Who last set last_payment, as the raw Atlas::SetBy enum number (0 unspecified, 1 feed, 2 user, 3 system).

Example:

1

account.loan_amount

number | null

required

The amount of the loan associated with the account.

Example:

1000

account.loan_amount_set_by

integer | null

required

Who last set loan_amount, as the raw Atlas::SetBy enum number (0 unspecified, 1 feed, 2 user, 3 system).

Example:

1

account.margin_balance

number | null

required

Represents the amount of debt the investor owes to the broker for the use of margin. It can be positive or negative, depending on the performance of the investments made with the borrowed funds. A positive margin balance indicates that the securities purchased on margin have increased in value, whereas a negative margin balance signifies that the securities have decreased in value.

Example:

1000

account.matures_on

string | null

required

The date on which the account matures.

Example:

"2015-10-13T17:57:37.000Z"

account.matures_on_set_by

integer | null

required

Who last set matures_on, as the raw Atlas::SetBy enum number (0 unspecified, 1 feed, 2 user, 3 system).

Example:

1

account.member_guid

string | null

required

The unique identifier for the member. Defined by MX.

Example:

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

account.member_id

string | null

required

The unique, partner-defined, identifier for the member associated with this account.

Example:

"member123"

account.member_is_managed_by_user

boolean | null

required

This indicates whether the member is managed by the user or the MX partner. Members created with the managed member feature will have this field set to false.

Example:

false

account.metadata

string | null

required

Additional information you stored about the account.

Example:

"some metadata"

account.minimum_balance

number | null

required

The minimum balance associated with the account.

Example:

100

account.minimum_balance_set_by

integer | null

required

Who last set minimum_balance, as the raw Atlas::SetBy enum number (0 unspecified, 1 feed, 2 user, 3 system).

Example:

1

account.minimum_payment

number | null

required

The minimum payment required for an account. This can apply to any debt account.

Example:

10

account.minimum_payment_set_by

integer | null

required

Who last set minimum_payment, as the raw Atlas::SetBy enum number (0 unspecified, 1 feed, 2 user, 3 system).

Example:

1

account.name

string | null

required

The human-readable name for the resource.

Example:

"Test account 2"

account.name_set_by

integer | null

required

Who last set name, as the raw Atlas::SetBy enum number (0 unspecified, 1 feed, 2 user, 3 system).

Example:

1

account.nickname

string | null

required

An alternate name for the account.

Example:

"My Checking"

account.nickname_set_by

integer | null

required

Who last set nickname, as the raw Atlas::SetBy enum number (0 unspecified, 1 feed, 2 user, 3 system).

Example:

1

account.original_balance

number | null

required

The original balance associated with the account. This will always be positive.

Example:

10

account.original_balance_set_by

integer | null

required

Who last set original_balance, as the raw Atlas::SetBy enum number (0 unspecified, 1 feed, 2 user, 3 system).

Example:

1

account.pay_out_amount

number | null

required

The amount paid out to the insured individual or beneficiary under the conditions of the insurance policy.

Example:

10

account.payment_due_at

string | null

required

The date and time at which the next payment is due on the account.

Example:

"2015-10-13T17:57:37.000Z"

account.payment_due_at_set_by

integer | null

required

Who last set payment_due_at, as the raw Atlas::SetBy enum number (0 unspecified, 1 feed, 2 user, 3 system).

Example:

1

account.payoff_balance

number | null

required

The payoff balance for a debt account. This will normally be a positive number.

Example:

10

account.payoff_balance_set_by

integer | null

required

Who last set payoff_balance, as the raw Atlas::SetBy enum number (0 unspecified, 1 feed, 2 user, 3 system).

Example:

1

account.premium_amount

number | null

required

The insurance policy's premium amount.

Example:

1

account.property_type

enum<string> | null

required

Subtype if the account type is PROPERTY. This field should be ignored unless the type is set to PROPERTY.

Available options:

APPLIANCES,

ART,

COMPUTER,

ELECTRONICS,

FURNITURE,

JEWELRY,

MISCELLANEOUS,

REAL_ESTATE,

SPORTS_EQUIPMENT,

VEHICLE,

null

Example:

"VEHICLE"

account.routing_number

string | null

required

The routing number for the account.

Example:

"68899990000000"

account.started_on

string | null

required

The date on which the loan from a debt account started.

Example:

"2025-10-13T17:57:37.000Z"

account.started_on_set_by

integer | null

required

Who last set started_on, as the raw Atlas::SetBy enum number (0 unspecified, 1 feed, 2 user, 3 system).

Example:

1

account.statement_balance

number | null

required

The balance at the end of the account's last statement period.

Example:

1000.5

account.statement_balance_set_by

integer | null

required

Who last set statement_balance, as the raw Atlas::SetBy enum number (0 unspecified, 1 feed, 2 user, 3 system).

Example:

1

account.subtype

string | null

required

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:

"MONEY_MARKET"

account.subtype_set_by

integer | null

required

Who last set subtype, as the raw Atlas::SetBy enum number (0 unspecified, 1 feed, 2 user, 3 system).

Example:

1

account.today_ugl_amount

number | null

required

The unrealized gain/loss amount for the day for the account.

Example:

1000.5

account.today_ugl_percentage

number | null

required

The unrealized gain/loss percentage for the date for the account.

Example:

6.9

account.total_account_value

number | null

required

The sum of the long and short positions, the sweep account and/or cash balance, and any margin debt associated with a particular account. This amount includes the market value of all positions held in the account and is reduced by any debit balance and the amount of short options positions that are "in the money". This may sum to a negative value, and it does not represent an account balance.

Example:

1

account.total_account_value_set_by

integer | null

required

Who last set total_account_value, as the raw Atlas::SetBy enum number (0 unspecified, 1 feed, 2 user, 3 system).

Example:

1

account.total_account_value_ugl

number | null

required

The unrealized gains and losses represent the amount the account has gained or lost based on the purchase price. This is calculated by subtracting the purchase price from the current market value. It does not affect the account until the positions are sold and "realized". This may sum to a negative value, and it does not represent an account balance.

Example:

1

account.type

enum<string> | null

required

The type of account. Some account types may include subtypes.

Available options:

ANY,

CASH,

CHECKING,

CHECKING_LINE_OF_CREDIT,

CREDIT_CARD,

DIGITAL_WALLET,

LOAN,

LINE_OF_CREDIT,

SAVINGS,

INVESTMENT,

MORTGAGE,

INSURANCE,

PREPAID,

PROPERTY,

null

Example:

"CHECKING"

account.type_set_by

integer | null

required

Who last set type, as the raw Atlas::SetBy enum number (0 unspecified, 1 feed, 2 user, 3 system).

Example:

1

account.updated_at

string | null

required

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

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

Example:

"2025-02-13T18:09:00+00:00"

account.user_guid

string | null

required

The unique identifier for the user. Defined by MX.

Example:

"USR-fa7537f3-48aa-a683-a02a-b18940482f54"

account.user_id

string | null

required

The unique partner-defined identifier for the user.

Example:

"u-1234"

account.feed_is_business

boolean | null

The is_business value reported by the data feed. Only rendered for business-suite clients.

Example:

false

account.is_business

boolean | null

Indicates whether the account is a business account (the inverse of is_personal). Only rendered for business-suite clients.

Example:

false