Skip to content
FFicanex

Request 10

ReturnInstitutions

List the institutions

GEThttps://api.ficanex.ca/service/json/ReturnInstitutionsRetrieves information. No data is changed.

Description

Returns every Financial Institution in THE EXCHANGE database, each with an ID. The ID is required by ReturnAtmSearchByInstitution.

Use Case

Use this request to populate an institution drop-down list on your ATM search form, or to find your own Financial Institution's ID so ReturnAtmSearchByInstitution shows only your ATMs.

The Request

GETReturnInstitutions

https://api.ficanex.ca/service/json/ReturnInstitutions?strAtmServiceKey=YOUR_KEY

operationparametervalueYOUR_KEY replace with your keyThe first parameter follows ?, and each additional parameter follows &.

The Response

Full List

Every Financial Institution.

{  "institutions": [    { "id": 1, "name": "Ficanex" },    { "id": 1562, "name": "Acadian Credit Union" },    { "id": 1566, "name": "Alterna Bank" }  ]}

The Request

The parameters sent with the request. Parameters marked Required must be included. The Example tab shows the complete request.

Parameters

Each parameter is added to the end of the request address.

strAtmServiceKeystringRequired

The Web Service Key assigned to your Financial Institution. Required for every request.

Example YOUR_KEY

The Response

The information returned by the request. The Example tab shows each response in full.

Successful Response Fields

institutionsarray

Every Financial Institution.

Example [ ... ]

institutions[].idnumber

The Financial Institution's ID. Use it as intInstitutionID.

Example 1566

institutions[].namestring

The Financial Institution's name.

Example Alterna Bank

Possible Responses

Each response includes a Status CodeA standard code returned with every response to indicate the result of your request:200: Indicates success.400 & 404: Indicate a problem with the request format or a missing resource.500 & 502: Indicate an issue occurred on THE EXCHANGE server.. These match the tabs in The Response panel.

  • 200Full List

    Every Financial Institution.

  • 400Missing Web Service Key

    The request did not include strAtmServiceKey.

    What to do: Add strAtmServiceKey to the request address.

  • 400Invalid Web Service Key

    A key was sent, but it does not match any Financial Institution.

    What to do: Check the key for typing errors. Your current key is in the Overview section of your Financial Institution's page on the FI Portal.