Skip to content
FFicanex

The basics

Request Status Responses

Here is the list of status codes a user will receive when completing a request.

200

Success

The request was successful. A response with no ATMs is still a successful response.

400

Request Error

The request needs to be corrected. Sending the same request again returns the same error.

404

Data not available in Database

For example, the operation name or the ATM ID was not found.

500

Web Service Error

This is an error in the web service, not in your request. Contact support@ficanex.ca.

Error Message Format

Every error response contains a single error message, as shown in the example below.

{  "error": "Invalid key"}

Error Messages and Resolution Steps

  • 400Missing strAtmServiceKey

    No Web Service Key was sent.

    Fix: Add strAtmServiceKey to the request address.

  • 400Invalid key

    The Web Service Key was not recognised.

    Fix: Check it against the key shown on the FI Portal.

  • 400Missing strAddress, Missing strPostalCode, Missing coordinates, Missing intCityID, Missing intInstitutionID, Missing intAtmId

    A required parameter was not included. The message names the missing parameter.

    Fix: Add the missing parameter. Each request page lists its required parameters.

  • 400Invalid address

    The address could not be located on the map.

    Fix: Check the spelling and include strCity and strProvince. Only Canadian addresses are supported.

  • 400Invalid postal code

    The postal code could not be located on the map.

    Fix: Check for typing errors. Only Canadian postal codes are supported.

  • 404Request not found

    The request name in the address was not recognised.

    Fix: Check its spelling against the request's page.

  • 404ATM not found

    The ReturnAtm request was given an ID that matches no ATM.

    Fix: Use the id field from a search result.

  • 502Address lookup upstream failed, Postal code lookup upstream failed

    THE EXCHANGE could not reach the mapping service it uses to locate addresses and postal codes.

    Fix: This is an error in the web service, not in your request. Contact support@ficanex.ca.

  • 500Internal server error

    An unexpected error occurred in the web service.

    Fix: This is an error in the web service, not in your request. Contact support@ficanex.ca.

Web Service Key errors are covered in more detail in Your Web Service Key.