Update account by member

curl --request PUT \
  --url https://int-api.mx.com/users/{user_identifier}/members/{member_identifier}/accounts/{account_identifier} \
  --header 'Accept-Version: <accept-version>' \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "account": {
    "account_subtype": "PERSONAL",
    "account_type": "CHECKING",
    "apy": 2.35,
    "available_balance": 1000,
    "balance": 1000,
    "currency_code": "USD",
    "interest_rate": 1,
    "is_business": false,
    "is_closed": false,
    "is_hidden": false,
    "metadata": "some metadata",
    "name": "Test account 2",
    "nickname": "Swiss Account",
    "skip_webhook": true
  }
}
'

import requests

url = "https://int-api.mx.com/users/{user_identifier}/members/{member_identifier}/accounts/{account_identifier}"

payload = { "account": {
        "account_subtype": "PERSONAL",
        "account_type": "CHECKING",
        "apy": 2.35,
        "available_balance": 1000,
        "balance": 1000,
        "currency_code": "USD",
        "interest_rate": 1,
        "is_business": False,
        "is_closed": False,
        "is_hidden": False,
        "metadata": "some metadata",
        "name": "Test account 2",
        "nickname": "Swiss Account",
        "skip_webhook": True
    } }
headers = {
    "Accept-Version": "<accept-version>",
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {
    'Accept-Version': '<accept-version>',
    Authorization: 'Basic <encoded-value>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    account: {
      account_subtype: 'PERSONAL',
      account_type: 'CHECKING',
      apy: 2.35,
      available_balance: 1000,
      balance: 1000,
      currency_code: 'USD',
      interest_rate: 1,
      is_business: false,
      is_closed: false,
      is_hidden: false,
      metadata: 'some metadata',
      name: 'Test account 2',
      nickname: 'Swiss Account',
      skip_webhook: true
    }
  })
};

fetch('https://int-api.mx.com/users/{user_identifier}/members/{member_identifier}/accounts/{account_identifier}', 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_identifier}/members/{member_identifier}/accounts/{account_identifier}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'account' => [
        'account_subtype' => 'PERSONAL',
        'account_type' => 'CHECKING',
        'apy' => 2.35,
        'available_balance' => 1000,
        'balance' => 1000,
        'currency_code' => 'USD',
        'interest_rate' => 1,
        'is_business' => false,
        'is_closed' => false,
        'is_hidden' => false,
        'metadata' => 'some metadata',
        'name' => 'Test account 2',
        'nickname' => 'Swiss Account',
        'skip_webhook' => true
    ]
  ]),
  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_identifier}/members/{member_identifier}/accounts/{account_identifier}"

	payload := strings.NewReader("{\n  \"account\": {\n    \"account_subtype\": \"PERSONAL\",\n    \"account_type\": \"CHECKING\",\n    \"apy\": 2.35,\n    \"available_balance\": 1000,\n    \"balance\": 1000,\n    \"currency_code\": \"USD\",\n    \"interest_rate\": 1,\n    \"is_business\": false,\n    \"is_closed\": false,\n    \"is_hidden\": false,\n    \"metadata\": \"some metadata\",\n    \"name\": \"Test account 2\",\n    \"nickname\": \"Swiss Account\",\n    \"skip_webhook\": true\n  }\n}")

	req, _ := http.NewRequest("PUT", 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.put("https://int-api.mx.com/users/{user_identifier}/members/{member_identifier}/accounts/{account_identifier}")
  .header("Accept-Version", "<accept-version>")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/json")
  .body("{\n  \"account\": {\n    \"account_subtype\": \"PERSONAL\",\n    \"account_type\": \"CHECKING\",\n    \"apy\": 2.35,\n    \"available_balance\": 1000,\n    \"balance\": 1000,\n    \"currency_code\": \"USD\",\n    \"interest_rate\": 1,\n    \"is_business\": false,\n    \"is_closed\": false,\n    \"is_hidden\": false,\n    \"metadata\": \"some metadata\",\n    \"name\": \"Test account 2\",\n    \"nickname\": \"Swiss Account\",\n    \"skip_webhook\": true\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://int-api.mx.com/users/{user_identifier}/members/{member_identifier}/accounts/{account_identifier}")

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

request = Net::HTTP::Put.new(url)
request["Accept-Version"] = '<accept-version>'
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"account\": {\n    \"account_subtype\": \"PERSONAL\",\n    \"account_type\": \"CHECKING\",\n    \"apy\": 2.35,\n    \"available_balance\": 1000,\n    \"balance\": 1000,\n    \"currency_code\": \"USD\",\n    \"interest_rate\": 1,\n    \"is_business\": false,\n    \"is_closed\": false,\n    \"is_hidden\": false,\n    \"metadata\": \"some metadata\",\n    \"name\": \"Test account 2\",\n    \"nickname\": \"Swiss Account\",\n    \"skip_webhook\": true\n  }\n}"

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

{
  "account": {
    "account_number_display": "3331261",
    "current_balance": 1000,
    "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",
    "metadata": "some metadata",
    "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"
    },
    "is_business": false,
    "feed_is_business": false,
    "balances": {
      "available_balance": 1000,
      "balance": 1000,
      "cash_balance": 1000,
      "margin_balance": 1000,
      "minimum_balance": 100,
      "original_balance": 10,
      "payoff_balance": 10,
      "statement_balance": 1000.5
    }
  }
}

PUT

users

{user_identifier}

members

{member_identifier}

accounts

{account_identifier}

Update account by member

curl --request PUT \
  --url https://int-api.mx.com/users/{user_identifier}/members/{member_identifier}/accounts/{account_identifier} \
  --header 'Accept-Version: <accept-version>' \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "account": {
    "account_subtype": "PERSONAL",
    "account_type": "CHECKING",
    "apy": 2.35,
    "available_balance": 1000,
    "balance": 1000,
    "currency_code": "USD",
    "interest_rate": 1,
    "is_business": false,
    "is_closed": false,
    "is_hidden": false,
    "metadata": "some metadata",
    "name": "Test account 2",
    "nickname": "Swiss Account",
    "skip_webhook": true
  }
}
'

import requests

url = "https://int-api.mx.com/users/{user_identifier}/members/{member_identifier}/accounts/{account_identifier}"

payload = { "account": {
        "account_subtype": "PERSONAL",
        "account_type": "CHECKING",
        "apy": 2.35,
        "available_balance": 1000,
        "balance": 1000,
        "currency_code": "USD",
        "interest_rate": 1,
        "is_business": False,
        "is_closed": False,
        "is_hidden": False,
        "metadata": "some metadata",
        "name": "Test account 2",
        "nickname": "Swiss Account",
        "skip_webhook": True
    } }
headers = {
    "Accept-Version": "<accept-version>",
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {
    'Accept-Version': '<accept-version>',
    Authorization: 'Basic <encoded-value>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    account: {
      account_subtype: 'PERSONAL',
      account_type: 'CHECKING',
      apy: 2.35,
      available_balance: 1000,
      balance: 1000,
      currency_code: 'USD',
      interest_rate: 1,
      is_business: false,
      is_closed: false,
      is_hidden: false,
      metadata: 'some metadata',
      name: 'Test account 2',
      nickname: 'Swiss Account',
      skip_webhook: true
    }
  })
};

fetch('https://int-api.mx.com/users/{user_identifier}/members/{member_identifier}/accounts/{account_identifier}', 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_identifier}/members/{member_identifier}/accounts/{account_identifier}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'account' => [
        'account_subtype' => 'PERSONAL',
        'account_type' => 'CHECKING',
        'apy' => 2.35,
        'available_balance' => 1000,
        'balance' => 1000,
        'currency_code' => 'USD',
        'interest_rate' => 1,
        'is_business' => false,
        'is_closed' => false,
        'is_hidden' => false,
        'metadata' => 'some metadata',
        'name' => 'Test account 2',
        'nickname' => 'Swiss Account',
        'skip_webhook' => true
    ]
  ]),
  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_identifier}/members/{member_identifier}/accounts/{account_identifier}"

	payload := strings.NewReader("{\n  \"account\": {\n    \"account_subtype\": \"PERSONAL\",\n    \"account_type\": \"CHECKING\",\n    \"apy\": 2.35,\n    \"available_balance\": 1000,\n    \"balance\": 1000,\n    \"currency_code\": \"USD\",\n    \"interest_rate\": 1,\n    \"is_business\": false,\n    \"is_closed\": false,\n    \"is_hidden\": false,\n    \"metadata\": \"some metadata\",\n    \"name\": \"Test account 2\",\n    \"nickname\": \"Swiss Account\",\n    \"skip_webhook\": true\n  }\n}")

	req, _ := http.NewRequest("PUT", 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.put("https://int-api.mx.com/users/{user_identifier}/members/{member_identifier}/accounts/{account_identifier}")
  .header("Accept-Version", "<accept-version>")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/json")
  .body("{\n  \"account\": {\n    \"account_subtype\": \"PERSONAL\",\n    \"account_type\": \"CHECKING\",\n    \"apy\": 2.35,\n    \"available_balance\": 1000,\n    \"balance\": 1000,\n    \"currency_code\": \"USD\",\n    \"interest_rate\": 1,\n    \"is_business\": false,\n    \"is_closed\": false,\n    \"is_hidden\": false,\n    \"metadata\": \"some metadata\",\n    \"name\": \"Test account 2\",\n    \"nickname\": \"Swiss Account\",\n    \"skip_webhook\": true\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://int-api.mx.com/users/{user_identifier}/members/{member_identifier}/accounts/{account_identifier}")

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

request = Net::HTTP::Put.new(url)
request["Accept-Version"] = '<accept-version>'
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"account\": {\n    \"account_subtype\": \"PERSONAL\",\n    \"account_type\": \"CHECKING\",\n    \"apy\": 2.35,\n    \"available_balance\": 1000,\n    \"balance\": 1000,\n    \"currency_code\": \"USD\",\n    \"interest_rate\": 1,\n    \"is_business\": false,\n    \"is_closed\": false,\n    \"is_hidden\": false,\n    \"metadata\": \"some metadata\",\n    \"name\": \"Test account 2\",\n    \"nickname\": \"Swiss Account\",\n    \"skip_webhook\": true\n  }\n}"

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

{
  "account": {
    "account_number_display": "3331261",
    "current_balance": 1000,
    "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",
    "metadata": "some metadata",
    "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"
    },
    "is_business": false,
    "feed_is_business": false,
    "balances": {
      "available_balance": 1000,
      "balance": 1000,
      "cash_balance": 1000,
      "margin_balance": 1000,
      "minimum_balance": 100,
      "original_balance": 10,
      "payoff_balance": 10,
      "statement_balance": 1000.5
    }
  }
}

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"

MX-Skip-Webhook

boolean

When true, the request does not trigger a webhook.

Path Parameters

account_identifier

string

required

Use either the account id you defined or the MX-defined account guid. See Assigning Resource IDs.

member_identifier

string

required

Use either the member id you defined or the MX-defined member guid. See Assigning Resource IDs.

user_identifier

string

required

Use either the user id you defined or the MX-defined user guid. See Assigning Resource IDs.

Query Parameters

includes

enum<string>[]

Enrich account responses with additional metadata. Pass one or more values as an array to selectively include data.

Accepted values: balances.

Example: ?includes[]=balances

Any other value returns an error.

Available options:

balances

Body

application/json

account

object

required

Hide child attributes

account.account_subtype

string | null

Can only be updated for manual accounts.

Example:

"PERSONAL"

account.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,

DIGITAL_WALLET,

LOAN,

LINE_OF_CREDIT,

SAVINGS,

INVESTMENT,

MORTGAGE,

INSURANCE,

PREPAID,

PROPERTY,

null

Example:

"CHECKING"

account.apr

number | null

Can only be updated for manual accounts. The annual percentage rate associated with the account.

Example:

5.25

account.apy

number

Can only be updated for manual accounts. The annual percentage yield associated with the account.

Example:

2.35

account.available_balance

number

Can only be updated for manual accounts.

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

Example:

1000

account.balance

number

Can only be updated for manual accounts. The current balance of the account.

Example:

1000

account.cash_surrender_value

number

Can only be updated for manual accounts. 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.credit_limit

number | null

Can only be updated for manual accounts. The credit limit associated with the account.

Example:

5000

account.currency_code

string | null

Can only be updated for manual accounts. The three-character ISO 4217 currency code, for example, USD.

Example:

"USD"

account.death_benefit

integer

Can only be updated for manual accounts. The amount paid to the beneficiary of the account upon death of the account owner.

Example:

1000

account.interest_rate

number

Can only be updated for manual accounts.

Example:

1

account.is_business

boolean

Can be updated for manual accounts and aggregated accounts.

Example:

false

account.is_closed

boolean

Can only be updated for manual accounts.

Example:

false

account.is_hidden

boolean

Can be updated for manual accounts and aggregated accounts.

Example:

false

account.loan_amount

number

Can only be updated for manual accounts.

Example:

1000

account.metadata

string

Can only be updated for manual accounts.

Example:

"some metadata"

account.name

string

Can only be updated for manual accounts.

Example:

"Test account 2"

account.nickname

string

Can only be updated for manual accounts.

Example:

"Swiss Account"

account.original_balance

number

Can only be updated for manual accounts.

Example:

10

account.property_type

string

Can only be updated for manual accounts.

Example:

"VEHICLE"

account.skip_webhook

boolean

If set to true, prevents sending an account webhook for the update if that webhook type is enabled for you.

Example:

true

Response

200 - application/json

account

object

required

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

required

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

Example:

"3331261"

account.current_balance

number | null

required

The current balance of the account.

Example:

1000

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:

"CHECKING"

account.type

enum<string> | null

required

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,

DIGITAL_WALLET,

LOAN,

LINE_OF_CREDIT,

SAVINGS,

INVESTMENT,

MORTGAGE,

INSURANCE,

PREPAID,

PROPERTY,

null

Example:

"CHECKING"

account.guid

string | null

required

Unique identifier for the account. Defined by MX.

Example:

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

account.id

string | null

required

The unique partner-defined identifier for the account.

Example:

"1040434698"

account.name

string | null

required

The human-readable name for the account.

Example:

"Test account 2"

account.nickname

string | null

required

An alternate name for the account.

Example:

"Swiss Account"

account.self

string

required

The API URI path for the account.

Example:

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

account.metadata

string | null

required

Additional information about the account, as a stringified JSON object.

Example:

"some metadata"

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

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.

Example:

"unique_id"

account.member.metadata

string | null

required

Additional information you can store about the member.

Example:

"some metadata"

account.member.name

string | null

required

The name of the member.

Example:

"MX Bank"

account.member.self

string

required

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

required

The unique identifier for the user. Defined by MX.

Example:

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

account.user.id

string | null

required

The unique partner-defined identifier for the user.

Example:

"unique_id"

account.user.metadata

string | null

required

Additional information you can store about the user.

Example:

"some metadata"

account.user.self

string

required

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

required

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

required

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"

account.is_business

boolean | null

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

Example:

false

account.feed_is_business

boolean | null

The is_business value reported by the data feed. Only rendered for business-suite clients, on single-account responses.

Example:

false

account.balances

object | null

Extended balance fields for an account. Only present when requested via includes[]=balances.

Hide child attributes

account.balances.available_balance

number | null

required

The available balance of the account.

Example:

1000

account.balances.balance

number | null

required

The current balance of the account.

Example:

1000

account.balances.cash_balance

number | null

required

The cash balance of the account.

Example:

1000

account.balances.margin_balance

number | null

required

The margin balance of the account.

Example:

1000

account.balances.minimum_balance

number | null

required

The minimum balance of the account.

Example:

100

account.balances.original_balance

number | null

required

The original balance of the account.

Example:

10

account.balances.payoff_balance

number | null

required

The payoff balance of the account.

Example:

10

account.balances.statement_balance

number | null

required

The statement balance of the account.

Example:

1000.5