right logo image
right logo image
Log on
⯆

API Explorer

Log off

v5.1.0 (267 APIs)

API Host: https://api3.openbankproject.com
Bank
Accounts
Views
Counterparties
Transactions

创建分支

为银行创建分行。

身份验证是强制性的

Typical Successful Response: 

								
									
{
  "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.0,
    "longitude":10.0
  },
  "meta":{
    "license":{
      "id":"PDDL",
      "name":"Open Data Commons Public Domain Dedication and 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"
}
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.
Connector Methods:
Version: OBPv3.0.0, function_name: by createBranch, operation_id: OBPv3.0.0-createBranch Tags: Branch,

删除分支

从给定的银行中删除分行。

身份验证是强制性的

Typical Successful Response: 

								
									
{
  "jsonString":"{}"
}
Required Roles:
  • CanDeleteBranch - Please login to request this Role
  • CanDeleteBranchAtAnyBank - 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-30218: Insufficient authorisation to Create Branch. You do not have the role CanCreateBranch.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.1.0, function_name: by deleteBranch, operation_id: OBPv3.1.0-deleteBranch Tags: Branch,

获取分支

返回有关由BANK_ID和BRANCH_ID指定的单个Branch的信息，包括：

  • 名称
  • 地址
  • 地理位置
  • 许可下发布该端点下的数据。

身份验证是可选的

Typical Successful Response: 

								
									
{
  "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.0,
    "longitude":10.0
  },
  "meta":{
    "license":{
      "id":"PDDL",
      "name":"Open Data Commons Public Domain Dedication and 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"
}
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • License may not be set. meta.license.id and eta.license.name can not be empty
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.0.0, function_name: by getBranch, operation_id: OBPv3.0.0-getBranch Tags: Branch, Bank, New-Style,

获取银行分行

返回有关BANK_ID指定的单个银行的分支机构的信息，包括：

  • 名称
  • 地址
  • 地理位置
  • 许可此端点下的数据在以下位置发布
  • 结构化开放时间
  • 无障碍标志
  • 分行类型
  • 更多信息

分页：

默认情况下，返回50条记录。

您可以使用url查询参数limit和offset进行分页
您还可以使用以下url查询参数：

  • city-字符串，找到该城市的分支，可选

  • insideMetersOf-数字，在给定的米距离内查找分支，可选

  • nearLatitude-数字，纬度值的位置，与MetersOf做查询过滤器配合使用，可选
  • nearLongitude-数字，经度值的位置，与MetersOf一起做查询过滤器，可选

注意：在仪表内部，nearLatitude和nearLongitude都为空或都具有值。

身份验证是可选的

Typical Successful 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.0,
      "longitude":10.0
    },
    "meta":{
      "license":{
        "id":"PDDL",
        "name":"Open Data Commons Public Domain Dedication and 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"
  }]
}
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.
  • No branches available. License may not be set.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.0.0, function_name: by getBranches, operation_id: OBPv3.0.0-getBranches Tags: Branch, Bank, New-Style,