Search ATM

Search ATM

The Search ATM endpoint allows users to find ATM locations where their payment card can be used. By providing a card identifier and geographic coordinates, the API returns a list of nearby ATMs within the specified radius. Results include address, distance, and operational details to help cardholders conveniently locate cash access points.

Endpoint

POST /api/paymentCards/atmPaymentCard

Authentication

Bearer token required. Obtain via:

POST https://api.banking.netevia.dev/api/auth/v2

Include in header: Authorization: Bearer {token}
Token lifetime: 10 minutes. Refresh via POST /api/auth/refresh.

When to use

Use this endpoint when a cardholder needs to locate ATMs near their current or desired location that accept their Netevia payment card. This is useful in mobile or web applications that provide ATM-finder features. Optional filters allow narrowing results to ATMs with specific capabilities such as 24-hour access, deposit functionality, or accessibility compliance.

Request Body

FieldTypeRequiredDescription
paymentCardIdstringYesUnique identifier of the payment card to search ATMs for
ltnumber (double)YesLatitude of the search location (decimal degrees)
ldnumber (double)YesLongitude of the search location (decimal degrees)
mileintegerYesSearch radius in miles from the provided coordinates
filterarray of stringNoOptional filters to narrow results. Allowed values: OPEN_24_HOURS, DEPOSIT_AVAILABLE, ACCESSIBLE
{
  "paymentCardId": "card_abc123def456",
  "lt": 25.7617,
  "ld": -80.1918,
  "mile": 5,
  "filter": ["OPEN_24_HOURS", "ACCESSIBLE"]
}

Response

200 OK

FieldTypeDescription
idstringUnique identifier of the ATM location
namestringName or label of the ATM
addressstringStreet address of the ATM
citystringCity where the ATM is located
statestringState where the ATM is located
postalCodestringPostal/ZIP code of the ATM location
latitudenumberLatitude coordinate of the ATM
longitudenumberLongitude coordinate of the ATM
distancenumberDistance from the search location in miles
hoursstringOperational hours description
featuresarray of stringSupported features (e.g., OPEN_24_HOURS, DEPOSIT_AVAILABLE, ACCESSIBLE)
[
  {
    "id": "atm_9982341",
    "name": "Netevia ATM - Brickell",
    "address": "1200 Brickell Ave",
    "city": "Miami",
    "state": "FL",
    "postalCode": "33131",
    "latitude": 25.7589,
    "longitude": -80.1944,
    "distance": 0.4,
    "hours": "Open 24 Hours",
    "features": ["OPEN_24_HOURS", "ACCESSIBLE"]
  },
  {
    "id": "atm_9982355",
    "name": "Netevia ATM - Downtown",
    "address": "100 SE 2nd St",
    "city": "Miami",
    "state": "FL",
    "postalCode": "33131",
    "latitude": 25.7743,
    "longitude": -80.1937,
    "distance": 1.2,
    "hours": "Mon-Fri 8AM-9PM, Sat-Sun 9AM-6PM",
    "features": ["DEPOSIT_AVAILABLE"]
  }
]

Error Codes

CodeWhen it happens
400Missing required fields (paymentCardId, lt, ld, or mile) or invalid values
401Token missing, expired, or invalid
403Insufficient permissions to access the specified payment card
404Payment card not found for the provided paymentCardId
500Internal server error

Common Mistakes

  • Swapping latitude (lt) and longitude (ld) values — ensure lt is latitude (north/south) and ld is longitude (east/west)
  • Providing an invalid or non-existent paymentCardId — the ID must correspond to an active card associated with the authenticated user
  • Setting mile to zero or a negative number — the radius must be a positive integer
  • Using an invalid filter value — only OPEN_24_HOURS, DEPOSIT_AVAILABLE, and ACCESSIBLE are accepted enum values

Related Endpoints

  • GET /api/paymentCards — List all payment cards for the authenticated customer
  • GET /api/paymentCards/{paymentCardId} — Retrieve details for a specific payment card
  • POST /api/paymentCards — Issue a new payment card

Example

curl -X POST https://api.banking.netevia.dev/api/paymentCards/atmPaymentCard \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "paymentCardId": "card_abc123def456",
    "lt": 25.7617,
    "ld": -80.1918,
    "mile": 5,
    "filter": ["OPEN_24_HOURS", "ACCESSIBLE"]
  }'
Body Params
string
required
length ≥ 1
double
required
double
required
int32
required
filter
array of objects | null
filter
Allowed:
Headers
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Response
200

Success

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here!