Read merchant location

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

import requests

url = "https://int-data.moneydesktop.com/merchant_locations/{merchant_location_guid}"

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/merchant_locations/{merchant_location_guid}', 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/merchant_locations/{merchant_location_guid}",
  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/merchant_locations/{merchant_location_guid}"

	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/merchant_locations/{merchant_location_guid}")
  .header("MD-SESSION-TOKEN", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://int-data.moneydesktop.com/merchant_locations/{merchant_location_guid}")

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

{
  "merchant_location": {
    "city": "Staten Island",
    "country": "United States",
    "created_at": "2021-10-05T23:35:19+00:00",
    "guid": "MCL-c51b9d25-9733-4def-8929-2d5bb1b2b9f1",
    "latitude": 40.5710098,
    "longitude": -74.1097041,
    "merchant_guid": "MCH-adb8a6ab-5e96-c4ef-22b3-beb0e7a79b3c",
    "phone_number": "(917) 426-0321",
    "postal_code": "10306",
    "region_code": "NY",
    "street_address": "2475 Hylan Blvd",
    "updated_at": "2021-10-05T23:35:19+00:00"
  }
}

GET

merchant_locations

{merchant_location_guid}

Read merchant location

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

import requests

url = "https://int-data.moneydesktop.com/merchant_locations/{merchant_location_guid}"

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/merchant_locations/{merchant_location_guid}', 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/merchant_locations/{merchant_location_guid}",
  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/merchant_locations/{merchant_location_guid}"

	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/merchant_locations/{merchant_location_guid}")
  .header("MD-SESSION-TOKEN", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://int-data.moneydesktop.com/merchant_locations/{merchant_location_guid}")

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

{
  "merchant_location": {
    "city": "Staten Island",
    "country": "United States",
    "created_at": "2021-10-05T23:35:19+00:00",
    "guid": "MCL-c51b9d25-9733-4def-8929-2d5bb1b2b9f1",
    "latitude": 40.5710098,
    "longitude": -74.1097041,
    "merchant_guid": "MCH-adb8a6ab-5e96-c4ef-22b3-beb0e7a79b3c",
    "phone_number": "(917) 426-0321",
    "postal_code": "10306",
    "region_code": "NY",
    "street_address": "2475 Hylan Blvd",
    "updated_at": "2021-10-05T23:35:19+00:00"
  }
}

Use this endpoint to get data on a specific merchant location. The merchant_location_guid can be found on transaction objects.

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.

Path Parameters

merchant_location_guid

string

required

The unique identifier for the merchant. Defined by MX.

Response

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

merchant_location

object

Hide child attributes

merchant_location.city

string

The city in which the merchant is located.

Example:

"Staten Island"

merchant_location.country

string

The country in which the merchant is located.

Example:

"United States"

merchant_location.created_at

string<date-time>

Date and time the merchant location was created, represented in ISO 8601 format with timestamp (e.g., 2015-04-13T12:01:23-00:00).

Example:

"2021-10-05T23:35:19+00:00"

merchant_location.guid

string

The unique identifier for the merchant location. Defined by MX.

Example:

"MCL-c51b9d25-9733-4def-8929-2d5bb1b2b9f1"

merchant_location.latitude

number

The latitude of the merchant location. This number is a signed decimal (e.g., Rio de Janeiro's latitude is -22.9027800 and Tokyo's latitude is 35.689488).

Example:

40.5710098

merchant_location.longitude

number

The longitude of the merchant location. This number is a signed decimal (e.g., Rio de Janeiro's longitude is -43.2075000 and Tokyo's longitude is 139.691706).

Example:

-74.1097041

merchant_location.merchant_guid

string

The unique identifier for the merchant to which this location belongs. Defined by MX.

Example:

"MCH-adb8a6ab-5e96-c4ef-22b3-beb0e7a79b3c"

merchant_location.phone_number

string

The phone number for the merchant location.

Example:

"(917) 426-0321"

merchant_location.postal_code

string

The postal code in which the merchant is located.

Example:

"10306"

merchant_location.region_code

string

The region in which the merchant is located; e.g., a U.S. state code such as UT.

Example:

"NY"

merchant_location.street_address

string

The street address at which the merchant is located.

Example:

"2475 Hylan Blvd"

merchant_location.updated_at

string<date-time>

Date and time the merchant record was updated, represented in ISO 8601 format with timestamp (e.g., 2015-04-13T12:01:23-00:00).

Example:

"2021-10-05T23:35:19+00:00"

Read merchant

Microdeposits Overview