Cash Deposits
Unit provides an API for nearby Cash Deposit store location search.
The API supports searching by coordinates and postal code.
List Cash Deposit store locations by coordinates.
| Verb | GET |
| Url | https://api.s.unit.sh/store-locations |
| Timeout (Seconds) | 120 |
Query Parameters#
| Name | Type | Default | Description |
|---|---|---|---|
| filter[coordinates] | JSON object | Filters the results by the specified coordinates. | |
| filter[serviceType] | string | Swipe | Optional. Filters the results by the specified service type. Possible values are: Swipe, Barcode. |
| page[limit] | integer | 100 | Optional. Maximum number of resources that will be returned. Maximum is 1000 resources. See Pagination. |
| page[offset] | integer | 0 | Optional. Number of resources to skip. See Pagination. |
curl -X GET 'https://api.s.unit.sh.co/store-locations?filter[coordinates]={"longitude": "-71.935242", "latitude": "40.730610"}' \-H "Authorization: Bearer ${TOKEN}"Response#
Response is a JSON:API document.
200 OK#
| Field | Type | Description |
|---|---|---|
| data | Array of Store Location | Array of Cash Deposit Store Location resources. |
| meta | JSON object that contains pagination data | Pagination data includes offset, limit and total (total items). |
Example Response:
{ "data": [ { "type": "storeLocation", "attributes": { "storeId": "2385", "retailerName": "CVS", "phone": "5163248587", "address": { "street": "38 Pantigo Rd", "city": "East Hampton", "state": "NY", "postalCode": "11937", "country": "US" }, "coordinates": { "longitude": -72.182441, "latitude": 40.965453 }, "distance": 20.74174506966581 } }, { "type": "storeLocation", "attributes": { "storeId": "4385", "retailerName": "7-Eleven", "phone": "6316682842", "address": { "street": "653 Montauk Hwy", "city": "Montauk", "state": "NY", "postalCode": "11954", "country": "US" }, "coordinates": { "longitude": -71.9495, "latitude": 41.032124 }, "distance": 20.8461474146222 } } ], "meta": { "pagination": { "total": 178, "limit": 2, "offset": 0 } }}
List Cash Deposit store locations by postal code.
| Verb | GET |
| Url | https://api.s.unit.sh/store-locations |
| Timeout (Seconds) | 120 |
Query Parameters#
| Name | Type | Default | Description |
|---|---|---|---|
| filter[postalCode] | string | Filters the results by the specified postal code. | |
| filter[serviceType] | string | Swipe | Optional. Filters the results by the specified service type. Possible values are: Swipe, Barcode. |
| page[limit] | integer | 100 | Optional. Maximum number of resources that will be returned. Maximum is 1000 resources. See Pagination. |
| page[offset] | integer | 0 | Optional. Number of resources to skip. See Pagination. |
curl -X GET 'https://api.s.unit.sh/store-locations?filter[postalCode]=12300' \-H "Authorization: Bearer ${TOKEN}"Response#
Response is a JSON:API document.
200 OK#
| Field | Type | Description |
|---|---|---|
| data | Array of Store Location | Array of Cash Deposit Store Location resources. |
| meta | JSON object that contains pagination data | Pagination data includes offset, limit and total (total items). |
Example Response:
{ "data": [ { "type": "storeLocation", "attributes": { "storeId": "2385", "retailerName": "CVS", "phone": "5163248587", "address": { "street": "38 Pantigo Rd", "city": "East Hampton", "state": "NY", "postalCode": "11937", "country": "US" }, "coordinates": { "longitude": -72.182441, "latitude": 40.965453 }, "distance": 20.74174506966581 } }, { "type": "storeLocation", "attributes": { "storeId": "4385", "retailerName": "7-Eleven", "phone": "6316682842", "address": { "street": "653 Montauk Hwy", "city": "Montauk", "state": "NY", "postalCode": "11954", "country": "US" }, "coordinates": { "longitude": -71.9495, "latitude": 41.032124 }, "distance": 20.8461474146222 } } ], "meta": { "pagination": { "total": 178, "limit": 2, "offset": 0 } }}