Draft

This is v2.2-draft — a working draft of the v2.2 standards, published for review and not yet ratified. It MUST NOT be used as the basis for a production implementation. For the current standards, switch to v2.1 using the version selector. See the v2.1 → v2.2-draft changelog for every change in this version.

Banking · TPP capability

ATMs 2 min read

The ATM API lets a TPP retrieve ATM location and service data published by LFIs. It is a read-only, public-data API — no user consent or redirect is required.

Access control Required role

BDSP

Bank Data Sharing Provider

Access to the ATM API requires the BDSP role. This role must be assigned to your application in the Trust Framework before calling the endpoint. See Roles for the full list of scopes and grant types this role permits.

What the API returns

A single GET/atms call returns all ATMs published by an LFI. Each ATM record includes:

Field

Description

ATMId

Unique terminal identifier

LFIId / LFIBrandId

Identifies the owning LFI and brand

Location

Address and GPS coordinates

Services

Supported transaction types (e.g. CashWithdrawal, Balance, PINChange)