Skip to main content
GET
/
accounts
List Accounts
curl --request GET \
  --url https://api.example.com/accounts \
  --header 'Content-Type: application/json' \
  --data '
{
  "account_number": "<string>",
  "apr": 123,
  "apy": 123,
  "available_balance": 123,
  "available_credit": 123,
  "balance": 123,
  "cash_advance_apr": 123,
  "cash_surrender_value": 123,
  "credit_limit": 123,
  "currency_code": "<string>",
  "day_payment_is_due": 123,
  "death_benefit": "<string>",
  "has_holdings": true,
  "has_monthly_transfer_limit": true,
  "id": "<string>",
  "insured_name": "<string>",
  "interest_rate": 123,
  "is_closed": true,
  "is_hidden": true,
  "last_payment": 123,
  "last_payment_at": 123,
  "last_payment_on": "<string>",
  "loan_amount": 123,
  "matures_at": 123,
  "matures_on": "<string>",
  "metadata": "<string>",
  "minimum_balance": 123,
  "minimum_payment": 123,
  "monthly_transfer_count": 123,
  "name": "<string>",
  "nickname": "<string>",
  "original_balance": 123,
  "past_due_amount": 123,
  "past_due_at": 123,
  "past_due_on": "<string>",
  "payment_due_at": 123,
  "payment_due_on": "<string>",
  "payoff_balance": 123,
  "pay_out_amount": 123,
  "pending_balance": 123,
  "premium_amount": 123,
  "routing_number": "<string>",
  "started_at": 123,
  "started_on": "<string>",
  "statement_balance": 123,
  "statement_closed_on": "<string>",
  "subtype": "<string>",
  "type": "<string>"
}
'
import requests

url = "https://api.example.com/accounts"

payload = {
    "account_number": "<string>",
    "apr": 123,
    "apy": 123,
    "available_balance": 123,
    "available_credit": 123,
    "balance": 123,
    "cash_advance_apr": 123,
    "cash_surrender_value": 123,
    "credit_limit": 123,
    "currency_code": "<string>",
    "day_payment_is_due": 123,
    "death_benefit": "<string>",
    "has_holdings": True,
    "has_monthly_transfer_limit": True,
    "id": "<string>",
    "insured_name": "<string>",
    "interest_rate": 123,
    "is_closed": True,
    "is_hidden": True,
    "last_payment": 123,
    "last_payment_at": 123,
    "last_payment_on": "<string>",
    "loan_amount": 123,
    "matures_at": 123,
    "matures_on": "<string>",
    "metadata": "<string>",
    "minimum_balance": 123,
    "minimum_payment": 123,
    "monthly_transfer_count": 123,
    "name": "<string>",
    "nickname": "<string>",
    "original_balance": 123,
    "past_due_amount": 123,
    "past_due_at": 123,
    "past_due_on": "<string>",
    "payment_due_at": 123,
    "payment_due_on": "<string>",
    "payoff_balance": 123,
    "pay_out_amount": 123,
    "pending_balance": 123,
    "premium_amount": 123,
    "routing_number": "<string>",
    "started_at": 123,
    "started_on": "<string>",
    "statement_balance": 123,
    "statement_closed_on": "<string>",
    "subtype": "<string>",
    "type": "<string>"
}
headers = {"Content-Type": "application/json"}

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

print(response.text)
const options = {
  method: 'GET',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    account_number: '<string>',
    apr: 123,
    apy: 123,
    available_balance: 123,
    available_credit: 123,
    balance: 123,
    cash_advance_apr: 123,
    cash_surrender_value: 123,
    credit_limit: 123,
    currency_code: '<string>',
    day_payment_is_due: 123,
    death_benefit: '<string>',
    has_holdings: true,
    has_monthly_transfer_limit: true,
    id: '<string>',
    insured_name: '<string>',
    interest_rate: 123,
    is_closed: true,
    is_hidden: true,
    last_payment: 123,
    last_payment_at: 123,
    last_payment_on: '<string>',
    loan_amount: 123,
    matures_at: 123,
    matures_on: '<string>',
    metadata: '<string>',
    minimum_balance: 123,
    minimum_payment: 123,
    monthly_transfer_count: 123,
    name: '<string>',
    nickname: '<string>',
    original_balance: 123,
    past_due_amount: 123,
    past_due_at: 123,
    past_due_on: '<string>',
    payment_due_at: 123,
    payment_due_on: '<string>',
    payoff_balance: 123,
    pay_out_amount: 123,
    pending_balance: 123,
    premium_amount: 123,
    routing_number: '<string>',
    started_at: 123,
    started_on: '<string>',
    statement_balance: 123,
    statement_closed_on: '<string>',
    subtype: '<string>',
    type: '<string>'
  })
};

fetch('https://api.example.com/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://api.example.com/accounts",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_POSTFIELDS => json_encode([
    'account_number' => '<string>',
    'apr' => 123,
    'apy' => 123,
    'available_balance' => 123,
    'available_credit' => 123,
    'balance' => 123,
    'cash_advance_apr' => 123,
    'cash_surrender_value' => 123,
    'credit_limit' => 123,
    'currency_code' => '<string>',
    'day_payment_is_due' => 123,
    'death_benefit' => '<string>',
    'has_holdings' => true,
    'has_monthly_transfer_limit' => true,
    'id' => '<string>',
    'insured_name' => '<string>',
    'interest_rate' => 123,
    'is_closed' => true,
    'is_hidden' => true,
    'last_payment' => 123,
    'last_payment_at' => 123,
    'last_payment_on' => '<string>',
    'loan_amount' => 123,
    'matures_at' => 123,
    'matures_on' => '<string>',
    'metadata' => '<string>',
    'minimum_balance' => 123,
    'minimum_payment' => 123,
    'monthly_transfer_count' => 123,
    'name' => '<string>',
    'nickname' => '<string>',
    'original_balance' => 123,
    'past_due_amount' => 123,
    'past_due_at' => 123,
    'past_due_on' => '<string>',
    'payment_due_at' => 123,
    'payment_due_on' => '<string>',
    'payoff_balance' => 123,
    'pay_out_amount' => 123,
    'pending_balance' => 123,
    'premium_amount' => 123,
    'routing_number' => '<string>',
    'started_at' => 123,
    'started_on' => '<string>',
    'statement_balance' => 123,
    'statement_closed_on' => '<string>',
    'subtype' => '<string>',
    'type' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "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://api.example.com/accounts"

	payload := strings.NewReader("{\n  \"account_number\": \"<string>\",\n  \"apr\": 123,\n  \"apy\": 123,\n  \"available_balance\": 123,\n  \"available_credit\": 123,\n  \"balance\": 123,\n  \"cash_advance_apr\": 123,\n  \"cash_surrender_value\": 123,\n  \"credit_limit\": 123,\n  \"currency_code\": \"<string>\",\n  \"day_payment_is_due\": 123,\n  \"death_benefit\": \"<string>\",\n  \"has_holdings\": true,\n  \"has_monthly_transfer_limit\": true,\n  \"id\": \"<string>\",\n  \"insured_name\": \"<string>\",\n  \"interest_rate\": 123,\n  \"is_closed\": true,\n  \"is_hidden\": true,\n  \"last_payment\": 123,\n  \"last_payment_at\": 123,\n  \"last_payment_on\": \"<string>\",\n  \"loan_amount\": 123,\n  \"matures_at\": 123,\n  \"matures_on\": \"<string>\",\n  \"metadata\": \"<string>\",\n  \"minimum_balance\": 123,\n  \"minimum_payment\": 123,\n  \"monthly_transfer_count\": 123,\n  \"name\": \"<string>\",\n  \"nickname\": \"<string>\",\n  \"original_balance\": 123,\n  \"past_due_amount\": 123,\n  \"past_due_at\": 123,\n  \"past_due_on\": \"<string>\",\n  \"payment_due_at\": 123,\n  \"payment_due_on\": \"<string>\",\n  \"payoff_balance\": 123,\n  \"pay_out_amount\": 123,\n  \"pending_balance\": 123,\n  \"premium_amount\": 123,\n  \"routing_number\": \"<string>\",\n  \"started_at\": 123,\n  \"started_on\": \"<string>\",\n  \"statement_balance\": 123,\n  \"statement_closed_on\": \"<string>\",\n  \"subtype\": \"<string>\",\n  \"type\": \"<string>\"\n}")

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

	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.get("https://api.example.com/accounts")
  .header("Content-Type", "application/json")
  .body("{\n  \"account_number\": \"<string>\",\n  \"apr\": 123,\n  \"apy\": 123,\n  \"available_balance\": 123,\n  \"available_credit\": 123,\n  \"balance\": 123,\n  \"cash_advance_apr\": 123,\n  \"cash_surrender_value\": 123,\n  \"credit_limit\": 123,\n  \"currency_code\": \"<string>\",\n  \"day_payment_is_due\": 123,\n  \"death_benefit\": \"<string>\",\n  \"has_holdings\": true,\n  \"has_monthly_transfer_limit\": true,\n  \"id\": \"<string>\",\n  \"insured_name\": \"<string>\",\n  \"interest_rate\": 123,\n  \"is_closed\": true,\n  \"is_hidden\": true,\n  \"last_payment\": 123,\n  \"last_payment_at\": 123,\n  \"last_payment_on\": \"<string>\",\n  \"loan_amount\": 123,\n  \"matures_at\": 123,\n  \"matures_on\": \"<string>\",\n  \"metadata\": \"<string>\",\n  \"minimum_balance\": 123,\n  \"minimum_payment\": 123,\n  \"monthly_transfer_count\": 123,\n  \"name\": \"<string>\",\n  \"nickname\": \"<string>\",\n  \"original_balance\": 123,\n  \"past_due_amount\": 123,\n  \"past_due_at\": 123,\n  \"past_due_on\": \"<string>\",\n  \"payment_due_at\": 123,\n  \"payment_due_on\": \"<string>\",\n  \"payoff_balance\": 123,\n  \"pay_out_amount\": 123,\n  \"pending_balance\": 123,\n  \"premium_amount\": 123,\n  \"routing_number\": \"<string>\",\n  \"started_at\": 123,\n  \"started_on\": \"<string>\",\n  \"statement_balance\": 123,\n  \"statement_closed_on\": \"<string>\",\n  \"subtype\": \"<string>\",\n  \"type\": \"<string>\"\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/accounts")

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

request = Net::HTTP::Get.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"account_number\": \"<string>\",\n  \"apr\": 123,\n  \"apy\": 123,\n  \"available_balance\": 123,\n  \"available_credit\": 123,\n  \"balance\": 123,\n  \"cash_advance_apr\": 123,\n  \"cash_surrender_value\": 123,\n  \"credit_limit\": 123,\n  \"currency_code\": \"<string>\",\n  \"day_payment_is_due\": 123,\n  \"death_benefit\": \"<string>\",\n  \"has_holdings\": true,\n  \"has_monthly_transfer_limit\": true,\n  \"id\": \"<string>\",\n  \"insured_name\": \"<string>\",\n  \"interest_rate\": 123,\n  \"is_closed\": true,\n  \"is_hidden\": true,\n  \"last_payment\": 123,\n  \"last_payment_at\": 123,\n  \"last_payment_on\": \"<string>\",\n  \"loan_amount\": 123,\n  \"matures_at\": 123,\n  \"matures_on\": \"<string>\",\n  \"metadata\": \"<string>\",\n  \"minimum_balance\": 123,\n  \"minimum_payment\": 123,\n  \"monthly_transfer_count\": 123,\n  \"name\": \"<string>\",\n  \"nickname\": \"<string>\",\n  \"original_balance\": 123,\n  \"past_due_amount\": 123,\n  \"past_due_at\": 123,\n  \"past_due_on\": \"<string>\",\n  \"payment_due_at\": 123,\n  \"payment_due_on\": \"<string>\",\n  \"payoff_balance\": 123,\n  \"pay_out_amount\": 123,\n  \"pending_balance\": 123,\n  \"premium_amount\": 123,\n  \"routing_number\": \"<string>\",\n  \"started_at\": 123,\n  \"started_on\": \"<string>\",\n  \"statement_balance\": 123,\n  \"statement_closed_on\": \"<string>\",\n  \"subtype\": \"<string>\",\n  \"type\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
If the provided institution_id is invalid, a 404 Not Found error response should be returned. If there are no accounts available for the user, an empty or self-terminating <accounts> element should be returned. MX will reconcile the accounts in our system with the accounts received in the response. This reconciliation process will insert new accounts and will update existing account details. Accounts that exist in the MX system that are not received in the data feed will not be removed. MX recommends partners return recently-closed accounts in the response with the is_closed field set to true. This allows MX to mark the account as closed, but to retain the account’s history for the user.

​
Response Fields

​
account_number
string
​
apr
decimal
​
apy
decimal
​
available_balance
decimal
required
​
available_credit
decimal
​
balance
decimal
required
​
cash_advance_apr
decimal
​
cash_surrender_value
decimal
​
credit_limit
decimal
​
currency_code
string
​
day_payment_is_due
integer
​
death_benefit
string
​
has_holdings
boolean
This indicates whether the account has holdings associated with it. This field is used fo syncing holdings with MDX On Demand and is not included in models for other APIs such as MDX Real Time, Nexus, or Platform.
​
has_monthly_transfer_limit
boolean
​
id
string
required
​
insured_name
string
​
interest_rate
decimal
​
is_closed
boolean
​
is_hidden
boolean
​
last_payment
decimal
​
last_payment_at
integer
​
last_payment_on
string
​
loan_amount
decimal
​
matures_at
integer
​
matures_on
string
​
metadata
string
​
minimum_balance
decimal
​
minimum_payment
decimal
​
monthly_transfer_count
decimal
​
name
string
required
​
nickname
string
​
original_balance
decimal
​
past_due_amount
decimal
​
past_due_at
integer
​
past_due_on
string
​
payment_due_at
integer
​
payment_due_on
string
​
payoff_balance
decimal
​
pay_out_amount
decimal
​
pending_balance
decimal
​
premium_amount
decimal
​
routing_number
string
​
started_at
integer
​
started_on
string
​
statement_balance
integer
​
statement_closed_on
string
​
subtype
string
​
type
string
required