---
title: "Get ATM Locations List"
method: GET
path: "/programs/{programCode}/locations/ATM"
tags: ["Locator"]
---

# Get ATM Locations List

`GET /programs/{programCode}/locations/ATM`

This endpoint provides the user with the ability to locate a nearby ATM. If the GET request is successful, the following response message will be returned along with a 200 HTTP status code

## Path parameters

- `programCode` string, required

## Query parameters

- `address` string
- `city` string
- `state` string
- `postalCode` string
- `country` string
- `latitude` number, double
- `longitude` number, double
- `radius` integer
- `offset` integer
- `limit` integer

## Headers

- `X-GD-RequestId` string, required

## Response `200`

OK

- GetAtmLocationsResponse — Represents the response returned after retrieving a list of ATM locations. Contains a list of ATM locations, total record count, and paging information. Inherits standard response metadata from Gd.Bos.DataTransfer.Response.ResponseBase.
  - `locations` AtmLocation[], nullable — The list of ATM locations matching the search or filter criteria.
    - `name` string, nullable — The name of the ATM location (e.g., bank or retail location name).
    - `address` string, nullable — The street address of the ATM location.
    - `city` string, nullable — The city where the ATM is located.
    - `state` string, nullable — The state or province where the ATM is located.
    - `zip` string, nullable — The postal or ZIP code for the ATM location.
    - `country` string, nullable — The country where the ATM is located.
    - `longitude` string, nullable — The longitude coordinate of the ATM location.
    - `latitude` string, nullable — The latitude coordinate of the ATM location.
    - `distance` number, double — The distance from the reference point to the ATM location, typically in miles or kilometers.
  - `totalRecordCount` integer — The total number of ATM location records available for the query.
  - `offset` integer — The offset (starting index) for the current page of results.
  - `limit` integer — The maximum number of ATM locations returned in this response (page size).
  - `responseDetails` ResponseDetail[], nullable — Required: A list of response details providing status codes, descriptions, and additional information about the result of the operation.
    - `code` integer — The primary status or error code for the response (e.g., 200 for success, 400 for validation error).
    - `subCode` integer, nullable — An optional subcode providing more granular detail about the response or error.
    - `description` string, nullable — A human-readable description of the response, error, or status.
    - `url` string, nullable — A URL linking to documentation or a web page with more information about the response code.

## Other responses

- `401` — Unauthorized
- `403` — Forbidden
- `500` — Internal Server Error
- `503` — Service Unavailable

---

[API](https://skmtc.net/greendot/apis/baas-apis.md) · [All operations](https://skmtc.net/greendot/apis/baas-apis/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/greendot/baas-apis/revisions/666553766b78/schema)