API Reference

Get Retail Locations List

get
https://example.com/programs//locations/retail

The Retail Locator API allows you to search for retail locations (based on proximity) that allow swipeReload and eCash. Search participating retail locations

Path Params
string
required

The Program code for the locator search context.

Query Params
string

The City name to filter retail locations. Optional.

string

The State or province code (e.g., "CA" for California). Optional.

string

The Postal or ZIP code to filter retail locations. Optional.

double

The Latitude coordinate for proximity search. Optional, used with longitude.

double

The Longitude coordinate for proximity search. Optional, used with latitude.

string

The Comma-separated list of features to filter locations (e.g., "swipeReload,eCash"). Optional.

int32

The Search radius in miles. Optional. Default is 20 miles if not specified.

int32

The Page number for paginated results. Optional. Default is 1. Range: 1-100.

int32

The Page size (number of results per page). Optional. Default is 20. Range: 1-1000.

Headers
string
required

The Unique request identifier for tracking and logging.

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

401

Unauthorized

Updated 2 months ago

Language
Credentials
Header
LoadingLoading…
Response
Choose an example:
application/json
text/json

Updated 2 months ago