Retrieve a list of ATMs in a given area.
Method | URL |
---|---|
GET | locations/atm?spatialFilter=:spatialFilter&count=:count&key=:key[&filter=:filter][&start=:start][&distanceUnit=:distanceUnit][&format=:format[&callback=:callback]] |
Type | Parameter Name | Required | Value type | Range |
---|---|---|---|---|
URL_PARAM | spatialFilter | Yes | string | |
URL_PARAM | filter | No | string | |
URL_PARAM | start | No | number | 0..49 |
URL_PARAM | count | Yes | number | 1..50 |
URL_PARAM | distanceUnit | No | string | mile | kilometer |
URL_PARAM | format | No | string | xml | json |
URL_PARAM | callback | No | string | |
URL_PARAM | key | Yes | string |
spatialFilter is required. The spatialFilter indicates the geographical area of interest.
There are two different formats of spatialFilter available:
Search | Kind | Format |
---|---|---|
nearby | Radius | nearby(:latitude,:longitude,:distance) |
bbox | Viewport | bbox(:southern_latitude, :southern_longitude, :northern_latitude, :northern_longitude) |
Use a radius search when searching around a specific place (address, ZIP code, landmark, etc.) and you have the locations' map coordinates latitude and longitude. Set distance to the radius of the search circle. The distance is expected to be in miles unless overriden with the distanceUnit parameter (defined below).
Use a viewport search when you wish to display all locations that would be visible on a given map rectangular area.
Note: No locations will be returned if there are more than 50 locations within the viewport.
Sub Parameter | Value type | Range |
---|---|---|
latitude | decimal | -90..90 |
longitude | decimal | -180..180 |
distance | integer | 1..10 |
Examples:
filter is optional. Use filter to limit the list of ATMs to only those with certain features/properties. Its value is a simple boolean expression.
Attributes available are:
Name | Description |
---|---|
IsDepositAvailable | Indicates that deposits can be made at the location. |
IsHandicappedAccessible | Indicates that the location is handicapped accessible. |
IsAvailable24Hours | Indicates that the location is open 24/7. |
Examples:
start is optional, zero based (meaning that the first record is record 0) and will default to 0. Use start to indicate the first row of results to be returned. The maximum value allowed is 49.
Examples:
count is required. Use count to indicate the number of rows to return. The maximum value allowed is 50.
Examples:
distanceUnit is optional, and will default to mile. It indicates the distance unit used in the nearby spatialFilter for the distance (3rd component value).
Examples:
format is optional. Use format indicate how the response should be formatted. Either JSON or XML.
Note: If a format is not specified, then the request headers will be used to determine the most appropriate response format.
Examples:
callback is optional and only applicable if format=json or the headers indicate a json response. Its use indicates a JSONP response is desired. Set callback to name of the JavaScript function name to call with the response data as its parameter.
Examples:
key is required. The key is used to validate the request source. You will be assigned a key to use for all requests. You may only use a key that has been assigned to you.
Example:
Status | Response |
---|---|
200 |
Response will be an object containing the status, and the list (array) of ATMs found.
{
Each
{
|
401 | "No valid authorization data provided" Indicates that the key parameter is missing or invalid/incorrect. |
403 |
Either of the following:
|
500 | Varies. |
Property | Description |
---|---|
Status |
|
statusMessage |
Provides some additional detail about the current status where available.
Note: If using a debug key, then a more explicit/descriptive response may be present. |
totalFound | The total number of ATMs found based on the criteria. Will not exceed 50. |
results | List of Found ATM Locations, or null. |
The following example requests the first closest 6 ATMs within 100 miles of 41.944366455078125, -87.65599822998047. The results are requested in JSON format.
https://locatorapistaging.moneypass.com/Service.svc/locations/atm?format=json&spatialFilter=nearby(41.944366455078125%2C-87.65599822998047%2C100)&start=0&count=6&key=MoneyPassLocatorApiKey
{ "status": "Success", "statusMessage": null, "results": [ { "atmLocation": { "address": { "city": "CHICAGO", "country": "USA", "postalCode": "60613", "state": "IL", "street": "3636 N BROADWAY ST" }, "coordinates": { "latitude": 41.94807, "longitude": -87.64778 }, "id": "100186", "name": "WAL-MART", "isAvailable24Hours": false, "isDepositAvailable": false, "isCashDepositOnlyAvailable": true, "isHandicappedAccessible": false, "isOffPremise": true, "isSeasonal": false, "languageType": null, "locationDescription": "STORE", "logoName": "WAL", "terminalId": "7E150457", "participantId": "FCT3" }, "distance": 0.49428558 }, { "atmLocation": { "address": { "city": "Chicago", "country": "USA", "postalCode": "60614", "state": "IL", "street": "2541 N Sheffield" }, "coordinates": { "latitude": 41.928307, "longitude": -87.65363 }, "id": "84998", "name": "Corporate America Family CU", "isAvailable24Hours": false, "isDepositAvailable": false, "isCashDepositOnlyAvailable": false, "isHandicappedAccessible": false, "isOffPremise": false, "isSeasonal": false, "languageType": null, "locationDescription": "Corporate America Family Credit Union", "logoName": "PAS", "terminalId": "7E150458", "participantId": "FCT3" }, "distance": 1.1175438 }, { "atmLocation": { "address": { "city": "CHICAGO", "country": "USA", "postalCode": "60614", "state": "IL", "street": "2550 NORTH CLYBOURN AVENUE" }, "coordinates": { "latitude": 41.92771, "longitude": -87.67458 }, "id": "81389", "name": "U.S. Bank Clybourn Avenue - Dominick's", "isAvailable24Hours": false, "isDepositAvailable": true, "isCashDepositOnlyAvailable": true, "isHandicappedAccessible": false, "isOffPremise": false, "isSeasonal": false, "languageType": null, "locationDescription": "USB CLYBOURN AVE DOMINICK", "logoName": "PAS", "terminalId": "7E150459", "participantId": "FCT3" }, "distance": 1.4972314 }, { "atmLocation": { "address": { "city": "Chicago", "country": "USA", "postalCode": "60614", "state": "IL", "street": "1953 North Clybourn Avenue" }, "coordinates": { "latitude": 41.916664, "longitude": -87.65743 }, "id": "79462", "name": "U.S. Bank Lincoln Park", "isAvailable24Hours": false, "isDepositAvailable": true, "isCashDepositOnlyAvailable": false, "isHandicappedAccessible": false, "isOffPremise": false, "isSeasonal": false, "languageType": null, "locationDescription": "US BANK LINCOLN PARK", "logoName": "PAS", "terminalId": "7E160457", "participantId": "FCT3" }, "distance": 1.9175832 }, { "atmLocation": { "address": { "city": "CHICAGO", "country": "USA", "postalCode": "60640", "state": "IL", "street": "4928 N BROADWAY ST" }, "coordinates": { "latitude": 41.972424, "longitude": -87.660225 }, "id": "86843", "name": "Cathay Bank", "isAvailable24Hours": false, "isDepositAvailable": false, "isCashDepositOnlyAvailable": true, "isHandicappedAccessible": false, "isOffPremise": false, "isSeasonal": false, "languageType": null, "locationDescription": "Financial Institution", "logoName": "PAS", "terminalId": "7E160557", "participantId": "FCT3" }, "distance": 1.9529327 }, { "atmLocation": { "address": { "city": "CHICAGO", "country": "USA", "postalCode": "60625", "state": "IL", "street": "4400 N. WESTERN" }, "coordinates": { "latitude": 41.96153, "longitude": -87.68905 }, "id": "85957", "name": "ALBANY BANK AND TRUST COMPANY", "isAvailable24Hours": false, "isDepositAvailable": false, "isHandicappedAccessible": false, "isOffPremise": false, "isSeasonal": false, "languageType": null, "locationDescription": "4400 N. WESTERN, CHICAGO, IL, 60625, USA", "logoName": "PAS", "terminalId": "7E162457", "participantId": "FCT3" }, "distance": 2.0736642 } ], "totalFound": 50 }
The following example requests the first closest 6 ATMs within 100 miles of 41.944366455078125, -87.65599822998047. The results are requested in XML format.
https://locatorapistaging.moneypass.com/Service.svc/locations/atm?format=xml&spatialFilter=nearby(41.944366455078125%2C-87.65599822998047%2C100)&start=0&count=6&key=MoneyPassLocatorApiKey
<?xml version="1.0" encoding="UTF-8"?> <getAtmLocationsResponse xmlns="http://schemas.datacontract.org/2004/07/SpatialPoint.MoneyPass.LocatorApi.ServiceLibrary.DataTransferObjects" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <status>Success</status> <statusMessage i:nil="true" /> <results> <foundAtmLocation> <atmLocation> <address> <city>CHICAGO</city> <country>USA</country> <postalCode>60613</postalCode> <state>IL</state> <street>3636 N BROADWAY ST</street> </address> <coordinates> <latitude>41.948069</latitude> <longitude>-87.647781</longitude> </coordinates> <id>100186</id> <name>WAL-MART</name> <isAvailable24Hours>false</isAvailable24Hours> <isDepositAvailable>false</isDepositAvailable> <isCashDepositOnlyAvailable>false</isCashDepositOnlyAvailable> <isHandicappedAccessible>false</isHandicappedAccessible> <isOffPremise>true</isOffPremise> <isSeasonal>false</isSeasonal> <languageType i:nil="true" /> <locationDescription>STORE</locationDescription> <logoName>WAL</logoName> <terminalId>7E150457</logoName> <participantId>FCT3</logoName> </atmLocation> <distance>0.4942855977275884</distance> </foundAtmLocation> <foundAtmLocation> <atmLocation> <address> <city>Chicago</city> <country>USA</country> <postalCode>60614</postalCode> <state>IL</state> <street>2541 N Sheffield</street> </address> <coordinates> <latitude>41.928306</latitude> <longitude>-87.65363</longitude> </coordinates> <id>84998</id> <name>Corporate America Family CU</name> <isAvailable24Hours>false</isAvailable24Hours> <isDepositAvailable>false</isDepositAvailable> <isCashDepositOnlyAvailable>true</isCashDepositOnlyAvailable> <isHandicappedAccessible>false</isHandicappedAccessible> <isOffPremise>false</isOffPremise> <isSeasonal>false</isSeasonal> <languageType i:nil="true" /> <locationDescription>Corporate America Family Credit Union</locationDescription> <logoName>PAS</logoName> <terminalId>7E150458</logoName> <participantId>FCT3</logoName> </atmLocation> <distance>1.1175437975417684</distance> </foundAtmLocation> <foundAtmLocation> <atmLocation> <address> <city>CHICAGO</city> <country>USA</country> <postalCode>60614</postalCode> <state>IL</state> <street>2550 NORTH CLYBOURN AVENUE</street> </address> <coordinates> <latitude>41.927711</latitude> <longitude>-87.674583</longitude> </coordinates> <id>81389</id> <name>U.S. Bank Clybourn Avenue - Dominick's</name> <isAvailable24Hours>false</isAvailable24Hours> <isDepositAvailable>true</isDepositAvailable> <isCashDepositOnlyAvailable>false</isCashDepositOnlyAvailable> <isHandicappedAccessible>false</isHandicappedAccessible> <isOffPremise>false</isOffPremise> <isSeasonal>false</isSeasonal> <languageType i:nil="true" /> <locationDescription>USB CLYBOURN AVE DOMINICK</locationDescription> <logoName>PAS</logoName> <terminalId>7E150459</logoName> <participantId>FCT3</logoName> </atmLocation> <distance>1.4972313718693517</distance> </foundAtmLocation> <foundAtmLocation> <atmLocation> <address> <city>Chicago</city> <country>USA</country> <postalCode>60614</postalCode> <state>IL</state> <street>1953 North Clybourn Avenue</street> </address> <coordinates> <latitude>41.916664</latitude> <longitude>-87.65743</longitude> </coordinates> <id>79462</id> <name>U.S. Bank Lincoln Park</name> <isAvailable24Hours>false</isAvailable24Hours> <isDepositAvailable>true</isDepositAvailable> <isCashDepositOnlyAvailable>true</isCashDepositOnlyAvailable> <isHandicappedAccessible>false</isHandicappedAccessible> <isOffPremise>false</isOffPremise> <isSeasonal>false</isSeasonal> <languageType i:nil="true" /> <locationDescription>US BANK LINCOLN PARK</locationDescription> <logoName>PAS</logoName> <terminalId>7E150560</logoName> <participantId>FCT3</logoName> </atmLocation> <distance>1.9175832637327195</distance> </foundAtmLocation> <foundAtmLocation> <atmLocation> <address> <city>CHICAGO</city> <country>USA</country> <postalCode>60640</postalCode> <state>IL</state> <street>4928 N BROADWAY ST</street> </address> <coordinates> <latitude>41.972424</latitude> <longitude>-87.660225</longitude> </coordinates> <id>86843</id> <name>Cathay Bank</name> <isAvailable24Hours>false</isAvailable24Hours> <isDepositAvailable>false</isDepositAvailable> <isCashDepositOnlyAvailable>false</isCashDepositOnlyAvailable> <isHandicappedAccessible>false</isHandicappedAccessible> <isOffPremise>false</isOffPremise> <isSeasonal>false</isSeasonal> <languageType i:nil="true" /> <locationDescription>Financial Institution</locationDescription> <logoName>PAS</logoName> <terminalId>7E150561</logoName> <participantId>FCT3</logoName> </atmLocation> <distance>1.9529326859971763</distance> </foundAtmLocation> <foundAtmLocation> <atmLocation> <address> <city>CHICAGO</city> <country>USA</country> <postalCode>60625</postalCode> <state>IL</state> <street>4400 N. WESTERN</street> </address> <coordinates> <latitude>41.961529</latitude> <longitude>-87.689049</longitude> </coordinates> <id>85957</id> <name>ALBANY BANK AND TRUST COMPANY</name> <isAvailable24Hours>false</isAvailable24Hours> <isDepositAvailable>false</isDepositAvailable> <isCashDepositOnlyAvailable>false</isCashDepositOnlyAvailable> <isHandicappedAccessible>false</isHandicappedAccessible> <isOffPremise>false</isOffPremise> <isSeasonal>false</isSeasonal> <languageType i:nil="true" /> <locationDescription>4400 N. WESTERN, CHICAGO, IL, 60625, USA</locationDescription> <logoName>PAS</logoName> <terminalId>7E150562</logoName> <participantId>FCT3</logoName> </atmLocation> <distance>2.0736642322745915</distance> </foundAtmLocation> </results> <totalFound>50</totalFound> </getAtmLocationsResponse>
Retrieve the coordinates and other attributes for a given ZIP Code.
Method | URL |
---|---|
GET | locations/:name?key=:key[&format=:format][&callback=:callback] |
Type | Parameter Name | Required | Value type | Range |
---|---|---|---|---|
URL_PATH | name | Yes | string | Currently limited to 5 digit US ZIP Codes. |
URL_PARAM | key | Yes | string | Supplied by Fiserv |
URL_PARAM | format | No | string | xml | json |
URL_PARAM | callback | No | string | Client-side JavaScript function name if a JSONP response is required. |
name is required. The name is the value being searched for.
Note:
Example:
key is required. Use key to indicate your authorization, hit rate limit and any associated quotas.
Examples:
format is optional. Use format to indicate how the response should be formatted. Either JSON or XML.
Note: If a format is not specified, then the request headers will be used to determine the most appropriate response format.
Examples:
callback is optional. Use callback to force a JSONP response where its value is the name of the JavaScript function to call with the response
as the only parameter.
Examples:
HTTP Status | Response |
---|---|
200 |
Response will be an object containing the status, and the results as an array of locations.
Each <location> object will have the following properties:
|
401 | "No valid authorization data provided" Indicates that the key parameter is missing or invalid/incorrect. |
403 | "Forbidden" Indicates that the Rate Limit or Quota has been exceeded. |
500 | Varies. |
Property | Description |
---|---|
Status |
|
statusMessage |
Provides some additional detail about the current status where available.
|
results |
The list of found results or null. |
The following example requests location info for US ZIP Code 60614.
https://locatorapistaging.moneypass.com/Service.svc/locations/60614?key=myAssignedKey
{ "status": "Success", "statusMessage": null, "results": [ { "address": { "city": null, "country": "USA", "county": null, "formattedAddress": null, "postalCode": "60614", "state": "IL", "street": null }, "coordinates": { "latitude": 41.9221, "longitude": -87.6493 }, "displayName": "60614, IL", "extents": { "northEast": { "latitude": 41.935986, "longitude": -87.62601 }, "southWest": { "latitude": 41.910786, "longitude": -87.67831 } }, "id": "314958", "name": "60614", "typeName": "PostalCode1" } ] }
<?xml version="1.0" encoding="UTF-8"?> <getLocationsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <status>Success</status> <statusMessage i:nil="true" /> <results> <location> <address> <city i:nil="true" /> <country>USA</country> <county i:nil="true" /> <formattedAddress i:nil="true" /> <postalCode>60614</postalCode> <state>IL</state> <street i:nil="true" /> </address> <coordinates> <latitude>41.9221</latitude> <longitude>-87.6493</longitude> </coordinates> <displayName>60614, IL</displayName> <extents> <northEast> <latitude>41.935985</latitude> <longitude>-87.626004</longitude> </northEast> <southWest> <latitude>41.910785</latitude> <longitude>-87.678309</longitude> </southWest> </extents> <id>314958</id> <name>60614</name> <typeName>PostalCode1</typeName> </location> </results> </getLocationsResponse>
Retrieve the Location (currently just US ZIP Code), if present, that is at (encompases) a given set of coordinates.
Method | URL |
---|---|
GET | locations/:latitude/:longitude?key=:key[&format=:format][&callback=:callback] |
Type | Parameter Name | Required | Value type | Range |
---|---|---|---|---|
URL_PATH | latitude | Yes | float | -90..90 |
URL_PATH | longitude | Yes | float | -180..180 |
URL_PARAM | key | Yes | string | Supplied by Fiserv |
URL_PARAM | format | No | string | xml | json |
URL_PARAM | callback | No | string | Client-side JavaScript function name if a JSONP response is required. |
latitude is required. The latitude is the latitudinal decimal coordinate.
Examples:
longitude is required. The longitude is the longitudinal decimal coordinate.
Examples:
key is required. Use key to indicate your authorization and limit the hit rate as well as any associated quotas.
Examples:
format is optional. Use format to indicate how the response should be formatted. Either JSON or XML.
Note: If a format is not specified, then the request headers will be used to determine the most appropriate response format.
Examples:
callback is optional. Use callback to force a JSONP response where its value is the name of the JavaScript function to call with the response as the only parameter.
Examples:
Status | Response |
---|---|
200 |
Response will be an object containing the status, and the results as an array of locations.
Each <location> object will have the following properties:
|
401 | "No valid authorization data provided" Indicates that the key parameter is missing or invalid/incorrect. |
403 | "Forbidden" Indicates that the Rate Limit or Quota has been exceeded. |
500 | Varies. |
Property | Description |
---|---|
Status |
|
statusMessage |
Provides some additional detail about the current status where available.
|
results |
The list of found results or null. |
The following example requests location info for the coordinates 41.80, -87.60.
https://locatorapistaging.moneypass.com/Service.svc/locations/41.80/-87.60?key=myAssignedKey
{ "status": "Success", "statusMessage": null, "results": [ { "address": { "city": null, "country": "USA", "county": null, "formattedAddress": null, "postalCode": "60615", "state": "IL", "street": null }, "coordinates": { "latitude": 41.8022, "longitude": -87.6006 }, "displayName": "60615, IL", "extents": { "northEast": { "latitude": 41.81142, "longitude": -87.5758 }, "southWest": { "latitude": 41.793434, "longitude": -87.62603 } }, "id": "314959", "name": "60615", "typeName": "PostalCode1" } ] }
<?xml version="1.0" encoding="UTF-8"?> <getLocationsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <status>Success</status> <statusMessage i:nil="true" /> <results> <location> <address> <city i:nil="true" /> <country>USA</country> <county i:nil="true" /> <formattedAddress i:nil="true" /> <postalCode>60615</postalCode> <state>IL</state> <street i:nil="true" /> </address> <coordinates> <latitude>41.8022</latitude> <longitude>-87.6006</longitude> </coordinates> <displayName>60615, IL</displayName> <extents> <northEast> <latitude>41.811422</latitude> <longitude>-87.575801</longitude> </northEast> <southWest> <latitude>41.793433</latitude> <longitude>-87.626032</longitude> </southWest> </extents> <id>314959</id> <name>60615</name> <typeName>PostalCode1</typeName> </location> </results> </getLocationsResponse>
All status codes are standard HTTP status codes. The ones below are used in this API.
Code | Meaning |
---|---|
200 | The request Succeeded. Inspect response for details. |
401 | The request is Unauthorized. Indicates that the key has not been set or is not set to a valid value. |
403 | The request is Forbidden. Indicates that the Rate Limit or Quota has been exceeded. |
500 | Service exception. |
Copyright ©2013- Fiserv All rights reserved. MoneyPass Confidential.