API Reference

This will return a full detailed list of Merchants and Merchant Locations approved for your partner catalog. This is particularly useful when the user has given location permission or is in a UX that contemplates proximity/location. An example of this is on the main dashboard for CrayPay under the “Nearby” tab.

This will generate a very large number of results(possibly hundreds of thousands), based on the catalog for your partnership and the parameters you pass in the call. We strongly recommend starting the “Radius” in the parameters with a default of less than 10 miles and limiting to no more than 100 (miles). The results can be used for filtering, sorting, searching, and other “discovery” and “display” experiences.

The suggested handling of locations is to only display the closest location of each merchant in the results, but allowing a user to view all locations in a drill-down or secondary/tertiary CTA

Log in to see full request history
Body Params
int32
string | null

Accepts string filter input for Search Criteria.

array of int64s | null

Accepts string filter input for Category.

Categories
double | null

Accepts string filter input for Discount.

double | null

Accepts string filter input for Latitude.

double | null

Accepts string filter input for Longitude.

int32 | null

Accepts integer filter input for radius (miles) within current location.

Response

Language
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json