API Explorer

name: ACCOUNT_MANAGEMENT_FEE

JSON response body fields:

country: Germany

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

latitude: 38.8951

longitude: -77.0364

name: ACCOUNT_MANAGEMENT_FEE

scheme: OBP

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":"OBP",
    "address":"DERBY6"
  }
}

Request Headers:

Response Headers:

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-10001: Incorrect json format.
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.1.0, function_name: by createBranch, operation_id: OBPv2.1.0-createBranch Tags: Branch, Open-Data,

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

User Authentication is Optional. The User need not be logged in.

URL Parameters:

BANK_ID: gh.29.uk

BRANCH_ID: DERBY6

JSON response body fields:

country: Germany

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

latitude: 38.8951

longitude: -77.0364

name: ACCOUNT_MANAGEMENT_FEE

scheme: OBP

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":"OBP",
    "address":"DERBY6"
  }
}

Request Headers:

Response Headers:

Required Roles:

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: 50
offset=NUMBER ==> default value: 0

eg1:?limit=100&offset=0

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

User Authentication is Optional. The User need not be logged in.

URL Parameters:

BANK_ID: gh.29.uk

JSON response body fields:

country: Germany

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

latitude: 38.8951

longitude: -77.0364

name: ACCOUNT_MANAGEMENT_FEE

scheme: OBP

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":"OBP",
      "address":"DERBY6"
    }
  }]
}

Request Headers:

Response Headers:

Required Roles:

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).
User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

BANK_ID: gh.29.uk

BRANCH_ID: DERBY6

JSON response body fields:

country: Germany

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

latitude: 38.8951

longitude: -77.0364

name: ACCOUNT_MANAGEMENT_FEE

scheme: OBP