Your Web Service Key

Locating Your Web Service Key

The key can be found in the Overview section of your Financial Institution page on the FI Portal.

If your key is not visible in the portal, contact support@ficanex.ca for assistance.

Sending Your Web Service Key

Add the key to the request address as the strAtmServiceKey parameterParameterA specific detail you send in with your request to control or filter the result, such as a service key, a postal code, or a true/false setting.. Every request requires it.

The first parameter follows a question mark (?). Each additional parameter follows an ampersand (&).

Replacing a Web Service Key

Ficanex staff can replace a key using the Generate Key button in the FI Portal. Financial Institutions can see their key but cannot generate a new one.

Setting limits to search results

A key can be configured so that searches return only your own Financial Institution’s ATMs, or exclude the ATMs of specific institutions. If you are missing ATMs you expect to see, contact Ficanex Support at support@ficanex.ca to check how your key is set up.

Storing Web Service Key Information

Your Web Service Key identifies your Financial Institution. Anyone who has it can make requests on your Financial Institution’s behalf.

The key is part of the web address of every request, so a request address is as private as the key. Do not share a request address in an email, a support ticket or a screenshot. If you need to show a request to Ficanex Support, replace your key with YOUR_KEY first.

Web Service Key Error Messages & Resolution Steps

These are the two error messages FIs will see if there’s an issue with their Web Service Key. These are status code 400 error messages. In the Request Status Responses section, you will find the full list of error messages and their resolution steps.