The following operations are supported. For a formal definition, please review the Service Description.

1. ReturnAllAtms
   

   Returns an XML document containing a list of all ATM locations. Each location node contains:

   • index attribute - the unique ranking of the ATM location within the results set
   • id attribute - the unique identifier of the ATM location
   • institution attribute - the name of the institution associated with the ATM location
   • url attribute - the URL of the institution associated with the ATM location
   • atmCount attribute - the number of ATM machines installed at this location
   • latitude attribute - the latitude of the ATM location which can be used to map the ATM
   • longitude attribute - the longitude of the ATM location which can be used to map the ATM
   • atmIds node - contains 1 or more child nodes that represent the specific ATMs supported by this ATM location
   • address/streetAddress node - the address associated with the ATM location
   • address/city node - the city associated with the ATM location
   • address/province node - the province associated with the ATM location
   • address/postalCode node - the postal code associated with the ATM location
   • address/landmark node - the landmark associated with the ATM location
   • features/deposits node - information about the deposit-taking abilities of the ATM location; values include 'true' and 'false'
   • features/hours node - information about the hours associated with the ATM location; values include 'Business Hours Only', '24 Hours a Day' and 'Restricted Access Building'
   • features/driveThru node - information about whether the ATM location is a drive-thru location; values include 'Yes', 'No' and 'Blank'
   • features/pinChange node - information about whether the ATM location supports PIN changes; values include 'true' and 'false'
   • features/voiceGuidance node - information about whether the ATM location supports voice guidance; values include 'true' and 'false'
   • creditCards/visa node - information about whether the ATM location supports Visa; values include 'true' and 'false'
   • creditCards/mastercard node - information about whether the ATM location supports Mastercard; values include 'true' and 'false'
   • creditCards/cirrus node - information about whether the ATM location supports Cirrus; values include 'true' and 'false'
   • creditCards/plus node - information about whether the ATM location supports Plus; values include 'true' and 'false'
   • languages node - contains 1 or more child nodes that represent the languages supported by this ATM location; values include English, French, Chinese, Punjabi, Italian and Polish

   This method requires the following parameter(s):

   • strAtmServiceKey - the unique key assigned to your institution
2. ReturnAtmSearchByAddress
   

   Returns an XML document containing a list of ATM locations based upon an address, including street address, city, province and postal code. See ReturnAllAtms for details of the information included in a successful response.

   This method requires the following parameter(s):

   • strAtmServiceKey - the unique key assigned to your institution
   • strAddress - the address with which to search
   • strCity - the city with which to search
   • strProvince - the province with which to search
   • strPostalCode - the postal code with which to search
   • bytRadius - a numeric value containing the radius of the area in which to search
3. ReturnAtmSearchByAddressWithMaximum
   

   Returns an XML document containing a specified number of ATM locations based upon an address, including street address, city, province and postal code. See ReturnAllAtms for details of the information included in a successful response.

   This method requires the following parameter(s):

   • strAtmServiceKey - the unique key assigned to your institution
   • strAddress - the address with which to search
   • strCity - the city with which to search
   • strProvince - the province with which to search
   • strPostalCode - the postal code with which to search
   • bytRadius - a numeric value containing the radius of the area in which to search
   • intMaximumAtms - a numeric value containing the maximum number of ATMs to return
4. ReturnCities
   

   Returns an XML document containing a list of cities in THE EXCHANGE database. Each city node contains:

   • id attribute - the unique identifier associated with the city
   • name attribute - the name of the city
   • provId attribute - the unique identifier of the province in which the city is located

   This method requires the following parameter:

   • strAtmServiceKey - the unique key assigned to your institution
5. ReturnAtmSearchByCity
   

   Returns an XML document containing a list of ATM locations based upon a city. See ReturnAllAtms for details of the information included in a successful response.

   This method requires the following parameter(s):

   • strAtmServiceKey - the unique key assigned to your institution
   • intCityID - an integer representing the unique identifier associated with a city
6. ReturnProvinces
   

   Returns an XML document containing a list of provinces in THE EXCHANGE database. Each province node contains:

   • id attribute - the unique identifier associated with the province
   • name attribute - the name of the province

   This method requires the following parameter:

   • strAtmServiceKey - the unique key assigned to your institution
7. ReturnAtmSearchByPostalCode
   

   Returns an XML document containing a list of ATM locations based upon a postal code. See ReturnAllAtms for details of the information included in a successful response.

   This method requires the following parameter(s):

   • strAtmServiceKey - the unique key assigned to your institution
   • strPostalCode - the postal code with which to search
   • bytRadius - a numeric value containing the radius of the area in which to search
8. ReturnAtmSearchByCoordinates
   

   Returns an XML document containing a list of ATM locations based upon a latitude and longitude. See ReturnAllAtms for details of the information included in a successful response.

   This method requires the following parameter(s):

   • strAtmServiceKey - the unique key assigned to your institution
   • strPostalCode - the postal code with which to search
   • dblLatitude - a numeric value containing the latitude with which to search
   • dblLongitude - a numeric value containing the longitude with which to search
   • bytRadius - a numeric value containing the radius of the area in which to search
9. ReturnAtmSearchByCoordinatesWithMaximum
   

   Returns an XML document containing a specified number of ATM locations based upon a latitude and longitude. See ReturnAllAtms for details of the information included in a successful response.

   This method requires the following parameter(s):

   • strAtmServiceKey - the unique key assigned to your institution
   • strPostalCode - the postal code with which to search
   • dblLatitude - a numeric value containing the latitude with which to search
   • dblLongitude - a numeric value containing the longitude with which to search
   • bytRadius - a numeric value containing the radius of the area in which to search
   • intMaximumAtms - a numeric value containing the maximum number of ATMs to return
10. ReturnInstitutions
    

    Returns an XML document containing a list of institutions in THE EXCHANGE database. Each institution node contains:

    • id attribute - the unique identifier associated with the institution
    • name attribute - the name of the institution

    This method requires the following parameter:

    • strAtmServiceKey - the unique key assigned to your institution
11. ReturnAtmSearchByInstitution
    

    Returns an XML document containing a list of ATM locations based upon an institution. See ReturnAllAtms for details of the information included in a successful response.

    This method requires the following parameter(s):

    • strAtmServiceKey - the unique key assigned to your institution
    • intInstitutionID - an integer representing the unique identifier associated with an institution