Unit.API.AtmLocations (Unit v1.0.0)

Copy Markdown View Source

API module for ATM Locator.

Helps end-customers find surcharge-free ATMs near their location. Supports lookup by coordinates or postal code.

Networks

Unit supports several ATM networks depending on your bank partner:

  • Allpoint (55,000+ locations)
  • MoneyPass (30,000+ locations)
  • SUM (others)

Summary

Functions

Find ATMs near a set of coordinates.

Find ATMs near a postal code.

Functions

list_by_coordinates(longitude, latitude, opts \\ [])

@spec list_by_coordinates(float(), float(), keyword()) ::
  {:ok, [Unit.Resource.AtmLocation.t()], map()} | {:error, term()}

Find ATMs near a set of coordinates.

Required params

  • :longitude — decimal longitude
  • :latitude — decimal latitude

Optional

  • :radius — search radius in miles (default: 5)
  • :page_limit, :page_offset

list_by_postal_code(postal_code, opts \\ [])

@spec list_by_postal_code(
  String.t(),
  keyword()
) :: {:ok, [Unit.Resource.AtmLocation.t()], map()} | {:error, term()}

Find ATMs near a postal code.

Required params

  • :postal_code — US ZIP code

Optional

  • :radius — search radius in miles (default: 5)