v1

latestSwagger 2.02026-07-1472831.8 KB
ATM Locations

Returns detailed information about an ATM location. This information can be used to display ATMs on a map, provide driving directions, or show special ATM features.

Returns detailed information about an ATM location. This information can be used to display ATMs on a map, provide driving directions, or show special ATM features.

get/atms/v1/atm

Query parameters

PageOffsetinteger required

Zero-based offset where the response will start. The actual start position is this value +1. An offset of 10 starts at item 11. Combined with the PageLength option this allows pagination to be supported through the service requests.

PageLengthinteger required

Maximum number of items to retrieve within the current "page" of results.

AddressLine1string

Line 1 of the street address for the merchant location. Usually includes the street number and name. This parameter is ignored if latitude and longitude are provided. If you provide this parameter you must also provide the Country parameter and either City parameter or PostalCode parameter.

AddressLine2string

Line 2 of the street address usually an apartment number or suite number. This parameter is used rarely and is ignored if latitude and longitude are provided. If you provide this parameter you must also provide the Country parameter and either City parameter or PostalCode parameter.

Citystring

The name of the city for a merchant location. This parameter is ignored if latitude and longitude are provided. If you provide this parameter you must also provide the Country parameter.

CountrySubdivisionstring

The state or province for a merchant location (only supported for US and Canada locations). This parameter is ignored if latitude and longitude are provided. If you provide this parameter you must also provide the Country parameter.

PostalCodestring

The zip code or postal code for a merchant location. This parameter is ignored if latitude and longitude are provided. If you provide this parameter you must also provide the Country parameter.

Countrystring

Any three digit country code for an ATM location. Valid values are Three digit alpha country code as defined in ISO 3166-1. This parameter is ignored if latitude and longitude are provided. This parameter is required if any other address information is provided including AddressLine1 AddressLine2 City PostalCode or CountrySubdivision.

Latitudenumber double

The latitude of a merchant location. If latitude is provided longitude must also be provided.

Longitudenumber double

The longitude of a merchant location. If longitude is provided latitude must also be provided.

DistanceUnitstring

Indicates the unit for the radius as well as the units of the distance of each location from the basepoint in the response.

Radiusinteger

This is the radius from the search point in the distance unit you set. For example if you want to search for locations within 50 miles of a certain point you would set DistanceUnit=mile and Radius=50. This parameter is ignored in non-geocoded countries.

SupportEMVinteger

This indicates whether the ATM should have the ability to read chip cards or not.

InternationalMaestroAcceptedinteger

This field will provide ATM Terminals which can still process Maestro transactions but are not yet EMV chip reader enabled. Information available only for USA and Argentina till October 2014.

Response

An array of ATM locations

Example response

{
  "Atms": {
    "Atm": [
      {
        "AccessFees": "DOMESTIC",
        "Availability": "ALWAYS_AVAILABLE",
        "Camera": "YES",
        "HandicapAccessible": "YES",
        "InternationalMaestroAccepted": 1,
        "Location": {
          "Address": {
            "City": "CHICAGO",
            "Country": {
              "Code": "AFG",
              "Geocoding": true,
              "Name": "AFGHANISTAN"
            },
            "CountrySubdivision": {
              "Code": "IL",
              "Name": "ILLINOIS"
            },
            "Line1": "42 ELM AVENUE",
            "Line2": "SUITE 100"
          },
          "Distance": 0.91,
          "DistanceUnit": "KILOMETER",
          "LocationType": {
            "AirportCode": "JFK",
            "Type": "AIRPORT"
          },
          "Name": "QUIK TRIP STORE 1",
          "Point": {
            "Latitude": 32.75723000000001,
            "Longitude": 89.700215
          }
        },
        "Owner": "EGLOBAL",
        "SharedDeposit": "YES",
        "Sponsor": "PeoplesBank",
        "SupportEMV": 1,
        "SurchargeFreeAlliance": "YES",
        "SurchargeFreeAllianceNetwork": "DOES_NOT_PARTICIPATE_IN_SFA"
      }
    ],
    "TotalCount": 2746
  }
}
All 7 operations