v1

latestOpenAPI 3.0.12026-07-243407211.3 MB
Locator

Get ATM Locations List

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

get/programs/{programCode}/locations/ATM

Path parameters

programCodestring required

The Program code for the locator search context.

Query parameters

addressstring

The Street address or partial address to search for ATMs near a specific location. Optional.

citystring

The City name to filter ATM locations. Optional.

statestring

The State or province code (e.g., "CA" for California). Optional.

postalCodestring

The Postal or ZIP code to filter ATM locations. Optional.

countrystring

The Country code (e.g., "US"). Optional.

latitudenumber double

The Latitude coordinate for proximity search. Optional, used with longitude.

longitudenumber double

The Longitude coordinate for proximity search. Optional, used with latitude.

radiusinteger

The Search radius in miles. Optional. Default is 100 miles if not specified or invalid.

offsetinteger

The Page number for paginated results. Optional. Default is 1.

limitinteger

The Page size (number of results per page). Optional. Default is 20. Maximum is 100.

Headers

X-GD-RequestIdstring required

The Unique request identifier for tracking and logging.

Response

OK

totalRecordCountinteger

The total number of ATM location records available for the query.

offsetinteger

The offset (starting index) for the current page of results.

limitinteger

The maximum number of ATM locations returned in this response (page size).