This specification includes all relevant artefacts for the Open Data Branch API Specification. This endpoint can contain multiple brands owned by a particular banking group. Each brand can own multiple branches. A branch is made up of:-

Identification - unique identification for the branch
SequenceNumber - 0 indicates that this is a main branch, 1..n indicates that it's either a sub or mobile branch.
Name - the branch name
Type - Physical or Mobile
CustomerSegment - The segment of customers that the branch serves e.g. Private, Retail, Business
Photo - you can supply a URL showing an image of the branch e.g. use Google streetview
Sort-Code(s) associated with branch
Service/Facility (see subsection below)
Accessibility (see subsection below)
Postal Address (see subsection below)

 

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"
}]
}