# Parameters
source: https://developer.mastercard.com/merchant-match-tool/documentation/parameters/index.md

## Single API {#single-api}

### Request Parameters {#request-parameters}

The following are the request parameters for the single-search API.

| Query Field Name |                                    Description                                    |  Type  |      Example      |
|------------------|-----------------------------------------------------------------------------------|--------|-------------------|
| merchantName     | Merchant Name to be queried. Alphanumeric characters allowed. Max length: 110     | string | Starbucks, Inc.   |
| streetAddress    | Alphanumeric characters allowed. Max length: 110                                  | string | 10 Main St, Apt 3 |
| city             | Alpha characters allowed. Max length: 30                                          | string | Los Angeles       |
| state            | Alpha characters allowed. Max length: 3                                           | string | NY                |
| postalCode       | Alphanumeric characters allowed. Max length: 10                                   | string | 10577             |
| country          | Alpha characters allowed. Max length: 3                                           | string | USA               |
| phoneNumber      | Alphanumeric characters allowed. Max length: 16                                   | string | 9175763488        |
| taxId            | Alphanumeric characters allowed (for USA it should only be digits). Max length: 9 | string | 834706918         |

### Response Parameters {#response-parameters}

The following are the response parameters for the single-search API.

|   Query Field Name   |                                                              Description                                                              |      Type      |      Example      |
|----------------------|---------------------------------------------------------------------------------------------------------------------------------------|----------------|-------------------|
| matched              | Match versus No-Match Indicator (Y or N)                                                                                              | boolean        | true              |
| confidenceLevel      | Matched confidence level (HIGH,MEDIUM or LOW)                                                                                         | string         | HIGH              |
| merchantId           | Id of the merchant in the database                                                                                                    | integer        | 7732345           |
| matchedName          | Matched Merchant name. (Alphanumeric characters allowed. Max length: 110)                                                             | string         | Starbucks, Inc.   |
| matchedStreet        | Matched Street Address of the merchant (Alpha numeric characters allowed. Max length: 110)                                            | string         | 10 Main St, Apt 3 |
| matchedCity          | Matched city of the merchant (Alpha characters allowed. Max length: 30)                                                               | string         | Los Angeles       |
| matchedState         | Matched state of the merchant (Alpha characters allowed. Max length: 3)                                                               | string         | NY                |
| matchedPostalCode    | Matched Postal Code of the merchant (Alphanumeric characters allowed. Max length: 10)                                                 | string         | 10577             |
| matchedCountry       | Matched country of the merchant (Alpha characters allowed. Max length: 3)                                                             | string         | USA               |
| matchedPhone         | Matched phone number of the merchant (Alpha numeric characters allowed. Max length: 16)                                               | string         | 9175763488        |
| matchedTaxId         | Matched tax id of the merchant (Alpha numeric characters allowed. Max length: 9)                                                      | string         | 834706918         |
| clearingLastSeenDate | Clearing Last seen date of the merchant                                                                                               | string ($date) | 2002-05-30        |
| transcationRecency   | Time period between Clearing Last Seen Date and Match Response Date for the Matched Supplier                                          | string         | 1 month           |
| mcc                  | Merchant Category Code                                                                                                                | integer(32)    | 1711              |
| mccGroup             | Merchant Category Code Group                                                                                                          | string         | Service Providers |
| purchaseCardLevel    | The maximum number of purchase card addenda the Supplier has processed with transactions. Purchase Card Level can be either 0, 1 or 2 | integer(32)    | 0                 |

## Multiple API {#multiple-api}

### Request Parameters {#request-parameters-1}

The following are the request parameters for the multiple-search API.

| Query Field Name |                                  Description                                  |  Type  |               Example                |
|------------------|-------------------------------------------------------------------------------|--------|--------------------------------------|
| requestId        | Every request must contain a request id as an identifier (UUID)               | string | 4b4961a2-2fd2-4308-813c-8b1f08503d9f |
| merchantName     | Merchant Name to be queried. Alphanumeric characters allowed. Max length: 110 | string | Starbucks, Inc.                      |
| streetAddress    | Alphanumeric characters allowed. Max length: 110                              | string | 10 Main St, Apt 3                    |
| city             | Alpha characters allowed. Max length: 30                                      | string | Los Angeles                          |
| state            | Alpha characters allowed. Max length: 3                                       | string | NY                                   |
| postalCode       | Alphanumeric characters allowed. Max length: 10                               | string | 10577                                |
| country          | Alpha characters allowed. Max length: 3                                       | string | USA                                  |
| phoneNumber      | Alphanumeric characters allowed. Max length: 16                               | string | 9175763488                           |
| taxId            | Alphanumeric characters allowed. Max length: 9                                | string | 834706918                            |

### Response Parameters {#response-parameters-1}

The following are the response parameters for the multiple-search API.

|   Query Field Name   |                                                              Description                                                              |     Type      |      Example      |
|----------------------|---------------------------------------------------------------------------------------------------------------------------------------|---------------|-------------------|
| matched              | Match versus No-Match Indicator                                                                                                       | boolean       | true              |
| confidenceLevel      | Matched confidence level( high, medium or low)                                                                                        | string        | HIGH              |
| merchantId           | Id of the merchant in the database                                                                                                    | integer(64)   | 7732345           |
| matchedName          | Matched Merchant name. (Alphanumeric characters allowed. Max length: 110)                                                             | string        | Starbucks, Inc.   |
| matchedStreet        | Matched Street Address of the merchant (Alpha numeric characters allowed. Max length: 110)                                            | string        | 10 Main St, Apt 3 |
| matchedCity          | Matched city of the merchant (Alpha characters allowed. Max length: 30)                                                               | string        | Los Angeles       |
| matchedState         | Matched state of the merchant (Alpha characters allowed. Max length: 3)                                                               | string        | NY                |
| matchedPostalCode    | Matched Postal Code of the merchant (Alphanumeric characters allowed. Max length: 10)                                                 | string        | 10577             |
| matchedCountry       | Matched country of the merchant (Alpha characters allowed. Max length: 3)                                                             | string        | USA               |
| matchedPhone         | Matched phone number of the merchant (Alpha numeric characters allowed. Max length: 16)                                               | string        | 9175763488        |
| matchedTaxId         | Matched tax id of the merchant (Alpha numeric characters allowed. Max length: 9)                                                      | string        | 834706918         |
| clearingLastSeenDate | Clearing Last seen date of the merchant                                                                                               | string($date) | 2002-05-30        |
| transcationRecency   | Time period between Clearing Last Seen Date and Match Response Date for the Matched Supplier                                          | string        | 1 month           |
| mcc                  | Merchant Category Code                                                                                                                | integer(32)   | 1711              |
| mccGroup             | Merchant Category Code Group                                                                                                          |               | Service Providers |
| purchaseCardLevel    | The maximum number of purchase card addenda the Supplier has processed with transactions. Purchase Card Level can be either 0, 1 or 2 | integer(32)   | 0                 |