# Merchant Details Test Cases source: https://developer.mastercard.com/consumer-clarity/documentation/testing/test-cases-merchant-details/index.md This article provides test case data that shows the merchant detail responses you can expect to receive from some example requests sent to the Consumer Clarity API. ## Test Cases {#test-cases} Following are the types of test cases provided in this article: #### Missing country or region code still returns a merchant match {#missing-country-or-region-code-still-returns-a-merchant-match} * [TC1: Request sent without a country code](https://developer.mastercard.com/consumer-clarity/documentation/testing/test-cases-merchant-details/index.md#tc1-request-without-a-country-code) * [TC3: Request sent without a region code](https://developer.mastercard.com/consumer-clarity/documentation/testing/test-cases-merchant-details/index.md#tc3-request-without-a-region-code) * [TC6: Multiple merchant locations without a region code](https://developer.mastercard.com/consumer-clarity/documentation/testing/test-cases-merchant-details/index.md#tc6-response-for-the-same-merchant-different-locations) * [TC7: Multiple merchant locations with name and country code only](https://developer.mastercard.com/consumer-clarity/documentation/testing/test-cases-merchant-details/index.md#tc7-response-includes-both-merchant-and-industry-logos) #### Limited request fields returns no merchant match {#limited-request-fields-returns-no-merchant-match} * [TC2: Merchant name and location only in request](https://developer.mastercard.com/consumer-clarity/documentation/testing/test-cases-merchant-details/index.md#tc2-request-with-a-name-and-location-only) #### Similar request information returns different merchant results {#similar-request-information-returns-different-merchant-results} * [TC3: Request with no region code returns some merchant data](https://developer.mastercard.com/consumer-clarity/documentation/testing/test-cases-merchant-details/index.md#tc3-request-without-a-region-code) * [TC4: Request without a region code returns more data](https://developer.mastercard.com/consumer-clarity/documentation/testing/test-cases-merchant-details/index.md#tc4-request-without-a-region-code-returns-more-data) #### Multiple merchant locations identified for different scenarios {#multiple-merchant-locations-identified-for-different-scenarios} * [TC6: Same merchant has multiple locations in different countries](https://developer.mastercard.com/consumer-clarity/documentation/testing/test-cases-merchant-details/index.md#tc6-response-for-the-same-merchant-different-locations) * [TC7: Same merchant has multiple locations in the same country](https://developer.mastercard.com/consumer-clarity/documentation/testing/test-cases-merchant-details/index.md#tc7-response-includes-both-merchant-and-industry-logos) #### Different types of responses that include logos {#different-types-of-responses-that-include-logos} * [TC5: Response returns all merchant result fields](https://developer.mastercard.com/consumer-clarity/documentation/testing/test-cases-merchant-details/index.md#tc5-response-includes-all-merchant-result-fields) * [TC6: Industry logo returned for the same merchant with multiple locations](https://developer.mastercard.com/consumer-clarity/documentation/testing/test-cases-merchant-details/index.md#tc6-response-for-the-same-merchant-different-locations) * [TC7: Both merchant and industry logos are returned](https://developer.mastercard.com/consumer-clarity/documentation/testing/test-cases-merchant-details/index.md#tc7-response-includes-both-merchant-and-industry-logos)
This table shows the request fields that are part of each test case and lists the values that are used in each one. | Test Case | cardAcceptor Name | cardAcceptor Location | cardAcceptor RegionCode | cardAcceptor CountryCode | Merchant CategoryCode | |----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------|-----------------------|-------------------------|--------------------------|-----------------------| | [TC1](https://developer.mastercard.com/consumer-clarity/documentation/testing/test-cases-merchant-details/index.md#tc1-request-without-a-country-code) | SHOE STORE 1234 | AUSTIN | TX | null | 5661 | | [TC2](https://developer.mastercard.com/consumer-clarity/documentation/testing/test-cases-merchant-details/index.md#tc2-request-with-a-name-and-location-only) | SHOE STORE 1235 | AUSTIN | null | null | null | | [TC3](https://developer.mastercard.com/consumer-clarity/documentation/testing/test-cases-merchant-details/index.md#tc3-request-without-a-region-code) | ZZZ\*ACADEMY | NEW YORK | null | USA | null | | [TC4](https://developer.mastercard.com/consumer-clarity/documentation/testing/test-cases-merchant-details/index.md#tc4-request-without-a-region-code-returns-more-data) | ANT\*156LE | LEEDS | null | GBR | null | | [TC5](https://developer.mastercard.com/consumer-clarity/documentation/testing/test-cases-merchant-details/index.md#tc5-response-includes-all-merchant-result-fields) | APPLHMK | 8002325512 | NY | USA | null | | [TC6](https://developer.mastercard.com/consumer-clarity/documentation/testing/test-cases-merchant-details/index.md#tc6-response-for-the-same-merchant-different-locations) | MY CHUR-Z MY CHUR-Z | PASTIDA MARIETTA | null null | GRC USA | null null | | [TC7](https://developer.mastercard.com/consumer-clarity/documentation/testing/test-cases-merchant-details/index.md#tc7-response-includes-both-merchant-and-industry-logos) | THE WAREHOUSE THE WAREHOUSE | RICHMOND HAMILTON | null null | NZL NZL | null null | | | | | | | | ### TC1: Request without a country code {#tc1-request-without-a-country-code} In this scenario, a request is sent that doesn't include a value for the `cardAcceptorCountryCode` field. We are still able to find a merchant match and the merchant details are returned in the response. #### Request {#request} ```JSON { "locale": "en-US", "searchCriteria": [ { "merchantCriteria": { "cardAcceptorName": "SHOE STORE 1234", "cardAcceptorLocation": "AUSTIN", "cardAcceptorRegionCode": "TX", "cardAcceptorCountryCode": null, "merchantCategoryCode": "5661" } } ] } ``` #### Expected response {#expected-response} ```JSON { "searchResults": [ { "recordId": "0.4e53d117.1755716735.5931e894-01", "resultStatus": { "code": "OK", "message": "OK." }, "merchantResult": { "merchantName": "The Shoe Store", "address": { "line1": "100 Main St", "city": "Austin", "postalCode": "78701", "countryCode": "USA", "countryName": "United States", "countrySubdivisionCode": "TX" }, "merchantCategory": { "code": "5661", "description": "SHOE STORES" }, "logos": [ { "height": 200, "width": 200, "url": "https://sandbox.content.ethoca.com/b/industry/61d0cd49-f86b-4c55-afbc-ccdc30abf990.png?size=200", "type": "INDUSTRY", "altTextTag": "Shoe Stores Logo" }, { "height": 400, "width": 400, "url": "https://sandbox.content.ethoca.com/b/industry/61d0cd49-f86b-4c55-afbc-ccdc30abf990.png?size=400", "type": "INDUSTRY", "altTextTag": "Shoe Stores Logo" } ], "merchantLocation": { "latitude": "30.309558", "longitude": "-97.759881" }, "dataPolicy": { "cacheable": true, "cacheExpiry": "2025-08-21T19:05:36.230+0000" }, "resultStatus": { "code": "MERCHANT_FOUND", "message": "Merchant results provided." } }, "purchaseReceipt": { "resultStatus": { "code": "RECEIPT_NOT_AVAILABLE", "message": "Purchase Receipt not available for this merchant." } } } ] } ``` [Back to top](https://developer.mastercard.com/consumer-clarity/documentation/testing/test-cases-merchant-details/index.md#test-cases) ### TC2: Request with a name and location only {#tc2-request-with-a-name-and-location-only} For this test case, a request is sent that only includes values for `cardAcceptorName` and `cardAcceptorLocation`. This is a limited amount of `merchantCriteria ` request data, which can result in you not receiving a merchant match. In fact, for this particular test case, the result is that a "merchant not found" message is returned. #### Request {#request-1} ```JSON { "locale": "en-US", "searchCriteria": [ { "merchantCriteria": { "cardAcceptorName": "SHOE STORE 1235", "cardAcceptorLocation": "AUSTIN", "cardAcceptorRegionCode": null, "cardAcceptorCountryCode": null, "merchantCategoryCode": null } } ] } ``` #### Expected response {#expected-response-1} ```JSON { "searchResults": [ { "recordId": "0.4e53d117.1755717603.59841625-01", "resultStatus": { "code": "OK", "message": "OK." }, "merchantResult": { "resultStatus": { "code": "MERCHANT_NOT_FOUND", "message": "Merchant could not be identified; no merchant results available." } } } ] } ``` [Back to top](https://developer.mastercard.com/consumer-clarity/documentation/testing/test-cases-merchant-details/index.md#test-cases) ### TC3: Request without a region code {#tc3-request-without-a-region-code} In this scenario, a request is sent that doesn't include a value for the `cardAcceptorRegionCode` field. A merchant is found that matches and their information is returned in the response. #### Request {#request-2} ```JSON { "locale": "en-US", "searchCriteria": [ { "merchantCriteria": { "cardAcceptorName": "ZZZ*ACADEMY", "cardAcceptorLocation": "NEW YORK", "cardAcceptorRegionCode": null, "cardAcceptorCountryCode": "USA", "merchantCategoryCode": null } } ] } ``` #### Expected response {#expected-response-2} ```JSON { "searchResults": [ { "recordId": "0.cef8da17.1672866768.720b9889-01", "resultStatus": { "code": "OK", "message": "OK." }, "merchantResult": { "merchantName": "Ziggy's School Center", "address": { "line1": "99 Elm St", "city": "New York", "postalCode": "10001", "countryCode": "USA", "countryName": "United States", "countrySubdivisionCode": "NY" }, "merchantCategory": { "code": "7911", "description": "DANCE HALLS SCHOOLS AND STUDIOS" }, "logos": [ { "height": 400, "width": 400, "url": "https://sandbox.content.ethoca.com/b/industry/68c4ed8b-236d-4436-abca-657fb52345b4.png?size=400", "type": "INDUSTRY", "altTextTag": "Elementary, Middle, High Schools Logo" }, { "height": 200, "width": 200, "url": "https://sandbox.content.ethoca.com/b/industry/68c4ed8b-236d-4436-abca-657fb52345b4.png?size=200", "type": "INDUSTRY", "altTextTag": "Elementary, Middle, High Schools Logo" } ], "resultStatus": { "code": "MERCHANT_FOUND", "message": "Merchant results provided." } }, "purchaseReceipt": { "resultStatus": { "code": "RECEIPT_NOT_ACCESSIBLE", "message": "Purchase receipt service not configured for this account." } } } ] } ``` [Back to top](https://developer.mastercard.com/consumer-clarity/documentation/testing/test-cases-merchant-details/index.md#test-cases) ### TC4: Request without a region code returns more data {#tc4-request-without-a-region-code-returns-more-data} Sometimes, a request is made that provides `merchantCriteria` fields that are the same as another request, but different types of information are returned in the response. In this test case, a request is also sent that doesn't include a value for the `cardAcceptorRegionCode` field. A merchant is found that matches, and all merchant data is returned in the response, including `websiteUrl` and `merchantLocation`. #### Request {#request-3} ```JSON { "locale": "en-US", "searchCriteria": [ { "merchantCriteria": { "cardAcceptorName": "ANT*156LE", "cardAcceptorLocation": "LEEDS", "cardAcceptorRegionCode": null, "cardAcceptorCountryCode": "GBR", "merchantCategoryCode": null } } ] } ``` #### Expected response {#expected-response-3} ```JSON { "searchResults": [ { "recordId": "0.cef8da17.1672867829.721b9d54-01", "resultStatus": { "code": "OK", "message": "OK." }, "merchantResult": { "merchantName": "Antler's Bakery", "address": { "line1": "2 Trevelyan Sq", "city": "Leeds", "postalCode": "LS1 6ED", "countryCode": "GBR", "countryName": "United Kingdom" }, "websiteUrl": "www.antlersbakery.com", "merchantCategory": { "code": "5812", "description": "EATING PLACES RESTAURANTS" }, "logos": [ { "height": 400, "width": 400, "url": "https://sandbox.content.ethoca.com/b/industry/83433225-0188-4d92-9bf3-19b599ebf21a.png?size=400", "type": "INDUSTRY", "altTextTag": "T+E Restaurants Logo" }, { "height": 200, "width": 200, "url": "https://sandbox.content.ethoca.com/b/industry/83433225-0188-4d92-9bf3-19b599ebf21a.png?size=200", "type": "INDUSTRY", "altTextTag": "T+E Restaurants Logo" } ], "merchantLocation": { "latitude": "53.796152", "longitude": "-1.543300", "type": "ROOFTOP" }, "resultStatus": { "code": "MERCHANT_FOUND", "message": "Merchant results provided." } }, "purchaseReceipt": { "resultStatus": { "code": "RECEIPT_NOT_ACCESSIBLE", "message": "Purchase receipt service not configured for this account." } } } ] } ``` [Back to top](https://developer.mastercard.com/consumer-clarity/documentation/testing/test-cases-merchant-details/index.md#test-cases) ### TC5: Response includes all merchant result fields {#tc5-response-includes-all-merchant-result-fields} In this test case, all merchant data is returned, including an industry logo as well as latitude and longitude. #### Request {#request-4} ```JSON { "locale": "en-US", "searchCriteria": [ { "merchantCriteria": { "cardAcceptorName": "APPLHMK", "cardAcceptorLocation": "8002325512", "cardAcceptorRegionCode": "NY", "cardAcceptorCountryCode": "USA", "merchantCategoryCode": null } } ] } ``` #### Expected response {#expected-response-4} ```JSON { "searchResults": [ { "recordId": "0.cef8da17.1672867192.72118826-01", "resultStatus": { "code": "OK", "message": "OK." }, "merchantResult": { "merchantName": "Apple Hammock's", "address": { "line1": "303 Lafayette St", "city": "New York", "postalCode": "10012", "countryCode": "USA", "countryName": "United States", "countrySubdivisionCode": "NY" }, "merchantCategory": { "code": "5941", "description": "SPORTING GOODS STORES" }, "logos": [ { "height": 400, "width": 400, "url": "https://sandbox.content.ethoca.com/b/industry/515199cd-c345-4037-abf6-472f82ba89f5.png?size=400", "type": "INDUSTRY", "altTextTag": "Home Furnishings / Furniture Logo" }, { "height": 200, "width": 200, "url": "https://sandbox.content.ethoca.com/b/industry/515199cd-c345-4037-abf6-472f82ba89f5.png?size=200", "type": "INDUSTRY", "altTextTag": "Home Furnishings / Furniture Logo" } ], "merchantLocation": { "latitude": "42.280492", "longitude": "-73.753364" }, "resultStatus": { "code": "MERCHANT_FOUND", "message": "Merchant results provided." } }, "purchaseReceipt": { "resultStatus": { "code": "RECEIPT_NOT_ACCESSIBLE", "message": "Purchase receipt service not configured for this account." } } } ] } ``` [Back to top](https://developer.mastercard.com/consumer-clarity/documentation/testing/test-cases-merchant-details/index.md#test-cases) ### TC6: Response for the same merchant different locations {#tc6-response-for-the-same-merchant-different-locations} Here, you see a request for the same merchant but with two locations and no `cardAcceptorRegionCode` provided. The response returns merchant information for each location, which also includes an industry logo. #### Request {#request-5} ```JSON { "locale": "en-US", "searchCriteria": [ { "merchantCriteria": { "cardAcceptorName": "MY CHUR-Z", "cardAcceptorLocation": "PASTIDA", "cardAcceptorRegionCode": null, "cardAcceptorCountryCode": "GRC", "merchantCategoryCode": null } }, { "merchantCriteria": { "cardAcceptorName": "MY CHUR-Z", "cardAcceptorLocation": "MARIETTA", "cardAcceptorRegionCode": null, "cardAcceptorCountryCode": "USA", "merchantCategoryCode": null } } ] } ``` #### Expected response {#expected-response-5} ```JSON { "searchResults": [ { "recordId": "0.cef8da17.1672868131.7220c927-01", "resultStatus": { "code": "OK", "message": "OK." }, "merchantResult": { "merchantName": "My Churroz", "address": { "city": "Pastida", "postalCode": "85106", "countryCode": "GRC", "countryName": "Greece" }, "merchantCategory": { "code": "5812", "description": "EATING PLACES RESTAURANTS" }, "logos": [ { "height": 400, "width": 400, "url": "https://sandbox.content.ethoca.com/b/industry/66a0c66e-991b-4990-beac-c80cb50a3bb2.png?size=400", "type": "INDUSTRY", "altTextTag": "Eating Places Logo" }, { "height": 200, "width": 200, "url": "https://sandbox.content.ethoca.com/b/industry/66a0c66e-991b-4990-beac-c80cb50a3bb2.png?size=200", "type": "INDUSTRY", "altTextTag": "Eating Places Logo" } ], "merchantLocation": { "latitude": "36.385073", "longitude": "28.137748" }, "resultStatus": { "code": "MERCHANT_FOUND", "message": "Merchant results provided." } }, "purchaseReceipt": { "resultStatus": { "code": "RECEIPT_NOT_ACCESSIBLE", "message": "Purchase receipt service not configured for this account." } } }, { "recordId": "0.cef8da17.1672868131.7220c927-02", "resultStatus": { "code": "OK", "message": "OK." }, "merchantResult": { "merchantName": "My Churroz", "address": { "line1": "3460 Sandy Plains Rd, Suite 510", "city": "Marietta", "postalCode": "30066", "countryCode": "USA", "countryName": "United States", "countrySubdivisionCode": "GA" }, "merchantCategory": { "code": "5812", "description": "EATING PLACES RESTAURANTS" }, "logos": [ { "height": 400, "width": 400, "url": "https://sandbox.content.ethoca.com/b/industry/66a0c66e-991b-4990-beac-c80cb50a3bb2.png?size=400", "type": "INDUSTRY", "altTextTag": "Eating Places Logo" }, { "height": 200, "width": 200, "url": "https://sandbox.content.ethoca.com/b/industry/66a0c66e-991b-4990-beac-c80cb50a3bb2.png?size=200", "type": "INDUSTRY", "altTextTag": "Eating Places Logo" } ], "resultStatus": { "code": "MERCHANT_FOUND", "message": "Merchant results provided." } }, "purchaseReceipt": { "resultStatus": { "code": "RECEIPT_NOT_ACCESSIBLE", "message": "Purchase receipt service not configured for this account." } } } ] } ``` [Back to top](https://developer.mastercard.com/consumer-clarity/documentation/testing/test-cases-merchant-details/index.md#test-cases) ### TC7: Response includes both merchant and industry logos {#tc7-response-includes-both-merchant-and-industry-logos} In this test case, the request is made for the same merchant but with two locations and only provides a `cardAcceptorName`, `cardAcceptorLocation`, and `cardAcceptorCountryCode`. The merchant is matched and the response returns information for each location, which includes both a merchant logo and an industry logo. #### Request {#request-6} ```JSON { "locale": "en-US", "searchCriteria": [ { "merchantCriteria": { "cardAcceptorName": "THE WAREHOUSE", "cardAcceptorLocation": "RICHMOND", "cardAcceptorRegionCode": null, "cardAcceptorCountryCode": "NZL", "merchantCategoryCode": null } }, { "merchantCriteria": { "cardAcceptorName": "THE WAREHOUSE", "cardAcceptorLocation": "HAMILTON", "cardAcceptorRegionCode": null, "cardAcceptorCountryCode": "NZL", "merchantCategoryCode": null } } ] } ``` #### Expected response {#expected-response-6} ```JSON { "searchResults": [ { "recordId": "0.cef8da17.1672868422.7224fd12-01", "resultStatus": { "code": "OK", "message": "OK." }, "merchantResult": { "merchantName": "THE WAREHOUSE RICHMOND", "address": { "line1": "186 QUEEN STREET", "city": "RICHMOND", "postalCode": "1010", "countryCode": "NZL", "countryName": "New Zealand" }, "merchantCategory": { "code": "5399", "description": "MISCELLANEOUS GENERAL MERCHANDISE" }, "logos": [ { "height": 400, "width": 400, "url": "https://sandbox.content.ethoca.com/b/industry/d22edc85-c3ab-43ed-94b4-3448cfea274f.png?size=400", "type": "INDUSTRY", "altTextTag": "Discount Department Stores Logo" }, { "height": 200, "width": 200, "url": "https://sandbox.content.ethoca.com/b/industry/d22edc85-c3ab-43ed-94b4-3448cfea274f.png?size=200", "type": "INDUSTRY", "altTextTag": "Discount Department Stores Logo" }, { "height": 200, "width": 200, "url": "https://sandbox.content.ethoca.com/b/merchant/b70c63d6-e9f3-4933-bc02-a5fc0ae010b9.png?size=200", "type": "MERCHANT", "altTextTag": "The Warehouse Logo" }, { "height": 400, "width": 400, "url": "https://sandbox.content.ethoca.com/b/merchant/b70c63d6-e9f3-4933-bc02-a5fc0ae010b9.png?size=400", "type": "MERCHANT", "altTextTag": "The Warehouse Logo" } ], "merchantLocation": { "latitude": "-36.769450", "longitude": "174.882750" }, "resultStatus": { "code": "MERCHANT_FOUND", "message": "Merchant results provided." } }, "purchaseReceipt": { "resultStatus": { "code": "RECEIPT_NOT_ACCESSIBLE", "message": "Purchase receipt service not configured for this account." } } }, { "recordId": "0.cef8da17.1672868422.7224fd12-02", "resultStatus": { "code": "OK", "message": "OK." }, "merchantResult": { "merchantName": "THE WAREHOUSE 141", "address": { "line1": "130 WARD STREET", "city": "HAMILTON", "postalCode": "3204", "countryCode": "NZL", "countryName": "New Zealand" }, "merchantCategory": { "code": "5310", "description": "DISCOUNT STORES" }, "logos": [ { "height": 400, "width": 400, "url": "https://sandbox.content.ethoca.com/b/industry/d22edc85-c3ab-43ed-94b4-3448cfea274f.png?size=400", "type": "INDUSTRY", "altTextTag": "Discount Department Stores Logo" }, { "height": 200, "width": 200, "url": "https://sandbox.content.ethoca.com/b/industry/d22edc85-c3ab-43ed-94b4-3448cfea274f.png?size=200", "type": "INDUSTRY", "altTextTag": "Discount Department Stores Logo" }, { "height": 200, "width": 200, "url": "https://sandbox.content.ethoca.com/b/merchant/b70c63d6-e9f3-4933-bc02-a5fc0ae010b9.png?size=200", "type": "MERCHANT", "altTextTag": "The Warehouse Logo" }, { "height": 400, "width": 400, "url": "https://sandbox.content.ethoca.com/b/merchant/b70c63d6-e9f3-4933-bc02-a5fc0ae010b9.png?size=400", "type": "MERCHANT", "altTextTag": "The Warehouse Logo" } ], "merchantLocation": { "latitude": "-37.787330", "longitude": "175.278920" }, "resultStatus": { "code": "MERCHANT_FOUND", "message": "Merchant results provided." } }, "purchaseReceipt": { "resultStatus": { "code": "RECEIPT_NOT_ACCESSIBLE", "message": "Purchase receipt service not configured for this account." } } } ] } ``` [Back to top](https://developer.mastercard.com/consumer-clarity/documentation/testing/test-cases-merchant-details/index.md#test-cases) ## Next Steps {#next-steps} * [Testing](https://developer.mastercard.com/consumer-clarity/documentation/testing/index.md) shows you where to find other types of test cases that you can run. * [API Reference](https://developer.mastercard.com/consumer-clarity/documentation/api-reference/index.md#apis) provides details about all of the fields and values in the Consumer Clarity API. * See [Code and Formats](https://developer.mastercard.com/consumer-clarity/documentation/code-and-formats/index.md) for detailed information about error response handling.