-
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
- 获取当前通话的通话上下文
- 获取连接器状态(环回)
- 获取适配器信息
- 获取速率限制信息
- 获取银行的适配器信息
-
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标记。
- 添加叙述。
- 添加图像。
- 添加标签。
- 添加评论。
- 获取图像。
- 获取标签。
- 获取标签。
- 获取评论。
- 获得叙述。
-
Transaction Request
- 保存历史交易
- 映射(类型->字符串)
- 映射(类型->字符串)
- 映射(类型->字符串)
- 映射(类型->字符串)
- 映射(类型->字符串)
- 映射(类型->字符串)
- 映射(类型->字符串)
- 映射(类型->字符串)
- 映射(类型->字符串)
- 获取支持的交易请求类型
-
User
- 创建密码重置网址
- 创建用户。
- 创建用户身份验证上下文
- 创建用户身份验证上下文更新
- 删除用户的身份验证上下文
- 删除用户身份验证上下文
- 刷新用户。
- 回答身份验证上下文更新挑战
- 获取所有用户
- 获取用户身份验证上下文
- 获取用户锁定状态
- 获取用户(当前)
- 解锁用户
- 通过USERNAME获取用户
- 通过USER_ID获取用户
- 通过电子邮件地址获取用户
-
View
- 创建视图。
- 删除检视
- 授予用户访问视图列表的权限。
- 授予用户访问视图的权限。
- 撤消对一个视图的访问。
- 撤消对帐户中所有视图的访问权限
- 更新视图。
- 获取帐户视图。
- 获取用户的帐户访问权限。
- 获得访问权限。
-
WebUi Props
-
Webhook
v5.1.0 (267 APIs)
创建其他帐户专用别名
为其他帐户OTHER_ACCOUNT_ID创建一个专用别名。
身份验证是可选的
如果视图不是公共的,则需要认证。
{
"success":"Success"
}
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
- OBP-10001: Incorrect json format.
- the view does not allow metadata access
- the view does not allow adding a private alias
- Alias cannot be added
- OBP-50000: Unknown Error.
删除交易对手私人别名
删除其他帐户OTHER_ACCOUNT_ID的私人别名。
身份验证是可选的
如果视图不是公共的,则需要认证。
{
"jsonString":"{}"
}
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
- the view does not allow metadata access
- the view does not allow deleting the private alias
- Alias cannot be deleted
- OBP-50000: Unknown Error.
删除其他银行帐户的更多信息。
{
"jsonString":"{}"
}
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
- the view does not allow metadata access
- the view does not allow deleting more info
- More Info cannot be deleted
- OBP-50000: Unknown Error.
删除其他银行帐户的网址。
{
"jsonString":"{}"
}
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
- the view does not allow metadata access
- the view does not allow deleting a url
- URL cannot be deleted
- OBP-50000: Unknown Error.
删除对方公共别名
删除另一个帐户OTHER_ACCOUNT_ID的公共别名。
身份验证是可选的
如果视图不是公共的,则需要认证。
{
"jsonString":"{}"
}
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
- the view does not allow metadata access
- the view does not allow deleting the public alias
- Alias cannot be deleted
- OBP-50000: Unknown Error.
删除对方公司位置。
删除其他银行帐户的公司位置。删除交易对手注册地址的地理位置
{
"jsonString":"{}"
}
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
- the view does not allow metadata access
- Corporate Location cannot be deleted
- Delete not completed
- OBP-50000: Unknown Error.
删除对方图片网址
删除其他银行帐户的图片网址。
{
"jsonString":"{}"
}
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-50000: Unknown Error.
删除对方开放公司网址
删除其他银行帐户的打开的公司网址。
{
"jsonString":"{}"
}
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
- the view does not allow metadata access
- the view does not allow deleting an open corporate url
- URL cannot be deleted
- OBP-50000: Unknown Error.
删除对方的物理位置。
删除其他银行帐户的实际位置。
{
"jsonString":"{}"
}
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
- OBP-30022: The current view does not have the permission:
- Physical Location cannot be deleted
- Delete not completed
- OBP-50000: Unknown Error.
将公共别名添加到其他银行帐户。
为其他帐户OTHER_ACCOUNT_ID创建公用别名。
身份验证是可选的
如果视图不是公共的,则需要认证。
注意:将为新的“其他帐户/交易对手”自动生成公共别名,因此仅在以下情况下使用此调用:
公共别名已删除。
VIEW_ID参数应该是允许调用者访问的视图,并且有权创建公共别名。
{
"success":"Success"
}
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
- OBP-10001: Incorrect json format.
- OBP-50000: Unknown Error.
- the view does not allow metadata access
- the view does not allow adding a public alias
- Alias cannot be added
- public alias added
将公司位置添加到交易对手
添加交易对手注册地址的地理位置
{
"success":"Success"
}
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
- the view does not allow metadata access
- the view does not allow adding a corporate location
- Coordinates not possible
- Corporate Location cannot be deleted
- OBP-50000: Unknown Error.
将图片网址添加到其他银行帐户。
添加指向交易对手徽标的网址
{
"success":"Success"
}
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
- OBP-10001: Incorrect json format.
- the view does not allow metadata access
- the view does not allow adding an image url
- URL cannot be added
- OBP-50000: Unknown Error.
将实际位置添加到其他银行帐户。
添加交易对手主要位置的地理坐标
{
"success":"Success"
}
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
- OBP-10001: Incorrect json format.
- the view does not allow metadata access
- the view does not allow adding a physical location
- Coordinates not possible
- Physical Location cannot be added
- OBP-50000: Unknown Error.
将开放公司网址添加到交易对手
将打开的公司网址添加到其他银行帐户。
{
"success":"Success"
}
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
- OBP-10001: Incorrect json format.
- the view does not allow metadata access
- the view does not allow adding an open corporate url
- URL cannot be added
- OBP-50000: Unknown Error.
将网址添加到其他银行帐户。
代表交易对手的网址(首页网址等)
{
"success":"Success"
}
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
- OBP-10001: Incorrect json format.
- the view does not allow metadata access
- the view does not allow adding a url
- URL cannot be added
- OBP-50000: Unknown Error.
更新交易对手公司位置
更新交易对手注册地址的地理位置
{
"success":"Success"
}
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
- OBP-10001: Incorrect json format.
- the view does not allow metadata access
- the view does not allow updating a corporate location
- Coordinates not possible
- Corporate Location cannot be updated
- OBP-50000: Unknown Error.
更新交易对手图片网址
更新指向交易对手徽标的网址
{
"success":"Success"
}
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
- OBP-10001: Incorrect json format.
- the view does not allow metadata access
- the view does not allow updating an image url
- URL cannot be updated
- OBP-50000: Unknown Error.
更新交易对手更多信息
从帐户的角度(例如,我的牙医)更新对方的更多信息描述。
{
"success":"Success"
}
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
- OBP-10001: Incorrect json format.
- the view does not allow metadata access
- the view does not allow updating more info
- More Info cannot be updated
- OBP-50000: Unknown Error.
更新交易对手的公开公司网址
更新其他银行帐户的未清公司网址。
{
"success":"Success"
}
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
- OBP-10001: Incorrect json format.
- the view does not allow metadata access
- the view does not allow updating an open corporate url
- URL cannot be updated
- OBP-50000: Unknown Error.
更新交易对手的实际位置
更新交易对手主要地点的地理坐标
{
"success":"Success"
}
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
- OBP-10001: Incorrect json format.
- the view does not allow metadata access
- the view does not allow updating a physical location
- Coordinates not possible
- Physical Location cannot be updated
- OBP-50000: Unknown Error.
更新交易对手私人别名
更新交易对手(又称其他帐户)的私有别名OTHER_ACCOUNT_ID。
身份验证是可选的
如果视图不是公共的,则需要认证。
{
"success":"Success"
}
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
- OBP-10001: Incorrect json format.
- the view does not allow metadata access
- the view does not allow updating the private alias
- Alias cannot be updated
- OBP-50000: Unknown Error.
更新其他银行帐户的公共别名。
更新其他帐户/交易对手OTHER_ACCOUNT_ID的公共别名。
身份验证是可选的
如果视图不是公共的,则需要认证。
{
"success":"Success"
}
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
- OBP-10001: Incorrect json format.
- OBP-20001: User not logged in. Authentication is required!
- the view does not allow metadata access
- the view does not allow updating the public alias
- Alias cannot be updated
- OBP-50000: Unknown Error.
更新其他银行帐户的网址。
代表交易对手的网址(首页网址等)
{
"success":"Success"
}
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
- OBP-10001: Incorrect json format.
- OBP-30022: The current view does not have the permission:
- OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID
- URL cannot be updated
- OBP-50000: Unknown Error.
添加交易对手更多信息
从帐户的角度(例如,我的牙医)添加对对方的描述。
{
"success":"Success"
}
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
- OBP-10001: Incorrect json format.
- OBP-30022: The current view does not have the permission:
- the view ownerdoes not allow adding more info
- More Info cannot be added
- OBP-50000: Unknown Error.
获取其他帐户专用别名
返回另一个帐户OTHER_ACCOUNT_ID的私有别名。
身份验证是可选的
如果视图不是公共的,则需要认证。
{
"alias":"String"
}
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
- the view does not allow metadata access
- the view does not allow private alias access
- OBP-50000: Unknown Error.
获取其他帐户元数据。
获取另一个帐户的元数据。
仅返回有关另一个银行帐户(OTHER_ACCOUNT_ID)的元数据,该银行帐户已与ACCOUNT_ID在BANK_ID共享了至少一笔交易。
如果视图不是公开的,则需要通过OAuth进行身份验证。
{
"public_alias":"NONE",
"private_alias":"NONE",
"more_info":"www.openbankproject.com",
"URL":"www.openbankproject.com",
"image_URL":"www.openbankproject.com",
"open_corporates_URL":"www.openbankproject.com",
"corporate_location":{
"latitude":1.231,
"longitude":1.231,
"date":"2017-09-18T22:00:00Z",
"user":{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"provider":"http://127.0.0.1:8080",
"display_name":"OBP"
}
},
"physical_location":{
"latitude":1.231,
"longitude":1.231,
"date":"2017-09-18T22:00:00Z",
"user":{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"provider":"http://127.0.0.1:8080",
"display_name":"OBP"
}
}
}
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-50000: Unknown Error.
- the view does not allow metadata access
获取其他银行帐户的公共别名。
返回其他帐户OTHER_ACCOUNT_ID的公共别名。
身份验证是可选的
如果视图不是公共的,则必须进行身份验证。
{
"alias":"String"
}
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
- OBP-50000: Unknown Error.
- the view does not allow metadata access
- the view does not allow public alias access