merchants-api-client

Merchants Locations API

• API version: 2.0.0
  • Build date: 2024-04-04T16:00:00.598858300-05:00[America/Chicago]

Merchants Locations API

For more information, please visit https://developer.mastercard.com/support

Automatically generated by the OpenAPI Generator

Requirements

Building the API client library requires:

1. Java 1.7+
2. Maven/Gradle

Installation

To install the API client library to your local Maven repository, simply execute:

mvn clean install

To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:

mvn clean deploy

Refer to the OSSRH Guide for more information.

Maven users

Add this dependency to your project's POM:

<dependency>
  <groupId>com.mastercard.api.merchants</groupId>
  <artifactId>merchants-api-client</artifactId>
  <version>1.0.0</version>
  <scope>compile</scope>
</dependency>

Gradle users

Add this dependency to your project's build file:

compile "com.mastercard.api.merchants:merchants-api-client:1.0.0"

Others

At first generate the JAR by executing:

mvn clean package

Then manually install the following JARs:

• target/merchants-api-client-1.0.0.jar
• target/lib/*.jar

Getting Started

Please follow the installation instruction and execute the following Java code:

// Import classes:
import com.mastercard.api.merchants.ApiClient;
import com.mastercard.api.merchants.ApiException;
import com.mastercard.api.merchants.Configuration;
import com.mastercard.api.merchants.models.*;
import com.mastercard.api.merchants.client.CategoriesApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.mastercard.com/locations/merchants");

    CategoriesApi apiInstance = new CategoriesApi(defaultClient);
    try {
      Categories result = apiInstance.getMerchantCategories();
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling CategoriesApi#getMerchantCategories");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Documentation for API Endpoints

All URIs are relative to https://api.mastercard.com/locations/merchants

Class	Method	HTTP request	Description
CategoriesApi	getMerchantCategories	GET /categories	Get a list of merchant categories
CountriesApi	getCountries	GET /countries	Get a list of countries
CountriesApi	getCountrySubdivisions	GET /country-subdivisions	Get a list of country subdivisions
MerchantsApi	getMerchants	POST /searches	Get a list of merchant details

Documentation for Models

• Categories
• Category
• Countries
• Country
• CountrySubdivision
• CountrySubdivisions
• Error
• ErrorResponse
• Errors
• Merchant
• MerchantSearch
• Merchants

Documentation for Authorization

All endpoints do not require authorization. Authentication schemes defined for the API:

Recommendation

It's recommended to create an instance of ApiClient per thread in a multithreaded environment to avoid any potential issues.

Author

apisupport@mastercard.com