Skip to main content
GET
/
payment_account
Read the account balance (Processors Only)
curl --request GET \
  --url https://int-api.mx.com/payment_account \
  --header 'Accept-Version: <accept-version>' \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://int-api.mx.com/payment_account"

headers = {
    "Accept-Version": "<accept-version>",
    "Authorization": "Bearer <token>"
}

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

print(response.text)
const options = {
  method: 'GET',
  headers: {'Accept-Version': '<accept-version>', Authorization: 'Bearer <token>'}
};

fetch('https://int-api.mx.com/payment_account', 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/payment_account",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Accept-Version: <accept-version>",
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

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

func main() {

	url := "https://int-api.mx.com/payment_account"

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

	req.Header.Add("Accept-Version", "<accept-version>")
	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://int-api.mx.com/payment_account")
  .header("Accept-Version", "<accept-version>")
  .header("Authorization", "Bearer <token>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://int-api.mx.com/payment_account")

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

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

response = http.request(request)
puts response.read_body
{
  "payment_account": {
    "account_guid": "ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1",
    "member_guid": "MBR-7c6f361b-e582-15b6-60c0-358f12466b4b",
    "user_guid": "USR-fa7537f3-48aa-a683-a02a-b18940482f54",
    "account_name": "My test account",
    "account_number": 6366816006,
    "account_type": "CHECKING",
    "available_balance": 1000,
    "balance": 1000,
    "created_at": "2025-02-13T18:08:00+00:00",
    "routing_number": 242722023,
    "transit_number": null,
    "updated_at": "2025-02-13T18:09:00+00:00"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
Accept-Version
string
default:v20250224
required

MX Platform API version.

Example:

"v20250224"

Response

200 - application/json

OK

​
payment_account
object