Skip to content
FFicanex

The basics

The ATM record

In this section, we will review the list of ATM Records. Every ATM search return includes the following information:

Example ATM Record

Below is an example of a single ATM record, as it appears in a JSON response. XML returns the same information in a slightly different layout; see JSON or XML?

{  "index": 0,  "id": 2021,  "atmIdentifier": "VSCU5972",  "institution": {    "id": 303,    "name": "Vancity Credit Union",    "url": "",    "isAtlanticCreditUnion": 0  },  "coordinates": { "latitude": 49.3236, "longitude": -123.072 },  "address": {    "streetAddress": "1620 Lonsdale Avenue",    "city": "North Vancouver",    "province": "BC",    "postalCode": "V7M2J3",    "landmark": "Lonsdale & 17th Street"  },  "features": {    "deposits": 1,    "hours": 2,    "driveThru": 0,    "pinChange": 1,    "voiceGuidance": 1  },  "creditCards": { "visa": 1, "plus": 0, "mastercard": 0, "cirrus": 1 },  "languages": ["en", "fr"]}

1. Identity

indexnumber

The ATM's position in the response, starting at 0.

Example 0

idnumber

The ATM's ID. Use it with ReturnAtm.

Example 2021

atmIdentifierstring

The ATM ID, as shown in the FI Portal.

Example VSCU5972

2. Institution

institution.idnumber

The ID of the Financial Institution the ATM belongs to.

Example 303

institution.namestring

The Financial Institution's name. Can be empty.

Example Vancity Credit Union

institution.urlstring

The Financial Institution's website address. Currently always empty.

Example ""

institution.isAtlanticCreditUnionnumber

1 if the Financial Institution is an Atlantic credit union, otherwise 0.

Possible values0No1Yes

3. Location and Address

coordinates.latitudenumber

The ATM's latitude. Use it to place the ATM on a map.

Example 49.3236

coordinates.longitudenumber

The ATM's longitude. Use it with the latitude to place the ATM on a map.

Example -123.072

address.streetAddressstring

The ATM's street address.

Example 1620 Lonsdale Avenue

address.citystring

The ATM's city.

Example North Vancouver

address.provincestring

The ATM's province.

Example BC

address.postalCodestring

The ATM's postal code, without a space.

Example V7M2J3

address.landmarkstring

A landmark to help find the ATM. If the ATM has none, the Financial Institution's default landmark text is used instead. Can be empty.

Example Lonsdale & 17th Street

4. Features

Each feature field is 1 for yes and 0 for no, except hours, which is a code from 1 to 4. The possible values are listed with each field.

features.depositsnumber

1 if the ATM accepts deposits, otherwise 0.

Possible values0No1Yes
features.hoursnumber

The ATM's opening hours, as a code.

Possible values1Business Hours Only224 Hours a Day3Restricted Access Building4Custom, see customHoursFrom and customHoursTo
features.customHoursFromstring

The opening time. Included only when hours is 4; otherwise this field is not included.

Example 09:00 AM

features.customHoursTostring

The closing time. Included only when hours is 4; otherwise this field is not included.

Example 05:00 PM

features.driveThrunumber

1 if the ATM is a drive-thru, otherwise 0.

Possible values0No1Yes
features.pinChangenumber

1 if members can change their PIN at the ATM, otherwise 0.

Possible values0No1Yes
features.voiceGuidancenumber

1 if the ATM offers voice guidance, otherwise 0.

Possible values0No1Yes

Custom Hours

When opening and closing times are entered for an ATM in the FI Portal, hours is set to 4 (Custom) and the record includes customHoursFrom and customHoursTo.

With custom hours (hours is 4)

"features": {  "deposits": 0,  "hours": 4,  "customHoursFrom": "09:00 AM",  "customHoursTo": "05:00 PM",  "driveThru": 0,  "pinChange": 1,  "voiceGuidance": 0}

Without custom hours (any other hours where 1 = Business Hours Only, 2 = 24 Hours a Day, 3 = Restricted Access Building)

"features": {  "deposits": 1,  "hours": 2,  "driveThru": 0,  "pinChange": 1,  "voiceGuidance": 1}

5. Card Networks

creditCards.visanumber

1 if the ATM accepts Visa.

Possible values0No1Yes
creditCards.mastercardnumber

1 if the ATM accepts Mastercard.

Possible values0No1Yes
creditCards.plusnumber

1 if the ATM accepts Plus.

Possible values0No1Yes
creditCards.cirrusnumber

1 if the ATM accepts Cirrus.

Possible values0No1Yes

6. Language Options Available

The languages field is a list of two-letter language codes. An ATM can offer any of the following languages:

CodeLanguage
enEnglish
frFrench
zhChinese
itItalian
koKorean
plPolish
paPunjabi
esSpanish
deGerman
ptPortuguese
ruRussian
jaJapanese
arArabic
viVietnamese
tlTagalog