Identify a merchant in Mastercard data based on provided metadata
GET {{baseUrl}}/matches?company_name=SingleMatchCompany&street_address=2000 Purchase St&postal_code=CQ0DW8NGR6&city=Purchase&state_province_code=NY&country_code=USA
Using the provided merchant metadata, similarity to merchant information in Mastercard's central locations table is determined and up to 10 of the best matches are returned for consideration.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
company_name | string | (Required) Name of merchant, limited to 250 characters. | |
street_address | string | (Required) The full street address of the merchant, limited to 250 characters. | |
postal_code | string | (Required) The postal code in the merchant's address. Expectations on returned values can be set based on country_code - e.g. for USA a 5-digit zip or 9-digit zip+4 (with the hyphen) postal code is expected. | |
city | string | (Required) The city name in the merchant's address. This is limited to alphanumeric characters, spaces, single quotes, and commas, and must not be more than 100 characters. | |
state_province_code | string | (Required) The state or province abbreviation in the merchant's address. Expected conventions will be determined based on country_code - e.g. for USA a 2-letter abbreviation is expected. | |
country_code | string | (Required) The 3-letter country abbreviation for the merchant. These abbreviations follow https://www.iso.org/iso-3166-country-codes.html, but only currently-supported countries will be accepted. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
[{"locationId":"00000000-0000-0000-0000-000000000001","matchRank":1,"merchantName":"SingleMatchCompany","streetAddress":"2000 Purchase St","city":"Purchase","state":"NY","postalCode":10577,"countryCode":"USA"}]