API Reference

Get ATM Locations List

get
https://example.com/programs//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 Params
string
required

The Program code for the locator search context.

Query Params
string

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

string

The City name to filter ATM locations. Optional.

string

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

string

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

string

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

double

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

double

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

int32

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

int32

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

int32

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

Headers
string
required

The Unique request identifier for tracking and logging.

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

401

Unauthorized

Updated 2 months ago

Language
Credentials
Header
LoadingLoading…
Response
Choose an example:
application/json
text/json

Updated 2 months ago