List merchants

curl --request GET \
  --url https://int-data.moneydesktop.com/merchants \
  --header 'MD-SESSION-TOKEN: <api-key>'

import requests

url = "https://int-data.moneydesktop.com/merchants"

headers = {"MD-SESSION-TOKEN": "<api-key>"}

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

print(response.text)

const options = {method: 'GET', headers: {'MD-SESSION-TOKEN': '<api-key>'}};

fetch('https://int-data.moneydesktop.com/merchants', 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-data.moneydesktop.com/merchants",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "MD-SESSION-TOKEN: <api-key>"
  ],
]);

$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-data.moneydesktop.com/merchants"

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

	req.Header.Add("MD-SESSION-TOKEN", "<api-key>")

	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-data.moneydesktop.com/merchants")
  .header("MD-SESSION-TOKEN", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://int-data.moneydesktop.com/merchants")

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

request = Net::HTTP::Get.new(url)
request["MD-SESSION-TOKEN"] = '<api-key>'

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

[
  {
    "merchants": [
      {
        "guid": "MCH-ad6d3405-ec03-721d-b0ca-eeceeebcb8b5",
        "logo_updated_at": null,
        "logo_url": "https://content.mx.com/logos/merchants/MCH-ad6d3405-ec03-721d-b0ca-eeceeebcb8b5.png",
        "name": "1-800 Contacts",
        "updated_at": "2022-05-20T20:15:36.000Z",
        "website_url": "https://www.1800contacts.com",
        "created_at": "2018-07-16T16:31:35.000Z"
      }
    ],
    "pagination": {
      "current_page": 1,
      "per_page": 25,
      "total_entries": 1,
      "total_pages": 1
    }
  }
]

GET

merchants

List merchants

curl --request GET \
  --url https://int-data.moneydesktop.com/merchants \
  --header 'MD-SESSION-TOKEN: <api-key>'

import requests

url = "https://int-data.moneydesktop.com/merchants"

headers = {"MD-SESSION-TOKEN": "<api-key>"}

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

print(response.text)

const options = {method: 'GET', headers: {'MD-SESSION-TOKEN': '<api-key>'}};

fetch('https://int-data.moneydesktop.com/merchants', 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-data.moneydesktop.com/merchants",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "MD-SESSION-TOKEN: <api-key>"
  ],
]);

$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-data.moneydesktop.com/merchants"

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

	req.Header.Add("MD-SESSION-TOKEN", "<api-key>")

	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-data.moneydesktop.com/merchants")
  .header("MD-SESSION-TOKEN", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://int-data.moneydesktop.com/merchants")

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

request = Net::HTTP::Get.new(url)
request["MD-SESSION-TOKEN"] = '<api-key>'

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

[
  {
    "merchants": [
      {
        "guid": "MCH-ad6d3405-ec03-721d-b0ca-eeceeebcb8b5",
        "logo_updated_at": null,
        "logo_url": "https://content.mx.com/logos/merchants/MCH-ad6d3405-ec03-721d-b0ca-eeceeebcb8b5.png",
        "name": "1-800 Contacts",
        "updated_at": "2022-05-20T20:15:36.000Z",
        "website_url": "https://www.1800contacts.com",
        "created_at": "2018-07-16T16:31:35.000Z"
      }
    ],
    "pagination": {
      "current_page": 1,
      "per_page": 25,
      "total_entries": 1,
      "total_pages": 1
    }
  }
]

List all merchants.

Authorizations

MD-SESSION-TOKEN

string

header

required

MX Session Token

Request an API token using the read API token endpoint in the MX SSO API.
Exchange an API token for a session token.
- A session token is obtained by sending a POST request to /sessions
- The session token will be used in each request made for the user. It should be passed in an MD-SESSION-TOKEN HTTP header as shown below.
- This session token is valid for 30 minutes from the time it was created. The 30 minute expiration counter is refreshed with each call.
- If you send a request with an expired session token you'll receive an error code of 4011.

curl -i https://int-data.moneydesktop.com/accounts \
-H 'MD-SESSION-TOKEN: CWforZl1Vn2vC_v6H4rnQRT1DoWpDouJAV-_5TBmiQRAtA8rsOG_BoajTiOSsL0A3bd-bmHXlA-eQzc9ywItKg' \
-H 'Content-Type: application/vnd.mx.nexus.v1+json' \
-H 'Accept: application/vnd.mx.nexus.v1+json'

In documentation code examples, replace <API_KEY_VALUE> with the session token.

Query Parameters

page

integer

Results are returned in paginated sets, this is the page of the results you would like to view. Defaults to page 1 if no page is specified.

records_per_page

integer

Requests to all list endpoints that return multiple transactions (e.g. list transactions) should specify the desired records_per_page. The supported range is from 10 to 1000. If the records_per_page parameter is not specified or is outside this range, a default of 25 records per page will be used.

Response

200 - application/vnd.mx.nexus.v1+json

merchants

object[]

Hide child attributes

merchants.guid

string

Unique identifier for the merchant. Defined by MX.

Example:

"MCH-ad6d3405-ec03-721d-b0ca-eeceeebcb8b5"

merchants.logo_updated_at

any

The date and time the logo associated with this merchant was last updated, represented in ISO 8601 format with timestamp.

Example:

null

merchants.logo_url

string

A URL which will return the merchant's logo.

Example:

"https://content.mx.com/logos/merchants/MCH-ad6d3405-ec03-721d-b0ca-eeceeebcb8b5.png"

merchants.name

string

The name of the merchant.

Example:

"1-800 Contacts"

merchants.updated_at

string

Date and time the merchant record was updated, represented in ISO 8601 format with timestamp.

Example:

"2022-05-20T20:15:36.000Z"

merchants.website_url

string

The URL of the merchant's website.

Example:

"https://www.1800contacts.com"

merchants.created_at

string

Date and time the merchant record was created, represented in ISO 8601 format with timestamp.

Example:

"2018-07-16T16:31:35.000Z"

pagination

object

Hide child attributes

pagination.current_page

integer

Example:

1

pagination.per_page

integer

Example:

25

pagination.total_entries

integer

Example:

1

pagination.total_pages

integer

Example:

1

Merchants Overview

Read merchant