Create manual account

curl --request POST \
  --url https://int-api.mx.com/users/{user_identifier}/accounts \
  --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": 3.25,
    "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}/accounts"

payload = { "account": {
        "account_subtype": "PERSONAL",
        "account_type": "CHECKING",
        "apy": 2.35,
        "available_balance": 1000,
        "balance": 1000,
        "currency_code": "USD",
        "interest_rate": 3.25,
        "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.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: {
      account_subtype: 'PERSONAL',
      account_type: 'CHECKING',
      apy: 2.35,
      available_balance: 1000,
      balance: 1000,
      currency_code: 'USD',
      interest_rate: 3.25,
      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}/accounts', 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}/accounts",
  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' => [
        'account_subtype' => 'PERSONAL',
        'account_type' => 'CHECKING',
        'apy' => 2.35,
        'available_balance' => 1000,
        'balance' => 1000,
        'currency_code' => 'USD',
        'interest_rate' => 3.25,
        '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}/accounts"

	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\": 3.25,\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("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_identifier}/accounts")
  .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\": 3.25,\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}/accounts")

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\": {\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\": 3.25,\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",
    "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"
    }
  }
}

POST

users

{user_identifier}

accounts

Create manual account

curl --request POST \
  --url https://int-api.mx.com/users/{user_identifier}/accounts \
  --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": 3.25,
    "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}/accounts"

payload = { "account": {
        "account_subtype": "PERSONAL",
        "account_type": "CHECKING",
        "apy": 2.35,
        "available_balance": 1000,
        "balance": 1000,
        "currency_code": "USD",
        "interest_rate": 3.25,
        "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.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: {
      account_subtype: 'PERSONAL',
      account_type: 'CHECKING',
      apy: 2.35,
      available_balance: 1000,
      balance: 1000,
      currency_code: 'USD',
      interest_rate: 3.25,
      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}/accounts', 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}/accounts",
  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' => [
        'account_subtype' => 'PERSONAL',
        'account_type' => 'CHECKING',
        'apy' => 2.35,
        'available_balance' => 1000,
        'balance' => 1000,
        'currency_code' => 'USD',
        'interest_rate' => 3.25,
        '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}/accounts"

	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\": 3.25,\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("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_identifier}/accounts")
  .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\": 3.25,\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}/accounts")

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\": {\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\": 3.25,\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",
    "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

user_identifier

string

required

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

Body

application/json

Manual account object to be created.

account

object

required

Hide child attributes

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

LOAN,

LINE_OF_CREDIT,

SAVINGS,

INVESTMENT,

MORTGAGE,

INSURANCE,

PREPAID,

PROPERTY

Example:

"CHECKING"

account.name

string

required

The human-readable name for the account.

Example:

"Test account 2"

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

number

The annual percentage rate associated with the account.

Example:

1

account.apy

number

The annual percentage yield associated with the account.

Example:

2.35

account.available_balance

number

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.balance

number

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.cash_surrender_value

number

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

The credit limit associated with the account.

Example:

100

account.currency_code

string | null

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

Example:

"USD"

account.death_benefit

integer

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

Example:

1000

account.interest_rate

number

The interest rate associated with the account.

Example:

3.25

account.is_business

boolean

Indicates whether the account is a business account.

Example:

false

account.is_closed

boolean

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

Example:

false

account.is_hidden

boolean

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

Example:

false

account.loan_amount

number

The amount of the loan associated with the account.

Example:

1000

account.metadata

string

Additional information you can store about the account.

Example:

"some metadata"

account.nickname

string

An alternate name for the account.

Example:

"Swiss Account"

account.original_balance

number

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

Example:

10

account.property_type

enum<string>

Subtype if the account type is PROPERTY. This field should be ignored unless the type is set to PROPERTY. For a full list of property types, see Account Types.

Available options:

APPLIANCES,

ART,

COMPUTER,

ELECTRONICS,

FURNITURE,

JEWELRY,

MISCELLANEOUS,

REAL_ESTATE,

SPORTS_EQUIPMENT,

VEHICLE

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

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"