v1

latestOpenAPI 3.0.12026-07-243407211.3 MB
Locator

Get Retail Locations List

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

get/programs/{programCode}/locations/retail

Path parameters

programCodestring required

The Program code for the locator search context.

Query parameters

citystring

The City name to filter retail locations. Optional.

statestring

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

postalCodestring

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

latitudenumber double

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

longitudenumber double

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

featureSetstring

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

radiusinteger

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

offsetinteger

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

limitinteger

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

Headers

X-GD-RequestIdstring required

The Unique request identifier for tracking and logging.

Response

OK

totalRecordCountinteger

The total number of retail location records available for the query.

offsetinteger

The offset (starting index) for the current page of results.

limitinteger

The maximum number of retail locations returned in this response (page size).