Skip to main content
GET
/
institutions
/
favorites
List favorite institutions
curl --request GET \
  --url https://int-api.mx.com/institutions/favorites \
  --header 'Authorization: Basic <encoded-value>'
import requests

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

headers = {"Authorization": "Basic <encoded-value>"}

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

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://int-api.mx.com/institutions/favorites', 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/institutions/favorites",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>"
  ],
]);

$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/institutions/favorites"

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

	req.Header.Add("Authorization", "Basic <encoded-value>")

	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/institutions/favorites")
  .header("Authorization", "Basic <encoded-value>")
  .asString();
require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'

response = http.request(request)
puts response.read_body
{
  "institutions": [
    {
      "client_status": "AVAILABLE",
      "code": "mxbank",
      "created_at": "2025-02-13T18:08:00+00:00",
      "forgot_password_url": "https://example.url.mxbank.com/forgot-password",
      "forgot_username_url": "https://example.url.mxbank.com/forgot-username",
      "guid": "INS-1572a04c-912b-59bf-5841-332c7dfafaef",
      "instructional_text": "Some instructional text <a href=\"https://example.url.mxbank.com/instructions\" id=\"instructional_text\">for end users</a>.",
      "instructional_text_steps": [
        "Step 1: Do this.",
        "Step 2: Do that."
      ],
      "is_disabled_by_client": false,
      "is_hidden": true,
      "iso_country_code": "US",
      "medium_logo_url": "https://content.moneydesktop.com/storage/MD_Assets/Ipad%20Logos/100x100/default_100x100.png",
      "name": "MX Bank",
      "small_logo_url": "https://content.moneydesktop.com/storage/MD_Assets/Ipad%20Logos/50x50/default_50x50.png",
      "status": "OPERATIONAL",
      "supported_products": [],
      "supports_oauth": true,
      "supports_tax_document": true,
      "trouble_signing_in_url": "https://example.url.mxbank.com/login-trouble",
      "url": "https://www.mxbank.com"
    }
  ],
  "pagination": {
    "current_page": 1,
    "per_page": 25,
    "total_entries": 1,
    "total_pages": 1
  }
}
This endpoint returns a paginated list containing institutions that have been set as favorites, sorted by popularity. Please contact MX to set a list of favorites.

Authorizations

​
Authorization
string
header
required

The MX Platform API requires basic access authentication using your client_id and api_key. These credentials must be Base64 encoded and included in the Authorization header of each API request to ensure secure access.

Here's an example using curl to access v20250224. Replace https://int-api.mx.com/endpoint with the actual API endpoint you wish to access and your Base64 encoded client_id and api_key.

curl -L -X POST `https://int-api.mx.com/endpoint' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Accept-Version: v20250224'
-H 'Authorization: Basic BASE_64_ENCODING_OF{client_id:api_key}'

Query Parameters

​
iso_country_code
string[]

An array of strings that filters institutions in the widget by the specified country code. Acceptable codes include US, CA, and MX (Mexico).

​
page
integer

Results are paginated. Specify current page.

​
records_per_page
integer

This specifies the number of records to be returned on each page. Defaults to 25. The valid range is from 10 to 1000. If the value exceeds 1000, the default value of 25 will be used instead.

Response

200 - application/json

OK

​
institutions
object[]
​
pagination
object