Get ATM Locations

Get the location for supported ATM's

Synapse supports cash deposits and withdrawals at MoneyPass ATMs. To find supported ATMs, make the GET Locate ATMs API call. You can filter by zip code or by latitude and longitude.

For ATMs that are not supported by our network, fees will be determined by the ATM and passed to the user.

API ENDPOINT

https://uat-api.synapsefi.com/v3.1/nodes/atms

QUERY PARAMETERS

zip:
string

Zip code for ATM locator

lat:
string

Latitude of the pin

lon:
string

Longitude of the pin

radius:
string1

radius in miles

page:
integer1

Page number

per_page:
integer20

Number of Nodes per page

EXAMPLE REQUEST

GET /v3.1/nodes/atms?zip=94114&radius=5 HTTP/1.1
Host: uat-api.synapsefi.com
X-SP-USER-IP: 127.0.0.1
X-SP-USER: oauth_auVIbQ8WXC0pnLU9ivEs4tcHDejqFJlwoNrZ3fO1|e83cf6ddcf778e37bfe3d48fc78a6502062fc
Content-Type: application/json
zip_code= "94114"
radius= "5"

client.locate_atms(zip='94114', lat=None, rad=None, page=None, per_page=None)
client.locateAtms({
  zip: '94114',
  radius: '5'
});
zip_code= "941114"
radius= "5"

client.locate_atm(zip: zip_code, radius: radius)
$zip = 94114;
$lat = null;
$lon = null;
$radius = 5;
$page = 1;
$per_page = 1;

$client->locate_atms($zip , $lat , $lon , $radius , $page , $per_page );
data, err := client.LocateATMs()

EXAMPLE RESPONSE

{
    "error_code": "0",
    "http_code": "200",
    "limit": 20,
    "atm_count": 50,
    "atms": [
        {
            "atmLocation": {
                "address": {
                    "city": "SAN FRANCISCO",
                    "country": "USA",
                    "postalCode": "94114",
                    "state": "CA",
                    "street": "443 CASTRO STREET"
                },
                "coordinates": {
                    "latitude": 37.761746,
                    "longitude": -122.435024
                },
                "id": "398744",
                "isAvailable24Hours": true,
                "isDepositAvailable": true,
                "isHandicappedAccessible": false,
                "isOffPremise": false,
                "isSeasonal": false,
                "languageType": null,
                "locationDescription": "US BANK CASTRO",
                "logoName": "PAS",
                "name": "U.S. Bank Castro"
            },
            "distance": 0.12729728274872307
        },
        {
            ...
        }
    ],
    "page": 1,
    "page_count": 3,
    "success": true
}

CASH DEPOSITS

You can set ATM limits per user when you PATCH the node preferences. These per user limits must fall below the limits set in your controls per CIP tag.

{
  "preferences": {
    "daily_transaction_limit": 1000,
    "daily_atm_withdrawal_limit": 100
  }
}

CHECK DEPOSITS

If a user attempts to deposit checks at an ATM, the card will automatically be set as allow_foreign_transactions: false, daily_atm_withdrawal_limit: 0, and daily_transaction_limit: 0. This way the user cannot attempt to withdraw or spend the funds deposited via check deposit at ATM.

Users can contact your platform to update these three fields.

Pagination

Responses are paginated, so to move through pages, add page as a GET parameter. Here is an example:

GET /v3.1/nodes/atms?page=2&per_page=20&zip=94114&raidius=5 HTTP/1.1
Host: uat-api.synapsefi.com
X-SP-USER-IP: 127.0.0.1
X-SP-USER: oauth_auVIbQ8WXC0pnLU9ivEs4tcHDejqFJlwoNrZ3fO1|e83cf6ddcf778e37bfe3d48fc78a6502062fc
Content-Type: application/json

Get ATM Locations


Get the location for supported ATM's

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.