ATM Locator API Endpoints

Search ATM Locations

The ATM Locator API searches ATM locations.

📘

Only withdrawals are allowed at ATM locations. Cash deposits can be made at retail locations found using the Retail Locator API.

API Call Structure

GET /programs/{programCode}/locations/ATM

Sample Response Body

{
   "responseDetails":[
      {
         "code":0,
         "subCode":0,
         "description":"string",
         "url":"string"
      }
   ],
   "totalRecordCount":0,
   "locations":[
      {
         "name":"RALPHS",
         "address":"101 MAIN ST.",
         "city":"PASADENA",
         "state":"CA",
         "zip":"91107",
         "country":"USA",
         "longitude":-119.0684,
         "latitude":35.1513,
         "distance":0.11853
      }
   ]"offset":"1",
   "limit":"100"
}

Response Parameters

• responseDetails – Contains code (0), subCode (0), description (string), and url (string). Refer to Response Details for more information.
• totalRecordCount – Contains the remaining fields.
• Locations - Contains the ATM location information.
• Name - Name of the business where the ATM is located. Ex: Ralphs
• Address - Address where the ATM is located. Ex: 101 Main St.
• City - City where the ATM is located. Ex: Pasadena
• State - State where the ATM is located. Ex: CA
• Zip - Zip code where the ATM is located. Ex: 91107
• Country - Country where the ATM is located. Ex: USA
• Longitude - Longitude where ATM is located. Ex: -119.0684
• Latitude - Latitude where ATM is located. Ex: 35.1513
• Distance - Distance in miles from where the customer (user) is to where the ATM is located.
• Offset – Contains the number of pages offset from the first page.
• Limit – Contains the number of rows that may be returned on each page.

Retail Locator API Endpoints

Search Retail Locations

The Retail Locator API searches for retail locations (based on proximity) that allow swipeReload and eCash.

API Call Structure

GET /programs/{programCode}/locations/retail

Sample Response Body

{
   "responseDetails":[
      {
         "code":0,
         "subCode":0,
         "description":"string",
         "url":"string"
      }
   ],
   "totalRecordCount":0,
   "locations":[
      {
         "name":"RALPHS",
         "address":"101 MAIN ST.",
         "city":"PASADENA",
         "state":"CA",
         "zip":"91107",
         "country":"USA",
         "longitude":-119.0684,
         "latitude":35.1513"features":[
            "swipeReload",
            "eCash"
         ]
      },
      "distance":0.11853
   }
]
}