-
API
-
The terms `API` (Application Programming Interface) and `Endpoint` are used somewhat interchangeablyMore...
- 获取API信息（根）
- 获取API配置
- 获取JSON Web密钥（JWK）
- 获取JSON Web密钥（JWK）URI
- 获取当前通话的通话上下文
- 获取连接器状态（环回）
- 获取适配器信息
- 获取速率限制信息
- 获取银行的适配器信息
-
-
Account
-
The thing that tokens of value (money) come in and out of. An account has one or more `owners` whichMore...
- 创建帐号
- 创建帐户属性
- 创建帐户（POST）
- 在所有银行（私人）获取帐户
- 在银行获取Firehose帐户
- 在银行获取帐户。
- 在银行获取帐户（仅ID）。
- 在银行获取帐户（最低）。
- 按ID获取帐户（完整）
- 按ID获取帐户（核心）
- 更新帐户属性
- 更新帐户标签。
- 更新账户。
- 查看可用资金
- 获取帐户余额
- 获取持有的帐户
- 获取支票簿订单
-
-
Bank
-
A Bank (aka Space) represents a financial institution, brand or organizational unit under which resMore...
- 取得银行
- 建立银行
- 映射（类型->字符串）
- 映射（类型->字符串）
- 获取银行
-
-
Consent
-
Consents provide a mechanism by which a third party App or User can access resources on behalf of aMore...
- 取得同意
- 回答同意挑战
- 建立同意书（EMAIL）
- 建立同意书（SMS）
- 撤销同意
-
-
Consumer
-
The "consumer" of the API, i.e. the web, mobile or serverside "App" that calls on the OBP API on beMore...
- 启用或禁用消费者
- 吸引消费者
- 吸引消费者
- 吸引消费者（登录用户）
- 更新使用者RedirectUrl
- 获取消费者的通话限制
- 设置消费者的通话限制
-
-
Counterparty Metadata
- 创建其他帐户专用别名
- 删除交易对手私人别名
- 删除其他银行帐户的更多信息。
- 删除其他银行帐户的网址。
- 删除对方公共别名
- 删除对方公司位置。
- 删除对方图片网址
- 删除对方开放公司网址
- 删除对方的物理位置。
- 将公共别名添加到其他银行帐户。
- 将公司位置添加到交易对手
- 将图片网址添加到其他银行帐户。
- 将实际位置添加到其他银行帐户。
- 将开放公司网址添加到交易对手
- 将网址添加到其他银行帐户。
- 更新交易对手公司位置
- 更新交易对手图片网址
- 更新交易对手更多信息
- 更新交易对手的公开公司网址
- 更新交易对手的实际位置
- 更新交易对手私人别名
- 更新其他银行帐户的公共别名。
- 更新其他银行帐户的网址。
- 添加交易对手更多信息
- 获取其他帐户专用别名
- 获取其他帐户元数据。
- 获取其他银行帐户的公共别名。
-
Customer
-
The legal entity that has the relationship to the bank. Customers are linked to Users via `User CusMore...
- 为客户增加税收居住
- 创建信用额度订单请求
- 创建客户。
- 创建用户客户链接。
- 删除客户地址
- 删除税收居民
- 向客户添加地址
- 在银行获取当前用户的客户
- 按MOBILE_PHONE_NUMBER获取客户
- 更新客户分支
- 更新客户地址
- 更新客户数量
- 更新客户的信用等级和来源
- 更新客户的信用额度
- 更新客户的其他数据
- 更新客户的手机号码
- 更新客户的电子邮件
- 更新客户的身份数据
- 添加社交媒体句柄
- 获取CRM活动
- 获取Firehose客户
- 获取信用额度订单请求
- 获取客户地址
- 获取客户的税收住所
- 获取客户社交媒体句柄
- 获取当前用户的客户
- 通过CUSTOMER_ID获取客户
- 通过CUSTOMER_NUMBER获取客户
- 通过请求ID获取信用额度订单请求
-
-
Method Routing
-
Open Bank Project can have different connectors, to connect difference data sources. We supportMore...
- 删除方法
- 更新方法
- 添加方法
- 获取MethodRoutings
-
-
Transaction
-
Transactions are records of successful movements of value into or out of an `Account`. OBP TransacMore...
- 获取其他交易帐户
- 获取帐户交易（完整）
- 获取帐户交易（核心）
- 获取帐户的Firehose交易
- 通过ID获取交易。
-
-
User
-
The entity that accesses the API with a login / authorisation token and has access to zero or moreMore...
- 创建密码重置网址
- 创建用户。
- 创建用户身份验证上下文
- 创建用户身份验证上下文更新
- 删除用户的身份验证上下文
- 删除用户身份验证上下文
- 刷新用户。
- 回答身份验证上下文更新挑战
- 获取所有用户
- 获取用户身份验证上下文
- 获取用户锁定状态
- 获取用户（当前）
- 解锁用户
- 通过USERNAME获取用户
- 通过USER_ID获取用户
- 通过电子邮件地址获取用户
-
-
API
-
获取API信息（根）
-
获取API配置
-
获取JSON Web密钥（JWK）
-
获取JSON Web密钥（JWK）URI
-
获取当前通话的通话上下文
-
获取连接器状态（环回）
-
获取适配器信息
-
获取速率限制信息
-
获取银行的适配器信息
-
获取API信息（根）
-
ATM
-
Account
-
创建帐号
-
创建帐户属性
-
创建帐户（POST）
-
在所有银行（私人）获取帐户
-
在银行获取Firehose帐户
-
在银行获取帐户。
-
在银行获取帐户（仅ID）。
-
在银行获取帐户（最低）。
-
按ID获取帐户（完整）
-
按ID获取帐户（核心）
-
更新帐户属性
-
更新帐户标签。
-
更新账户。
-
查看可用资金
-
获取帐户余额
-
获取持有的帐户
-
获取支票簿订单
-
创建帐号
-
Account Application
-
Account Metadata
-
Account Public
-
Bank
-
Branch
-
Card
-
Consent
-
Consumer
-
Counterparty
-
Counterparty Metadata
-
创建其他帐户专用别名
-
删除交易对手私人别名
-
删除其他银行帐户的更多信息。
-
删除其他银行帐户的网址。
-
删除对方公共别名
-
删除对方公司位置。
-
删除对方图片网址
-
删除对方开放公司网址
-
删除对方的物理位置。
-
将公共别名添加到其他银行帐户。
-
将公司位置添加到交易对手
-
将图片网址添加到其他银行帐户。
-
将实际位置添加到其他银行帐户。
-
将开放公司网址添加到交易对手
-
将网址添加到其他银行帐户。
-
更新交易对手公司位置
-
更新交易对手图片网址
-
更新交易对手更多信息
-
更新交易对手的公开公司网址
-
更新交易对手的实际位置
-
更新交易对手私人别名
-
更新其他银行帐户的公共别名。
-
更新其他银行帐户的网址。
-
添加交易对手更多信息
-
获取其他帐户专用别名
-
获取其他帐户元数据。
-
获取其他银行帐户的公共别名。
-
创建其他帐户专用别名
-
Customer
-
为客户增加税收居住
-
创建信用额度订单请求
-
创建客户。
-
创建用户客户链接。
-
删除客户地址
-
删除税收居民
-
向客户添加地址
-
在银行获取当前用户的客户
-
按MOBILE_PHONE_NUMBER获取客户
-
更新客户分支
-
更新客户地址
-
更新客户数量
-
更新客户的信用等级和来源
-
更新客户的信用额度
-
更新客户的其他数据
-
更新客户的手机号码
-
更新客户的电子邮件
-
更新客户的身份数据
-
添加社交媒体句柄
-
获取CRM活动
-
获取Firehose客户
-
获取信用额度订单请求
-
获取客户地址
-
获取客户的税收住所
-
获取客户社交媒体句柄
-
获取当前用户的客户
-
通过CUSTOMER_ID获取客户
-
通过CUSTOMER_NUMBER获取客户
-
通过请求ID获取信用额度订单请求
-
为客户增加税收居住
-
Customer Meeting
-
Customer Message
-
Data Warehouse
-
Direct Debit
-
Documentation
-
Dynamic Entity
-
FX
-
KYC
-
Method Routing
-
Metric
-
Product
-
Product Collection
-
Role
-
为用户添加权利。
-
删除权利
-
删除权利请求
-
添加当前用户的权利请求。
-
获取一家银行的权益
-
获取当前用户的权利。
-
获取当前用户的权利请求。
-
获取所有权利
-
获取所有权利请求
-
获取用户权利
-
获取用户的权利请求。
-
获取角色
-
获取银行用户的权利。
-
为用户添加权利。
-
Sandbox
-
Scope
-
Standing Order
-
System View
-
Transaction
-
Transaction Metadata
-
删除where标记。
-
删除叙述。
-
删除图片
-
删除标签。
-
删除评论。
-
更新where标记。
-
更新叙述。
-
添加where标记。
-
添加叙述。
-
添加图像。
-
添加标签。
-
添加评论。
-
获取图像。
-
获取标签。
-
获取标签。
-
获取评论。
-
获得叙述。
-
删除where标记。
-
Transaction Request
-
保存历史交易
-
映射（类型->字符串）
-
映射（类型->字符串）
-
映射（类型->字符串）
-
映射（类型->字符串）
-
映射（类型->字符串）
-
映射（类型->字符串）
-
映射（类型->字符串）
-
映射（类型->字符串）
-
映射（类型->字符串）
-
获取支持的交易请求类型
-
保存历史交易
-
User
-
创建密码重置网址
-
创建用户。
-
创建用户身份验证上下文
-
创建用户身份验证上下文更新
-
删除用户的身份验证上下文
-
删除用户身份验证上下文
-
刷新用户。
-
回答身份验证上下文更新挑战
-
获取所有用户
-
获取用户身份验证上下文
-
获取用户锁定状态
-
获取用户（当前）
-
解锁用户
-
通过USERNAME获取用户
-
通过USER_ID获取用户
-
通过电子邮件地址获取用户
-
创建密码重置网址
-
View
-
创建视图。
-
删除检视
-
授予用户访问视图列表的权限。
-
授予用户访问视图的权限。
-
撤消对一个视图的访问。
-
撤消对帐户中所有视图的访问权限
-
更新视图。
-
获取帐户视图。
-
获取用户的帐户访问权限。
-
获得访问权限。
-
创建视图。
-
WebUi Props
-
Webhook
v5.1.0 (267 APIs)
API Host: https://api3.openbankproject.com
Bank
Accounts
Views
Counterparties
Transactions
数据仓库搜索
搜索数据仓库并获取行级结果。
身份验证是强制性的
必须具有CanSearchWarehouse权利。您可以在下面请求角色。
弹性（搜索）用于后台。请参阅下面的链接以获取语法。
用法示例：
POST /搜索/仓库/ THE_INDEX_YOU_WANT_TO_USE
POST /搜索/仓库/ INDEX1，INDEX2
POST /搜索/仓库/全部
{体内任何有效的Elasticsearch查询DSL}
Typical Successful Response:
{
"jsonString":"{}"
}
Required Roles:
-
CanSearchWarehouse
- 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-20006: User is missing one or more roles:
- OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.0.0,
function_name: by dataWarehouseSearch, operation_id: OBPv3.0.0-dataWarehouseSearch
Tags: Data-Warehouse, New-Style,
数据仓库统计
搜索数据仓库并获得仓库字段的统计汇总
在某些数字字段上进行统计汇总：
身份验证是强制性的
CanSearchWarehouseStats角色是必需的。您可以在下面提出要求。
弹性（搜索）用于后台。请参阅下面的链接以获取语法。
用法示例：
邮政/搜索/仓库/统计/索引/字段
POST /搜索/仓库/统计/全部/字段
{体内任何有效的Elasticsearch查询DSL}
Typical Successful Response:
{
"jsonString":"{}"
}
Required Roles:
-
CanSearchWarehouseStatistics
- 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-20006: User is missing one or more roles:
- OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.0.0,
function_name: by dataWarehouseStatistics, operation_id: OBPv3.0.0-dataWarehouseStatistics
Tags: Data-Warehouse, New-Style,