View ATMs

ATMs

GET https://api.synapsefi.com/v3.1/nodes/atms

This endpoint allows you to get and view all the available ATMs around a location.

Query Parameters

Name	Type	Description
lat	number	Latitude of the location
lon	number	Longitude of the location
radius	integer	Radius of the geofence (miles) NOTE: green_dot does not support the use of radius as a parameter
page	integer	Page number of the paginated request. Default is 1.
per_page	number	Number of objects to return per page. Default is 20.
atm_network_type	string	Type of atm network. Options: all_point, money_pass or green_dot.

Headers

Name	Type	Description
X-SP-USER	string	Your OAuth key and device fingerprint, separated by a pipe.
X-SP-USER-IP	string	IP address of your device.
X-SP-GATEWAY	string	Your Client ID and Secret, separated by a pipe.

200

{
    "atms": [
        {
            "atmLocation": {
                "DistanceMeters": "156",
                "DistanceUnit": "miles",
                "LocationID": "1441562192",
                "LocationName": "Walgreens",
                "LocationType": "ATM",
                "LocationTypeLabel": "ATM",
                "MapIcon": "315.png",
                "MapUrl": "http://maps.google.com/maps/api/staticmap?center=37.793819,-122.395088&maptype=roadmap&markers=color:red%7Clabel:1%7C37.793819,-122.395088&markers=color:red%7Ccolor:red%7Clabel:2%7C37.79255,-122.3944&sensor=true",
                "SurchargeFree": "Surcharge Free",
                "address": {
                    "city": "San Francisco",
                    "country": "USA",
                    "postalCode": "94105",
                    "state": "CA",
                    "street": "88 Spear St"
                },
                "coordinates": {
                    "latitude": "37.79255",
                    "longitude": "-122.3944"
                }
            },
            "atm_network_type": "all_point",
            "distance": 0.1
        },
        .....
    ],
    "atms_count": 19,
    "error_code": "0",
    "http_code": "200",
    "limit": 20,
    "page": 1,
    "page_count": 1,
    "success": true
}

Example Request

HTTP

GET /v3.1/nodes/atms?page=1&per_page=20&lat=37.793819&lon=-122.395088&radius=1&atm_network_type=all_point HTTP/1.1
Host: uat-api.synapsefi.com
X-SP-GATEWAY: client_id_2bb1e412edd311e6bd04e285d6015267|client_secret_6zZVr8biuqGkyo9IxMO5jY2QlSp0nmD4EBAgKcJW
Content-Type: application/json

cURL

curl --location --request GET 'https://uat-api.synapsefi.com/v3.1/nodes/atms?page=1&per_page=20&lat=37.793819&lon=-122.395088&raidius=1&atm_network_type=all_point' \
--header 'X-SP-GATEWAY: client_id_2bb1e412edd311e6bd04e285d6015267|client_secret_6zZVr8biuqGkyo9IxMO5jY2QlSp0nmD4EBAgKcJW' \
--header 'Content-Type: application/json'

Python

//

JS

//

PHP

//

GO

//