THE EXCHANGE® ATM Web Service

THE EXCHANGE Network ATM API Documentation

Overview

THE EXCHANGE® ATM Web Service allows you to easily connect to THE EXCHANGE® database and integrate up-to-date ATM information directly into your websites and mobile applications. The service supports industry-standard web technologies, making it compatible with almost any platform or application.

Accessing the Web Service Key

Access to the web service is secured using a unique Web Service Key. This key must be included with every request made to the service.

Locating Your Key: You can find your key in the Overview section of your Financial Institution’s page on the FI Portal.
Requesting a Key: If your Web Service Key is not displayed on the portal, please contact support@ficanex.ca to have one generated for your institution.

Integration & Usage

Since the implementation of THE EXCHANGE® ATM Web Service varies from client to client depending upon the technologies used, this guide focuses on how to access the service and understand the data retrieved rather than offering step-by-step application code. For a working example of how ATM search features can be presented, visit THE EXCHANGE® website.

Developers can connect to the service using JSON, SOAP calls, or standard HTTP GET and POST requests.

Important: Please ensure your Financial Institution’s ATM details in the FI Portal are kept up to date, as this information powers THE EXCHANGE® ATM Locator API.

Request Process

1
Request
Your software asks which ATMs are within 5 km of the postal code V7M2J3.
2
Search
THE EXCHANGE locates the postal code on the map and searches for nearby ATMs.
3
Response
THE EXCHANGE returns each ATM with its address, hours and features.

Each request is a web address, which can be entered in a browser to view the response. API Integration Overview walks through an example.

City and Institution Searches Require an ID

ReturnAtmSearchByCity and ReturnAtmSearchByInstitution do not accept a name. First, look up the ID with the ReturnCities or ReturnInstitutions request, then search using that ID.

API Endpoints

THE EXCHANGE® ATM Web Service offers 12 methods which can be used to access data in the ATM database. To review each method in detail, go to the API Endpoints section.