ATM & Retail Locators Overview

ATM & Retail Locator APIs can be used for locating ATM and retail locations.

ATM Locator API Endpoints

Get ATM Locations List

This endpoint provides the user with the ability to locate a nearby ATM.

📘

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"
}

Retail Locator API Endpoints

Get Retail Locations List

The Retail Locator API allows you to search 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
   }
]
}