API Explorer

v2.0.0 (116 APIs)

Bank
Accounts
Views
Counterparties
Transactions

Get Bank Branches

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

Possible custom url parameters for pagination:

  • limit=NUMBER ==> default value: 50
  • offset=NUMBER ==> default value: 0

eg1:?limit=100&offset=0

  • sort_direction=ASC/DESC ==> default value: DESC.

eg2:?limit=100&offset=0&sort_direction=ASC

You can use the url query parameters limit and offset for pagination

Authentication is Optional

URL Parameters:

JSON response body fields:

Typical Successful Response:

								
									
{ "branches":[{ "id":"5995d6a2-01b3-423c-a173-5481df49bdaf", "name":"String", "address":{ "line_1":"Osloer Straße 16/17", "line_2":"Wedding", "line_3":"", "city":"Berlin", "state":"Berlin Brandenburg", "postcode":"13359", "country":"DE" }, "location":{ "latitude":11.45, "longitude":11.45 }, "lobby":{ "hours":"5" }, "drive_up":{ "hours":"5" }, "meta":{ "license":{ "id":"5", "name":"TESOBE" } }, "branch_routing":{ "scheme":"BranchNumber", "address":"678" } }] }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • No branches available. License may not be set.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv1.4.0, function_name: by getBranches, operation_id: OBPv1.4.0-getBranches Tags: Branch,