GET//
Use this endpoint to search for retail store locations that support cash loads.
URL query parameters
| Fields | Description |
|---|---|
| start_index integer Optional | Sort order index of the first resource in the returned array. Allowable Values: 0 min |
| count integer Optional | Number of resources to retrieve. Allowable Values: 1 min 1-100 |
| latitude decimal Optional | Latitude of the geographic coordinates to retrieve. Allowable Values: -90–90 |
| longitude decimal Optional | Longitude of the geographic coordinates to retrieve. Allowable Values: -180–180 |
| postal_code string Optional | Postal code (zip code) to retrieve. Allowable Values: Example: 94612 |
| radius decimal Optional | Radius from latitude and longitude provided for the store. Allowable Values: 0.1–25 |
Response body
| Fields | Description |
|---|---|
| count integer Returned | Number of store locations returned. Allowable Values: 1-100 |
| start_index integer Returned | Sort order index of the first resource in the returned array. Allowable Values: Any integer |
| end_index integer Returned | Sort order index of the last resource in the returned array. Allowable Values: Any integer |
| is_more boolean Returned | A value of true indicates that more unreturned resources exist.Allowable Values: true, false |
| data array of objects Returned | Array of store location objects. Allowable Values: Valid array of one or more store location objects |
| data[].name string Conditionally returned | Name of the store location. Allowable Values: 255 char max |
| data[].address string Conditionally returned | Street address of the store location. Allowable Values: 255 char max |
| data[].city string Conditionally returned | City of the store location. Allowable Values: 40 char max |
| data[].state string Conditionally returned | State of the store location. Allowable Values: 32 char max |
| data[].postal_code string Conditionally returned | Postal code (zip code) of the store location. Allowable Values: 10 char max |
| data[].latitude decimal Conditionally returned | Latitude of the store location. Allowable Values: -90-90 |
| data[].longitude decimal Conditionally returned | Longitude of the store location. Allowable Values: -180-180 |
| data[].metadata object Conditionally returned | Custom metadata associated with the store location. Allowable Values: You can define the names and values of up to 20 fields in the format "my_name_1": "my_value_1". |
Sample response body
JSON
{
"count": 1,
"start_index": 0,
"end_index": 0,
"is_more": false,
"data": [
{
"name": "Marqeta",
"address": "180 Grand Ave",
"city": "Oakland",
"state": "CA",
"postal_code": "94612",
"latitude": 37.8085,
"longitude": -122.2668
}
]
}