This specification includes all relevant artefacts for the Open Data ATM API Specification.

This endpoint can contain multiple brands owned by a particular banking group. Each brand can provide multiple ATMs.

An ATM consists of:-

A unique Identification

ATMServices - a pre-defined set of standard code names defining services available from an ATM e.g. PinUnblock.

OtherATMServices - allows a bank to add it's own non-standard/proprietary codes, code names and descriptions.

Accessibility - a pre-defined set of standard code names defining accessibility features that the ATM offers e.g. InductionLoop

OtherAccessibility - allows a bank to add it's own non-standard/proprietary codes, code names and descriptions.

 

Documentation

  • Contents
    Check on the OpenAPI Documentation carefully to understand the required request and structure.
     
  • Security
    Remember to retrieve the credentials of your App in "My Apps" checking on the Consumer Key and Consumer Secret.

Error Format

All OpenBanking APIs throw errors in following JSON format:

{"Id": "123",
"Code": "123", 
"Message":"Message example",
"Description": "Description of error", 
"Errors":[
{
 "ErrorCode":"AC17",
 "Message":"Message Example",
 "Path":"/accounts",
 "Url":"url.example.com"
}]
}

Supported Languages - the 2-digit ISO 639-1 language code.

Location - This is where the ATM is located and is a mix of a postal address and the geographic coordinates (decimal Latitude and Longitude). Postal address information can either be:-

i) Up to 7 lines of unstructured address information (AddressLine)

ii) Structured address information e.g. BuildingNumber, StreetName, Town, PostCode etc or a mixture of both.

Location is very important so the API provider should ensure that either geographical coordinates (preferred) or a combination of building number and postcode are supplied so that the ATM can be accurately located on a map.

Base currency - currently restricted to 'GBP' only, but may be extended in future to cope with other currencies dispensed by ATMs at airports, for example, if the API providers are able to supply this information.

Minimum possible amount - This will inform a consumer as the minimum possible amount that they can withdraw from an ATM. Note: This is not the same as the minimum denomination. For example, an ATM may dispense £5 notes but require the consumer to withdraw a minimum possible amount of £10

 

Documentation

  • Contents
    Check on the OpenAPI Documentation carefully to understand the required request and structure.
     
  • Security
    Remember to retrieve the credentials of your App in "My Apps" checking on the Consumer Key and Consumer Secret.

Error Format

All OpenBanking APIs throw errors in following JSON format:

{"Id": "123",
"Code": "123", 
"Message":"Message example",
"Description": "Description of error", 
"Errors":[
{
 "ErrorCode":"AC17",
 "Message":"Message Example",
 "Path":"/accounts",
 "Url":"url.example.com"
}]
}