Get Branches for a Bank
GET /obp/v7.0.0/banks/BANK_ID/branches
OBPv3.0.0-getBranches No role required BranchBank
Returns information about branches for a single bank specified by BANK_ID including:
- Name
- Address
- Geo Location
- License the data under this endpoint is released under
- Structured opening hours
- Accessible flag
- Branch Type
- More Info
Pagination:
By default, 50 records are returned.
You can use the url query parameters limit and offset for pagination You can also use the follow url query parameters:
-
city - string, find Branches those in this city, optional
-
withinMetersOf - number, find Branches within given meters distance, optional
-
nearLatitude - number, a position of latitude value, cooperate with withMetersOf do query filter, optional
-
nearLongitude - number, a position of longitude value, cooperate with withMetersOf do query filter, optional
note: withinMetersOf, nearLatitude and nearLongitude either all empty or all have value.
User Authentication is Optional. The User need not be logged in.
URL Parameters:
BANK_ID: gh.29.uk
JSON response body fields (36)
- accessibleFeatures
- address
- bank_id
- gh.29.uk
- branch_routing
- branch_type
- branches
- city
- closing_time
- 2020-01-27
- country_code
- 1254
- county
- drive_up
- friday
- id
- d8839721-ad8f-45dd-9f78-2080414b93f9
- is_accessible
- false
- latitude
- 38.8951
- license
- line_1
- line_2
- line_3
- lobby
- location
- longitude
- -77.0364
- meta
- monday
- more_info
- More information about this fee
- name
- ACCOUNT_MANAGEMENT_FEE
- opening_time
- phone_number
- postcode
- saturday
- scheme
- OBP
- state
- sunday
- thursday
- tuesday
- wednesday
Example success response
{
"branches": [
{
"id": "branch-id-123",
"bank_id": "bank-id-123",
"name": "Branch by the Lake",
"address": {
"line_1": "No 1 the Road",
"line_2": "The Place",
"line_3": "The Hill",
"city": "Berlin",
"county": "String",
"state": "Brandenburg",
"postcode": "13359",
"country_code": "DE"
},
"location": {
"latitude": 10,
"longitude": 10
},
"meta": {
"license": {
"id": "ODbL-1.0",
"name": "Open Database License"
}
},
"lobby": {
"monday": [
{
"opening_time": "10:00",
"closing_time": "18:00"
}
],
"tuesday": [
{
"opening_time": "10:00",
"closing_time": "18:00"
}
],
"wednesday": [
{
"opening_time": "10:00",
"closing_time": "18:00"
}
],
"thursday": [
{
"opening_time": "10:00",
"closing_time": "18:00"
}
],
"friday": [
{
"opening_time": "10:00",
"closing_time": "18:00"
}
],
"saturday": [
{
"opening_time": "10:00",
"closing_time": "18:00"
}
],
"sunday": [
{
"opening_time": "10:00",
"closing_time": "18:00"
}
]
},
"drive_up": {
"monday": {
"opening_time": "10:00",
"closing_time": "18:00"
},
"tuesday": {
"opening_time": "10:00",
"closing_time": "18:00"
},
"wednesday": {
"opening_time": "10:00",
"closing_time": "18:00"
},
"thursday": {
"opening_time": "10:00",
"closing_time": "18:00"
},
"friday": {
"opening_time": "10:00",
"closing_time": "18:00"
},
"saturday": {
"opening_time": "10:00",
"closing_time": "18:00"
},
"sunday": {
"opening_time": "10:00",
"closing_time": "18:00"
}
},
"branch_routing": {
"scheme": "OBP",
"address": "123abc"
},
"is_accessible": "true",
"accessibleFeatures": "wheelchair, atm usuable by the visually impaired",
"branch_type": "Full service store",
"more_info": "short walk to the lake from here",
"phone_number": "+381631954907"
}
]
}Possible errors (3)
- OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
- OBP-32001: No branches available. License may not be set.
- OBP-50000: Unknown Error.