API Explorer

v2.2.0 (220 APIs)

Bank
Accounts
Views
Counterparties
Transactions

Create Branch

Create Branch for the Bank.

Authentication is Mandatory

URL Parameters:

BANK_ID: gh.29.uk

JSON request body fields:

address:

bank_id: gh.29.uk

branch_routing:

city:

country: Germany

drive_up:

hours:

id: d8839721-ad8f-45dd-9f78-2080414b93f9

latitude: 38.8951

license:

line_1:

line_2:

line_3:

lobby:

location:

longitude: -77.0364

meta:

name: ACCOUNT_MANAGEMENT_FEE

postcode:

scheme: scheme value

state:

JSON response body fields:

address:

bank_id: gh.29.uk

branch_routing:

city:

country: Germany

drive_up:

hours:

id: d8839721-ad8f-45dd-9f78-2080414b93f9

latitude: 38.8951

license:

line_1:

line_2:

line_3:

lobby:

location:

longitude: -77.0364

meta:

name: ACCOUNT_MANAGEMENT_FEE

postcode:

scheme: scheme value

state:

Typical Successful Response:

								
									
{ "id":"123", "bank_id":"gh.29.uk", "name":"OBP", "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 }, "meta":{ "license":{ "id":"ODbL-1.0", "name":"Open Database License" } }, "lobby":{ "hours":"5" }, "drive_up":{ "hours":"5" }, "branch_routing":{ "scheme":"BranchNumber", "address":"678" } }
Required Roles:
  • CanCreateBranch - Please login to request this Role
  • CanCreateBranchAtAnyBank - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-30209: Insufficient authorisation to Create Branch. You do not have the role CanCreateBranch.
  • OBP-50000: Unknown Error.
  • OBP-20006: User is missing one or more roles:
Connector Methods:
Version: OBPv2.2.0, function_name: by createBranch, operation_id: OBPv2.2.0-createBranch Tags: Branch, Open-Data, Old-Style,

Get Bank Branch

Returns information about branches for a single bank specified by BANK_ID and BRANCH_ID including:
meta.license.id and eta.license.name fields must not be empty.

  • Name
  • Address
  • Geo Location
  • License the data under this endpoint is released under

Authentication is Optional

URL Parameters:

BANK_ID: gh.29.uk

BRANCH_ID: DERBY6

JSON response body fields:

address:

branch_routing:

city:

country: Germany

drive_up:

hours:

id: d8839721-ad8f-45dd-9f78-2080414b93f9

latitude: 38.8951

license:

line_1:

line_2:

line_3:

lobby:

location:

longitude: -77.0364

meta:

name: ACCOUNT_MANAGEMENT_FEE

postcode:

scheme: scheme value

state:

Typical Successful Response:

								
									
{ "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":"ODbL-1.0", "name":"Open Database License" } }, "branch_routing":{ "scheme":"BranchNumber", "address":"678" } }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • 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
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv2.1.0, function_name: by getBranch, operation_id: OBPv2.1.0-getBranch Tags: Branch, Old-Style,

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: 500
  • 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:

BANK_ID: gh.29.uk

JSON response body fields:

address:

branch_routing:

branches:

city:

country: Germany

drive_up:

hours:

id: d8839721-ad8f-45dd-9f78-2080414b93f9

latitude: 38.8951

license:

line_1:

line_2:

line_3:

lobby:

location:

longitude: -77.0364

meta:

name: ACCOUNT_MANAGEMENT_FEE

postcode:

scheme: scheme value

state:

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":"ODbL-1.0", "name":"Open Database License" } }, "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, Old-Style,

Update Branch

Update an existing branch for a bank account (Authenticated access).
Authentication is Mandatory

URL Parameters:

BANK_ID: gh.29.uk

BRANCH_ID: DERBY6

JSON response body fields:

address:

branch_routing:

city:

country: Germany

drive_up:

hours:

id: d8839721-ad8f-45dd-9f78-2080414b93f9

latitude: 38.8951

license:

line_1:

line_2:

line_3:

lobby:

location:

longitude: -77.0364

meta:

name: ACCOUNT_MANAGEMENT_FEE

postcode:

scheme: scheme value

state:

Typical Successful Response:

								
									
{ "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":"ODbL-1.0", "name":"Open Database License" } }, "branch_routing":{ "scheme":"BranchNumber", "address":"678" } }
Required Roles:
  • CanUpdateBranch - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-10001: Incorrect json format.
  • OBP-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv2.1.0, function_name: by updateBranch, operation_id: OBPv2.1.0-updateBranch Tags: Branch, Old-Style,