{"swagger":"2.0","info":{"title":"Open Bank Project API","description":"An Open Source API for Banks. (c) TESOBE GmbH. 2011 - 2024. Licensed under the AGPL and commercial licences.","contact":{"name":"TESOBE GmbH. / Open Bank Project","url":"https://openbankproject.com","email":"contact@tesobe.com"},"version":"v5.1.0"},"host":"apisandbox.openbankproject.com","basePath":"/","schemes":["http","https"],"securityDefinitions":{"directLogin":{"type":"apiKey","description":"https://github.com/OpenBankProject/OBP-API/wiki/Direct-Login","in":"header","name":"Authorization"},"gatewayLogin":{"type":"apiKey","description":"https://github.com/OpenBankProject/OBP-API/wiki/Gateway-Login","in":"header","name":"Authorization"}},"security":[{"directLogin":[],"gatewayLogin":[]}],"paths":{"/obp/v5.1.0/banks/{BANK_ID}/branches":{"get":{"tags":["Branch","Bank"],"summary":"Get Branches for a Bank","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"
Returns information about branches for a single bank specified by BANK_ID including:
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
note: withinMetersOf, nearLatitude and nearLongitude either all empty or all have value.
Authentication is Optional
","operationId":"getBranches","parameters":[{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/BranchesJsonV300"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorBankNotFound"}}}},"post":{"tags":["Branch"],"summary":"Create Branch","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Create Branch for the Bank.
Authentication is Mandatory
","operationId":"createBranch","parameters":[{"in":"body","name":"body","description":"BranchJsonV300 object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/BranchJsonV300"}},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/BranchJsonV300"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/obp/v5.1.0/banks/{BANK_ID}/branches/{BRANCH_ID}":{"delete":{"tags":["Branch"],"summary":"Delete Branch","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Delete Branch from given Bank.
Authentication is Mandatory
","operationId":"deleteBranch","parameters":[{"in":"path","name":"BRANCH_ID","description":"The branch id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"204":{"description":"Success"},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}},"get":{"tags":["Branch","Bank"],"summary":"Get Branch","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Returns information about a single Branch specified by BANK_ID and BRANCH_ID including:
Authentication is Optional
","operationId":"getBranch","parameters":[{"in":"path","name":"BRANCH_ID","description":"The branch id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/BranchJsonV300"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorBranchNotFoundByBranchId"}}}}}},"definitions":{"ErrorUserNotLoggedIn":{"properties":{"message":{"type":"string","example":"OBP-20001: User not logged in. Authentication is required!"}}},"ErrorBankNotFound":{"properties":{"message":{"type":"string","example":"OBP-30001: Bank not found. Please specify a valid value for BANK_ID."}}},"ErrorBranchNotFoundByBranchId":{"properties":{"message":{"type":"string","example":"OBP-300010: Branch not found. Please specify a valid value for BRANCH_ID. Or License may not be set. meta.license.id and meta.license.name can not be empty"}}},"LicenseJsonV140":{"required":["id","name"],"properties":{"id":{"type":"string","example":"ODbL-1.0"},"name":{"type":"string","example":"Open Database License"}}},"BranchJsonV300":{"required":["name","phone_number","location","branch_type","branch_routing","drive_up","more_info","bank_id","id","meta","lobby","accessibleFeatures","address","is_accessible"],"properties":{"name":{"type":"string","example":"Branch by the Lake"},"phone_number":{"type":"string","example":"+381631954907"},"location":{"$ref":"#/definitions/LocationJsonV140"},"branch_type":{"type":"string","example":"Full service store"},"branch_routing":{"$ref":"#/definitions/BranchRoutingJsonV141"},"drive_up":{"$ref":"#/definitions/DriveUpJsonV330"},"more_info":{"type":"string","example":"short walk to the lake from here"},"bank_id":{"type":"string","example":"bank-id-123"},"id":{"type":"string","example":"branch-id-123"},"meta":{"$ref":"#/definitions/MetaJsonV140"},"lobby":{"$ref":"#/definitions/LobbyJsonV330"},"accessibleFeatures":{"type":"string","example":"wheelchair, atm usuable by the visually impaired"},"address":{"$ref":"#/definitions/AddressJsonV300"},"is_accessible":{"type":"string","example":"true"}}},"LobbyJsonV330":{"required":["sunday","tuesday","wednesday","monday","friday","thursday","saturday"],"properties":{"sunday":{"type":"array","items":{"$ref":"#/definitions/OpeningTimesV300"}},"tuesday":{"type":"array","items":{"$ref":"#/definitions/OpeningTimesV300"}},"wednesday":{"type":"array","items":{"$ref":"#/definitions/OpeningTimesV300"}},"monday":{"type":"array","items":{"$ref":"#/definitions/OpeningTimesV300"}},"friday":{"type":"array","items":{"$ref":"#/definitions/OpeningTimesV300"}},"thursday":{"type":"array","items":{"$ref":"#/definitions/OpeningTimesV300"}},"saturday":{"type":"array","items":{"$ref":"#/definitions/OpeningTimesV300"}}}},"MetaJsonV140":{"required":["license"],"properties":{"license":{"$ref":"#/definitions/LicenseJsonV140"}}},"BranchesJsonV300":{"required":["branches"],"properties":{"branches":{"type":"array","items":{"$ref":"#/definitions/BranchJsonV300"}}}},"DriveUpJsonV330":{"required":["sunday","tuesday","wednesday","monday","friday","thursday","saturday"],"properties":{"sunday":{"$ref":"#/definitions/OpeningTimesV300"},"tuesday":{"$ref":"#/definitions/OpeningTimesV300"},"wednesday":{"$ref":"#/definitions/OpeningTimesV300"},"monday":{"$ref":"#/definitions/OpeningTimesV300"},"friday":{"$ref":"#/definitions/OpeningTimesV300"},"thursday":{"$ref":"#/definitions/OpeningTimesV300"},"saturday":{"$ref":"#/definitions/OpeningTimesV300"}}},"LocationJsonV140":{"required":["latitude","longitude"],"properties":{"latitude":{"type":"number","format":"double","example":"11.45"},"longitude":{"type":"number","format":"double","example":"11.45"}}},"AddressJsonV300":{"required":["city","line_2","state","postcode","county","country_code","line_3","line_1"],"properties":{"city":{"type":"string","example":"Berlin"},"line_2":{"type":"string","example":"The Place"},"state":{"type":"string","example":"Brandenburg"},"postcode":{"type":"string","example":"13359"},"county":{"type":"string","example":""},"country_code":{"type":"string","example":"DE"},"line_3":{"type":"string","example":"The Hill"},"line_1":{"type":"string","example":"No 1 the Road"}}},"BranchRoutingJsonV141":{"required":["scheme","address"],"properties":{"scheme":{"type":"string","example":"BranchNumber"},"address":{"type":"string","example":"678"}}},"OpeningTimesV300":{"required":["opening_time","closing_time"],"properties":{"opening_time":{"type":"string","example":"10:00"},"closing_time":{"type":"string","example":"18:00"}}}}}