# Visa Global ATM Locator
Search API Reference
- [Getting Started](https://developer.visa.com/capabilities/atmlocator/docs)
- [Authentication Method](https://developer.visa.com/capabilities/atmlocator/docs-authentication)
- [How to Use Visa Global ATM Locator](https://developer.visa.com/capabilities/atmlocator/docs-how-to)
- [Error Codes](https://developer.visa.com/pages/visa-developer-error-codes)
- [Product Terms](https://developer.visa.com/capabilities/atmlocator/product-terms)
- [Request & Response Codes](https://developer.visa.com/request_response_codes)
# Locate ATMs API
The ATM Locator service lets cardholders search and find a convenient ATM when they need cash from over 1 million ATMs in over 200 countries. The ATM Locator Service is a cost effective way to deliver user friendly and trusted information when user needs
## Find Near by ATM Totals v3 - Latest
Return the number and statistic info of ATMs nearest to a given location based on the searching criteria
### Request
##### Request Body schema: application/json
ATM Locator Request creation
| | |
| --- | --- |
| requestData
required | object |
| | | |
| --- | --- |
| distance
required | number
distance is limited to 60 mi or 100 km
Example: 20 |
| distanceUnit
required | string
Enum:"mi" "km"
Example: "mi" |
| location
required | object |
| | | |
| --- | --- |
| geocodes
required | object |
| | | |
| --- | --- |
| latitude
required | string
Example: "30.26759000000004" |
| longitude
required | string
Example: "-97.74298999999996" | |
| address | object |
| placeName | string
Example: "Austin" | |
| options
required | object |
| | | |
| --- | --- |
| range
required | object |
| | | |
| --- | --- |
| count
required | integer
count is limited to 100
Example: 10 |
| start
required | integer
Example: 0 | |
| sort
required | object |
| | | |
| --- | --- |
| direction
required | string
Enum:"asc" "desc"
Example: "asc" |
| primary
required | string
Enum:"distance" "placeName" "city"
Example: "distance" | |
| findFilters | Array of objects |
| Array
| | |
| --- | --- |
| filterName | string |
| filterVaule | string | |
| operationName | string
Enum:"and" "or"
Example: "or" |
| useFirstAmbiguous | boolean | |
| culture | string
Example: "en-US" |
| metaDataOptions | number
Example: 0 | |
| wsRequestHeaderV2 | object |
| | | |
| --- | --- |
| applicationId | string
Example: "VATMLOC" |
| correlationId | string
Example: "909420141104053819420" |
| requestMessageId | string
Example: "rohuang-001" |
| requestTs | string
Example: "2021-04-14T20:28:16.000Z" |
| userBid | string
Example: "10000108" |
| userId | string
Example: "CDISIUserID" | |
### Responses
200
Successful Response
##### Response Schema: application/json application/json application/pdf
| | |
| --- | --- |
| responseData | object |
| | | |
| --- | --- |
| bestMapView | object |
| | | |
| --- | --- |
| distanceAcross | number
Example: 3.7338603 |
| northEast | object |
| | | |
| --- | --- |
| latitude | number
Example: 41.63241 |
| longitude | number
Example: -86.21856 | |
| northWest | object |
| | | |
| --- | --- |
| latitude | number
Example: 41.63241 |
| longitude | number
Example: -86.21856 | |
| southEast | object |
| | | |
| --- | --- |
| latitude | number
Example: 41.63241 |
| longitude | number
Example: -86.21856 | |
| southWest | object |
| | | |
| --- | --- |
| latitude | number
Example: 41.63241 |
| longitude | number
Example: -86.21856 | | |
| distanceUnit | string |
| foundATMLocations | Array of objects |
| Array
| | |
| --- | --- |
| location | object |
| | | |
| --- | --- |
| address | object |
| | | |
| --- | --- |
| city | string |
| country | string |
| formattedAddress | string |
| postalCode | string |
| state | string |
| street | string |
| street2 | string | |
| coordinates | object |
| | | |
| --- | --- |
| latitude | number
Example: 41.63241 |
| longitude | number
Example: -86.21856 | |
| distance | string |
| isMappable | string |
| ownerBusName | string |
| placeName | string |
| properties | Array of objects |
| Array
| | |
| --- | --- |
| name | string |
| value | string | |
| score | number |
| typeName | string | | |
| matchedLocations | Array of objects |
| metaData | object |
| | | |
| --- | --- |
| fields | string
Example: "stringconcatenated|pipedelimited|listoffieldsavailableforATMlocations" |
| filters | string
Example: "stringconcatenated|pipedelimited|listofallfiltersavailableinthetargetareaATMs" |
| targetCulture | string | |
| properties | Array of objects |
| Array
| | |
| --- | --- |
| name | string |
| value | string | |
| totalATMCount | integer
Example: 5089 | |
| responseSummaryData | object |
| wsResponseHeader | object |
| wsResponseHeaderV2 | object |
| | | |
| --- | --- |
| correlationId | string
Example: "909420141104053819420" |
| numOfRowsReturned | integer |
| requestMessageId | string
Example: "rohuang-001" |
| responseMessageId | string
Example: "51VATMLOC9717920220304001030521" |
| responseTs | string |
| totalNumberOfRecords | string | |
| wsStatus | object |
| | | |
| --- | --- |
| statusCode | string
Example: "API000" |
| statusDesc | string
Example: "Visa ATM Locator Svc-Success" |
400
Bad Request
##### Response Schema: application/json application/json application/pdf
| | |
| --- | --- |
| responseStatus | object |
| | | |
| --- | --- |
| statusCode | string |
| statusDescription | string | |
default
Unexpected error
##### Response Schema: application/json application/json application/pdf
| | |
| --- | --- |
| error | string |
| message | string |
| path | string |
| status | number |
| timestamp | string |
post/globalatmlocator/v3/localatms/totalsinquiry
Sandbox server
https://sandbox.api.visa.com/globalatmlocator/v3/localatms/totalsinquiry
### Request samples
- Payload
application/json
```json
{"requestData": {"culture": "en-US",
"options": {"sort": {"primary": "distance",
"direction": "asc"
},
"range": {"count": 10,
"start": 0
},
"findFilters": [{"filterName": "string",
"filterVaule": "string"
}],
"operationName": "or",
"useFirstAmbiguous": true
},
"distance": 20,
"location": {"address": {},
"geocodes": {"latitude": "30.26759000000004",
"longitude": "-97.74298999999996"},
"placeName": "Austin"
},
"distanceUnit": "mi",
"metaDataOptions": 0
},
"wsRequestHeaderV2": {"userId": "CDISIUserID",
"userBid": "10000108",
"requestTs": "2021-04-14T20:28:16.000Z",
"applicationId": "VATMLOC",
"correlationId": "909420141104053819420",
"requestMessageId": "rohuang-001"
}}
```
### Response samples
- 200
- 400
- default
application/json
application/json
application/pdf
```json
{"wsStatus": {"statusCode": "API000",
"statusDesc": "Visa ATM Locator Svc-Success"
},
"responseData": {"metaData": {"fields": "stringconcatenated|pipedelimited|listoffieldsavailableforATMlocations",
"filters": "stringconcatenated|pipedelimited|listofallfiltersavailableinthetargetareaATMs",
"targetCulture": "string"
},
"properties": [{"name": "string",
"value": "string"
}],
"bestMapView": {"northEast": {"latitude": 41.63241,
"longitude": -86.21856
},
"northWest": {"latitude": 41.63241,
"longitude": -86.21856
},
"southEast": {"latitude": 41.63241,
"longitude": -86.21856
},
"southWest": {"latitude": 41.63241,
"longitude": -86.21856
},
"distanceAcross": 3.7338603
},
"distanceUnit": "string",
"totalATMCount": 5089,
"matchedLocations": [{}, {}, {}],
"foundATMLocations": [{"location": {"score": 0,
"address": {"city": "string",
"state": "string",
"street": "string",
"country": "string",
"street2": "string",
"postalCode": "string",
"formattedAddress": "string"},
"distance": "string",
"typeName": "string",
"placeName": "string",
"isMappable": "string",
"properties": [{"name": "string",
"value": "string"}],
"coordinates": {"latitude": 41.63241,
"longitude": -86.21856},
"ownerBusName": "string"}}],
"wsResponseHeader": {},
"wsResponseHeaderV2": {"responseTs": "string",
"correlationId": "909420141104053819420",
"requestMessageId": "rohuang-001",
"numOfRowsReturned": 0,
"responseMessageId": "51VATMLOC9717920220304001030521",
"totalNumberOfRecords": "string"
},
"responseSummaryData": {}}
```