Locations Merchants API Reference Application

Table of Contents

• Overview
  • Compatibility
  • References
  • Frameworks
• Setup
  • Prerequisites
  • Application Configuration
  • Build and Execute
  • Reference Application Usage
  • Integrating with OpenAPI Generator
• Use Cases
  • Parameters
  • Request Body
  • Countries
  • Country SubDivisions
  • Merchant Categories
  • Merchant Searches
• API Reference
  • Reference App API Reference
  • Locations Merchants API Reference
• Authentication
  • Mastercard's OAuth Library
• Support
• License

Overview

This project showcases retrieving Merchant locations using the Locations Merchants API.

This application illustrates connecting to the Locations Merchants API using Mastercard's OAuth library, and an OpenAPI generated client.

Compatibility

• Java 11 or later

References

• Mastercard’s OAuth Signer library
• Using OAuth 1.0a to Access Mastercard APIs

Frameworks

• Spring
• OpenAPI Generator
• Java 11
• Maven

Setup

Prerequisites

• Mastercard Developers Account
• A text editor or IDE
• Java 11
• Spring Boot 2.2+
• Apache Maven 3.3+
• Set up the JAVA_HOME environment variable to match the location of your Java installation.

Application Configuration

1. Follow this credentials quick guide to get the credentials needed to run this application
   • Be sure to add Locations to your project.
   • A zip file will be downloaded automatically with your key.
2. Take note of the given consumer key, keyalias, and keystore password given upon the project creation.
3. Extract the zip file which contains .p12 file.
4. Update your credentials in the properties found in /src/main/resources/application.properties.

application.properties

mastercard.api.base-path=https://sandbox.api.mastercard.com/locations/merchants, is the sandbox application URL to connect to Mastercard.

• Note: For production usage, use https://api.mastercard.com/locations/merchants.

Below properties will be required for authentication of API calls.

• mastercard.p12.path=, this refers to .p12 file found in the signing key. Place the downloaded .p12 file path here.
• mastercard.consumer.key=, this refers to your consumer key. Copy it from "Keys" section on your project page in Mastercard Developers.
• mastercard.keystore.alias=keyalias, this is the default value of key alias. If it is modified, use the updated one from keys section in Mastercard Developers.
• mastercard.keystore.pass=keystorepassword, this is the default value of key alias. If it is modified, use the updated one from keys section in Mastercard Developers.

Build and Execute

1. Run mvn clean install from the root of the project directory.
   • When install is run, the OpenAPI Generator plugin will generate the sources for connecting to the Locations API.
2. run java -jar target/locations-merchants-reference-app-X.X.X.jar to start the project.
   • Notice: Replace X with version of the reference app.
   • Example: java -jar target/locations-merchants-reference-app-1.0.0.jar
3. Navigate to http://localhost:8080/ in your browser.
   • Example: http://localhost:8080//locations/merchants/countries a GET call to retrieve countries endpoint for Merchant Locations country list.
   • Example: http://localhost:8080/locations/merchants/country-subdivisions?country_code=USA a GET call to retrieve USA country sub divisions endpoint for Merchant Locations country sub division list.

Requesting a Merchant Searches POST call

1. A tool like Postman or Insomnia is needed to perform a POST call

2. select the option POST from the HTTP request dropdown.

3. Provide the URL in the address bar.

   • Example: http://localhost:8080/locations/merchants/searches

4. Select the BODY tab around the address bar and select the option type JSON.

5. A Merchant location search can be performed either by longitude, latitude or by address and postal code like in the below example in BODY.

   • Example:

                   {
                       "longitude":"38.6270",
                       "latitude":"-90.1994",
                       "merchantType":"paypass"
                   }
   

   • Example:

                   {
                      "addressLine1":"1 CONVENTION CENTER PLZ",
                      "addressLine2":"",
                      "city":"SAINT CHARLES",
                      "countryCode":"USA",
                      "countrySubdivisionCode":"MO",
                      "postalCode":"63303",
                      "merchantType":"paypass"
                   }
   

Reference Application Usage

• Use the locations app in the sandbox to find merchant searches.
• click on a marker to open more information on the right panel.
• click on right panel to expand the marker to make calls.

Integrating with OpenAPI Generator

OpenAPI Generator generates API client libraries from OpenAPI Specs. It provides generators and library templates for supporting multiple languages and frameworks.

See also:

• OpenAPI Generator (maven Plugin)
• OpenAPI Generator (executable)
• CONFIG OPTIONS for java

OpenAPI Generator Plugin Configuration

<plugin>
               <groupId>org.openapitools</groupId>
               <artifactId>openapi-generator-maven-plugin</artifactId>
               <version>4.3.0</version>
               <executions>
                   <execution>
                       <goals>
                           <goal>generate</goal>
                       </goals>
                       <configuration>
                           <inputSpec>${project.basedir}/src/main/resources/locations-merchants-api-spec.yaml</inputSpec>
                           <generatorName>java</generatorName>
                           <library>okhttp-gson</library>
                           <configurationFile>${project.basedir}/src/main/resources/openapi-config.json</configurationFile>
                           <generateApiTests>false</generateApiTests>
                           <generateModelTests>false</generateModelTests>
                           <configOptions>
                               <sourceFolder>src/gen/java/main</sourceFolder>
                           </configOptions>
                       </configuration>
                   </execution>
               </executions>
</plugin>

Use Cases

Parameters

These are the parameters used for the Locations API. Few parameters are required.

Name	Type	Default Value	Purpose
client_id	String	null	For countries; client_id is used to identify the client performing the search.
country_code	String		For country subdivisions; country_code is used to identify the country to be searched.
offset	int	0	For Pagination; offset is used to offset the start of the list.
limit	int	25	For Pagination; limit is used to limit the number of entities returned
distance	int	5	For Merchants location information search based on radius; distance is used to search the length of distance from the centroid point.
distanceUnit	String	MILE	Unit of measurement for calculating the radius search; Measurement of distance unit in miles or kilometers. Value string (MILE or KM)

RequestBody

These are the parameters used for the Locations API. Few parameters are required.

Name	Type	Default Value	Purpose
addressLine1	String		For Merchants search; AddressLine1 is used to search the Merchants locations based on the address
addressLine2	String		For Merchants search; AddressLine2 is used to search the Merchants locations based on the address
city	String		For Merchants search; City is used to search the Merchants locations based of address
countrySubdivisionCode	String		For Merchants search; City is used to search the Merchants locations based of address
latitude	String		For Merchants search ; latitude is used to perform Merchants search based on latitude and longitude
longitude	String		For Merchants search ; latitude is used to perform Merchants search based on latitude and longitude
postalCode	String		For Merchants search; postal code is used to search Merchants locations based on the address
merchantType	String		For merchants location information offering services around 5 mile radius by specific coordinates or using a address; Type of merchant location. Options are 'paypass' 'repower' 'easysavings' and 'cashback'.

Countries

Get All Countries information.

Locations Merchants API URL	Method	Parameters	Request Model	Response model
/countries	GET	client_id		Countries

Country SubDivisions

Get Country Subdivisions based on country code.

Locations Merchants API URL	Method	Parameters	Request Model	Response model
/country-subdivisions	GET	countryCode, client_id		CountrySubdivisions

Merchant Categories

Get All merchant categories supported.

Locations Merchants API URL	Method	Parameters	Request Model	Response model
/categories	GET	client_id		Categories

Merchant Searches

Retrieving Merchants locations based on a latitude/longitude or on a physical address or postal code

Locations Merchants API URL	Method	Parameters	BodyParameters	Request Model	Response model
/searches	POST	offset,limit,distance,distanceUnit	addressLine1,addressLine2,city,countrySubdivisionCode,latitude,longitude,postalcode,merchantType	MerchantSearch	Merchants

API Reference

Reference Application API Reference

Reference App URL	Parameters	Reference App Usage	Locations Merchants Endpoint Used
/locations/merchants/countries	client_id	Lists countries that have Merchants offering services	/locations/merchants/countries
/locations/merchants/country-subdivisions	country_code,client_id	Lists country subdivisions that have Merchants offering the following services by country code USA or CAN	/locations/merchants/country-subdivisions
/locations/merchants/categories	client_id	Lists all the merchant categories supported	/locations/merchants/categories
/locations/merchants/searches	offset,limit,distance,distanceUnit,merchantType	Lists merchants location information offering services around 5 mile radius by specific coordinates or using a address	/locations/merchants/searches
Example Search Request in a rest client (or browser) of your choice: http://localhost:8080/locations/merchants/searches?latitude=45.50977&longitude=-73.55163

Locations Merchants API Reference

See the API Reference page in the documentation.

API Endpoint	Description
Get Countries	Lists countries that have Merchants offering services
Get Country Subdivisions Details	Lists country subdivisions that have Merchants offering the following services by country code USA or CAN
Get Merchants category	Lists all the merchant categories supported
Post Merchants Search	Lists merchants location information offering services by specific coordinates or using a address

Authentication

Mastercard oauth1 Signer Library

This dependency is required to properly call the API.

<dependency>
    <groupId>com.mastercard.developer</groupId>
    <artifactId>oauth1-signer</artifactId>
    <version>1.2.3</version>
</dependency>

Link to the oauth1 library's Github

Looking for other languages?

See the code used in this application to utilize the library.

Found in /src/java/com.mastercard.locationsatmsreferenceapplication.config.ApiClientConfiguration

ApiClient client = new ApiClient();
HttpLoggingInterceptor loggingInterceptor = new HttpLoggingInterceptor(logger::info);
loggingInterceptor.level(HttpLoggingInterceptor.Level.BASIC);
try {
    client.setBasePath(basePath);
    client.setHttpClient(
            client.getHttpClient()
                    .newBuilder()
                    .addInterceptor(new OkHttpOAuth1Interceptor(consumerKey, getSigningKey()))
                    .addInterceptor(loggingInterceptor)
                    .build()
    );

    return client;
} catch (Exception e) {
    logger.error("Error occurred while configuring ApiClient", e);
}
return client;

Support

If you would like further information, please send an email to [email protected]

License

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Copyright © 1994-2023, All Rights Reserved by Mastercard.