API Explorer

v5.1.0 filtered by tag: ATM (267 APIs)

Bank
Accounts
Views
Counterparties
Transactions

获取API信息(根)

返回有关以下内容的信息:

  • API版本
  • 信息托管
  • 托管信息
  • 能源信息
  • Git提交
Typical Successful Response:

								
									
{ "version":"String", "version_status":"String", "git_commit":"String", "connector":"String", "hosted_by":{ "organisation":"String", "email":"String", "phone":"String", "organisation_website":"String" }, "hosted_at":{ "organisation":"Amazon", "organisation_website":"https://aws.amazon.com/" }, "energy_source":{ "organisation":"Stromio", "organisation_website":"https://www.stromio.de/" } }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-50000: Unknown Error.
  • no connector set
Connector Methods:
Version: OBPv4.0.0, function_name: by root, operation_id: OBPv4.0.0-root Tags: API, New-Style,

获取API配置

返回有关以下内容的信息:

  • 默认的bank_id
  • Akka配置
  • 弹性搜索配置
  • 缓存功能
Typical Successful Response:

								
									
{ "akka":{ "ports":[{ "property":"default", "value":"8080" }], "log_level":"Debug", "remote_data_secret_matched":true }, "elastic_search":{ "metrics":[{ "property":"String", "value":"Mapper" }], "warehouse":[{ "property":"String", "value":"ElasticSearch" }] }, "cache":[{ "function_name":"getBanks", "ttl_in_seconds":5 }], "scopes":{ "require_scopes_for_all_roles":true, "require_scopes_for_listed_roles":["CanCreateUserAuthContextUpdate"] } }
Required Roles:
  • CanGetConfig - 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.1.0, function_name: by config, operation_id: OBPv3.1.0-config Tags: API, New-Style,

获取JSON Web密钥(JWK)

获取服务器的公共JSON Web密钥(JWK)集和证书链。
客户端应用程序需要验证ID令牌,自包含访问令牌和其他已发布的对象。

Typical Successful Response:

								
									
{ "kty":"RSA", "e":"AQAB", "use":"sig", "kid":"fr6-BxXH5gikFeZ2O6rGk0LUmJpukeswASN_TMW8U_s", "n":"hrB0OWqg6AeNU3WCnhheG18R5EbQtdNYGOaSeylTjkj2lZr0_vkhNVYvase-CroxO4HOT06InxTYwLnmJiyv2cZxReuoVjTlk--olGu-9MZooiFiqWez0JzndyKxQ27OiAjFsMh0P04kaUXeHKhXRfiU7K2FqBshR1UlnWe7iHLkq2p9rrGjxQc7ff0w-Uc0f-8PWg36Y2Od7s65493iVQwnI13egqMaSvgB1s8_dgm08noEjhr8C5m1aKmr5oipWEPNi-SBV2VNuiCLR1IEPuXq0tOwwZfv31t34KPO-2H2bbaWmzGJy9mMOGqoNrbXyGiUZoyeHRELaNtm1GilyQ" }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.1.0, function_name: by getServerJWK, operation_id: OBPv3.1.0-getServerJWK Tags: API, Account Information Service (AIS),

获取JSON Web密钥(JWK)URI

获取OAuth2服务器的公共JSON Web密钥(JWK)URI。
客户端应用程序需要验证ID令牌,自包含访问令牌和其他已发布的对象。

Typical Successful Response:

								
									
{ "jwks_uris":[{ "jwks_uri":"https://www.googleapis.com/oauth2/v3/certs" }] }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.1.0, function_name: by getOAuth2ServerJWKsURIs, operation_id: OBPv3.1.0-getOAuth2ServerJWKsURIs Tags: API,

获取当前通话的通话上下文

获取当前通话的通话上下文。

身份验证是强制性的

Typical Successful Response:

								
									
{ "jsonString":"{}" }
Required Roles:
  • CanGetCallContext - 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-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by getCallContext, operation_id: OBPv4.0.0-getCallContext Tags: API, New-Style,

获取连接器状态(环回)

该端点调用连接器以检查后端传输(例如Kafka)是否可以到达。

当前,这仅适用于基于Kafka的连接器。

对于基于Kafka的连接器,此端点将消息写入Kafka并再次读取。

将来,此端点还可能返回有关数据库连接等的信息。

身份验证是强制性的

Typical Successful Response:

								
									
{ "connector_version":"kafka_vSept2018", "git_commit":"f0acd4be14cdcb94be3433ec95c1ad65228812a0", "duration_time":"10 ms" }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.1.0, function_name: by getObpConnectorLoopback, operation_id: OBPv3.1.0-getObpConnectorLoopback Tags: API, New-Style,

获取适配器信息

获取有关适配器的基本信息。

身份验证是强制性的

Typical Successful Response:

								
									
{ "name":"String", "version":"String", "git_commit":"String", "date":"2013-01-21T23:08:00Z" }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.1.0, function_name: by getAdapterInfo, operation_id: OBPv3.1.0-getAdapterInfo Tags: API, New-Style,

获取速率限制信息

获取有关此OBP实例上的速率限制设置的信息,例如:

速率限制已启用并处于活动状态吗?
后端用于跟踪API调用(例如REDIS)。

身份验证是强制性的

Typical Successful Response:

								
									
{ "enabled":true, "technology":"REDIS", "service_available":true, "is_active":true }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.1.0, function_name: by getRateLimitingInfo, operation_id: OBPv3.1.0-getRateLimitingInfo Tags: API, New-Style,

获取银行的适配器信息

获取有关代表该银行进行监听的适配器的基本信息。

身份验证是强制性的

Typical Successful Response:

								
									
{ "name":"String", "version":"String", "git_commit":"String", "date":"2013-01-21T23:08:00Z" }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.0.0, function_name: by getAdapterInfoForBank, operation_id: OBPv3.0.0-getAdapterInfoForBank Tags: API, New-Style,

创建ATM

为银行创建ATM。

身份验证是强制性的

Typical Successful Response:

								
									
{ "id":"atm-id-123", "bank_id":"GENODEM1GLS", "name":"Atm by the Lake", "address":{ "line_1":"No 1 the Road", "line_2":"The Place", "line_3":"The Hill", "city":"Berlin", "county":"", "state":"Brandenburg", "postcode":"13359", "country_code":"DE" }, "location":{ "latitude":11.45, "longitude":11.45 }, "meta":{ "license":{ "id":"5", "name":"TESOBE" } }, "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" }, "is_accessible":"true", "located_at":"Full service store", "more_info":"short walk to the lake from here", "has_deposit_capability":"true" }
Required Roles:
  • CanCreateAtm - Please login to request this Role
  • CanCreateAtmAtAnyBank - 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-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.0.0, function_name: by createAtm, operation_id: OBPv3.0.0-createAtm Tags: ATM,

获取银行ATMS

返回有关BANK_ID指定的单个银行的ATM的信息,包括:

  • 地址
  • 地理位置
  • 许可此端点下的数据在以下位置发布

分页:

默认情况下,返回100条记录。

您可以使用url查询参数limitoffset进行分页

身份验证是可选的

Typical Successful Response:

								
									
{ "id":"atm-id-123", "bank_id":"GENODEM1GLS", "name":"Atm by the Lake", "address":{ "line_1":"No 1 the Road", "line_2":"The Place", "line_3":"The Hill", "city":"Berlin", "county":"", "state":"Brandenburg", "postcode":"13359", "country_code":"DE" }, "location":{ "latitude":11.45, "longitude":11.45 }, "meta":{ "license":{ "id":"5", "name":"TESOBE" } }, "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" }, "is_accessible":"true", "located_at":"Full service store", "more_info":"short walk to the lake from here", "has_deposit_capability":"true" }
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 ATMs available. License may not be set.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.0.0, function_name: by getAtms, operation_id: OBPv3.0.0-getAtms Tags: ATM, New-Style,

获取银行自动柜员机

返回由BANK_ID和ATM_ID指定的单个银行的有关ATM的信息,包括:

  • 地址
  • 地理位置
  • 许可此端点下的数据在以下位置发布

身份验证是可选的

Typical Successful Response:

								
									
{ "id":"atm-id-123", "bank_id":"GENODEM1GLS", "name":"Atm by the Lake", "address":{ "line_1":"No 1 the Road", "line_2":"The Place", "line_3":"The Hill", "city":"Berlin", "county":"", "state":"Brandenburg", "postcode":"13359", "country_code":"DE" }, "location":{ "latitude":11.45, "longitude":11.45 }, "meta":{ "license":{ "id":"5", "name":"TESOBE" } }, "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" }, "is_accessible":"true", "located_at":"Full service store", "more_info":"short walk to the lake from here", "has_deposit_capability":"true" }
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-30009: ATM not found. Please specify a valid value for ATM_ID.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.0.0, function_name: by getAtm, operation_id: OBPv3.0.0-getAtm Tags: ATM, New-Style,

创建帐号

在BANK_ID指定的银行和ACCOUNT_ID指定的ID处创建帐户。

用户可以为自己创建一个帐户-或-在POST正文中指定了USER_ID的用户。

如果指定了PUT体USER_ID ,登录的用户必须具有角色canCreateAccount。创建帐户后,该帐户将归USER_ID指定的用户所有。

如果指定PUT主体USER_ID,则该帐户将由登录的用户拥有。

“ product_code”字段应为Product的product_code。
如果“产品代码”与产品中的产品代码匹配,则将创建与产品属性匹配的帐户属性。

注意:金额必须为零。

Typical Successful Response:

								
									
{ "account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "label":"My Account", "product_code":"AC", "balance":{ "currency":"EUR", "amount":"10" }, "branch_id":"DERBY6", "account_routing":{ "scheme":"AccountNumber", "address":"4930396" }, "account_attributes":[{ "product_code":"saving1", "account_attribute_id":"613c83ea-80f9-4560-8404-b9cd4ec42a7f", "name":"OVERDRAFT_START_DATE", "type":"DATE_WITH_DAY", "value":"2012-04-23" }] }
Required Roles:
  • CanCreateAccount - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-10001: Incorrect json format.
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-30107: Invalid User Id.
  • OBP-30110: Invalid Account Id. The ACCOUNT_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.
  • OBP-30111: Invalid Bank Id. The BANK_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.
  • OBP-20005: User not found. Please specify a valid value for USER_ID.
  • OBP-20006: User is missing one or more roles:
  • OBP-30106: Invalid Balance Amount.
  • OBP-30112: Invalid Number. Initial balance must be a number, e.g 1000.00
  • OBP-30109: Initial Balance of Account must be Zero (0).
  • OBP-30105: Invalid Balance Currency.
  • OBP-30208: Account_ID already exists at the Bank.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.1.0, function_name: by createAccount, operation_id: OBPv3.1.0-createAccount Tags: Account, Onboarding,

创建帐户属性

创建帐户属性

帐户属性用于描述带有键入的键值对列表的金融产品。

每个帐户属性都通过ACCOUNT_ID链接到其帐户

典型的帐户属性可能是:

ISIN(用于国际债券)
VKN(用于德国债券)
REDCODE(信用衍生产品的Markit短代码)
LOAN_ID(例如用于Anacredit报告)

发行日期(债券在市场上发行时)
MATURITY_DATE(产品寿命终止)
可交易的

有关更多示例,请参见FPML

类型字段必须是“ STRING”,“ INTEGER”,“ DOUBLE”或DATE_WITH_DAY”之一

身份验证是强制性的

Typical Successful Response:

								
									
{ "product_code":"saving1", "account_attribute_id":"613c83ea-80f9-4560-8404-b9cd4ec42a7f", "name":"OVERDRAFT_START_DATE", "type":"DATE_WITH_DAY", "value":"2012-04-23" }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.1.0, function_name: by createAccountAttribute, operation_id: OBPv3.1.0-createAccountAttribute Tags: Account, New-Style,

创建帐户(POST)

在BANK_ID指定的银行创建帐户。

用户可以为自己创建一个帐户-或-在POST正文中指定了USER_ID的用户。

如果指定了POST体USER_ID ,登录的用户必须具有角色CanCreateAccount。创建帐户后,该帐户将归USER_ID指定的用户所有。

如果指定POST正文USER_ID,则该帐户将由登录的用户拥有。

“ product_code”字段应为Product的product_code。
如果product_code与Product中的product_code匹配,则将创建与Product Attributes匹配的帐户属性。

注意:金额必须为零。

Typical Successful Response:

								
									
{ "account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "label":"My Account", "product_code":"AC", "balance":{ "currency":"EUR", "amount":"10" }, "branch_id":"DERBY6", "account_routing":{ "scheme":"AccountNumber", "address":"4930396" }, "account_attributes":[{ "product_code":"saving1", "account_attribute_id":"613c83ea-80f9-4560-8404-b9cd4ec42a7f", "name":"OVERDRAFT_START_DATE", "type":"DATE_WITH_DAY", "value":"2012-04-23" }] }
Required Roles:
  • CanCreateAccount - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-10001: Incorrect json format.
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-30106: Invalid Balance Amount.
  • OBP-30112: Invalid Number. Initial balance must be a number, e.g 1000.00
  • OBP-30109: Initial Balance of Account must be Zero (0).
  • OBP-30105: Invalid Balance Currency.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by addAccount, operation_id: OBPv4.0.0-addAccount Tags: Account, Onboarding,

在所有银行(私人)获取帐户

映射(类型->字符串)
Typical Successful Response:

								
									
{ "accounts":[{ "id":"5995d6a2-01b3-423c-a173-5481df49bdaf", "label":"String", "bank_id":"GENODEM1GLS", "account_type":"330", "account_routings":[{ "scheme":"AccountNumber", "address":"4930396" }], "views":[{ "id":"owner", "short_name":"Owner", "description":"This view is for the owner for the account.", "is_public":false }] }] }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.0.0, function_name: by corePrivateAccountsAllBanks, operation_id: OBPv3.0.0-corePrivateAccountsAllBanks Tags: Account, Account Information Service (AIS), PrivateData, New-Style,

在银行获取Firehose帐户

获取为其分配了firehose视图的帐户。

该端点允许批量访问帐户。

需要CanUseFirehoseAtAnyBank角色

要显示在列表中,每个帐户必须链接有一个流水视图。

firehose视图的is_firehose = true

对于VIEW_ID,请尝试“所有者”

身份验证是强制性的

Typical Successful Response:

								
									
{ "accounts":[{ "id":"5995d6a2-01b3-423c-a173-5481df49bdaf", "bank_id":"String", "label":"String", "number":"String", "owners":[{ "id":"5995d6a2-01b3-423c-a173-5481df49bdaf", "provider":"http://127.0.0.1:8080", "display_name":"OBP" }], "type":"String", "balance":{ "currency":"EUR", "amount":"10" }, "account_routings":[{ "scheme":"AccountNumber", "address":"4930396" }], "account_rules":[{ "scheme":"OVERDRAFT", "value":"10" }] }] }
Required Roles:
  • CanUseFirehoseAtAnyBank - 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-50000: Unknown Error.
Connector Methods:
Version: OBPv3.0.0, function_name: by getFirehoseAccountsAtOneBank, operation_id: OBPv3.0.0-getFirehoseAccountsAtOneBank Tags: Account, Account-Firehose, FirehoseData, New-Style,

在银行获取帐户。

返回用户有权访问的BANK_ID帐户列表。
对于每个帐户,API都会返回帐户ID和用户可用的视图。
每个帐户必须至少有一个私有视图。

可选的请求参数:

  • account_type_filter:一个或多个accountType值,以逗号分隔
  • account_type_filter_operation:account_type_filter的过滤器类型,值必须为INCLUDE或EXCLUDE

整个网址示例:
/ banks / BANK_ID / accounts?account_type_filter = 330,CURRENT + PLUS&account_type_filter_operation = INCLUDE

身份验证是强制性的

Typical Successful Response:

								
									
{ "accounts":[{ "id":"8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0", "label":"NoneLabel", "bank_id":"GENODEM1GLS", "views_available":[{ "id":"1", "short_name":"HHH", "is_public":true }] }] }
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.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv2.0.0, function_name: by getPrivateAccountsAtOneBank, operation_id: OBPv2.0.0-getPrivateAccountsAtOneBank Tags: Account, PrivateData, PublicData, New-Style,

在银行获取帐户(仅ID)。

仅返回用户有权访问的BANK_ID上的帐户ID列表。

每个帐户必须至少有一个私有视图。

对于每个帐户,API都会返回其帐户ID。

如果要在视图上查看更多信息,请使用“帐户详细信息”调用。

可选的请求参数:

  • account_type_filter:一个或多个accountType值,以逗号分隔
  • account_type_filter_operation:account_type_filter的过滤器类型,值必须为INCLUDE或EXCLUDE

整个网址示例:
/ banks / BANK_ID / accounts / account_ids / private?account_type_filter = 330,CURRENT + PLUS&account_type_filter_operation = INCLUDE

身份验证是强制性的

Typical Successful Response:

								
									
{ "accounts":[{ "id":"5995d6a2-01b3-423c-a173-5481df49bdaf" }] }
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-50000: Unknown Error.
Connector Methods:
Version: OBPv3.0.0, function_name: by getPrivateAccountIdsbyBankId, operation_id: OBPv3.0.0-getPrivateAccountIdsbyBankId Tags: Account, Account Information Service (AIS), New-Style,

在银行获取帐户(最低)。

映射(类型->字符串)
Typical Successful Response:

								
									
{ "accounts":[{ "id":"5995d6a2-01b3-423c-a173-5481df49bdaf", "label":"String", "bank_id":"GENODEM1GLS", "account_type":"330", "account_routings":[{ "scheme":"AccountNumber", "address":"4930396" }], "views":[{ "id":"owner", "short_name":"Owner", "description":"This view is for the owner for the account.", "is_public":false }] }] }
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-50000: Unknown Error.
Connector Methods:
Version: OBPv3.0.0, function_name: by privateAccountsAtOneBank, operation_id: OBPv3.0.0-privateAccountsAtOneBank Tags: Account, Account Information Service (AIS), New-Style,

按ID获取帐户(完整)

映射(类型->字符串)
Typical Successful Response:

								
									
{ "id":"5995d6a2-01b3-423c-a173-5481df49bdaf", "label":"NoneLabel", "number":"123", "owners":[{ "id":"5995d6a2-01b3-423c-a173-5481df49bdaf", "provider":"http://127.0.0.1:8080", "display_name":"OBP" }], "product_code":"OBP", "balance":{ "currency":"EUR", "amount":"10" }, "views_available":[{ "id":"123", "short_name":"short_name", "description":"description", "is_public":true, "alias":"None", "hide_metadata_if_alias_used":true, "can_add_comment":true, "can_add_corporate_location":true, "can_add_image":true, "can_add_image_url":true, "can_add_more_info":true, "can_add_open_corporates_url":true, "can_add_physical_location":true, "can_add_private_alias":true, "can_add_public_alias":true, "can_add_tag":true, "can_add_url":true, "can_add_where_tag":true, "can_delete_comment":true, "can_delete_corporate_location":true, "can_delete_image":true, "can_delete_physical_location":true, "can_delete_tag":true, "can_delete_where_tag":true, "can_edit_owner_comment":true, "can_see_bank_account_balance":true, "can_see_bank_account_bank_name":true, "can_see_bank_account_currency":true, "can_see_bank_account_iban":true, "can_see_bank_account_label":true, "can_see_bank_account_national_identifier":true, "can_see_bank_account_number":true, "can_see_bank_account_owners":true, "can_see_bank_account_swift_bic":true, "can_see_bank_account_type":true, "can_see_comments":true, "can_see_corporate_location":true, "can_see_image_url":true, "can_see_images":true, "can_see_more_info":true, "can_see_open_corporates_url":true, "can_see_other_account_bank_name":true, "can_see_other_account_iban":true, "can_see_other_account_kind":true, "can_see_other_account_metadata":true, "can_see_other_account_national_identifier":true, "can_see_other_account_number":true, "can_see_other_account_swift_bic":true, "can_see_owner_comment":true, "can_see_physical_location":true, "can_see_private_alias":true, "can_see_public_alias":true, "can_see_tags":true, "can_see_transaction_amount":true, "can_see_transaction_balance":true, "can_see_transaction_currency":true, "can_see_transaction_description":true, "can_see_transaction_finish_date":true, "can_see_transaction_metadata":true, "can_see_transaction_other_bank_account":true, "can_see_transaction_start_date":true, "can_see_transaction_this_bank_account":true, "can_see_transaction_type":true, "can_see_url":true, "can_see_where_tag":true }], "bank_id":"GENODEM1GLS", "account_routing":{ "scheme":"AccountNumber", "address":"4930396" }, "account_attributes":[{ "product_code":"saving1", "account_attribute_id":"613c83ea-80f9-4560-8404-b9cd4ec42a7f", "name":"OVERDRAFT_START_DATE", "type":"DATE_WITH_DAY", "value":"2012-04-23" }], "tags":[{ "id":"5995d6a2-01b3-423c-a173-5481df49bdaf", "value":"OBP", "date":"2017-09-18T22:00:00Z", "user":{ "id":"5995d6a2-01b3-423c-a173-5481df49bdaf", "provider":"http://127.0.0.1:8080", "display_name":"OBP" } }] }
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.
  • OBP-30003: Account not found. Please specify a valid value for ACCOUNT_ID.
  • OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID
  • OBP-20017: Current user does not have access to the view. Please specify a valid value for VIEW_ID.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by getPrivateAccountByIdFull, operation_id: OBPv4.0.0-getPrivateAccountByIdFull Tags: Account, New-Style,

按ID获取帐户(核心)

映射(类型->字符串)
Typical Successful Response:

								
									
{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "bank_id":"GENODEM1GLS", "label":"My Account", "number":"546387432", "owners":[{ "id":"5995d6a2-01b3-423c-a173-5481df49bdaf", "provider":"http://127.0.0.1:8080", "display_name":"OBP" }], "product_code":"AC", "balance":{ "currency":"EUR", "amount":"10" }, "account_routings":[{ "scheme":"AccountNumber", "address":"4930396" }], "views_basic":[{ "id":"owner", "short_name":"Owner", "description":"This view is for the owner for the account.", "is_public":false }], "account_attributes":[{ "product_code":"saving1", "account_attribute_id":"613c83ea-80f9-4560-8404-b9cd4ec42a7f", "name":"OVERDRAFT_START_DATE", "type":"DATE_WITH_DAY", "value":"2012-04-23" }], "tags":[{ "id":"5995d6a2-01b3-423c-a173-5481df49bdaf", "value":"OBP", "date":"2017-09-18T22:00:00Z", "user":{ "id":"5995d6a2-01b3-423c-a173-5481df49bdaf", "provider":"http://127.0.0.1:8080", "display_name":"OBP" } }] }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by getCoreAccountById, operation_id: OBPv4.0.0-getCoreAccountById Tags: Account, Account Information Service (AIS), New-Style,

更新帐户属性

更新帐户属性

帐户属性用于描述带有键入的键值对列表的金融产品。

每个帐户属性都通过ACCOUNT_ID链接到其帐户

典型的帐户属性可能是:

ISIN(用于国际债券)
VKN(用于德国债券)
REDCODE(信用衍生产品的Markit短代码)
LOAN_ID(例如用于Anacredit报告)

发行日期(债券在市场上发行时)
MATURITY_DATE(产品寿命终止)
可交易的

有关更多示例,请参见FPML

身份验证是强制性的

Typical Successful Response:

								
									
{ "product_code":"saving1", "account_attribute_id":"613c83ea-80f9-4560-8404-b9cd4ec42a7f", "name":"OVERDRAFT_START_DATE", "type":"DATE_WITH_DAY", "value":"2012-04-23" }
Required Roles:
  • CanUpdateAccountAttribute - 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-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.1.0, function_name: by updateAccountAttribute, operation_id: OBPv3.1.0-updateAccountAttribute Tags: Account, New-Style,

更新帐户标签。

更新帐户标签。标签是帐户所有者如何知道帐户的方式,例如“我的储蓄帐户”

身份验证是强制性的

Typical Successful Response:

								
									
{ "success":"Success" }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-10001: Incorrect json format.
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
  • OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
  • user does not have access to owner view on account
Connector Methods:
Version: OBPv1.2.1, function_name: by updateAccountLabel, operation_id: OBPv1.2.1-updateAccountLabel Tags: Account,

更新账户。

更新帐户。

身份验证是强制性的

Typical Successful Response:

								
									
{ "bank_id":"GENODEM1GLS", "account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "label":"Label", "type":"CURRENT", "branch_id":"1234", "account_routing":{ "scheme":"AccountNumber", "address":"4930396" } }
Required Roles:
  • CanUpdateAccount - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-10001: Incorrect json format.
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
  • OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
Connector Methods:
Version: OBPv3.1.0, function_name: by updateAccount, operation_id: OBPv3.1.0-updateAccount Tags: Account,

查看可用资金

查看可用资金
强制性URL参数:

  • 数量= NUM​​BER
  • 货币= STRING
Typical Successful Response:

								
									
{ "answer":"yes", "date":"2019-12-02T09:27:34Z", "available_funds_request_id":"c4ykz59svsr9b7fmdxk8ezs7" }
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-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
  • OBP-20054: Invalid amount. Please specify a valid value for amount.
  • OBP-10003: Invalid Currency Value. It should be three letters ISO Currency Code.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.1.0, function_name: by checkFundsAvailable, operation_id: OBPv3.1.0-checkFundsAvailable Tags: Account, Confirmation of Funds Service (PIIS), New-Style,

获取帐户余额

在一家银行获取当前用户帐户的余额。

Typical Successful Response:

								
									
{ "accounts":[{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "label":"My Account", "bank_id":"GENODEM1GLS", "account_routings":[{ "scheme":"accountNumber", "address":"123456" }], "balance":{ "currency":"EUR", "amount":"100" } }], "overall_balance":{ "currency":"EUR", "amount":"100" }, "overall_balance_date":"2017-09-18T22:00:00Z" }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.1.0, function_name: by getBankAccountsBalances, operation_id: OBPv3.1.0-getBankAccountsBalances Tags: Account, Account Information Service (AIS), New-Style,

获取持有的帐户

如果尚未为该用户分配所有者视图,则获取当前用户拥有的帐户。

可用于将帐户加入API-因为所有其他帐户和交易端点都需要分配视图。

可选的请求参数:

  • account_type_filter:一个或多个accountType值,以逗号分隔
  • account_type_filter_operation:account_type_filter的过滤器类型,值必须为INCLUDE或EXCLUDE

整个网址示例:
/ banks / BANK_ID / accounts-held?account_type_filter = 330,CURRENT + PLUS&account_type_filter_operation = INCLUDE

身份验证是强制性的

Typical Successful Response:

								
									
{ "accounts":[{ "id":"12314", "bank_id":"123", "number":"123", "account_routings":[{ "scheme":"AccountNumber", "address":"4930396" }] }] }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.0.0, function_name: by getAccountsHeld, operation_id: OBPv3.0.0-getAccountsHeld Tags: Account, Account Information Service (AIS), View, New-Style,

获取支票簿订单

注意:此端点当前仅返回示例数据。

  Get all checkbook orders 
Typical Successful Response:

								
									
{ "account":{ "bank_id":"GENODEM1GLS", "account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "account_type":"330", "account_routings":[{ "scheme":"AccountNumber", "address":"4930396" }], "branch_routings":[{ "scheme":"BranchNumber", "address":"678" }] }, "orders":[{ "order":{ "order_id":"xjksajfkj", "order_date":"07082013", "number_of_checkbooks":"4", "distribution_channel":"1201", "status":"2", "first_check_number":"5165276", "shipping_code":"1" } }] }
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-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
  • OBP-50211: Connector did not return the set of check book.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.1.0, function_name: by getCheckbookOrders, operation_id: OBPv3.1.0-getCheckbookOrders Tags: Account, New-Style,

创建账户申请

创建账户申请

身份验证是强制性的

Typical Successful Response:

								
									
{ "account_application_id":"gc23a7e2-7dd2-4bdf-a0b4-ae31232a4763", "product_code":"saveing1", "user":{ "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "email":"eveline@example.com", "provider_id":"Chris", "provider":"http://127.0.0.1:8080", "username":"felixsmith" }, "customer":{ "bank_id":"GENODEM1GLS", "customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customer_number":"5987953", "legal_name":"Eveline Tripman", "mobile_phone_number":"+44 07972 444 876", "email":"eveline@example.com", "face_image":{ "url":"www.openbankproject", "date":"2017-09-18T22:00:00Z" }, "date_of_birth":"2017-09-18T22:00:00Z", "relationship_status":"single", "dependants":10, "dob_of_dependants":["2017-09-18T22:00:00Z"], "credit_rating":{ "rating":"OBP", "source":"OBP" }, "credit_limit":{ "currency":"EUR", "amount":"10" }, "highest_education_attained":"Master", "employment_status":"worker", "kyc_status":true, "last_ok_date":"2017-09-18T22:00:00Z", "title":"Dr.", "branch_id":"DERBY6", "name_suffix":"Sr" }, "date_of_application":"2017-09-18T22:00:00Z", "status":"REQUESTED" }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.1.0, function_name: by createAccountApplication, operation_id: OBPv3.1.0-createAccountApplication Tags: Account-Application, Account, New-Style,

更新帐户申请状态

更新帐户申请状态

身份验证是强制性的

Typical Successful Response:

								
									
{ "account_application_id":"gc23a7e2-7dd2-4bdf-a0b4-ae31232a4763", "product_code":"saveing1", "user":{ "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "email":"eveline@example.com", "provider_id":"Chris", "provider":"http://127.0.0.1:8080", "username":"felixsmith" }, "customer":{ "bank_id":"GENODEM1GLS", "customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customer_number":"5987953", "legal_name":"Eveline Tripman", "mobile_phone_number":"+44 07972 444 876", "email":"eveline@example.com", "face_image":{ "url":"www.openbankproject", "date":"2017-09-18T22:00:00Z" }, "date_of_birth":"2017-09-18T22:00:00Z", "relationship_status":"single", "dependants":10, "dob_of_dependants":["2017-09-18T22:00:00Z"], "credit_rating":{ "rating":"OBP", "source":"OBP" }, "credit_limit":{ "currency":"EUR", "amount":"10" }, "highest_education_attained":"Master", "employment_status":"worker", "kyc_status":true, "last_ok_date":"2017-09-18T22:00:00Z", "title":"Dr.", "branch_id":"DERBY6", "name_suffix":"Sr" }, "date_of_application":"2017-09-18T22:00:00Z", "status":"REQUESTED" }
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.1.0, function_name: by updateAccountApplicationStatus, operation_id: OBPv3.1.0-updateAccountApplicationStatus Tags: Account-Application, Account, New-Style,

获取帐户申请

获取帐户申请。

身份验证是强制性的

Typical Successful Response:

								
									
{ "account_applications":[{ "account_application_id":"gc23a7e2-7dd2-4bdf-a0b4-ae31232a4763", "product_code":"saveing1", "user":{ "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "email":"eveline@example.com", "provider_id":"Chris", "provider":"http://127.0.0.1:8080", "username":"felixsmith" }, "customer":{ "bank_id":"GENODEM1GLS", "customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customer_number":"5987953", "legal_name":"Eveline Tripman", "mobile_phone_number":"+44 07972 444 876", "email":"eveline@example.com", "face_image":{ "url":"www.openbankproject", "date":"2017-09-18T22:00:00Z" }, "date_of_birth":"2017-09-18T22:00:00Z", "relationship_status":"single", "dependants":10, "dob_of_dependants":["2017-09-18T22:00:00Z"], "credit_rating":{ "rating":"OBP", "source":"OBP" }, "credit_limit":{ "currency":"EUR", "amount":"10" }, "highest_education_attained":"Master", "employment_status":"worker", "kyc_status":true, "last_ok_date":"2017-09-18T22:00:00Z", "title":"Dr.", "branch_id":"DERBY6", "name_suffix":"Sr" }, "date_of_application":"2017-09-18T22:00:00Z", "status":"REQUESTED" }] }
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.1.0, function_name: by getAccountApplications, operation_id: OBPv3.1.0-getAccountApplications Tags: Account-Application, Account, New-Style,

通过ID获取帐户申请

获取帐户申请。

身份验证是强制性的

Typical Successful Response:

								
									
{ "account_application_id":"gc23a7e2-7dd2-4bdf-a0b4-ae31232a4763", "product_code":"saveing1", "user":{ "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "email":"eveline@example.com", "provider_id":"Chris", "provider":"http://127.0.0.1:8080", "username":"felixsmith" }, "customer":{ "bank_id":"GENODEM1GLS", "customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customer_number":"5987953", "legal_name":"Eveline Tripman", "mobile_phone_number":"+44 07972 444 876", "email":"eveline@example.com", "face_image":{ "url":"www.openbankproject", "date":"2017-09-18T22:00:00Z" }, "date_of_birth":"2017-09-18T22:00:00Z", "relationship_status":"single", "dependants":10, "dob_of_dependants":["2017-09-18T22:00:00Z"], "credit_rating":{ "rating":"OBP", "source":"OBP" }, "credit_limit":{ "currency":"EUR", "amount":"10" }, "highest_education_attained":"Master", "employment_status":"worker", "kyc_status":true, "last_ok_date":"2017-09-18T22:00:00Z", "title":"Dr.", "branch_id":"DERBY6", "name_suffix":"Sr" }, "date_of_application":"2017-09-18T22:00:00Z", "status":"REQUESTED" }
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.1.0, function_name: by getAccountApplication, operation_id: OBPv3.1.0-getAccountApplication Tags: Account-Application, Account, New-Style,

删除帐户标签。

删除有关在view上创建的帐户ACCOUNT_ID的标签TAG_ID。

身份验证是强制性的

由于标签与用户链接,因此需要进行身份验证。

Typical Successful Response:

								
									
{ "jsonString":"{}" }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • 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
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by deleteTagForViewOnAccount, operation_id: OBPv4.0.0-deleteTagForViewOnAccount Tags: Account-Metadata, Account,

在帐户上添加标签。

视图 VIEW_ID上发布有关帐户ACCOUNT_ID的标签。

身份验证是强制性的

由于标签与用户链接,因此需要进行身份验证。

Typical Successful Response:

								
									
{ "id":"5995d6a2-01b3-423c-a173-5481df49bdaf", "value":"OBP", "date":"2017-09-18T22:00:00Z", "user":{ "id":"5995d6a2-01b3-423c-a173-5481df49bdaf", "provider":"http://127.0.0.1:8080", "display_name":"OBP" } }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • 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
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by addTagForViewOnAccount, operation_id: OBPv4.0.0-addTagForViewOnAccount Tags: Account-Metadata, Account,

获取帐户标签。

返回在视图 (VIEW_ID)上创建的帐户ACCOUNT_ID标签。
身份验证是强制性的

由于标签与用户链接,因此需要进行身份验证。

Typical Successful Response:

								
									
{ "tags":[{ "id":"5995d6a2-01b3-423c-a173-5481df49bdaf", "value":"OBP", "date":"2017-09-18T22:00:00Z", "user":{ "id":"5995d6a2-01b3-423c-a173-5481df49bdaf", "provider":"http://127.0.0.1:8080", "display_name":"OBP" } }] }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • 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:
  • OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by getTagsForViewOnAccount, operation_id: OBPv4.0.0-getTagsForViewOnAccount Tags: Account-Metadata, Account,

在所有银行获取公共帐户。

在所有银行获得公共帐户(匿名访问)。
返回至少包含一个公共视图的帐户(is_public为true的视图)
对于每个帐户,API都会返回ID和可用的视图。

身份验证是可选的

Typical Successful Response:

								
									
{ "accounts":[{ "id":"8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0", "label":"NoneLabel", "bank_id":"GENODEM1GLS", "views_available":[{ "id":"1", "short_name":"HHH", "is_public":true }] }] }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • Could not get accounts.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv2.0.0, function_name: by publicAccountsAllBanks, operation_id: OBPv2.0.0-publicAccountsAllBanks Tags: Account-Public, Account, PublicData,

在银行获取公共帐户

返回位于BANK_ID的公共帐户(匿名访问)列表。对于每个帐户,API都会返回ID和可用的视图。

身份验证是可选的

Typical Successful Response:

								
									
{ "accounts":[{ "id":"8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0", "label":"NoneLabel", "bank_id":"GENODEM1GLS", "views_available":[{ "id":"1", "short_name":"HHH", "is_public":true }] }] }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv2.0.0, function_name: by publicAccountsAtOneBank, operation_id: OBPv2.0.0-publicAccountsAtOneBank Tags: Account-Public, Account, PublicData, New-Style,

通过ID获取公共帐户

返回有关具有公开视图的帐户的信息。

该帐户由ACCOUNT_ID指定。该信息由VIEW_ID指定的视图审核。

  • 拥有者
  • 类型
  • 平衡
  • 路由

PSD2上下文:PSD2要求客户可以通过第三方应用程序访问其帐户信息。
此调用使用OAuth通过委托身份验证提供余额和其他帐户信息。

身份验证是可选的

Typical Successful Response:

								
									
{ "id":"5995d6a2-01b3-423c-a173-5481df49bdaf", "bank_id":"String", "label":"String", "number":"String", "owners":[{ "id":"5995d6a2-01b3-423c-a173-5481df49bdaf", "provider":"http://127.0.0.1:8080", "display_name":"OBP" }], "type":"String", "balance":{ "currency":"EUR", "amount":"10" }, "account_routings":[{ "scheme":"AccountNumber", "address":"4930396" }], "account_rules":[{ "scheme":"OVERDRAFT", "value":"10" }] }
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.
  • OBP-30003: Account not found. Please specify a valid value for ACCOUNT_ID.
  • OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.0.0, function_name: by getPublicAccountById, operation_id: OBPv3.0.0-getPublicAccountById Tags: Account-Public, Account, New-Style,

取得银行

获取由BANK_ID指定的银行
返回有关BANK_ID指定的单个银行的信息,包括:

  • 银行简称
  • 徽标网址
  • 网站
Typical Successful Response:

								
									
{ "id":"gh.29.uk", "short_name":"short_name ", "full_name":"full_name", "logo":"logo", "website":"www.openbankproject.com", "bank_routing":{ "scheme":"Bank_ID", "address":"gh.29.uk" } }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
Connector Methods:
Version: OBPv3.0.0, function_name: by bankById, operation_id: OBPv3.0.0-bankById Tags: Bank, Account Information Service (AIS), New-Style,

建立银行

创建一个新的银行(授权访问)。
身份验证是强制性的

Typical Successful Response:

								
									
{ "id":"gh.29.uk.x", "full_name":"uk", "short_name":"uk", "logo_url":"https://static.openbankproject.com/images/sandbox/bank_x.png", "website_url":"https://www.example.com", "swift_bic":"IIIGGB22", "national_identifier":"UK97ZZZ1234567890", "bank_routing":{ "scheme":"BIC", "address":"OKOYFIHH" } }
Required Roles:
  • CanCreateBank - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-10001: Incorrect json format.
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-30210: Insufficient authorisation to Create Bank. You do not have the role CanCreateBank.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by createBank, operation_id: OBPv4.0.0-createBank Tags: Bank,

映射(类型->字符串)

映射(类型->字符串)
Typical Successful Response:

								
									
{ "id":{ "value":"123" }, "bankId":{ "value":"gh.uk.9j" }, "shortCode":"80080", "summary":"SANDBOX_TAN", "description":"This is the sandbox mode, charging litter money.", "charge":{ "currency":"EUR", "amount":"100" } }
Required Roles:
  • CanCreateTransactionType - 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-40005: Insufficient authorisation to Create Transaction Type offered by the bank. The Request could not be created because you don't have access to CanCreateTransactionType.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv2.1.0, function_name: by createTransactionType, operation_id: OBPv2.1.0-createTransactionType Tags: Bank,

映射(类型->字符串)

映射(类型->字符串)
Typical Successful Response:

								
									
{ "transaction_types":[{ "id":{ "value":"123" }, "bank_id":"GENODEM1GLS", "short_code":"PlaceholderString", "summary":"PlaceholderString", "description":"PlaceholderString", "charge":{ "currency":"EUR", "amount":"10" } }] }
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.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv2.0.0, function_name: by getTransactionTypes, operation_id: OBPv2.0.0-getTransactionTypes Tags: Bank, Account Information Service (AIS),

获取银行

获取此API实例上的银行
返回此服务器支持的银行列表:

  • 网址中用作参数的ID
  • 银行简称
  • 徽标网址
  • 网站
Typical Successful Response:

								
									
{ "banks":[{ "id":"gh.29.uk", "short_name":"short_name ", "full_name":"full_name", "logo":"logo", "website":"www.openbankproject.com", "bank_routing":{ "scheme":"Bank_ID", "address":"gh.29.uk" } }] }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by getBanks, operation_id: OBPv4.0.0-getBanks Tags: Bank, Account Information Service (AIS), New-Style,

创建分支

为银行创建分行。

身份验证是强制性的

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查询参数limitoffset进行分页
您还可以使用以下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,

创建卡

映射(类型->字符串)
Typical Successful Response:

								
									
{ "card_id":"36f8a9e6-c2b1-407a-8bd0-421b7119307e ", "bank_id":"GENODEM1GLS", "card_number":"364435172576215", "card_type":"Credit", "name_on_card":"SusanSmith", "issue_number":"1", "serial_number":"1324234", "valid_from_date":"2017-09-18T22:00:00Z", "expires_date":"2017-09-18T22:00:00Z", "enabled":true, "cancelled":true, "on_hot_list":true, "technology":"technologyString1", "networks":["networks1"], "allows":["credit","debit"], "account":{ "id":"123", "label":"OBP", "views_available":[{ "id":"123", "short_name":"short_name", "description":"description", "is_public":true, "alias":"None", "hide_metadata_if_alias_used":true, "can_add_comment":true, "can_add_corporate_location":true, "can_add_image":true, "can_add_image_url":true, "can_add_more_info":true, "can_add_open_corporates_url":true, "can_add_physical_location":true, "can_add_private_alias":true, "can_add_public_alias":true, "can_add_tag":true, "can_add_url":true, "can_add_where_tag":true, "can_delete_comment":true, "can_delete_corporate_location":true, "can_delete_image":true, "can_delete_physical_location":true, "can_delete_tag":true, "can_delete_where_tag":true, "can_edit_owner_comment":true, "can_see_bank_account_balance":true, "can_see_bank_account_bank_name":true, "can_see_bank_account_currency":true, "can_see_bank_account_iban":true, "can_see_bank_account_label":true, "can_see_bank_account_national_identifier":true, "can_see_bank_account_number":true, "can_see_bank_account_owners":true, "can_see_bank_account_swift_bic":true, "can_see_bank_account_type":true, "can_see_comments":true, "can_see_corporate_location":true, "can_see_image_url":true, "can_see_images":true, "can_see_more_info":true, "can_see_open_corporates_url":true, "can_see_other_account_bank_name":true, "can_see_other_account_iban":true, "can_see_other_account_kind":true, "can_see_other_account_metadata":true, "can_see_other_account_national_identifier":true, "can_see_other_account_number":true, "can_see_other_account_swift_bic":true, "can_see_owner_comment":true, "can_see_physical_location":true, "can_see_private_alias":true, "can_see_public_alias":true, "can_see_tags":true, "can_see_transaction_amount":true, "can_see_transaction_balance":true, "can_see_transaction_currency":true, "can_see_transaction_description":true, "can_see_transaction_finish_date":true, "can_see_transaction_metadata":true, "can_see_transaction_other_bank_account":true, "can_see_transaction_start_date":true, "can_see_transaction_this_bank_account":true, "can_see_transaction_type":true, "can_see_url":true, "can_see_where_tag":true }], "bank_id":"GENODEM1GLS" }, "replacement":{ "requested_date":"2017-09-18T22:00:00Z", "reason_requested":"RENEW" }, "pin_reset":[{ "requested_date":"2017-09-18T22:00:00Z", "reason_requested":"FORGOT" }], "collected":"2017-09-18T22:00:00Z", "posted":"2017-09-18T22:00:00Z", "customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh" }
Required Roles:
  • CanCreateCardsForBank - 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-10015: Allowed values are:
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.1.0, function_name: by addCardForBank, operation_id: OBPv3.1.0-addCardForBank Tags: Card,

创建卡属性

创建卡属性

卡属性用于描述带有键入的键值对列表的金融产品。

每个卡属性都通过CARD_ID链接到其卡

类型字段必须是“ STRING”,“ INTEGER”,“ DOUBLE”或DATE_WITH_DAY”之一

身份验证是强制性的

Typical Successful Response:

								
									
{ "name":"OVERDRAFT_START_DATE", "card_id":"36f8a9e6-c2b1-407a-8bd0-421b7119307e ", "attribute_type":"DOUBLE", "bank_id":{ "value":"GENODEM1GLS" }, "value":"2012-04-23", "card_attribute_id":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50" }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.1.0, function_name: by createCardAttribute, operation_id: OBPv3.1.0-createCardAttribute Tags: Card, New-Style,

删除卡

在CARD_ID指定的银行删除卡。

身份验证是强制性的

Typical Successful Response:

								
									
{ "jsonString":"{}" }
Required Roles:
  • CanCreateCardsForBank - 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-10015: Allowed values are:
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.1.0, function_name: by deleteCardForBank, operation_id: OBPv3.1.0-deleteCardForBank Tags: Card,

更新卡

映射(类型->字符串)
Typical Successful Response:

								
									
{ "card_id":"36f8a9e6-c2b1-407a-8bd0-421b7119307e ", "bank_id":"GENODEM1GLS", "card_number":"364435172576215", "card_type":"Credit", "name_on_card":"SusanSmith", "issue_number":"1", "serial_number":"1324234", "valid_from_date":"2017-09-18T22:00:00Z", "expires_date":"2017-09-18T22:00:00Z", "enabled":true, "cancelled":true, "on_hot_list":true, "technology":"technologyString1", "networks":["networks1"], "allows":["credit","debit"], "account":{ "id":"123", "label":"OBP", "views_available":[{ "id":"123", "short_name":"short_name", "description":"description", "is_public":true, "alias":"None", "hide_metadata_if_alias_used":true, "can_add_comment":true, "can_add_corporate_location":true, "can_add_image":true, "can_add_image_url":true, "can_add_more_info":true, "can_add_open_corporates_url":true, "can_add_physical_location":true, "can_add_private_alias":true, "can_add_public_alias":true, "can_add_tag":true, "can_add_url":true, "can_add_where_tag":true, "can_delete_comment":true, "can_delete_corporate_location":true, "can_delete_image":true, "can_delete_physical_location":true, "can_delete_tag":true, "can_delete_where_tag":true, "can_edit_owner_comment":true, "can_see_bank_account_balance":true, "can_see_bank_account_bank_name":true, "can_see_bank_account_currency":true, "can_see_bank_account_iban":true, "can_see_bank_account_label":true, "can_see_bank_account_national_identifier":true, "can_see_bank_account_number":true, "can_see_bank_account_owners":true, "can_see_bank_account_swift_bic":true, "can_see_bank_account_type":true, "can_see_comments":true, "can_see_corporate_location":true, "can_see_image_url":true, "can_see_images":true, "can_see_more_info":true, "can_see_open_corporates_url":true, "can_see_other_account_bank_name":true, "can_see_other_account_iban":true, "can_see_other_account_kind":true, "can_see_other_account_metadata":true, "can_see_other_account_national_identifier":true, "can_see_other_account_number":true, "can_see_other_account_swift_bic":true, "can_see_owner_comment":true, "can_see_physical_location":true, "can_see_private_alias":true, "can_see_public_alias":true, "can_see_tags":true, "can_see_transaction_amount":true, "can_see_transaction_balance":true, "can_see_transaction_currency":true, "can_see_transaction_description":true, "can_see_transaction_finish_date":true, "can_see_transaction_metadata":true, "can_see_transaction_other_bank_account":true, "can_see_transaction_start_date":true, "can_see_transaction_this_bank_account":true, "can_see_transaction_type":true, "can_see_url":true, "can_see_where_tag":true }], "bank_id":"GENODEM1GLS" }, "replacement":{ "requested_date":"2017-09-18T22:00:00Z", "reason_requested":"RENEW" }, "pin_reset":[{ "requested_date":"2017-09-18T22:00:00Z", "reason_requested":"FORGOT" }], "collected":"2017-09-18T22:00:00Z", "posted":"2017-09-18T22:00:00Z", "customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh" }
Required Roles:
  • CanCreateCardsForBank - 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-10015: Allowed values are:
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.1.0, function_name: by updatedCardForBank, operation_id: OBPv3.1.0-updatedCardForBank Tags: Card,

更新卡属性

更新卡属性

卡属性用于描述带有键入的键值对列表的金融产品。

每个卡属性都通过CARD_ID链接到其卡

身份验证是强制性的

Typical Successful Response:

								
									
{ "name":"OVERDRAFT_START_DATE", "card_id":"36f8a9e6-c2b1-407a-8bd0-421b7119307e ", "attribute_type":"DOUBLE", "bank_id":{ "value":"GENODEM1GLS" }, "value":"2012-04-23", "card_attribute_id":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50" }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.1.0, function_name: by updateCardAttribute, operation_id: OBPv3.1.0-updateCardAttribute Tags: Card, New-Style,

获取信用卡订单状态

注意:此端点当前仅返回示例数据。

  Get status of Credit Card orders 

获取所有订单

Typical Successful Response:

								
									
{ "cards":[{ "card_type":"5", "card_description":"good", "use_type":"3" }] }
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-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
  • OBP-50212: Connector did not return the set of status of credit card.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.1.0, function_name: by getStatusOfCreditCardOrder, operation_id: OBPv3.1.0-getStatusOfCreditCardOrder Tags: Card, New-Style,

获取当前用户的卡片

映射(类型->字符串)
Typical Successful Response:

								
									
{ "cards":[{ "bank_id":"GENODEM1GLS", "bank_card_number":"364435172576215", "name_on_card":"String", "issue_number":"1", "serial_number":"1324234", "valid_from_date":"2017-09-18T22:00:00Z", "expires_date":"2017-09-18T22:00:00Z", "enabled":true, "cancelled":true, "on_hot_list":true, "technology":"String", "networks":["String"], "allows":["String"], "account":{ "id":"123", "label":"OBP", "views_available":[{ "id":"123", "short_name":"short_name", "description":"description", "is_public":true, "alias":"None", "hide_metadata_if_alias_used":true, "can_add_comment":true, "can_add_corporate_location":true, "can_add_image":true, "can_add_image_url":true, "can_add_more_info":true, "can_add_open_corporates_url":true, "can_add_physical_location":true, "can_add_private_alias":true, "can_add_public_alias":true, "can_add_tag":true, "can_add_url":true, "can_add_where_tag":true, "can_delete_comment":true, "can_delete_corporate_location":true, "can_delete_image":true, "can_delete_physical_location":true, "can_delete_tag":true, "can_delete_where_tag":true, "can_edit_owner_comment":true, "can_see_bank_account_balance":true, "can_see_bank_account_bank_name":true, "can_see_bank_account_currency":true, "can_see_bank_account_iban":true, "can_see_bank_account_label":true, "can_see_bank_account_national_identifier":true, "can_see_bank_account_number":true, "can_see_bank_account_owners":true, "can_see_bank_account_swift_bic":true, "can_see_bank_account_type":true, "can_see_comments":true, "can_see_corporate_location":true, "can_see_image_url":true, "can_see_images":true, "can_see_more_info":true, "can_see_open_corporates_url":true, "can_see_other_account_bank_name":true, "can_see_other_account_iban":true, "can_see_other_account_kind":true, "can_see_other_account_metadata":true, "can_see_other_account_national_identifier":true, "can_see_other_account_number":true, "can_see_other_account_swift_bic":true, "can_see_owner_comment":true, "can_see_physical_location":true, "can_see_private_alias":true, "can_see_public_alias":true, "can_see_tags":true, "can_see_transaction_amount":true, "can_see_transaction_balance":true, "can_see_transaction_currency":true, "can_see_transaction_description":true, "can_see_transaction_finish_date":true, "can_see_transaction_metadata":true, "can_see_transaction_other_bank_account":true, "can_see_transaction_start_date":true, "can_see_transaction_this_bank_account":true, "can_see_transaction_type":true, "can_see_url":true, "can_see_where_tag":true }], "bank_id":"GENODEM1GLS" }, "replacement":{ "requested_date":"2017-09-18T22:00:00Z", "reason_requested":"RENEW" }, "pin_reset":[{ "requested_date":"2017-09-18T22:00:00Z", "reason_requested":"FORGOT" }], "collected":"2017-09-18T22:00:00Z", "posted":"2017-09-18T22:00:00Z" }] }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv1.3.0, function_name: by getCards, operation_id: OBPv1.3.0-getCards Tags: Card, User,

获取指定银行的卡

映射(类型->字符串)
Typical Successful Response:

								
									
{ "cards":[{ "card_id":"36f8a9e6-c2b1-407a-8bd0-421b7119307e ", "bank_id":"GENODEM1GLS", "card_number":"364435172576215", "card_type":"Credit", "name_on_card":"SusanSmith", "issue_number":"1", "serial_number":"1324234", "valid_from_date":"2017-09-18T22:00:00Z", "expires_date":"2017-09-18T22:00:00Z", "enabled":true, "cancelled":true, "on_hot_list":true, "technology":"technologyString1", "networks":["networks1"], "allows":["credit","debit"], "account":{ "id":"123", "label":"OBP", "views_available":[{ "id":"123", "short_name":"short_name", "description":"description", "is_public":true, "alias":"None", "hide_metadata_if_alias_used":true, "can_add_comment":true, "can_add_corporate_location":true, "can_add_image":true, "can_add_image_url":true, "can_add_more_info":true, "can_add_open_corporates_url":true, "can_add_physical_location":true, "can_add_private_alias":true, "can_add_public_alias":true, "can_add_tag":true, "can_add_url":true, "can_add_where_tag":true, "can_delete_comment":true, "can_delete_corporate_location":true, "can_delete_image":true, "can_delete_physical_location":true, "can_delete_tag":true, "can_delete_where_tag":true, "can_edit_owner_comment":true, "can_see_bank_account_balance":true, "can_see_bank_account_bank_name":true, "can_see_bank_account_currency":true, "can_see_bank_account_iban":true, "can_see_bank_account_label":true, "can_see_bank_account_national_identifier":true, "can_see_bank_account_number":true, "can_see_bank_account_owners":true, "can_see_bank_account_swift_bic":true, "can_see_bank_account_type":true, "can_see_comments":true, "can_see_corporate_location":true, "can_see_image_url":true, "can_see_images":true, "can_see_more_info":true, "can_see_open_corporates_url":true, "can_see_other_account_bank_name":true, "can_see_other_account_iban":true, "can_see_other_account_kind":true, "can_see_other_account_metadata":true, "can_see_other_account_national_identifier":true, "can_see_other_account_number":true, "can_see_other_account_swift_bic":true, "can_see_owner_comment":true, "can_see_physical_location":true, "can_see_private_alias":true, "can_see_public_alias":true, "can_see_tags":true, "can_see_transaction_amount":true, "can_see_transaction_balance":true, "can_see_transaction_currency":true, "can_see_transaction_description":true, "can_see_transaction_finish_date":true, "can_see_transaction_metadata":true, "can_see_transaction_other_bank_account":true, "can_see_transaction_start_date":true, "can_see_transaction_this_bank_account":true, "can_see_transaction_type":true, "can_see_url":true, "can_see_where_tag":true }], "bank_id":"GENODEM1GLS" }, "replacement":{ "requested_date":"2017-09-18T22:00:00Z", "reason_requested":"RENEW" }, "pin_reset":[{ "requested_date":"2017-09-18T22:00:00Z", "reason_requested":"FORGOT" }], "collected":"2017-09-18T22:00:00Z", "posted":"2017-09-18T22:00:00Z", "customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh" }] }
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-50000: Unknown Error.
Connector Methods:
Version: OBPv3.1.0, function_name: by getCardsForBank, operation_id: OBPv3.1.0-getCardsForBank Tags: Card,

通过ID获取卡

映射(类型->字符串)
Typical Successful Response:

								
									
{ "card_id":"36f8a9e6-c2b1-407a-8bd0-421b7119307e ", "bank_id":"GENODEM1GLS", "card_number":"364435172576215", "card_type":"Credit", "name_on_card":"SusanSmith", "issue_number":"1", "serial_number":"1324234", "valid_from_date":"2017-09-18T22:00:00Z", "expires_date":"2017-09-18T22:00:00Z", "enabled":true, "cancelled":true, "on_hot_list":true, "technology":"technologyString1", "networks":["networks1"], "allows":["credit","debit"], "account":{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "label":"My Account", "views_available":[{ "id":"owner", "name":"Owner", "description":"This view is for the owner for the account." }], "bank_id":"GENODEM1GLS" }, "replacement":{ "requested_date":"2017-09-18T22:00:00Z", "reason_requested":"RENEW" }, "pin_reset":[{ "requested_date":"2017-09-18T22:00:00Z", "reason_requested":"FORGOT" }], "collected":"2017-09-18T22:00:00Z", "posted":"2017-09-18T22:00:00Z", "customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "card_attributes":[{ "name":"OVERDRAFT_START_DATE", "card_id":"36f8a9e6-c2b1-407a-8bd0-421b7119307e ", "attribute_type":"STRING", "bank_id":{ "value":"GENODEM1GLS" }, "value":"2012-04-23", "card_attribute_id":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50" }] }
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-50000: Unknown Error.
Connector Methods:
Version: OBPv3.1.0, function_name: by getCardForBank, operation_id: OBPv3.1.0-getCardForBank Tags: Card,

取得同意

OBP同意书允许同意书持有人呼叫一个或多个端点。

必须使用SCA(严格的客户身份验证)来创建和授权同意书。

也就是说,可以由授权用户通过OBP REST API创建同意书,但是必须通过带外(OOB)机制(例如发送到手机的代码)进行确认。

每个同意书都具有以下状态之一:初始化,接受,拒绝,撤回,已接收,有效,撤回BYPSU,已过期,终止DBP。

该端点获取当前用户创建的同意。

身份验证是强制性的

Typical Successful Response:

								
									
{ "consents":[{ "consent_id":"9d429899-24f5-42c8-8565-943ffa6a7945", "jwt":"eyJhbGciOiJIUzI1NiJ9.eyJlbnRpdGxlbWVudHMiOltdLCJjcmVhdGVkQnlVc2VySWQiOiJhYjY1MzlhOS1iMTA1LTQ0ODktYTg4My0wYWQ4ZDZjNjE2NTciLCJzdWIiOiIyMWUxYzhjYy1mOTE4LTRlYWMtYjhlMy01ZTVlZWM2YjNiNGIiLCJhdWQiOiJlanpuazUwNWQxMzJyeW9tbmhieDFxbXRvaHVyYnNiYjBraWphanNrIiwibmJmIjoxNTUzNTU0ODk5LCJpc3MiOiJodHRwczpcL1wvd3d3Lm9wZW5iYW5rcHJvamVjdC5jb20iLCJleHAiOjE1NTM1NTg0OTksImlhdCI6MTU1MzU1NDg5OSwianRpIjoiMDlmODhkNWYtZWNlNi00Mzk4LThlOTktNjYxMWZhMWNkYmQ1Iiwidmlld3MiOlt7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAxIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifSx7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAyIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifV19.8cc7cBEf2NyQvJoukBCmDLT7LXYcuzTcSYLqSpbxLp4", "status":"INITIATED" }] }
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-50000: Unknown Error.
Connector Methods:
Version: OBPv3.1.0, function_name: by getConsents, operation_id: OBPv3.1.0-getConsents Tags: Consent, Account Information Service (AIS), New-Style,

回答同意挑战

OBP同意书允许同意书持有人呼叫一个或多个端点。

必须使用SCA(严格的客户身份验证)来创建和授权同意书。

也就是说,可以由授权用户通过OBP REST API创建同意书,但是必须通过带外(OOB)机制(例如发送到手机的代码)进行确认。

每个同意书都具有以下状态之一:初始化,接受,拒绝,撤回,已接收,有效,撤回BYPSU,已过期,终止DBP。

该端点用于确认先前创建的同意。

用户必须提供例如通过SMS带外(OOB)发送的代码。

身份验证是强制性的

Typical Successful Response:

								
									
{ "consent_id":"9d429899-24f5-42c8-8565-943ffa6a7945", "jwt":"eyJhbGciOiJIUzI1NiJ9.eyJlbnRpdGxlbWVudHMiOltdLCJjcmVhdGVkQnlVc2VySWQiOiJhYjY1MzlhOS1iMTA1LTQ0ODktYTg4My0wYWQ4ZDZjNjE2NTciLCJzdWIiOiIyMWUxYzhjYy1mOTE4LTRlYWMtYjhlMy01ZTVlZWM2YjNiNGIiLCJhdWQiOiJlanpuazUwNWQxMzJyeW9tbmhieDFxbXRvaHVyYnNiYjBraWphanNrIiwibmJmIjoxNTUzNTU0ODk5LCJpc3MiOiJodHRwczpcL1wvd3d3Lm9wZW5iYW5rcHJvamVjdC5jb20iLCJleHAiOjE1NTM1NTg0OTksImlhdCI6MTU1MzU1NDg5OSwianRpIjoiMDlmODhkNWYtZWNlNi00Mzk4LThlOTktNjYxMWZhMWNkYmQ1Iiwidmlld3MiOlt7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAxIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifSx7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAyIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifV19.8cc7cBEf2NyQvJoukBCmDLT7LXYcuzTcSYLqSpbxLp4", "status":"INITIATED" }
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-50200: Connector cannot return the data we requested.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.1.0, function_name: by answerConsentChallenge, operation_id: OBPv3.1.0-answerConsentChallenge Tags: Consent, Account Information Service (AIS), New-Style,

建立同意书(EMAIL)

OBP同意书允许同意书持有人呼叫一个或多个端点。

必须使用SCA(严格的客户身份验证)来创建和授权同意书。

也就是说,可以由授权用户通过OBP REST API创建同意书,但是必须通过带外(OOB)机制(例如发送到手机的代码)进行确认。

每个同意书都具有以下状态之一:初始化,接受,拒绝,撤回,已接收,有效,撤回BYPSU,已过期,终止DBP。

该端点开始创建同意的过程。

同意是在INITIATED状态下创建的。

通过SCA_METHOD中定义的传输,将一次性密码(OTP)(又称为安全性挑战)发送给用户(OOB)
SCA_METHOD通常是“ SMS”或“ EMAIL”。 “ EMAIL”用于测试目的。

创建同意书后,OBP(或后端系统)将存储挑战,以便稍后可以根据用户通过“回答同意书挑战”端点提供的值进行检查。

身份验证是强制性的

Typical Successful Response:

								
									
{ "consent_id":"9d429899-24f5-42c8-8565-943ffa6a7945", "jwt":"eyJhbGciOiJIUzI1NiJ9.eyJlbnRpdGxlbWVudHMiOltdLCJjcmVhdGVkQnlVc2VySWQiOiJhYjY1MzlhOS1iMTA1LTQ0ODktYTg4My0wYWQ4ZDZjNjE2NTciLCJzdWIiOiIyMWUxYzhjYy1mOTE4LTRlYWMtYjhlMy01ZTVlZWM2YjNiNGIiLCJhdWQiOiJlanpuazUwNWQxMzJyeW9tbmhieDFxbXRvaHVyYnNiYjBraWphanNrIiwibmJmIjoxNTUzNTU0ODk5LCJpc3MiOiJodHRwczpcL1wvd3d3Lm9wZW5iYW5rcHJvamVjdC5jb20iLCJleHAiOjE1NTM1NTg0OTksImlhdCI6MTU1MzU1NDg5OSwianRpIjoiMDlmODhkNWYtZWNlNi00Mzk4LThlOTktNjYxMWZhMWNkYmQ1Iiwidmlld3MiOlt7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAxIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifSx7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAyIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifV19.8cc7cBEf2NyQvJoukBCmDLT7LXYcuzTcSYLqSpbxLp4", "status":"INITIATED" }
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-50200: Connector cannot return the data we requested.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.1.0, function_name: by createConsentEmail, operation_id: OBPv3.1.0-createConsentEmail Tags: Consent, Account Information Service (AIS), New-Style,

建立同意书(SMS)

OBP同意书允许同意书持有人呼叫一个或多个端点。

必须使用SCA(严格的客户身份验证)来创建和授权同意书。

也就是说,可以由授权用户通过OBP REST API创建同意书,但是必须通过带外(OOB)机制(例如发送到手机的代码)进行确认。

每个同意书都具有以下状态之一:初始化,接受,拒绝,撤回,已接收,有效,撤回BYPSU,已过期,终止DBP。

该端点开始创建同意的过程。

同意是在INITIATED状态下创建的。

通过SCA_METHOD中定义的传输,将一次性密码(OTP)(又称为安全性挑战)发送给用户(OOB)
SCA_METHOD通常是“ SMS”或“ EMAIL”。 “ EMAIL”用于测试目的。

创建同意书后,OBP(或后端系统)将存储挑战,以便稍后可以根据用户通过“回答同意书挑战”端点提供的值进行检查。

身份验证是强制性的

Typical Successful Response:

								
									
{ "consent_id":"9d429899-24f5-42c8-8565-943ffa6a7945", "jwt":"eyJhbGciOiJIUzI1NiJ9.eyJlbnRpdGxlbWVudHMiOltdLCJjcmVhdGVkQnlVc2VySWQiOiJhYjY1MzlhOS1iMTA1LTQ0ODktYTg4My0wYWQ4ZDZjNjE2NTciLCJzdWIiOiIyMWUxYzhjYy1mOTE4LTRlYWMtYjhlMy01ZTVlZWM2YjNiNGIiLCJhdWQiOiJlanpuazUwNWQxMzJyeW9tbmhieDFxbXRvaHVyYnNiYjBraWphanNrIiwibmJmIjoxNTUzNTU0ODk5LCJpc3MiOiJodHRwczpcL1wvd3d3Lm9wZW5iYW5rcHJvamVjdC5jb20iLCJleHAiOjE1NTM1NTg0OTksImlhdCI6MTU1MzU1NDg5OSwianRpIjoiMDlmODhkNWYtZWNlNi00Mzk4LThlOTktNjYxMWZhMWNkYmQ1Iiwidmlld3MiOlt7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAxIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifSx7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAyIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifV19.8cc7cBEf2NyQvJoukBCmDLT7LXYcuzTcSYLqSpbxLp4", "status":"INITIATED" }
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-50200: Connector cannot return the data we requested.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.1.0, function_name: by createConsentSms, operation_id: OBPv3.1.0-createConsentSms Tags: Consent, Account Information Service (AIS), New-Style,

撤销同意

OBP同意书允许同意书持有人呼叫一个或多个端点。

必须使用SCA(严格的客户身份验证)来创建和授权同意书。

也就是说,可以由授权用户通过OBP REST API创建同意书,但是必须通过带外(OOB)机制(例如发送到手机的代码)进行确认。

每个同意书都具有以下状态之一:初始化,接受,拒绝,撤回,已接收,有效,撤回BYPSU,已过期,终止DBP。

撤销由CONSENT_ID指定的当前用户的同意书

身份验证是强制性的

Typical Successful Response:

								
									
{ "consent_id":"9d429899-24f5-42c8-8565-943ffa6a7945", "jwt":"eyJhbGciOiJIUzI1NiJ9.eyJlbnRpdGxlbWVudHMiOltdLCJjcmVhdGVkQnlVc2VySWQiOiJhYjY1MzlhOS1iMTA1LTQ0ODktYTg4My0wYWQ4ZDZjNjE2NTciLCJzdWIiOiIyMWUxYzhjYy1mOTE4LTRlYWMtYjhlMy01ZTVlZWM2YjNiNGIiLCJhdWQiOiJlanpuazUwNWQxMzJyeW9tbmhieDFxbXRvaHVyYnNiYjBraWphanNrIiwibmJmIjoxNTUzNTU0ODk5LCJpc3MiOiJodHRwczpcL1wvd3d3Lm9wZW5iYW5rcHJvamVjdC5jb20iLCJleHAiOjE1NTM1NTg0OTksImlhdCI6MTU1MzU1NDg5OSwianRpIjoiMDlmODhkNWYtZWNlNi00Mzk4LThlOTktNjYxMWZhMWNkYmQ1Iiwidmlld3MiOlt7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAxIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifSx7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAyIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifV19.8cc7cBEf2NyQvJoukBCmDLT7LXYcuzTcSYLqSpbxLp4", "status":"REJECTED" }
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-50000: Unknown Error.
Connector Methods:
Version: OBPv3.1.0, function_name: by revokeConsent, operation_id: OBPv3.1.0-revokeConsent Tags: Consent, Account Information Service (AIS), New-Style,

启用或禁用消费者

启用/禁用由CONSUMER_ID指定的使用者。

Typical Successful Response:

								
									
{ "enabled":false }
Required Roles:
  • CanEnableConsumers - Please login to request this Role
  • CanDisableConsumers - 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: OBPv2.1.0, function_name: by enableDisableConsumers, operation_id: OBPv2.1.0-enableDisableConsumers Tags: Consumer, API,

吸引消费者

映射(类型->字符串)
Typical Successful Response:

								
									
{ "consumers":[{ "consumer_id":"8e716299-4668-4efd-976a-67f57a9984ec", "app_name":"SOFI", "app_type":"Web", "description":"Account Management", "developer_email":"eveline@example.com", "redirect_url":"www.openbankproject.com", "created_by_user":{ "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "email":"eveline@example.com", "provider_id":"Chris", "provider":"http://127.0.0.1:8080", "username":"felixsmith" }, "enabled":true, "created":"2017-09-18T22:00:00Z" }] }
Required Roles:
  • CanGetConsumers - 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.1.0, function_name: by getConsumers, operation_id: OBPv3.1.0-getConsumers Tags: Consumer, API, New-Style,

吸引消费者

映射(类型->字符串)
Typical Successful Response:

								
									
{ "consumer_id":1213, "app_name":"SOFI", "app_type":"Web", "description":"Account Management", "developer_email":"eveline@example.com", "redirect_url":"www.openbankproject.com", "created_by_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "created_by_user":{ "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "email":"eveline@example.com", "provider_id":"Chris", "provider":"http://127.0.0.1:8080", "username":"felixsmith" }, "enabled":true, "created":"2017-09-18T22:00:00Z" }
Required Roles:
  • CanGetConsumers - 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-30019: Consumer not found. Please specify a valid value for CONSUMER_ID.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.1.0, function_name: by getConsumer, operation_id: OBPv3.1.0-getConsumer Tags: Consumer, API, New-Style,

吸引消费者(登录用户)

映射(类型->字符串)
Typical Successful Response:

								
									
{ "consumers":[{ "consumer_id":"8e716299-4668-4efd-976a-67f57a9984ec", "app_name":"SOFI", "app_type":"Web", "description":"Account Management", "developer_email":"eveline@example.com", "redirect_url":"www.openbankproject.com", "created_by_user":{ "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "email":"eveline@example.com", "provider_id":"Chris", "provider":"http://127.0.0.1:8080", "username":"felixsmith" }, "enabled":true, "created":"2017-09-18T22:00:00Z" }] }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.1.0, function_name: by getConsumersForCurrentUser, operation_id: OBPv3.1.0-getConsumersForCurrentUser Tags: Consumer, API, New-Style,

更新使用者RedirectUrl

映射(类型->字符串)
Typical Successful Response:

								
									
{ "consumer_id":1213, "app_name":"SOFI", "app_type":"Web", "description":"Account Management", "developer_email":"eveline@example.com", "redirect_url":"www.openbankproject.com", "created_by_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "created_by_user":{ "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "email":"eveline@example.com", "provider_id":"Chris", "provider":"http://127.0.0.1:8080", "username":"felixsmith" }, "enabled":true, "created":"2017-09-18T22:00:00Z" }
Required Roles:
  • CanUpdateConsumerRedirectUrl - 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: OBPv2.1.0, function_name: by updateConsumerRedirectUrl, operation_id: OBPv2.1.0-updateConsumerRedirectUrl Tags: Consumer, API,

获取消费者的通话限制

获取每个消费者的通话限制。
身份验证是强制性的

Typical Successful Response:

								
									
{ "per_second_call_limit":"-1", "per_minute_call_limit":"-1", "per_hour_call_limit":"-1", "per_day_call_limit":"-1", "per_week_call_limit":"-1", "per_month_call_limit":"-1", "current_state":{ "per_second":{ "calls_made":-1, "reset_in_seconds":-1 }, "per_minute":{ "calls_made":-1, "reset_in_seconds":-1 }, "per_hour":{ "calls_made":-1, "reset_in_seconds":-1 }, "per_day":{ "calls_made":-1, "reset_in_seconds":-1 }, "per_week":{ "calls_made":-1, "reset_in_seconds":-1 }, "per_month":{ "calls_made":-1, "reset_in_seconds":-1 } } }
Required Roles:
  • CanSetCallLimits - 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-10001: Incorrect json format.
  • OBP-20014: Invalid Consumer ID. Please specify a valid value for CONSUMER_ID.
  • OBP-30019: Consumer not found. Please specify a valid value for CONSUMER_ID.
  • OBP-20006: User is missing one or more roles:
  • OBP-30023: Cannot update Consumer
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.1.0, function_name: by getCallsLimit, operation_id: OBPv3.1.0-getCallsLimit Tags: Consumer, New-Style,

设置消费者的通话限制

设置使用者的API调用限制:

每秒
每分钟
每小时
每个星期
每月

身份验证是强制性的

Typical Successful Response:

								
									
{ "from_date":"2017-09-18T22:00:00Z", "to_date":"2017-09-18T22:00:00Z", "per_second_call_limit":"-1", "per_minute_call_limit":"-1", "per_hour_call_limit":"-1", "per_day_call_limit":"-1", "per_week_call_limit":"-1", "per_month_call_limit":"-1" }
Required Roles:
  • CanSetCallLimits - 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-10001: Incorrect json format.
  • OBP-20014: Invalid Consumer ID. Please specify a valid value for CONSUMER_ID.
  • OBP-30019: Consumer not found. Please specify a valid value for CONSUMER_ID.
  • OBP-20006: User is missing one or more roles:
  • OBP-30023: Cannot update Consumer
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.1.0, function_name: by callsLimit, operation_id: OBPv3.1.0-callsLimit Tags: Consumer, New-Style,

创建交易对手(明确)

映射(类型->字符串)
Typical Successful Response:

								
									
{ "name":"CounterpartyName", "description":"My landlord", "created_by_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "this_bank_id":"GENODEM1GLS", "this_account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "this_view_id":"owner", "counterparty_id":"1d65db7c-a7b2-4839-af41-958276ab7790", "other_bank_routing_scheme":"bankCode", "other_bank_routing_address":"10", "other_branch_routing_scheme":"branchNumber", "other_branch_routing_address":"10010", "other_account_routing_scheme":"accountNumber", "other_account_routing_address":"7987987-2348987-234234", "other_account_secondary_routing_scheme":"accountId", "other_account_secondary_routing_address":"8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0", "is_beneficiary":true, "bespoke":[{ "key":"englishName", "value":"english Name" }], "metadata":{ "public_alias":"String", "more_info":"String", "url":"String", "image_url":"String", "open_corporates_url":"String", "corporate_location":{ "latitude":11.45, "longitude":11.45, "date":"2017-09-18T22:00:00Z", "user":{ "id":"123", "provider":"http://127.0.0.1:8080", "username":"felixsmith" } }, "physical_location":{ "latitude":11.45, "longitude":11.45, "date":"2017-09-18T22:00:00Z", "user":{ "id":"123", "provider":"http://127.0.0.1:8080", "username":"felixsmith" } }, "private_alias":"String" } }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-30110: Invalid Account Id. The ACCOUNT_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.
  • OBP-30111: Invalid Bank Id. The BANK_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-30003: Account not found. Please specify a valid value for ACCOUNT_ID.
  • OBP-10001: Incorrect json format.
  • OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID
  • OBP-30014: Counterparty already exists. Please specify a different value for BANK_ID or ACCOUNT_ID or VIEW_ID or NAME.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv2.2.0, function_name: by createCounterparty, operation_id: OBPv2.2.0-createCounterparty Tags: Counterparty, Account,

获取一个帐户的其他帐户。

返回有关所有其他帐户的数据,这些帐户已经与ACCOUNT_ID共享了至少一个交易,且帐户为BANK_ID。
身份验证是可选的

如果视图VIEW_ID不公开,则需要进行身份验证。

Typical Successful Response:

								
									
{ "other_accounts":[{ "id":"5995d6a2-01b3-423c-a173-5481df49bdaf", "holder":{ "name":"OBP", "is_alias":true }, "bank_routing":{ "scheme":"Bank_ID", "address":"gh.29.uk" }, "account_routings":[{ "scheme":"AccountNumber", "address":"4930396" }], "metadata":{ "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" } } } }] }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • 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-30005: View not found for Account. Please specify a valid value for VIEW_ID
  • OBP-50200: Connector cannot return the data we requested.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.0.0, function_name: by getOtherAccountsForBankAccount, operation_id: OBPv3.0.0-getOtherAccountsForBankAccount Tags: Counterparty, Account, New-Style,

获取对方(明确)。

映射(类型->字符串)
Typical Successful Response:

								
									
{ "counterparties":[{ "name":"CounterpartyName", "description":"My landlord", "created_by_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "this_bank_id":"GENODEM1GLS", "this_account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "this_view_id":"owner", "counterparty_id":"1d65db7c-a7b2-4839-af41-958276ab7790", "other_bank_routing_scheme":"bankCode", "other_bank_routing_address":"10", "other_branch_routing_scheme":"branchNumber", "other_branch_routing_address":"10010", "other_account_routing_scheme":"accountNumber", "other_account_routing_address":"7987987-2348987-234234", "other_account_secondary_routing_scheme":"accountId", "other_account_secondary_routing_address":"8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0", "is_beneficiary":true, "bespoke":[{ "key":"englishName", "value":"english Name" }] }] }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • 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-30005: View not found for Account. Please specify a valid value for VIEW_ID
  • OBP-30022: The current view does not have the permission:
  • OBP-20017: Current user does not have access to the view. Please specify a valid value for VIEW_ID.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv2.2.0, function_name: by getExplictCounterpartiesForAccount, operation_id: OBPv2.2.0-getExplictCounterpartiesForAccount Tags: Counterparty, Payment Initiation Service (PIS), Account,

通过ID获取其他帐户。

返回有关“其他帐户”的数据,该“其他帐户”已通过BANK_ID与ACCOUNT_ID共享了至少一笔交易。
身份验证是可选的

如果视图不是公共的,则需要认证。

Typical Successful Response:

								
									
{ "id":"5995d6a2-01b3-423c-a173-5481df49bdaf", "holder":{ "name":"OBP", "is_alias":true }, "bank_routing":{ "scheme":"Bank_ID", "address":"gh.29.uk" }, "account_routings":[{ "scheme":"AccountNumber", "address":"4930396" }], "metadata":{ "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" } } } }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • 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-30005: View not found for Account. Please specify a valid value for VIEW_ID
  • OBP-50200: Connector cannot return the data we requested.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.0.0, function_name: by getOtherAccountByIdForBankAccount, operation_id: OBPv3.0.0-getOtherAccountByIdForBankAccount Tags: Counterparty, Account, New-Style,

通过交易对手ID(明确)获取交易对手。

映射(类型->字符串)
Typical Successful Response:

								
									
{ "name":"CounterpartyName", "description":"My landlord", "created_by_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "this_bank_id":"GENODEM1GLS", "this_account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "this_view_id":"owner", "counterparty_id":"1d65db7c-a7b2-4839-af41-958276ab7790", "other_bank_routing_scheme":"bankCode", "other_bank_routing_address":"10", "other_branch_routing_scheme":"branchNumber", "other_branch_routing_address":"10010", "other_account_routing_scheme":"accountNumber", "other_account_routing_address":"7987987-2348987-234234", "other_account_secondary_routing_scheme":"accountId", "other_account_secondary_routing_address":"8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0", "is_beneficiary":true, "bespoke":[{ "key":"englishName", "value":"english Name" }], "metadata":{ "public_alias":"String", "more_info":"String", "url":"String", "image_url":"String", "open_corporates_url":"String", "corporate_location":{ "latitude":11.45, "longitude":11.45, "date":"2017-09-18T22:00:00Z", "user":{ "id":"123", "provider":"http://127.0.0.1:8080", "username":"felixsmith" } }, "physical_location":{ "latitude":11.45, "longitude":11.45, "date":"2017-09-18T22:00:00Z", "user":{ "id":"123", "provider":"http://127.0.0.1:8080", "username":"felixsmith" } }, "private_alias":"String" } }
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-50000: Unknown Error.
Connector Methods:
Version: OBPv2.2.0, function_name: by getExplictCounterpartyById, operation_id: OBPv2.2.0-getExplictCounterpartyById Tags: Counterparty, Payment Initiation Service (PIS), Counterparty-Metadata,

创建其他帐户专用别名

为其他帐户OTHER_ACCOUNT_ID创建一个专用别名。

身份验证是可选的
如果视图不是公共的,则需要认证。

Typical Successful Response:

								
									
{ "success":"Success" }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • 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.
Connector Methods:
Version: OBPv1.2.1, function_name: by addOtherAccountPrivateAlias, operation_id: OBPv1.2.1-addOtherAccountPrivateAlias Tags: Counterparty-Metadata, Counterparty,

删除交易对手私人别名

删除其他帐户OTHER_ACCOUNT_ID的私人别名。

身份验证是可选的
如果视图不是公共的,则需要认证。

Typical Successful Response:

								
									
{ "jsonString":"{}" }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • 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.
Connector Methods:
Version: OBPv1.2.1, function_name: by deleteCounterpartyPrivateAlias, operation_id: OBPv1.2.1-deleteCounterpartyPrivateAlias Tags: Counterparty-Metadata, Counterparty,

删除其他银行帐户的更多信息。

Typical Successful Response:

								
									
{ "jsonString":"{}" }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • 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.
Connector Methods:
Version: OBPv1.2.1, function_name: by deleteCounterpartyMoreInfo, operation_id: OBPv1.2.1-deleteCounterpartyMoreInfo Tags: Counterparty-Metadata, Counterparty,

删除其他银行帐户的网址。

Typical Successful Response:

								
									
{ "jsonString":"{}" }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • 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.
Connector Methods:
Version: OBPv1.2.1, function_name: by deleteCounterpartyUrl, operation_id: OBPv1.2.1-deleteCounterpartyUrl Tags: Counterparty-Metadata, Counterparty,

删除对方公共别名

删除另一个帐户OTHER_ACCOUNT_ID的公共别名。

身份验证是可选的
如果视图不是公共的,则需要认证。

Typical Successful Response:

								
									
{ "jsonString":"{}" }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • 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.
Connector Methods:
Version: OBPv1.2.1, function_name: by deleteCounterpartyPublicAlias, operation_id: OBPv1.2.1-deleteCounterpartyPublicAlias Tags: Counterparty-Metadata, Counterparty,

删除对方公司位置。

删除其他银行帐户的公司位置。删除交易对手注册地址的地理位置

Typical Successful Response:

								
									
{ "jsonString":"{}" }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • 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.
Connector Methods:
Version: OBPv1.2.1, function_name: by deleteCounterpartyCorporateLocation, operation_id: OBPv1.2.1-deleteCounterpartyCorporateLocation Tags: Counterparty-Metadata, Counterparty,

删除对方图片网址

删除其他银行帐户的图片网址。

Typical Successful Response:

								
									
{ "jsonString":"{}" }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv1.2.1, function_name: by deleteCounterpartyImageUrl, operation_id: OBPv1.2.1-deleteCounterpartyImageUrl Tags: Counterparty-Metadata, Counterparty,

删除对方开放公司网址

删除其他银行帐户的打开的公司网址。

Typical Successful Response:

								
									
{ "jsonString":"{}" }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • 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.
Connector Methods:
Version: OBPv1.2.1, function_name: by deleteCounterpartyOpenCorporatesUrl, operation_id: OBPv1.2.1-deleteCounterpartyOpenCorporatesUrl Tags: Counterparty-Metadata, Counterparty,

删除对方的物理位置。

删除其他银行帐户的实际位置。

Typical Successful Response:

								
									
{ "jsonString":"{}" }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • 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.
Connector Methods:
Version: OBPv1.2.1, function_name: by deleteCounterpartyPhysicalLocation, operation_id: OBPv1.2.1-deleteCounterpartyPhysicalLocation Tags: Counterparty-Metadata, Counterparty,

将公共别名添加到其他银行帐户。

为其他帐户OTHER_ACCOUNT_ID创建公用别名。

身份验证是可选的
如果视图不是公共的,则需要认证。

注意:将为新的“其他帐户/交易对手”自动生成公共别名,因此仅在以下情况下使用此调用:
公共别名已删除。

VIEW_ID参数应该是允许调用者访问的视图,并且有权创建公共别名。

Typical Successful Response:

								
									
{ "success":"Success" }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • 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
Connector Methods:
Version: OBPv1.2.1, function_name: by addCounterpartyPublicAlias, operation_id: OBPv1.2.1-addCounterpartyPublicAlias Tags: Counterparty-Metadata, Counterparty,

将公司位置添加到交易对手

添加交易对手注册地址的地理位置

Typical Successful Response:

								
									
{ "success":"Success" }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • 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.
Connector Methods:
Version: OBPv1.2.1, function_name: by addCounterpartyCorporateLocation, operation_id: OBPv1.2.1-addCounterpartyCorporateLocation Tags: Counterparty-Metadata, Counterparty,

将图片网址添加到其他银行帐户。

添加指向交易对手徽标的网址

Typical Successful Response:

								
									
{ "success":"Success" }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • 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.
Connector Methods:
Version: OBPv1.2.1, function_name: by addCounterpartyImageUrl, operation_id: OBPv1.2.1-addCounterpartyImageUrl Tags: Counterparty-Metadata, Counterparty,

将实际位置添加到其他银行帐户。

添加交易对手主要位置的地理坐标

Typical Successful Response:

								
									
{ "success":"Success" }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • 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.
Connector Methods:
Version: OBPv1.2.1, function_name: by addCounterpartyPhysicalLocation, operation_id: OBPv1.2.1-addCounterpartyPhysicalLocation Tags: Counterparty-Metadata, Counterparty,

将开放公司网址添加到交易对手

将打开的公司网址添加到其他银行帐户。

Typical Successful Response:

								
									
{ "success":"Success" }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • 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.
Connector Methods:
Version: OBPv1.2.1, function_name: by addCounterpartyOpenCorporatesUrl, operation_id: OBPv1.2.1-addCounterpartyOpenCorporatesUrl Tags: Counterparty-Metadata, Counterparty,

将网址添加到其他银行帐户。

代表交易对手的网址(首页网址等)

Typical Successful Response:

								
									
{ "success":"Success" }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • 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.
Connector Methods:
Version: OBPv1.2.1, function_name: by addCounterpartyUrl, operation_id: OBPv1.2.1-addCounterpartyUrl Tags: Counterparty-Metadata, Counterparty,

更新交易对手公司位置

更新交易对手注册地址的地理位置

Typical Successful Response:

								
									
{ "success":"Success" }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • 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.
Connector Methods:
Version: OBPv1.2.1, function_name: by updateCounterpartyCorporateLocation, operation_id: OBPv1.2.1-updateCounterpartyCorporateLocation Tags: Counterparty-Metadata, Counterparty,

更新交易对手图片网址

更新指向交易对手徽标的网址

Typical Successful Response:

								
									
{ "success":"Success" }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • 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.
Connector Methods:
Version: OBPv1.2.1, function_name: by updateCounterpartyImageUrl, operation_id: OBPv1.2.1-updateCounterpartyImageUrl Tags: Counterparty-Metadata, Counterparty,

更新交易对手更多信息

从帐户的角度(例如,我的牙医)更新对方的更多信息描述。

Typical Successful Response:

								
									
{ "success":"Success" }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • 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.
Connector Methods:
Version: OBPv1.2.1, function_name: by updateCounterpartyMoreInfo, operation_id: OBPv1.2.1-updateCounterpartyMoreInfo Tags: Counterparty-Metadata, Counterparty,

更新交易对手的公开公司网址

更新其他银行帐户的未清公司网址。

Typical Successful Response:

								
									
{ "success":"Success" }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • 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.
Connector Methods:
Version: OBPv1.2.1, function_name: by updateCounterpartyOpenCorporatesUrl, operation_id: OBPv1.2.1-updateCounterpartyOpenCorporatesUrl Tags: Counterparty-Metadata, Counterparty,

更新交易对手的实际位置

更新交易对手主要地点的地理坐标

Typical Successful Response:

								
									
{ "success":"Success" }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • 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.
Connector Methods:
Version: OBPv1.2.1, function_name: by updateCounterpartyPhysicalLocation, operation_id: OBPv1.2.1-updateCounterpartyPhysicalLocation Tags: Counterparty-Metadata, Counterparty,

更新交易对手私人别名

更新交易对手(又称其他帐户)的私有别名OTHER_ACCOUNT_ID。

身份验证是可选的
如果视图不是公共的,则需要认证。

Typical Successful Response:

								
									
{ "success":"Success" }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • 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.
Connector Methods:
Version: OBPv1.2.1, function_name: by updateCounterpartyPrivateAlias, operation_id: OBPv1.2.1-updateCounterpartyPrivateAlias Tags: Counterparty-Metadata, Counterparty,

更新其他银行帐户的公共别名。

更新其他帐户/交易对手OTHER_ACCOUNT_ID的公共别名。

身份验证是可选的
如果视图不是公共的,则需要认证。

Typical Successful Response:

								
									
{ "success":"Success" }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • 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.
Connector Methods:
Version: OBPv1.2.1, function_name: by updateCounterpartyPublicAlias, operation_id: OBPv1.2.1-updateCounterpartyPublicAlias Tags: Counterparty-Metadata, Counterparty,

更新其他银行帐户的网址。

代表交易对手的网址(首页网址等)

Typical Successful Response:

								
									
{ "success":"Success" }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • 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.
Connector Methods:
Version: OBPv1.2.1, function_name: by updateCounterpartyUrl, operation_id: OBPv1.2.1-updateCounterpartyUrl Tags: Counterparty-Metadata, Counterparty,

添加交易对手更多信息

从帐户的角度(例如,我的牙医)添加对对方的描述。

Typical Successful Response:

								
									
{ "success":"Success" }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • 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.
Connector Methods:
Version: OBPv1.2.1, function_name: by addCounterpartyMoreInfo, operation_id: OBPv1.2.1-addCounterpartyMoreInfo Tags: Counterparty-Metadata, Counterparty,

获取其他帐户专用别名

返回另一个帐户OTHER_ACCOUNT_ID的私有别名。

身份验证是可选的
如果视图不是公共的,则需要认证。

Typical Successful Response:

								
									
{ "alias":"String" }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • 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.
Connector Methods:
Version: OBPv1.2.1, function_name: by getOtherAccountPrivateAlias, operation_id: OBPv1.2.1-getOtherAccountPrivateAlias Tags: Counterparty-Metadata, Counterparty,

获取其他帐户元数据。

获取另一个帐户的元数据。
仅返回有关另一个银行帐户(OTHER_ACCOUNT_ID)的元数据,该银行帐户已与ACCOUNT_ID在BANK_ID共享了至少一笔交易。

如果视图不是公开的,则需要通过OAuth进行身份验证。

Typical Successful Response:

								
									
{ "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" } } }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
  • the view does not allow metadata access
Connector Methods:
Version: OBPv1.2.1, function_name: by getOtherAccountMetadata, operation_id: OBPv1.2.1-getOtherAccountMetadata Tags: Counterparty-Metadata, Counterparty,

获取其他银行帐户的公共别名。

返回其他帐户OTHER_ACCOUNT_ID的公共别名。
身份验证是可选的
如果视图不是公共的,则必须进行身份验证。

Typical Successful Response:

								
									
{ "alias":"String" }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • 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
Connector Methods:
Version: OBPv1.2.1, function_name: by getCounterpartyPublicAlias, operation_id: OBPv1.2.1-getCounterpartyPublicAlias Tags: Counterparty-Metadata, Counterparty,

为客户增加税收居住

向CUSTOMER_ID指定的客户添加税收住所。

身份验证是强制性的

Typical Successful Response:

								
									
{ "domain":"Enter some domain", "tax_number":"Enter some number", "tax_residence_id":"902ba3bb-dedd-45e7-9319-2fd3f2cd98a1" }
Required Roles:
  • CanCreateTaxResidence - 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-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.1.0, function_name: by createTaxResidence, operation_id: OBPv3.1.0-createTaxResidence Tags: Customer, KYC, New-Style,

创建信用额度订单请求

注意:此端点当前仅返回示例数据。

创建信用额度订单请求

Typical Successful Response:

								
									
{ "execution_time":"String", "execution_date":"String", "token":"String", "short_reference":"String" }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.1.0, function_name: by createCreditLimitRequest, operation_id: OBPv3.1.0-createCreditLimitRequest Tags: Customer, New-Style,

创建客户。

客户资源存储客户编号,法定姓名,电子邮件,电话号码,他们的出生日期,关系状态,学历,个人资料图片的网址,KYC状态等。
日期格式必须为2013-01-21T23:08:00Z

身份验证是强制性的

Typical Successful Response:

								
									
{ "bank_id":"GENODEM1GLS", "customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customer_number":"5987953", "legal_name":"Eveline Tripman", "mobile_phone_number":"+44 07972 444 876", "email":"eveline@example.com", "face_image":{ "url":"www.openbankproject", "date":"2017-09-18T22:00:00Z" }, "date_of_birth":"2017-09-18T22:00:00Z", "relationship_status":"single", "dependants":10, "dob_of_dependants":["2017-09-18T22:00:00Z"], "credit_rating":{ "rating":"OBP", "source":"OBP" }, "credit_limit":{ "currency":"EUR", "amount":"10" }, "highest_education_attained":"Master", "employment_status":"worker", "kyc_status":true, "last_ok_date":"2017-09-18T22:00:00Z", "title":"Dr.", "branch_id":"DERBY6", "name_suffix":"Sr" }
Required Roles:
  • CanCreateCustomer - Please login to request this Role
  • CanCreateCustomerAtAnyBank - 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-30006: Customer Number already exists. Please specify a different value for BANK_ID or CUSTOMER_NUMBER.
  • OBP-20005: User not found. Please specify a valid value for USER_ID.
  • OBP-30007: The User is already linked to a Customer at the bank specified by BANK_ID
  • OBP-30024: Could not create Consumer
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.1.0, function_name: by createCustomer, operation_id: OBPv3.1.0-createCustomer Tags: Customer, Person, New-Style,

将用户链接到客户

身份验证是强制性的

必须具有CanCreateUserCustomerLink或CanCreateUserCustomerLinkAtAnyBank权利。

Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Version: OBPv2.0.0, function_name: by createUserCustomerLinks, operation_id: OBPv2.0.0-createUserCustomerLinks Tags: Customer, User,

删除客户地址

删除由CUSTOMER_ADDRESS_ID指定的客户地址。

身份验证是强制性的

Typical Successful Response:

								
									
{ "jsonString":"{}" }
Required Roles:
  • CanDeleteCustomerAddress - 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.1.0, function_name: by deleteCustomerAddress, operation_id: OBPv3.1.0-deleteCustomerAddress Tags: Customer, KYC, New-Style,

删除税收居民

删除由TAX_RESIDENCE_ID指定的客户的税收居所。

身份验证是强制性的

Typical Successful Response:

								
									
{ "jsonString":"{}" }
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.1.0, function_name: by deleteTaxResidence, operation_id: OBPv3.1.0-deleteTaxResidence Tags: Customer, KYC, New-Style,

向客户添加地址

向CUSTOMER_ID指定的客户添加地址。

身份验证是强制性的

Typical Successful Response:

								
									
{ "customer_address_id":"5995d6a2-01b3-423c-a173-5481df49bdaf", "customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "line_1":"No 1 the Road", "line_2":"The Place", "line_3":"The Hill", "city":"Berlin", "county":"", "state":"Brandenburg", "postcode":"13359", "country_code":"DE", "tags":["mailing","home"], "status":"OK", "insert_date":"2017-09-18T22:00:00Z" }
Required Roles:
  • CanCreateCustomerAddress - 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-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.1.0, function_name: by createCustomerAddress, operation_id: OBPv3.1.0-createCustomerAddress Tags: Customer, New-Style,

在银行获取当前用户的客户

返回链接到当前已验证用户的银行客户列表。

身份验证是强制性的

Typical Successful Response:

								
									
{ "customers":[{ "bank_id":"GENODEM1GLS", "customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customer_number":"5987953", "legal_name":"Eveline Tripman", "mobile_phone_number":"+44 07972 444 876", "email":"eveline@example.com", "face_image":{ "url":"www.openbankproject", "date":"2017-09-18T22:00:00Z" }, "date_of_birth":"2017-09-18T22:00:00Z", "relationship_status":"single", "dependants":10, "dob_of_dependants":["2017-09-18T22:00:00Z"], "credit_rating":{ "rating":"OBP", "source":"OBP" }, "credit_limit":{ "currency":"EUR", "amount":"10" }, "highest_education_attained":"Master", "employment_status":"worker", "kyc_status":true, "last_ok_date":"2017-09-18T22:00:00Z" }] }
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-30008: User Customer Link not found by USER_ID
  • OBP-30008: User Customer Link not found by USER_ID
  • OBP-30046: Customer not found. Please specify a valid value for CUSTOMER_ID.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv2.1.0, function_name: by getCustomersForCurrentUserAtBank, operation_id: OBPv2.1.0-getCustomersForCurrentUserAtBank Tags: Customer,

按MOBILE_PHONE_NUMBER获取客户

获取由MOBILE_PHONE_NUMBER指定的客户。

通常将两个通配符与LIKE运算符结合使用:
%-百分号代表零个,一个或多个字符
_-下划线表示单个字符
例如{“ customer_phone_number”:“%381%”}列出所有包含381序列的号码

身份验证是强制性的

Typical Successful Response:

								
									
{ "bank_id":"GENODEM1GLS", "customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customer_number":"5987953", "legal_name":"Eveline Tripman", "mobile_phone_number":"+44 07972 444 876", "email":"eveline@example.com", "face_image":{ "url":"www.openbankproject", "date":"2017-09-18T22:00:00Z" }, "date_of_birth":"2017-09-18T22:00:00Z", "relationship_status":"single", "dependants":10, "dob_of_dependants":["2017-09-18T22:00:00Z"], "credit_rating":{ "rating":"OBP", "source":"OBP" }, "credit_limit":{ "currency":"EUR", "amount":"10" }, "highest_education_attained":"Master", "employment_status":"worker", "kyc_status":true, "last_ok_date":"2017-09-18T22:00:00Z", "title":"Dr.", "branch_id":"DERBY6", "name_suffix":"Sr" }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-30008: User Customer Link not found by USER_ID
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by getCustomersByCustomerPhoneNumber, operation_id: OBPv4.0.0-getCustomersByCustomerPhoneNumber Tags: Customer, KYC, New-Style,

更新客户分支

更新CUSTOMER_ID指定的客户分支。

身份验证是强制性的

Typical Successful Response:

								
									
{ "bank_id":"GENODEM1GLS", "customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customer_number":"5987953", "legal_name":"Eveline Tripman", "mobile_phone_number":"+44 07972 444 876", "email":"eveline@example.com", "face_image":{ "url":"www.openbankproject", "date":"2017-09-18T22:00:00Z" }, "date_of_birth":"2017-09-18T22:00:00Z", "relationship_status":"single", "dependants":10, "dob_of_dependants":["2017-09-18T22:00:00Z"], "credit_rating":{ "rating":"OBP", "source":"OBP" }, "credit_limit":{ "currency":"EUR", "amount":"10" }, "highest_education_attained":"Master", "employment_status":"worker", "kyc_status":true, "last_ok_date":"2017-09-18T22:00:00Z", "title":"Dr.", "branch_id":"DERBY6", "name_suffix":"Sr" }
Required Roles:
  • CanUpdateCustomerIdentity - 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-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.1.0, function_name: by updateCustomerBranch, operation_id: OBPv3.1.0-updateCustomerBranch Tags: Customer, New-Style,

更新客户地址

更新CUSTOMER_ADDRESS_ID指定的客户地址。

身份验证是强制性的

Typical Successful Response:

								
									
{ "customer_address_id":"5995d6a2-01b3-423c-a173-5481df49bdaf", "customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "line_1":"No 1 the Road", "line_2":"The Place", "line_3":"The Hill", "city":"Berlin", "county":"", "state":"Brandenburg", "postcode":"13359", "country_code":"DE", "tags":["mailing","home"], "status":"OK", "insert_date":"2017-09-18T22:00:00Z" }
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-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.1.0, function_name: by updateCustomerAddress, operation_id: OBPv3.1.0-updateCustomerAddress Tags: Customer, New-Style,

更新客户数量

更新CUSTOMER_ID指定的客户编号。

身份验证是强制性的

Typical Successful Response:

								
									
{ "bank_id":"GENODEM1GLS", "customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customer_number":"5987953", "legal_name":"Eveline Tripman", "mobile_phone_number":"+44 07972 444 876", "email":"eveline@example.com", "face_image":{ "url":"www.openbankproject", "date":"2017-09-18T22:00:00Z" }, "date_of_birth":"2017-09-18T22:00:00Z", "relationship_status":"single", "dependants":10, "dob_of_dependants":["2017-09-18T22:00:00Z"], "credit_rating":{ "rating":"OBP", "source":"OBP" }, "credit_limit":{ "currency":"EUR", "amount":"10" }, "highest_education_attained":"Master", "employment_status":"worker", "kyc_status":true, "last_ok_date":"2017-09-18T22:00:00Z", "title":"Dr.", "branch_id":"DERBY6", "name_suffix":"Sr" }
Required Roles:
  • CanUpdateCustomerNumber - 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-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.1.0, function_name: by updateCustomerNumber, operation_id: OBPv3.1.0-updateCustomerNumber Tags: Customer, New-Style,

更新客户的信用等级和来源

更新CUSTOMER_ID指定的客户的信用等级和来源。

身份验证是强制性的

Typical Successful Response:

								
									
{ "bank_id":"GENODEM1GLS", "customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customer_number":"5987953", "legal_name":"Eveline Tripman", "mobile_phone_number":"+44 07972 444 876", "email":"eveline@example.com", "face_image":{ "url":"www.openbankproject", "date":"2017-09-18T22:00:00Z" }, "date_of_birth":"2017-09-18T22:00:00Z", "relationship_status":"single", "dependants":10, "dob_of_dependants":["2017-09-18T22:00:00Z"], "credit_rating":{ "rating":"OBP", "source":"OBP" }, "credit_limit":{ "currency":"EUR", "amount":"10" }, "highest_education_attained":"Master", "employment_status":"worker", "kyc_status":true, "last_ok_date":"2017-09-18T22:00:00Z", "title":"Dr.", "branch_id":"DERBY6", "name_suffix":"Sr" }
Required Roles:
  • CanUpdateCustomerCreditRatingAndSource - 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-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.1.0, function_name: by updateCustomerCreditRatingAndSource, operation_id: OBPv3.1.0-updateCustomerCreditRatingAndSource Tags: Customer, New-Style,

更新客户的信用额度

更新CUSTOMER_ID指定的客户的信用额度。

身份验证是强制性的

Typical Successful Response:

								
									
{ "bank_id":"GENODEM1GLS", "customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customer_number":"5987953", "legal_name":"Eveline Tripman", "mobile_phone_number":"+44 07972 444 876", "email":"eveline@example.com", "face_image":{ "url":"www.openbankproject", "date":"2017-09-18T22:00:00Z" }, "date_of_birth":"2017-09-18T22:00:00Z", "relationship_status":"single", "dependants":10, "dob_of_dependants":["2017-09-18T22:00:00Z"], "credit_rating":{ "rating":"OBP", "source":"OBP" }, "credit_limit":{ "currency":"EUR", "amount":"10" }, "highest_education_attained":"Master", "employment_status":"worker", "kyc_status":true, "last_ok_date":"2017-09-18T22:00:00Z", "title":"Dr.", "branch_id":"DERBY6", "name_suffix":"Sr" }
Required Roles:
  • CanUpdateCustomerCreditLimit - 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-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.1.0, function_name: by updateCustomerCreditLimit, operation_id: OBPv3.1.0-updateCustomerCreditLimit Tags: Customer, New-Style,

更新客户的其他数据

更新CUSTOMER_ID指定的客户的其他数据。

身份验证是强制性的

Typical Successful Response:

								
									
{ "bank_id":"GENODEM1GLS", "customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customer_number":"5987953", "legal_name":"Eveline Tripman", "mobile_phone_number":"+44 07972 444 876", "email":"eveline@example.com", "face_image":{ "url":"www.openbankproject", "date":"2017-09-18T22:00:00Z" }, "date_of_birth":"2017-09-18T22:00:00Z", "relationship_status":"single", "dependants":10, "dob_of_dependants":["2017-09-18T22:00:00Z"], "credit_rating":{ "rating":"OBP", "source":"OBP" }, "credit_limit":{ "currency":"EUR", "amount":"10" }, "highest_education_attained":"Master", "employment_status":"worker", "kyc_status":true, "last_ok_date":"2017-09-18T22:00:00Z", "title":"Dr.", "branch_id":"DERBY6", "name_suffix":"Sr" }
Required Roles:
  • CanUpdateCustomerIdentity - 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-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.1.0, function_name: by updateCustomerData, operation_id: OBPv3.1.0-updateCustomerData Tags: Customer, New-Style,

更新客户的手机号码

更新CUSTOMER_ID指定的客户的手机号码。

身份验证是强制性的

Typical Successful Response:

								
									
{ "bank_id":"GENODEM1GLS", "customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customer_number":"5987953", "legal_name":"Eveline Tripman", "mobile_phone_number":"+44 07972 444 876", "email":"eveline@example.com", "face_image":{ "url":"www.openbankproject", "date":"2017-09-18T22:00:00Z" }, "date_of_birth":"2017-09-18T22:00:00Z", "relationship_status":"single", "dependants":10, "dob_of_dependants":["2017-09-18T22:00:00Z"], "credit_rating":{ "rating":"OBP", "source":"OBP" }, "credit_limit":{ "currency":"EUR", "amount":"10" }, "highest_education_attained":"Master", "employment_status":"worker", "kyc_status":true, "last_ok_date":"2017-09-18T22:00:00Z", "title":"Dr.", "branch_id":"DERBY6", "name_suffix":"Sr" }
Required Roles:
  • CanUpdateCustomerMobilePhoneNumber - 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-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.1.0, function_name: by updateCustomerMobileNumber, operation_id: OBPv3.1.0-updateCustomerMobileNumber Tags: Customer, New-Style,

更新客户的电子邮件

更新CUSTOMER_ID指定的客户的电子邮件。

身份验证是强制性的

Typical Successful Response:

								
									
{ "bank_id":"GENODEM1GLS", "customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customer_number":"5987953", "legal_name":"Eveline Tripman", "mobile_phone_number":"+44 07972 444 876", "email":"eveline@example.com", "face_image":{ "url":"www.openbankproject", "date":"2017-09-18T22:00:00Z" }, "date_of_birth":"2017-09-18T22:00:00Z", "relationship_status":"single", "dependants":10, "dob_of_dependants":["2017-09-18T22:00:00Z"], "credit_rating":{ "rating":"OBP", "source":"OBP" }, "credit_limit":{ "currency":"EUR", "amount":"10" }, "highest_education_attained":"Master", "employment_status":"worker", "kyc_status":true, "last_ok_date":"2017-09-18T22:00:00Z", "title":"Dr.", "branch_id":"DERBY6", "name_suffix":"Sr" }
Required Roles:
  • CanUpdateCustomerEmail - 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-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.1.0, function_name: by updateCustomerEmail, operation_id: OBPv3.1.0-updateCustomerEmail Tags: Customer, New-Style,

更新客户的身份数据

更新CUSTOMER_ID指定的客户的身份数据。

身份验证是强制性的

Typical Successful Response:

								
									
{ "bank_id":"GENODEM1GLS", "customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customer_number":"5987953", "legal_name":"Eveline Tripman", "mobile_phone_number":"+44 07972 444 876", "email":"eveline@example.com", "face_image":{ "url":"www.openbankproject", "date":"2017-09-18T22:00:00Z" }, "date_of_birth":"2017-09-18T22:00:00Z", "relationship_status":"single", "dependants":10, "dob_of_dependants":["2017-09-18T22:00:00Z"], "credit_rating":{ "rating":"OBP", "source":"OBP" }, "credit_limit":{ "currency":"EUR", "amount":"10" }, "highest_education_attained":"Master", "employment_status":"worker", "kyc_status":true, "last_ok_date":"2017-09-18T22:00:00Z", "title":"Dr.", "branch_id":"DERBY6", "name_suffix":"Sr" }
Required Roles:
  • CanUpdateCustomerIdentity - 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-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.1.0, function_name: by updateCustomerIdentity, operation_id: OBPv3.1.0-updateCustomerIdentity Tags: Customer, New-Style,

添加社交媒体句柄

为CUSTOMER_ID指定的客户添加社交媒体句柄。

Typical Successful Response:

								
									
{ "success":"Success" }
Required Roles:
  • CanAddSocialMediaHandle - 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-10001: Incorrect json format.
  • OBP-30111: Invalid Bank Id. The BANK_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.
  • OBP-20006: User is missing one or more roles:
  • OBP-30046: Customer not found. Please specify a valid value for CUSTOMER_ID.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv2.0.0, function_name: by addSocialMediaHandle, operation_id: OBPv2.0.0-addSocialMediaHandle Tags: Customer,

获取CRM活动

Typical Successful Response:

								
									
{ "crm_events":[{ "id":"5995d6a2-01b3-423c-a173-5481df49bdaf", "bank_id":"GENODEM1GLS", "customer_name":"String", "customer_number":"5987953", "category":"String", "detail":"String", "channel":"String", "scheduled_date":"2017-09-18T22:00:00Z", "actual_date":"2017-09-18T22:00:00Z", "result":"String" }] }
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 CRM Events available.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv1.4.0, function_name: by getCrmEvents, operation_id: OBPv1.4.0-getCrmEvents Tags: Customer,

获取Firehose客户

获得具有流水线视图的客户。

允许批量访问客户。
用户必须具有CanUseFirehoseAtAnyBank角色

用于分页的可能的自定义URL参数:

  • sort_direction = ASC / DESC
  • 限制= NUM​​BER ==>默认值:50
  • 偏移量= NUM​​BER ==>默认值:0
  • from_date = DATE =>默认值:创建最早的客户的日期(格式如下)
  • to_date = DATE =>默认值:创建的最新客户的日期(格式如下)

日期格式参数 :yyyy-MM-dd'T'HH:mm:ss.SSS'Z'(2017-09-19T02:31:05.000Z)==>时区为UTC。

身份验证是强制性的

Typical Successful Response:

								
									
{ "customers":[{ "bank_id":"GENODEM1GLS", "customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customer_number":"5987953", "legal_name":"Eveline Tripman", "mobile_phone_number":"+44 07972 444 876", "email":"eveline@example.com", "face_image":{ "url":"www.openbankproject", "date":"2017-09-18T22:00:00Z" }, "date_of_birth":"2017-09-18T22:00:00Z", "relationship_status":"single", "dependants":10, "dob_of_dependants":["2017-09-18T22:00:00Z"], "credit_rating":{ "rating":"OBP", "source":"OBP" }, "credit_limit":{ "currency":"EUR", "amount":"10" }, "highest_education_attained":"Master", "employment_status":"worker", "kyc_status":true, "last_ok_date":"2017-09-18T22:00:00Z" }] }
Required Roles:
  • CanUseFirehoseAtAnyBank - 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-00009: Account firehose is not allowed on this instance. Please set allow_account_firehose = true in props files.
  • OBP-00012: Customer firehose is not allowed on this instance. Please set allow_customer_firehose = true in props files.
  • OBP-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.1.0, function_name: by getFirehoseCustomers, operation_id: OBPv3.1.0-getFirehoseCustomers Tags: Customer, FirehoseData, New-Style,

获取信用额度订单请求

注意:此端点当前仅返回示例数据。

获取信用额度订单请求

Typical Successful Response:

								
									
{ "rank_amount_1":"String", "nominal_interest_1":"String", "rank_amount_2":"String", "nominal_interest_2":"String" }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.1.0, function_name: by getCreditLimitRequests, operation_id: OBPv3.1.0-getCreditLimitRequests Tags: Customer,

获取客户地址

获取由CUSTOMER_ID指定的客户地址。

身份验证是强制性的

Typical Successful Response:

								
									
{ "addresses":[{ "customer_address_id":"5995d6a2-01b3-423c-a173-5481df49bdaf", "customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "line_1":"No 1 the Road", "line_2":"The Place", "line_3":"The Hill", "city":"Berlin", "county":"", "state":"Brandenburg", "postcode":"13359", "country_code":"DE", "tags":["mailing","home"], "status":"OK", "insert_date":"2017-09-18T22:00:00Z" }] }
Required Roles:
  • CanGetCustomerAddress - 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.1.0, function_name: by getCustomerAddresses, operation_id: OBPv3.1.0-getCustomerAddresses Tags: Customer, KYC, New-Style,

获取客户的税收住所

获取由CUSTOMER_ID指定的客户的税收住所。

身份验证是强制性的

Typical Successful Response:

								
									
{ "tax_residence":[{ "domain":"Enter some domain", "tax_number":"Enter some number", "tax_residence_id":"902ba3bb-dedd-45e7-9319-2fd3f2cd98a1" }] }
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.1.0, function_name: by getTaxResidence, operation_id: OBPv3.1.0-getTaxResidence Tags: Customer, KYC, New-Style,

获取客户社交媒体句柄

获取由CUSTOMER_ID指定的客户的社交媒体句柄。

身份验证是强制性的

Typical Successful Response:

								
									
{ "checks":[{ "customer_number":"5987953", "type":"PlaceholderString", "handle":"PlaceholderString", "date_added":"2017-09-18T22:00:00Z", "date_activated":"2017-09-18T22:00:00Z" }] }
Required Roles:
  • CanGetSocialMediaHandles - 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-30046: Customer not found. Please specify a valid value for CUSTOMER_ID.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv2.0.0, function_name: by getSocialMediaHandles, operation_id: OBPv2.0.0-getSocialMediaHandles Tags: Customer,

获取当前用户的客户

获取链接到用户的所有客户。

身份验证是强制性的

Typical Successful Response:

								
									
{ "customers":[{ "bank_id":"GENODEM1GLS", "customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customer_number":"5987953", "legal_name":"Eveline Tripman", "mobile_phone_number":"+44 07972 444 876", "email":"eveline@example.com", "face_image":{ "url":"www.openbankproject", "date":"2017-09-18T22:00:00Z" }, "date_of_birth":"19900101", "relationship_status":"single", "dependants":10, "dob_of_dependants":["19900101"], "credit_rating":{ "rating":"OBP", "source":"OBP" }, "credit_limit":{ "currency":"EUR", "amount":"10" }, "highest_education_attained":"Master", "employment_status":"worker", "kyc_status":true, "last_ok_date":"2017-09-18T22:00:00Z", "title":"Dr.", "branch_id":"DERBY6", "name_suffix":"Sr" }] }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-30008: User Customer Link not found by USER_ID
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.0.0, function_name: by getCustomersForUser, operation_id: OBPv3.0.0-getCustomersForUser Tags: Customer, User, New-Style,

通过CUSTOMER_ID获取客户

获取由CUSTOMER_ID指定的客户。

身份验证是强制性的

Typical Successful Response:

								
									
{ "bank_id":"GENODEM1GLS", "customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customer_number":"5987953", "legal_name":"Eveline Tripman", "mobile_phone_number":"+44 07972 444 876", "email":"eveline@example.com", "face_image":{ "url":"www.openbankproject", "date":"2017-09-18T22:00:00Z" }, "date_of_birth":"2017-09-18T22:00:00Z", "relationship_status":"single", "dependants":10, "dob_of_dependants":["2017-09-18T22:00:00Z"], "credit_rating":{ "rating":"OBP", "source":"OBP" }, "credit_limit":{ "currency":"EUR", "amount":"10" }, "highest_education_attained":"Master", "employment_status":"worker", "kyc_status":true, "last_ok_date":"2017-09-18T22:00:00Z", "title":"Dr.", "branch_id":"DERBY6", "name_suffix":"Sr" }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-30008: User Customer Link not found by USER_ID
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.1.0, function_name: by getCustomerByCustomerId, operation_id: OBPv3.1.0-getCustomerByCustomerId Tags: Customer, New-Style,

通过CUSTOMER_NUMBER获取客户

获取由CUSTOMER_NUMBER指定的客户。

身份验证是强制性的

Typical Successful Response:

								
									
{ "bank_id":"GENODEM1GLS", "customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customer_number":"5987953", "legal_name":"Eveline Tripman", "mobile_phone_number":"+44 07972 444 876", "email":"eveline@example.com", "face_image":{ "url":"www.openbankproject", "date":"2017-09-18T22:00:00Z" }, "date_of_birth":"2017-09-18T22:00:00Z", "relationship_status":"single", "dependants":10, "dob_of_dependants":["2017-09-18T22:00:00Z"], "credit_rating":{ "rating":"OBP", "source":"OBP" }, "credit_limit":{ "currency":"EUR", "amount":"10" }, "highest_education_attained":"Master", "employment_status":"worker", "kyc_status":true, "last_ok_date":"2017-09-18T22:00:00Z", "title":"Dr.", "branch_id":"DERBY6", "name_suffix":"Sr" }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-30008: User Customer Link not found by USER_ID
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.1.0, function_name: by getCustomerByCustomerNumber, operation_id: OBPv3.1.0-getCustomerByCustomerNumber Tags: Customer, KYC, New-Style,

通过请求ID获取信用额度订单请求

注意:此端点当前仅返回示例数据。

  Get Credit Limit Order Request By Request Id 
Typical Successful Response:

								
									
{ "rank_amount_1":"String", "nominal_interest_1":"String", "rank_amount_2":"String", "nominal_interest_2":"String" }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.1.0, function_name: by getCreditLimitRequestByRequestId, operation_id: OBPv3.1.0-getCreditLimitRequestByRequestId Tags: Customer, New-Style,

创建会议(视频会议/通话)

创建会议:与银行发起视频会议/通话。

会议资源包含有关视频/其他会议会话的元数据

provider_id确定会议/视频聊天服务的提供者。必须是网址友好的(没有空格)。

Purpose_id解释了聊天的目的。入职|抵押|投诉等。必须是网址友好的(不能有空格)。

需要登录。

此调用是实验性的 。当前尚未设置staff_user_id。需要进一步调用才能正确设置此设置。

Typical Successful Response:

								
									
{ "meeting_id":"UUID-String", "provider_id":"Chris", "purpose_id":"String, eg: onboarding", "bank_id":"GENODEM1GLS", "present":{ "staff_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "customer_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1" }, "keys":{ "session_id":"String", "staff_token":"String", "customer_token":"String" }, "when":"2017-09-18T22:00:00Z", "creator":{ "name":"Simon ", "mobile_phone":"+44 07972 444 876", "email_address":"eveline@example.com" }, "invitees":[{ "contact_details":{ "name":"Simon ", "mobile_phone":"+44 07972 444 876", "email_address":"eveline@example.com" }, "status":"String, eg: Good" }] }
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-50000: Unknown Error.
Connector Methods:
Version: OBPv3.1.0, function_name: by createMeeting, operation_id: OBPv3.1.0-createMeeting Tags: Customer-Meeting, KYC, Customer, User, Experimental,

开会

获取由BANK_ID / MEETING_ID指定的会议
会议包含有关视频会议/聊天等的元数据,并用于促进会议。

实际的会议/聊天由外部服务处理。

需要登录。

此调用是实验性的 ,将来需要进一步的授权。

Typical Successful Response:

								
									
{ "meeting_id":"UUID-String", "provider_id":"Chris", "purpose_id":"String, eg: onboarding", "bank_id":"GENODEM1GLS", "present":{ "staff_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "customer_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1" }, "keys":{ "session_id":"String", "staff_token":"String", "customer_token":"String" }, "when":"2017-09-18T22:00:00Z", "creator":{ "name":"Simon ", "mobile_phone":"+44 07972 444 876", "email_address":"eveline@example.com" }, "invitees":[{ "contact_details":{ "name":"Simon ", "mobile_phone":"+44 07972 444 876", "email_address":"eveline@example.com" }, "status":"String, eg: Good" }] }
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-30104: Meeting not found.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.1.0, function_name: by getMeeting, operation_id: OBPv3.1.0-getMeeting Tags: Customer-Meeting, KYC, Customer, User, Experimental,

开会

会议包含有关视频会议/聊天等的元数据,并用于促进会议。

实际的会议/聊天由外部服务处理。

需要登录。

此调用是实验性的 ,将来需要进一步的授权。

Typical Successful Response:

								
									
{ "meetings":[{ "meeting_id":"UUID-String", "provider_id":"Chris", "purpose_id":"String, eg: onboarding", "bank_id":"GENODEM1GLS", "present":{ "staff_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "customer_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1" }, "keys":{ "session_id":"String", "staff_token":"String", "customer_token":"String" }, "when":"2017-09-18T22:00:00Z", "creator":{ "name":"Simon ", "mobile_phone":"+44 07972 444 876", "email_address":"eveline@example.com" }, "invitees":[{ "contact_details":{ "name":"Simon ", "mobile_phone":"+44 07972 444 876", "email_address":"eveline@example.com" }, "status":"String, eg: Good" }] }] }
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-50000: Unknown Error.
Connector Methods:
Version: OBPv3.1.0, function_name: by getMeetings, operation_id: OBPv3.1.0-getMeetings Tags: Customer-Meeting, KYC, Customer, User, Experimental,

创建客户留言。

为CUSTOMER_ID指定的客户创建一条消息

Typical Successful Response:

								
									
{ "success":"Success" }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv1.4.0, function_name: by createCustomerMessage, operation_id: OBPv1.4.0-createCustomerMessage Tags: Customer-Message, Customer, Person,

获取客户消息(当前)

获取已登录客户的消息
发送给当前已验证用户的消息。

需要通过OAuth进行身份验证。

Typical Successful Response:

								
									
{ "messages":[{ "id":"5995d6a2-01b3-423c-a173-5481df49bdaf", "date":"2017-09-18T22:00:00Z", "message":"String", "from_department":"String", "from_person":"String" }] }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv1.4.0, function_name: by getCustomerMessages, operation_id: OBPv1.4.0-getCustomerMessages Tags: Customer-Message, Customer,

数据仓库搜索

搜索数据仓库并获取行级结果。

身份验证是强制性的

必须具有CanSearchWarehouse权利。您可以在下面请求角色。

弹性(搜索)用于后台。请参阅下面的链接以获取语法。

用法示例:

POST /搜索/仓库/ THE_INDEX_YOU_WANT_TO_USE

POST /搜索/仓库/ INDEX1,INDEX2

POST /搜索/仓库/全部

{体内任何有效的Elasticsearch查询DSL}

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,

数据仓库统计

搜索数据仓库并获得仓库字段的统计汇总

在某些数字字段上进行统计汇总:

https://www.elastic.co/guide/zh-CN/elasticsearch/reference/current/search-aggregations-metrics-stats-aggregation.html

身份验证是强制性的

CanSearchWarehouseStats角色是必需的。您可以在下面提出要求。

弹性(搜索)用于后台。请参阅下面的链接以获取语法。

用法示例:

邮政/搜索/仓库/统计/索引/字段

POST /搜索/仓库/统计/全部/字段

{体内任何有效的Elasticsearch查询DSL}

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,

创建直接借记

为帐户创建直接借记。

身份验证是强制性的

Typical Successful Response:

								
									
{ "direct_debit_id":"aa0533bd-eb22-4bff-af75-d45240361b05", "bank_id":"GENODEM1GLS", "account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "counterparty_id":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh", "date_signed":"2019-12-02T09:27:34Z", "date_starts":"2019-12-02T09:27:34Z", "date_expires":"2019-12-02T09:27:34Z", "date_cancelled":"2019-12-02T09:27:34Z", "active":true }
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-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:
  • OBP-10001: Incorrect json format.
  • OBP-30046: Customer not found. Please specify a valid value for CUSTOMER_ID.
  • OBP-20057: User not found by userId.
  • OBP-30017: Counterparty not found. Please specify a valid value for COUNTERPARTY_ID.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by createDirectDebit, operation_id: OBPv4.0.0-createDirectDebit Tags: Direct-Debit, Account, New-Style,

创建直接借记(管理)

为帐户创建直接借记。

身份验证是强制性的

Typical Successful Response:

								
									
{ "direct_debit_id":"aa0533bd-eb22-4bff-af75-d45240361b05", "bank_id":"GENODEM1GLS", "account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "counterparty_id":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh", "date_signed":"2019-12-02T09:27:34Z", "date_starts":"2019-12-02T09:27:34Z", "date_expires":"2019-12-02T09:27:34Z", "date_cancelled":"2019-12-02T09:27:34Z", "active":true }
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-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:
  • OBP-10001: Incorrect json format.
  • OBP-30046: Customer not found. Please specify a valid value for CUSTOMER_ID.
  • OBP-20057: User not found by userId.
  • OBP-30017: Counterparty not found. Please specify a valid value for COUNTERPARTY_ID.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by createDirectDebitManagement, operation_id: OBPv4.0.0-createDirectDebitManagement Tags: Direct-Debit, Account, New-Style,

测试资源文档

我只是一个测试资源文档

这应该是H1

这应该是H2

这应该是H3

这应该是H4

这是包含两个项目的列表:

他们自己有下划线_

单词周围有下划线

有下划线_in_words

有“ underscores_in_words_inside_quotes”

有(underscores_in_words_in_brackets)

...

Typical Successful Response:

								
									
{ "jsonString":"{}" }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv1.4.0, function_name: by testResourceDoc, operation_id: OBPv1.4.0-testResourceDoc Tags: Documentation,

获取API词汇表

Map(类型->对象,属性-> Map(html->地图(类型->字符串),降价->地图(类型->字符串)))
Typical Successful Response:

								
									
{ "glossary_items":[{ "title":"Dr.", "description":{ "markdown":"String", "html":"String" } }] }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.0.0, function_name: by glossary, operation_id: OBPv3.0.0-glossary Tags: Documentation,

获取Swagger文档

以Swagger格式返回有关此服务器上RESTful资源的文档。

API_VERSION是您想要有关例如v3.0.0的文档的版本

您可以使用'tags'网址参数过滤此端点,例如?tags = Account,Bank

(给所有端点一个或多个用于分组的标签)

您可以使用'functions'url参数过滤此端点,例如?functions = getBanks,bankById

(每个端点通过“功能”在OBP Scala代码中实现)

您可以使用“目录” URL参数过滤此端点,例如?core =&psd2 = true&obwg =

有关更多信息,请参见Resource Doc端点。

以下是更多示例:
http:// localhost:8080 / obp / v3.1.0 / resource-docs / v3.1.0 / swagger
http:// localhost:8080 / obp / v3.1.0 / resource-docs / v3.1.0 / swagger?psd2 = true
http:// localhost:8080 / obp / v3.1.0 / resource-docs / v3.1.0 / swagger?tags = Account,Bank
http:// localhost:8080 / obp / v3.1.0 / resource-docs / v3.1.0 / swagger?functions = getBanks,bankById
http:// localhost:8080 / obp / v3.1.0 / resource-docs / v3.1.0 / swagger?psd2 = true&tags = Account,Bank&functions = getBanks,bankById

Typical Successful Response:

								
									
{ "jsonString":"{}" }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv1.4.0, function_name: by getResourceDocsSwagger, operation_id: OBPv1.4.0-getResourceDocsSwagger Tags: Documentation, API,

获取消息文档

映射(类型->字符串)
Typical Successful Response:

								
									
{ "message_docs":[{ "process":"getAccounts", "message_format":"KafkaV2017", "outbound_topic":"to.obp.api.1.caseclass.OutboundGetAccounts", "inbound_topic":"from.obp.api.1.to.adapter.mf.caseclass.OutboundGetAccounts", "description":"get Banks", "example_outbound_message":{ "jsonString":"{}" }, "example_inbound_message":{ "jsonString":"{}" }, "outboundAvroSchema":{ "jsonString":"{}" }, "inboundAvroSchema":{ "jsonString":"{}" }, "adapter_implementation":{ "group":"CORE", "suggested_order":3 } }] }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv2.2.0, function_name: by getMessageDocs, operation_id: OBPv2.2.0-getMessageDocs Tags: Documentation, API,

获取消息文档招摇

映射(类型->字符串)
Typical Successful Response:

								
									
{ "message_docs":[{ "process":"getAccounts", "message_format":"KafkaV2017", "outbound_topic":"to.obp.api.1.caseclass.OutboundGetAccounts", "inbound_topic":"from.obp.api.1.to.adapter.mf.caseclass.OutboundGetAccounts", "description":"get Banks", "example_outbound_message":{ "jsonString":"{}" }, "example_inbound_message":{ "jsonString":"{}" }, "outboundAvroSchema":{ "jsonString":"{}" }, "inboundAvroSchema":{ "jsonString":"{}" }, "adapter_implementation":{ "group":"CORE", "suggested_order":3 } }] }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.1.0, function_name: by getMessageDocsSwagger, operation_id: OBPv3.1.0-getMessageDocsSwagger Tags: Documentation, API,

获取资源文档。

获取有关此服务器上RESTful资源的文档,包括POST和PUT请求的示例正文。

这是用于记录OBP端点的本机数据格式。每个端点都有一个在源代码中定义的Resource Doc(Scala案例类)。

OBP API资源管理器使用此端点来显示和使用API​​文档。

大多数(但不是全部)字段也都可以使用摇摇欲坠的格式。 (Swagger终结点是从“资源文档”构建的。)

API_VERSION是您想要有关例如v3.0.0的文档的版本

您可以使用标签参数过滤此端点,例如?tags = Account,Bank

您可以使用功能参数过滤此端点,例如?functions = enableDisableConsumers,getConnectorMetrics

有关可能的函数值,请参见此终结点返回的JSON中的Implemented_by.function或OBP源代码或API Explorer的页脚,它们会产生逗号分隔的函数列表,这些函数列表反映了服务器或API Explorer基于标记等进行过滤。

您可以使用“目录” URL参数过滤此端点,例如?core =&psd2 = true&obwg =

有关更多信息,请参见Resource Doc端点。

以下是更多示例:
http:// localhost:8080 / obp / v3.1.0 / resource-docs / v3.1.0 / obp
http:// localhost:8080 / obp / v3.1.0 / resource-docs / v3.1.0 / obp?psd2 = true
http:// localhost:8080 / obp / v3.1.0 / resource-docs / v3.1.0 / obp?tags = Account,Bank
http:// localhost:8080 / obp / v3.1.0 / resource-docs / v3.1.0 / obp?functions = getBanks,bankById
http:// localhost:8080 / obp / v3.1.0 / resource-docs / v3.1.0 / obp?psd2 = true&tags = Account,Bank&functions = getBanks,bankById

  • operation_id是“ v”,版本和功能的串联,并且应该是唯一的(用于DOM元素ID等,可能用于链接到源代码)
  • 版本引用定义了API调用的版本。
  • function是实现此端点的(标量)部分函数。每个API版本都是唯一的。
  • 对于根调用,request_url为空,否则为路径。它包含标准前缀(例如/ obp)和实现的版本(定义此端点的版本),例如/obp/v1.2.0/resource
  • 对于根调用,指定路径(建议使用)为空,否则为路径。它包含标准前缀(例如/ obp)和调用中指定的版本,例如/obp/v3.1.0/resource。在OBP中,首先在request_url上使端点可用,但是在更高版本(specified_url)下通常使相同的资源(函数调用)可用。要访问所有端点的最新版本,请使用OBP实例上可用的最新版本,例如/obp/v3.1.0-要获取原始版本,请使用request_url。我们建议使用指定的URL,因为非语义上的改进很可能会应用于以后的调用实现中。
  • 摘要是与草率术语一致的简短描述。
  • 说明可能包含html标记(从服务器上的markdown生成)。
Typical Successful Response:

								
									
{ "jsonString":"{}" }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv1.4.0, function_name: by getResourceDocsObp, operation_id: OBPv1.4.0-getResourceDocsObp Tags: Documentation, API,

创建动态实体

创建一个DynamicEntity。

身份验证是强制性的

创建一个DynamicEntity,创建成功后,将自动生成相应的CRUD端点

当前的支持文件类型如下:
[字符串,数字,整数,布尔值]

Typical Successful Response:

								
									
{ "FooBar":{ "required":["name"], "properties":{ "name":{ "type":"string", "example":"James Brown" }, "number":{ "type":"integer", "example":698761728 } } }, "dynamicEntityId":"dynamic-entity-id" }
Required Roles:
  • CanCreateDynamicEntity - 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-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by createDynamicEntity, operation_id: OBPv4.0.0-createDynamicEntity Tags: Dynamic-Entity, API, New-Style,

删除动态实体

删除由DYNAMIC_ENTITY_ID指定的DynamicEntity。

身份验证是强制性的

Typical Successful Response:

								
									
{ "jsonString":"{}" }
Required Roles:
  • CanDeleteDynamicEntity - 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: OBPv4.0.0, function_name: by deleteDynamicEntity, operation_id: OBPv4.0.0-deleteDynamicEntity Tags: Dynamic-Entity, API, New-Style,

更新DynamicEntity

更新DynamicEntity。

身份验证是强制性的

更新一个DynamicEntity,更新完成后,将更改相应的CRUD端点。

当前的支持文件类型如下:
[字符串,数字,整数,布尔值]

Typical Successful Response:

								
									
{ "FooBar":{ "required":["name"], "properties":{ "name":{ "type":"string", "example":"James Brown" }, "number":{ "type":"integer", "example":698761728 } } }, "dynamicEntityId":"dynamic-entity-id" }
Required Roles:
  • CanUpdateDynamicEntity - 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-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by updateDynamicEntity, operation_id: OBPv4.0.0-updateDynamicEntity Tags: Dynamic-Entity, API, New-Style,

获取动态实体

获取所有DynamicEntities。

Typical Successful Response:

								
									
{ "dynamic_entities":[{ "FooBar":{ "required":["name"], "properties":{ "name":{ "type":"string", "example":"James Brown" }, "number":{ "type":"integer", "example":698761728 } } }, "dynamicEntityId":"dynamic-entity-id" }] }
Required Roles:
  • CanGetDynamicEntities - 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: OBPv4.0.0, function_name: by getDynamicEntities, operation_id: OBPv4.0.0-getDynamicEntities Tags: Dynamic-Entity, API, New-Style,

创建效果图

为银行创建或更新Fx。

例:

“ from_currency_code”:“ EUR”,
“ to_currency_code”:“ USD”,
“ conversion_value”:1.136305,
“ inverse_conversion_value”:1 / 1.136305 = 0.8800454103431737,

因此1欧元= 1.136305美元

1美元= 0.8800欧元

身份验证是强制性的

Typical Successful Response:

								
									
{ "bank_id":"GENODEM1GLS", "from_currency_code":"EUR", "to_currency_code":"USD", "conversion_value":1.136305, "inverse_conversion_value":0.8800454103431737, "effective_date":"2017-09-18T22:00:00Z" }
Required Roles:
  • CanCreateFxRate - Please login to request this Role
  • CanCreateFxRateAtAnyBank - 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-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv2.2.0, function_name: by createFx, operation_id: OBPv2.2.0-createFx Tags: FX,

获取当前的FxRate

获取由BANK_ID,FROM_CURRENCY_CODE和TO_CURRENCY_CODE指定的最新汇率

OBP可能会根据运行中的连接器尝试不同的FX汇率信息源。

例如,我们要转换EUR => USD:

OBP将:
第一次尝试-连接器(数据库,核心银行系统或外部FX服务)
第2部分-第1部分-fallbackexchangerates / eur.json
第2次尝试第2部分-fallbackexchangerates / usd.json(使用反速率)
第三次尝试-外汇汇率的硬编码地图。

外汇流量

Typical Successful Response:

								
									
{ "bank_id":"GENODEM1GLS", "from_currency_code":"EUR", "to_currency_code":"GBP", "conversion_value":1.001, "inverse_conversion_value":0.998, "effective_date":"2017-09-18T22:00:00Z" }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-10003: Invalid Currency Value. It should be three letters ISO Currency Code.
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-10004: ISO Currency code combination not supported for FX. Please modify the FROM_CURRENCY_CODE or TO_CURRENCY_CODE.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv2.2.0, function_name: by getCurrentFxRate, operation_id: OBPv2.2.0-getCurrentFxRate Tags: FX, New-Style,

为客户获取KYC Media

获取确认客户身份的KYC媒体(扫描,图片,视频)。

身份验证是强制性的

Typical Successful Response:

								
									
{ "medias":[{ "bank_id":"GENODEM1GLS", "customer_id":"PlaceholderString", "id":"PlaceholderString", "customer_number":"5987953", "type":"PlaceholderString", "url":"PlaceholderString", "date":"2017-09-18T22:00:00Z", "relates_to_kyc_document_id":"PlaceholderString", "relates_to_kyc_check_id":"PlaceholderString" }] }
Required Roles:
  • CanGetAnyKycMedia - 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-30046: Customer not found. Please specify a valid value for CUSTOMER_ID.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv2.0.0, function_name: by getKycMedia, operation_id: OBPv2.0.0-getKycMedia Tags: KYC, Customer,

添加KYC Media。

为CUSTOMER_ID指定的客户添加一些KYC媒体。 KYC媒体资源与KYC文档和KYC检查有关,并包含用于扫描护照,公用事业账单等的媒体URL。

Typical Successful Response:

								
									
{ "bank_id":"GENODEM1GLS", "customer_id":"PlaceholderString", "id":"PlaceholderString", "customer_number":"5987953", "type":"PlaceholderString", "url":"PlaceholderString", "date":"2017-09-18T22:00:00Z", "relates_to_kyc_document_id":"PlaceholderString", "relates_to_kyc_check_id":"PlaceholderString" }
Required Roles:
  • CanAddKycMedia - 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-10001: Incorrect json format.
  • OBP-30046: Customer not found. Please specify a valid value for CUSTOMER_ID.
  • OBP-00004: Server error: could not add message
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv2.0.0, function_name: by addKycMedia, operation_id: OBPv2.0.0-addKycMedia Tags: KYC, Customer,

添加KYC文档。

为CUSTOMER_ID指定的客户添加一个KYC文档。 KYC文件包含文件类型(例如护照),签发地点,有效期等。

Typical Successful Response:

								
									
{ "bank_id":"GENODEM1GLS", "customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "id":"PlaceholderString", "customer_number":"5987953", "type":"PlaceholderString", "number":"PlaceholderString", "issue_date":"2017-09-18T22:00:00Z", "issue_place":"PlaceholderString", "expiry_date":"2017-09-18T22:00:00Z" }
Required Roles:
  • CanAddKycDocument - 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-10001: Incorrect json format.
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-30046: Customer not found. Please specify a valid value for CUSTOMER_ID.
  • Server error: could not add KycDocument
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv2.0.0, function_name: by addKycDocument, operation_id: OBPv2.0.0-addKycDocument Tags: KYC, Customer,

添加KYC检查

为CUSTOMER_ID指定的客户添加KYC支票。 KYC Checks存储KYC团队对客户进行的检查的详细信息,他们的评论和满意的状态。

Typical Successful Response:

								
									
{ "bank_id":"GENODEM1GLS", "customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "id":"PlaceholderString", "customer_number":"5987953", "date":"2017-09-18T22:00:00Z", "how":"PlaceholderString", "staff_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "staff_name":"PlaceholderString", "satisfied":true, "comments":"PlaceholderString" }
Required Roles:
  • CanAddKycCheck - 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-10001: Incorrect json format.
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-30046: Customer not found. Please specify a valid value for CUSTOMER_ID.
  • OBP-00004: Server error: could not add message
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv2.0.0, function_name: by addKycCheck, operation_id: OBPv2.0.0-addKycCheck Tags: KYC, Customer,

添加KYC状态

为CUSTOMER_ID指定的客户添加一个kyc_status。 KYC状态是客户的KYC状态的时间表

Typical Successful Response:

								
									
{ "customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customer_number":"5987953", "ok":true, "date":"2017-09-18T22:00:00Z" }
Required Roles:
  • CanAddKycStatus - 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-10001: Incorrect json format.
  • OBP-30111: Invalid Bank Id. The BANK_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.
  • OBP-50000: Unknown Error.
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-00004: Server error: could not add message
  • OBP-30046: Customer not found. Please specify a valid value for CUSTOMER_ID.
Connector Methods:
Version: OBPv2.0.0, function_name: by addKycStatus, operation_id: OBPv2.0.0-addKycStatus Tags: KYC, Customer,

获取客户KYC文件

获取CUSTOMER_ID指定的客户的KYC(了解您的客户)文档
获取确认客户身份的文件清单
护照,驾驶执照等
身份验证是可选的

Typical Successful Response:

								
									
{ "documents":[{ "bank_id":"GENODEM1GLS", "customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "id":"PlaceholderString", "customer_number":"5987953", "type":"PlaceholderString", "number":"PlaceholderString", "issue_date":"2017-09-18T22:00:00Z", "issue_place":"PlaceholderString", "expiry_date":"2017-09-18T22:00:00Z" }] }
Required Roles:
  • CanGetAnyKycDocuments - 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-30046: Customer not found. Please specify a valid value for CUSTOMER_ID.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv2.0.0, function_name: by getKycDocuments, operation_id: OBPv2.0.0-getKycDocuments Tags: KYC, Customer,

获取客户KYC检查

获取由CUSTOMER_ID指定的客户的KYC检查。

身份验证是强制性的

Typical Successful Response:

								
									
{ "checks":[{ "bank_id":"GENODEM1GLS", "customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "id":"PlaceholderString", "customer_number":"5987953", "date":"2017-09-18T22:00:00Z", "how":"PlaceholderString", "staff_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "staff_name":"PlaceholderString", "satisfied":true, "comments":"PlaceholderString" }] }
Required Roles:
  • CanGetAnyKycChecks - 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-30046: Customer not found. Please specify a valid value for CUSTOMER_ID.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv2.0.0, function_name: by getKycChecks, operation_id: OBPv2.0.0-getKycChecks Tags: KYC, Customer,

获取客户KYC状态

随时间获取由CUSTOMER_ID指定的客户的KYC状态。

身份验证是强制性的

Typical Successful Response:

								
									
{ "statuses":[{ "customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customer_number":"5987953", "ok":true, "date":"2017-09-18T22:00:00Z" }] }
Required Roles:
  • CanGetAnyKycStatuses - 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-30046: Customer not found. Please specify a valid value for CUSTOMER_ID.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv2.0.0, function_name: by getKycStatuses, operation_id: OBPv2.0.0-getKycStatuses Tags: KYC, Customer,

删除方法

删除METHOD_ROUTING_ID指定的MethodRouting。

身份验证是强制性的

Typical Successful Response:

								
									
{ "jsonString":"{}" }
Required Roles:
  • CanDeleteMethodRouting - 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.1.0, function_name: by deleteMethodRouting, operation_id: OBPv3.1.0-deleteMethodRouting Tags: Method-Routing, API, New-Style,

更新方法

更新MethodRouting。

身份验证是强制性的

领域解释:

  • method_name是必需的字符串值
  • connector_name是必需的字符串值
  • is_bank_id_exact_match是必需的布尔值,如果bank_id_pattern是确切的bank_id值,则此值为true;否则,此值为true。如果bank_id_pattern为null或正则表达式,则该值为false
  • bank_id_pattern是可选的字符串值,可以为null,确切的bank_id或正则表达式
  • 参数是键值对的可选数组。您可以为此方法设置一些参数
    注意:
  • 如果bank_id_pattern是正则表达式,则需要对特殊字符进行转义,例如:bank_id_pattern =“ some-id_pattern_ \ d +”

Typical Successful Response:

								
									
{ "is_bank_id_exact_match":true, "method_name":"getBank", "connector_name":"rest_vMar2019", "method_routing_id":"this-method-routing-Id", "bank_id_pattern":"some_bankId", "parameters":[{ "key":"url", "value":"http://mydomain.com/xxx" }] }
Required Roles:
  • CanUpdateMethodRouting - 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-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.1.0, function_name: by updateMethodRouting, operation_id: OBPv3.1.0-updateMethodRouting Tags: Method-Routing, API, New-Style,

添加方法

添加一个MethodRouting。

身份验证是强制性的

领域解释:

  • method_name是必需的字符串值
  • connector_name是必需的字符串值
  • is_bank_id_exact_match是必需的布尔值,如果bank_id_pattern是确切的bank_id值,则此值为true;否则,此值为true。如果bank_id_pattern为null或正则表达式,则该值为false
  • bank_id_pattern是可选的字符串值,可以为null,确切的bank_id或正则表达式
  • 参数是键值对的可选数组。您可以为此方法设置一些参数

注意:

  • 如果bank_id_pattern是正则表达式,则需要对特殊字符进行转义,例如:bank_id_pattern =“ some-id_pattern_ \ d +”
Typical Successful Response:

								
									
{ "is_bank_id_exact_match":false, "method_name":"getBank", "connector_name":"rest_vMar2019", "method_routing_id":"this-method-routing-Id", "bank_id_pattern":"some_bankId_.*", "parameters":[{ "key":"url", "value":"http://mydomain.com/xxx" }] }
Required Roles:
  • CanCreateMethodRouting - 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-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.1.0, function_name: by createMethodRouting, operation_id: OBPv3.1.0-createMethodRouting Tags: Method-Routing, API, New-Style,

获取MethodRoutings

获取所有MethodRoutings。

查询网址参数:

  • method_name:使用method_name进行过滤
  • active:如果active = true,它将显示所有webui_道具。即使已设置,我们也会重新运行所有默认的webui_ props

例如:
http:// localhost:8080 / obp / v3.1.0 / management / method_routings?active = true
http:// localhost:8080 / obp / v3.1.0 / management / method_routings?method_name = getBank

Typical Successful Response:

								
									
{ "method_routings":[{ "is_bank_id_exact_match":false, "method_name":"getBanks", "connector_name":"rest_vMar2019", "method_routing_id":"method-routing-id", "bank_id_pattern":"some_bank_.*", "parameters":[{ "key":"url", "value":"http://mydomain.com/xxx" }] }] }
Required Roles:
  • CanGetMethodRoutings - 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.1.0, function_name: by getMethodRoutings, operation_id: OBPv3.1.0-getMethodRoutings Tags: Method-Routing, API, New-Style,

获取指标

Typical Successful Response:

								
									
{ "metrics":[{ "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "url":"www.openbankproject.com", "date":"2017-09-18T22:00:00Z", "user_name":"OBP", "app_name":"SOFI", "developer_email":"eveline@example.com", "implemented_by_partial_function":"getBanks", "implemented_in_version":"v210", "consumer_id":"123", "verb":"get", "correlation_id":"v8ho6h5ivel3uq7a5zcnv0w1", "duration":39 }] }
Required Roles:
  • CanReadMetrics - 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: OBPv2.1.0, function_name: by getMetrics, operation_id: OBPv2.1.0-getMetrics Tags: Metric, API,

获取汇总指标

返回有关api使用情况的汇总指标。总计数,响应时间(以毫秒为单位)等。

应该能够过滤以下字段

例如:/ management / aggregate-metrics?from_date = 2017-09-19T02:31:05.000Z&to_date = 2017-09-19T02:31:05.000Z&consumer_id = 5
&user_id = 66214b8e-259e-44ad-8868-3eb47be70646&implemented_by_partial_function = getTransactionsForBankAccount
&implemented_in_version = v3.0.0&url = / obp / v3.0.0 / banks / gh.29.uk / accounts / 8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0 / owner / transactions
&verb = GET&anon = false&app_name = MapperPostman
&exclude_app_names = API-EXPLORER,API-Manager,SOFI,空

1个from_date(默认为当前日期的前一天):例如:from_date = 2017-09-19T02:31:05.000Z

2 to_date(默认为当前日期),例如:to_date = 2017-09-19T02:31:05.000Z

3 Consumer_id(如果为null,则忽略)

4 user_id(如果为null,则忽略)

5 anon(如果忽略null)仅支持两个值:true(返回user_id为null的位置)或false(返回user_id不为null的位置。)

6 url(如果为null,则忽略),注意:不能包含'&'。

7 app_name(如果为null,则忽略)

8 Implemented_by_partial_function(如果为null,则忽略),

9 Implemented_in_version(如果为null则忽略)

10个动词(如果为null,则忽略)

11correlation_id(如果为null,则忽略)

12个持续时间(如果忽略null)非数字字符将被忽略

13 exclude_app_names(如果为null则忽略)。例如:&exclude_app_names = API-EXPLORER,API-Manager,SOFI,null

14 exclude_url_patterns(如果为null,则忽略)。您可以设计自己的SQL NOT LIKE模式。例如:&exclude_url_patterns =%management / metrics%,%management / aggregate-metrics%

15 exclude_implemented_by_partial_functions(如果为null则忽略)。例如:&exclude_implemented_by_partial_functions = getMetrics,getConnectorMetrics,getAggregateMetrics

身份验证是强制性的

Typical Successful Response:

								
									
{ "count":7076, "average_response_time":65.21, "minimum_response_time":1.0, "maximum_response_time":9039.0 }
Required Roles:
  • CanReadAggregateMetrics - 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 getAggregateMetrics, operation_id: OBPv3.0.0-getAggregateMetrics Tags: Metric, Aggregate-Metrics, New-Style,

获取连接器指标

获取所有指标

需要CanGetConnectorMetrics角色

过滤第1部分。将参数过滤 (没有通配符等)到GET / management / connector / metrics

应该能够根据以下指标字段进行过滤

例如:/ management / connector / metrics?from_date = 2017-09-19&to_date = 2017-09-19&limit = 50&offset = 2

1个from_date(默认为当前日期之前的一周):例如:from_date = 2017-09-19

2 to_date(默认为当前日期),例如:to_date = 2017-09-19

3个限制(用于分页:默认为1000),例如:limit = 2000

4个偏移量(对于分页:零索引,默认为0),例如:offset = 10

例如:/ management / connector / metrics?from_date = 2017-09-19&to_date = 2017-09-19&limit = 100&offset = 300

其他过滤器:

5 connector_name(如果为null,则忽略)

6 function_name(如果为null,则忽略)

7correlation_id(如果为null,则忽略)

Typical Successful Response:

								
									
{ "metrics":[{ "connector_name":"mapper", "function_name":"getBanks", "correlation_id":"12345", "date":"2017-09-18T22:00:00Z", "duration":1000 }] }
Required Roles:
  • CanGetConnectorMetrics - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-10005: Invalid Date Format. Could not convert value to a Date.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv2.2.0, function_name: by getConnectorMetrics, operation_id: OBPv2.2.0-getConnectorMetrics Tags: Metric, API,

获取顶级API

获取有关最受欢迎的API的指标。例如:总计数,响应时间(以毫秒为单位)等。

应该能够过滤以下字段

例如:/management/metrics/top-apis?from_date=2017-09-19T02:31:05.000Z&to_date=2017-09-19T02:31:05.000Z&consumer_id=5
&user_id = 66214b8e-259e-44ad-8868-3eb47be70646&implemented_by_partial_function = getTransactionsForBankAccount
&implemented_in_version = v3.0.0&url = / obp / v3.0.0 / banks / gh.29.uk / accounts / 8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0 / owner / transactions
&verb = GET&anon = false&app_name = MapperPostman
&exclude_app_names = API-EXPLORER,API-Manager,SOFI,空

1个from_date(默认为当前日期的前一天):例如:from_date = 2017-09-19T02:31:05.000Z

2 to_date(默认为当前日期),例如:to_date = 2017-09-19T02:31:05.000Z

3 Consumer_id(如果为null,则忽略)

4 user_id(如果为null,则忽略)

5 anon(如果忽略null)仅支持两个值:true(返回user_id为null的位置)或false(返回user_id不为null的位置。)

6 url(如果为null,则忽略),注意:不能包含'&'。

7 app_name(如果为null,则忽略)

8 Implemented_by_partial_function(如果为null,则忽略),

9 Implemented_in_version(如果为null则忽略)

10个动词(如果为null,则忽略)

11correlation_id(如果为null,则忽略)

12个持续时间(如果忽略null)非数字字符将被忽略

13 exclude_app_names(如果为null则忽略)。例如:&exclude_app_names = API-EXPLORER,API-Manager,SOFI,null

14 exclude_url_patterns(如果为null,则忽略)。您可以设计自己的SQL NOT LIKE模式。例如:&exclude_url_patterns =%management / metrics%,%management / aggregate-metrics%

15 exclude_implemented_by_partial_functions(如果为null则忽略)。例如:&exclude_implemented_by_partial_functions = getMetrics,getConnectorMetrics,getAggregateMetrics

身份验证是强制性的

Typical Successful Response:

								
									
{ "top_apis":[{ "count":7076, "Implemented_by_partial_function":"getBanks", "implemented_in_version":"v1.2.1" }] }
Required Roles:
  • CanReadMetrics - 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-10016: Incorrect filter Parameters in URL.
  • OBP-30042: Could not get the top apis from database.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.1.0, function_name: by getTopAPIs, operation_id: OBPv3.1.0-getTopAPIs Tags: Metric, New-Style,

获得顶级消费者

获取有关API使用量最大消费方的指标,例如总数,消费者ID和app_name。

应该能够过滤以下字段

例如:/management/metrics/top-consumers?from_date=2017-09-19T02:31:05.000Z&to_date=2017-05-22T01:02:03.000Z&consumer_id=5
&user_id = 66214b8e-259e-44ad-8868-3eb47be70646&implemented_by_partial_function = getTransactionsForBankAccount
&implemented_in_version = v3.0.0&url = / obp / v3.0.0 / banks / gh.29.uk / accounts / 8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0 / owner / transactions
&verb = GET&anon = false&app_name = MapperPostman
&exclude_app_names = API-EXPLORER,API-Manager,SOFI,空
&limit = 100

1个from_date(默认为当前日期的前一天):例如:from_date = 2017-09-19T02:31:05.000Z

2 to_date(默认为当前日期),例如:to_date = 2017-09-19T02:31:05.000Z

3 Consumer_id(如果为null,则忽略)

4 user_id(如果为null,则忽略)

5 anon(如果忽略null)仅支持两个值:true(返回user_id为null的位置)或false(返回user_id不为null的位置。)

6 url(如果为null,则忽略),注意:不能包含'&'。

7 app_name(如果为null,则忽略)

8 Implemented_by_partial_function(如果为null,则忽略),

9 Implemented_in_version(如果为null则忽略)

10个动词(如果为null,则忽略)

11correlation_id(如果为null,则忽略)

12个持续时间(如果忽略null)非数字字符将被忽略

13 exclude_app_names(如果为null则忽略)。例如:&exclude_app_names = API-EXPLORER,API-Manager,SOFI,null

14 exclude_url_patterns(如果为null,则忽略)。您可以设计自己的SQL NOT LIKE模式。例如:&exclude_url_patterns =%management / metrics%,%management / aggregate-metrics%

15 exclude_implemented_by_partial_functions(如果为null则忽略)。例如:&exclude_implemented_by_partial_functions = getMetrics,getConnectorMetrics,getAggregateMetrics

16个限制(用于分页:默认为50),例如:limit = 200

身份验证是强制性的

Typical Successful Response:

								
									
{ "top_consumers":[{ "count":7076, "consumer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "app_name":"Api Explorer", "developer_email":"eveline@example.com" }] }
Required Roles:
  • CanReadMetrics - 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-10016: Incorrect filter Parameters in URL.
  • OBP-30045: Could not get the top consumers from database.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.1.0, function_name: by getMetricsTopConsumers, operation_id: OBPv3.1.0-getMetricsTopConsumers Tags: Metric, New-Style,

通过Elasticsearch搜索API指标。

通过Elastic Search搜索对此API实例进行的API调用。

需要登录。

需要CanSearchMetrics授权才能搜索指标数据。

参数:

esType-elasticsearch类型

简单查询:

q-plain_text_query

df-搜索的默认字段

sort-要排序的字段

大小-返回的匹配数,默认为10

from-显示热门歌曲,起始于

json查询:

来源-JSON_query_(网址转义)

用法示例:

/ search / metrics / q = findThis

要么:

/ search / metrics / source = {“ query”:{“ query_string”:{“ query”:“ findThis”}}}

注意!!

整个JSON查询字符串必须使用URL编码:

  • 对于{使用%7B
  • 对于},请使用%7D
  • 对于:使用%3A
  • 对于“使用%22

等等..

仅q,source和esType传递给Elastic

弹性简单查询: https : //www.elastic.co/guide/en/elasticsearch/reference/current/search-uri-request.html

弹性JSON查询: https : //www.elastic.co/guide/zh-CN/elasticsearch/reference/current/query-filter-context.html

Typical Successful Response:

								
									
{ "jsonString":"{}" }
Required Roles:
  • CanSearchMetrics - 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: OBPv2.0.0, function_name: by elasticSearchMetrics, operation_id: OBPv2.0.0-elasticSearchMetrics Tags: Metric, API,

创建产品

映射(类型->字符串)
Typical Successful Response:

								
									
{ "bank_id":"GENODEM1GLS", "code":"product_code", "parent_product_code":"parent", "name":"product name", "category":"category", "family":"family", "super_family":"super family", "more_info_url":"www.example.com/prod1/more-info.html", "details":"Details", "description":"Description", "meta":{ "license":{ "id":"5", "name":"TESOBE" } }, "product_attributes":[{ "product_code":"saving1", "product_attribute_id":"613c83ea-80f9-4560-8404-b9cd4ec42a7f", "name":"OVERDRAFT_START_DATE", "type":"DATE_WITH_DAY", "value":"2012-04-23" }] }
Required Roles:
  • CanCreateProduct - Please login to request this Role
  • CanCreateProductAtAnyBank - 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-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.1.0, function_name: by createProduct, operation_id: OBPv3.1.0-createProduct Tags: Product,

创建产品属性

创建产品属性

产品属性用于描述带有类型化键值对列表的金融产品。

每个产品属性均通过PRODUCT_CODE链接到其产品

典型的产品属性可能是:

ISIN(用于国际债券)
VKN(用于德国债券)
REDCODE(信用衍生产品的Markit短代码)
LOAN_ID(例如用于Anacredit报告)

发行日期(债券在市场上发行时)
MATURITY_DATE(产品寿命终止)
可交易的

有关更多示例,请参见FPML

类型字段必须是“ STRING”,“ INTEGER”,“ DOUBLE”或DATE_WITH_DAY”之一

身份验证是强制性的

Typical Successful Response:

								
									
{ "product_code":"saving1", "product_attribute_id":"613c83ea-80f9-4560-8404-b9cd4ec42a7f", "name":"OVERDRAFT_START_DATE", "type":"DATE_WITH_DAY", "value":"2012-04-23" }
Required Roles:
  • CanCreateProductAttribute - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.1.0, function_name: by createProductAttribute, operation_id: OBPv3.1.0-createProductAttribute Tags: Product, New-Style,

删除产品属性

删除产品属性

产品属性用于描述带有类型化键值对列表的金融产品。

每个产品属性均通过PRODUCT_CODE链接到其产品

按ID删除产品属性。

身份验证是强制性的

Typical Successful Response:

								
									
{ "jsonString":"{}" }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.1.0, function_name: by deleteProductAttribute, operation_id: OBPv3.1.0-deleteProductAttribute Tags: Product, New-Style,

更新产品属性

更新产品属性。

产品属性用于描述带有类型化键值对列表的金融产品。

每个产品属性均通过PRODUCT_CODE链接到其产品

通过其ID更新一个产品属性。

身份验证是强制性的

Typical Successful Response:

								
									
{ "product_code":"saving1", "product_attribute_id":"613c83ea-80f9-4560-8404-b9cd4ec42a7f", "name":"OVERDRAFT_START_DATE", "type":"DATE_WITH_DAY", "value":"2012-04-23" }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.1.0, function_name: by updateProductAttribute, operation_id: OBPv3.1.0-updateProductAttribute Tags: Product, New-Style,

获取产品

映射(类型->字符串)
Typical Successful Response:

								
									
{ "products":[{ "bank_id":"GENODEM1GLS", "code":"product_code", "parent_product_code":"parent", "name":"product name", "category":"category", "family":"family", "super_family":"super family", "more_info_url":"www.example.com/prod1/more-info.html", "details":"Details", "description":"Description", "meta":{ "license":{ "id":"5", "name":"TESOBE" } }, "product_attributes":[{ "product_code":"saving1", "product_attribute_id":"613c83ea-80f9-4560-8404-b9cd4ec42a7f", "name":"OVERDRAFT_START_DATE", "type":"DATE_WITH_DAY", "value":"2012-04-23" }] }] }
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-30011: Product not found. Please specify a valid value for PRODUCT_CODE.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.1.0, function_name: by getProducts, operation_id: OBPv3.1.0-getProducts Tags: Product,

获取产品属性

获取产品属性

产品属性用于描述带有类型化键值对列表的金融产品。

每个产品属性均通过PRODUCT_CODE链接到其产品

通过其ID获得一个产品属性。

身份验证是强制性的

Typical Successful Response:

								
									
{ "product_code":"saving1", "product_attribute_id":"613c83ea-80f9-4560-8404-b9cd4ec42a7f", "name":"OVERDRAFT_START_DATE", "type":"DATE_WITH_DAY", "value":"2012-04-23" }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.1.0, function_name: by getProductAttribute, operation_id: OBPv3.1.0-getProductAttribute Tags: Product, New-Style,

获取产品树

映射(类型->字符串)
Typical Successful Response:

								
									
{ "bank_id":"testBank2", "code":"PRODUCT_CODE", "name":"product name", "category":"category", "family":"family", "super_family":"super family", "more_info_url":"www.example.com/prod1/more-info.html", "details":"Details", "description":"Description", "meta":{ "license":{ "id":"5", "name":"TESOBE" } }, "parent_product":{ "bank_id":"testBank2", "code":"PARENT_CODE", "name":"product name", "category":"category", "family":"family", "super_family":"super family", "more_info_url":"www.example.com/prod1/more-info.html", "details":"Details", "description":"Description", "meta":{ "license":{ "id":"5", "name":"TESOBE" } }, "parent_product":{ "bank_id":"testBank2", "code":"GRANDPARENT_CODE", "name":"product name", "category":"category", "family":"family", "super_family":"super family", "more_info_url":"www.example.com/prod1/more-info.html", "details":"Details", "description":"Description", "meta":{ "license":{ "id":"5", "name":"TESOBE" } } } } }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-30011: Product not found. Please specify a valid value for PRODUCT_CODE.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.1.0, function_name: by getProductTree, operation_id: OBPv3.1.0-getProductTree Tags: Product,

获取银行产品

映射(类型->字符串)
Typical Successful Response:

								
									
{ "bank_id":"GENODEM1GLS", "code":"product_code", "parent_product_code":"parent", "name":"product name", "category":"category", "family":"family", "super_family":"super family", "more_info_url":"www.example.com/prod1/more-info.html", "details":"Details", "description":"Description", "meta":{ "license":{ "id":"5", "name":"TESOBE" } }, "product_attributes":[{ "product_code":"saving1", "product_attribute_id":"613c83ea-80f9-4560-8404-b9cd4ec42a7f", "name":"OVERDRAFT_START_DATE", "type":"DATE_WITH_DAY", "value":"2012-04-23" }] }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-30011: Product not found. Please specify a valid value for PRODUCT_CODE.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.1.0, function_name: by getProduct, operation_id: OBPv3.1.0-getProduct Tags: Product,

创建产品集

在银行创建或更新产品集合。

使用产品集合来创建产品“购物篮”,“组合”,“指数”,“集合”,“基础清单”,“桶”等。

产品与产品系列之间存在多对多关系:

  • 一个产品可以存在于许多集合中

  • 一个集合可以包含许多产品。

集合具有集合代码,一个父产品和一个或多个子产品。

产品组vs产品系列:

  • 您可以使用Product中的parent_product_code定义产品的层次结构-以便子Product继承其父Product的属性。

  • 您可以使用“产品集合”定义产品的集合(也称为篮子或桶)。

身份验证是强制性的

Typical Successful Response:

								
									
{ "product_collection":[{ "collection_code":"C", "product_code":"D", "items":[{ "member_product_code":"A" },{ "member_product_code":"B" }] }] }
Required Roles:
  • CanMaintainProductCollection - 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-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.1.0, function_name: by createProductCollection, operation_id: OBPv3.1.0-createProductCollection Tags: Product-Collection, Product,

获取产品集合

映射(类型->字符串)
Typical Successful Response:

								
									
{ "collection_code":"A", "products":[{ "bank_id":"GENODEM1GLS", "code":"product_code", "parent_product_code":"parent", "name":"product name", "category":"category", "family":"family", "super_family":"super family", "more_info_url":"www.example.com/prod1/more-info.html", "details":"Details", "description":"Description", "meta":{ "license":{ "id":"5", "name":"TESOBE" } }, "product_attributes":[{ "product_code":"saving1", "product_attribute_id":"613c83ea-80f9-4560-8404-b9cd4ec42a7f", "name":"OVERDRAFT_START_DATE", "type":"DATE_WITH_DAY", "value":"2012-04-23" }] }] }
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-50000: Unknown Error.
Connector Methods:
Version: OBPv3.1.0, function_name: by getProductCollection, operation_id: OBPv3.1.0-getProductCollection Tags: Product-Collection, Product,

为用户添加权利。

创建权利。向用户授予角色。

权利用于向用户授予系统或银行级别的角色。 (有关帐户级别的权限,请参见视图)

对于系统级角色(例如CanGetAnyUser),将bank_id设置为空字符串,即“ bank_id”:“”

对于银行级别的角色(例如CanCreateAccount),将bank_id设置为有效值,例如“ bank_id”:“ my-bank-id”

必须进行身份验证,并且用户必须是超级管理员。超级管理员列在“道具”文件中。

Typical Successful Response:

								
									
{ "entitlement_id":"6fb17583-1e49-4435-bb74-a14fe0996723", "role_name":"CanQueryOtherUser", "bank_id":"GENODEM1GLS" }
Required Roles:
  • CanCreateEntitlementAtOneBank - Please login to request this Role
  • CanCreateEntitlementAtAnyBank - 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-20005: User not found. Please specify a valid value for USER_ID.
  • OBP-10001: Incorrect json format.
  • OBP-10007: Incorrect Role name:
  • OBP-30205: This entitlement is a Bank Role. Please set bank_id to a valid bank id.
  • OBP-30206: This entitlement is a System Role. Please set bank_id to empty string.
  • OBP-30216: Entitlement already exists for the user.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv2.0.0, function_name: by addEntitlement, operation_id: OBPv2.0.0-addEntitlement Tags: Role, Entitlement, User,

删除权利

为USER_ID指定的用户删除ENTITLEMENT_ID指定的权利

必须进行身份验证,并且用户必须是超级管理员。
超级管理员列在“道具”文件中。

Typical Successful Response:

								
									
{ "jsonString":"{}" }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20050: Current User is not a Super Admin!
  • OBP-30212: EntitlementId not found
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv2.0.0, function_name: by deleteEntitlement, operation_id: OBPv2.0.0-deleteEntitlement Tags: Role, User, Entitlement,

删除权利请求

删除由ENTITLEMENT_REQUEST_ID指定的针对USER_ID指定的用户的权利请求

身份验证是强制性的

Typical Successful Response:

								
									
{ "jsonString":"{}" }
Required Roles:
  • CanDeleteEntitlementRequestsAtAnyBank - 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-20050: Current User is not a Super Admin!
  • OBP-50200: Connector cannot return the data we requested.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.0.0, function_name: by deleteEntitlementRequest, operation_id: OBPv3.0.0-deleteEntitlementRequest Tags: Role, Entitlement, User, New-Style,

添加当前用户的权利请求。

创建权利请求。

任何登录的用户都可以使用此终结点来请求权利

权利用于向用户授予系统或银行级别的角色。 (有关帐户级别的权限,请参见视图)

对于系统级角色(例如CanGetAnyUser),将bank_id设置为空字符串,即“ bank_id”:“”

对于银行级别的角色(例如CanCreateAccount),将bank_id设置为有效值,例如“ bank_id”:“ my-bank-id”

身份验证是强制性的

Typical Successful Response:

								
									
{ "entitlement_request_id":"6fb17583-1e49-4435-bb74-a14fe0996723", "user":{ "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "email":"eveline@example.com", "provider_id":"Chris", "provider":"http://127.0.0.1:8080", "username":"felixsmith", "entitlements":{ "list":[{ "entitlement_id":"6fb17583-1e49-4435-bb74-a14fe0996723", "role_name":"CanQueryOtherUser", "bank_id":"GENODEM1GLS" }] } }, "role_name":"CanQueryOtherUser", "bank_id":"GENODEM1GLS", "created":"2017-09-18T22:00:00Z" }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20005: User not found. Please specify a valid value for USER_ID.
  • OBP-10001: Incorrect json format.
  • OBP-10007: Incorrect Role name:
  • OBP-30205: This entitlement is a Bank Role. Please set bank_id to a valid bank id.
  • OBP-30206: This entitlement is a System Role. Please set bank_id to empty string.
  • OBP-30214: Entitlement Request already exists for the user.
  • OBP-30217: Entitlement Request cannot be added.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.0.0, function_name: by addEntitlementRequest, operation_id: OBPv3.0.0-addEntitlementRequest Tags: Role, Entitlement, User, New-Style,

获取一家银行的权益

身份验证是强制性的

Typical Successful Response:

								
									
{ "list":[{ "entitlement_id":"6fb17583-1e49-4435-bb74-a14fe0996723", "role_name":"CanQueryOtherUser", "bank_id":"GENODEM1GLS" }] }
Required Roles:
  • CanGetEntitlementsForOneBank - Please login to request this Role
  • CanGetEntitlementsForAnyBank - 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: OBPv4.0.0, function_name: by getEntitlementsForBank, operation_id: OBPv4.0.0-getEntitlementsForBank Tags: Role, Entitlement, User, New-Style,

获取当前用户的权利。

获取当前用户的权利。

身份验证是强制性的

Typical Successful Response:

								
									
{ "list":[{ "entitlement_id":"6fb17583-1e49-4435-bb74-a14fe0996723", "role_name":"CanQueryOtherUser", "bank_id":"GENODEM1GLS" }] }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20050: Current User is not a Super Admin!
  • OBP-50200: Connector cannot return the data we requested.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.0.0, function_name: by getEntitlementsForCurrentUser, operation_id: OBPv3.0.0-getEntitlementsForCurrentUser Tags: Role, Entitlement, User, New-Style,

获取当前用户的权利请求。

获取当前用户的权利请求。

身份验证是强制性的

Typical Successful Response:

								
									
{ "entitlement_requests":[{ "entitlement_request_id":"6fb17583-1e49-4435-bb74-a14fe0996723", "user":{ "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "email":"eveline@example.com", "provider_id":"Chris", "provider":"http://127.0.0.1:8080", "username":"felixsmith", "entitlements":{ "list":[{ "entitlement_id":"6fb17583-1e49-4435-bb74-a14fe0996723", "role_name":"CanQueryOtherUser", "bank_id":"GENODEM1GLS" }] } }, "role_name":"CanQueryOtherUser", "bank_id":"GENODEM1GLS", "created":"2017-09-18T22:00:00Z" }] }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20050: Current User is not a Super Admin!
  • OBP-50200: Connector cannot return the data we requested.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.0.0, function_name: by getEntitlementRequestsForCurrentUser, operation_id: OBPv3.0.0-getEntitlementRequestsForCurrentUser Tags: Role, Entitlement, User, New-Style,

获取所有权利

需要登录。

角色字段上可能的过滤器:

例如:/ entitlements?role = CanGetCustomer

Typical Successful Response:

								
									
{ "list":[{ "entitlement_id":"6fb17583-1e49-4435-bb74-a14fe0996723", "role_name":"CanQueryOtherUser", "bank_id":"GENODEM1GLS" }] }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20050: Current User is not a Super Admin!
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.1.0, function_name: by getAllEntitlements, operation_id: OBPv3.1.0-getAllEntitlements Tags: Role, Entitlement, New-Style,

获取所有权利请求

获取所有权利请求

身份验证是强制性的

Typical Successful Response:

								
									
{ "entitlement_requests":[{ "entitlement_request_id":"6fb17583-1e49-4435-bb74-a14fe0996723", "user":{ "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "email":"eveline@example.com", "provider_id":"Chris", "provider":"http://127.0.0.1:8080", "username":"felixsmith", "entitlements":{ "list":[{ "entitlement_id":"6fb17583-1e49-4435-bb74-a14fe0996723", "role_name":"CanQueryOtherUser", "bank_id":"GENODEM1GLS" }] } }, "role_name":"CanQueryOtherUser", "bank_id":"GENODEM1GLS", "created":"2017-09-18T22:00:00Z" }] }
Required Roles:
  • CanGetEntitlementRequestsAtAnyBank - 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-20050: Current User is not a Super Admin!
  • OBP-50200: Connector cannot return the data we requested.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.0.0, function_name: by getAllEntitlementRequests, operation_id: OBPv3.0.0-getAllEntitlementRequests Tags: Role, Entitlement, User, New-Style,

获取用户权利

身份验证是强制性的

Typical Successful Response:

								
									
{ "list":[{ "entitlement_id":"6fb17583-1e49-4435-bb74-a14fe0996723", "role_name":"CanQueryOtherUser", "bank_id":"GENODEM1GLS" }] }
Required Roles:
  • CanGetEntitlementsForAnyUserAtAnyBank - 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: OBPv4.0.0, function_name: by getEntitlements, operation_id: OBPv4.0.0-getEntitlements Tags: Role, Entitlement, User, New-Style,

获取用户的权利请求。

获取用户的权利请求。

身份验证是强制性的

Typical Successful Response:

								
									
{ "entitlement_requests":[{ "entitlement_request_id":"6fb17583-1e49-4435-bb74-a14fe0996723", "user":{ "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "email":"eveline@example.com", "provider_id":"Chris", "provider":"http://127.0.0.1:8080", "username":"felixsmith", "entitlements":{ "list":[{ "entitlement_id":"6fb17583-1e49-4435-bb74-a14fe0996723", "role_name":"CanQueryOtherUser", "bank_id":"GENODEM1GLS" }] } }, "role_name":"CanQueryOtherUser", "bank_id":"GENODEM1GLS", "created":"2017-09-18T22:00:00Z" }] }
Required Roles:
  • CanGetEntitlementRequestsAtAnyBank - 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-20050: Current User is not a Super Admin!
  • OBP-50200: Connector cannot return the data we requested.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.0.0, function_name: by getEntitlementRequests, operation_id: OBPv3.0.0-getEntitlementRequests Tags: Role, Entitlement, User, New-Style,

获取角色

返回所有可用角色

身份验证是强制性的

Typical Successful Response:

								
									
{ "roles":[{ "role":"eBranch", "requires_bank_id":true }] }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv2.1.0, function_name: by getRoles, operation_id: OBPv2.1.0-getRoles Tags: Role, New-Style,

获取银行用户的权利。

获取由BANK_ID和USER_ID指定的权利

身份验证是强制性的

Typical Successful Response:

								
									
{ "list":[{ "entitlement_id":"6fb17583-1e49-4435-bb74-a14fe0996723", "role_name":"CanQueryOtherUser", "bank_id":"GENODEM1GLS" }] }
Required Roles:
  • CanGetEntitlementsForAnyUserAtOneBank - Please login to request this Role
  • CanGetEntitlementsForAnyUserAtAnyBank - 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: OBPv2.1.0, function_name: by getEntitlementsByBankAndUser, operation_id: OBPv2.1.0-getEntitlementsByBankAndUser Tags: Role, Entitlement, User,

创建沙箱

映射(类型->字符串)
Typical Successful Response:

								
									
{ "success":"Success" }
Required Roles:
  • CanCreateSandbox - 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-10001: Incorrect json format.
  • OBP-00002: Data import is disabled for this API instance.
  • OBP-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv2.1.0, function_name: by sandboxDataImport, operation_id: OBPv2.1.0-sandboxDataImport Tags: Sandbox, API,

删除消费者范围

对于由CONSUMER_ID指定的使用者,删除由SCOPE_ID指定的使用者范围

必须进行身份验证,并且用户必须是超级管理员。
超级管理员列在“道具”文件中。

Typical Successful Response:

								
									
{ "jsonString":"{}" }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20050: Current User is not a Super Admin!
  • OBP-30212: EntitlementId not found
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.0.0, function_name: by deleteScope, operation_id: OBPv3.0.0-deleteScope Tags: Scope, Role, Entitlement, New-Style,

添加消费者范围。

创建范围。授予消费者角色。

范围用于将系统或银行级别的角色授予消费者(App)。 (有关帐户级别的权限,请参见视图)

对于系统级角色(例如CanGetAnyUser),将bank_id设置为空字符串,即“ bank_id”:“”

对于银行级别的角色(例如CanCreateAccount),将bank_id设置为有效值,例如“ bank_id”:“ my-bank-id”

Typical Successful Response:

								
									
{ "scope_id":"88625da4-a671-435e-9d24-e5b6e5cc404f", "role_name":"CanGetEntitlementsForAnyUserAtOneBank", "bank_id":"GENODEM1GLS" }
Required Roles:
  • CanCreateScopeAtOneBank - Please login to request this Role
  • CanCreateScopeAtAnyBank - 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-20024: Consumer not found. Please specify a valid value for CONSUMER_ID.
  • OBP-10001: Incorrect json format.
  • OBP-10007: Incorrect Role name:
  • OBP-30205: This entitlement is a Bank Role. Please set bank_id to a valid bank id.
  • OBP-30206: This entitlement is a System Role. Please set bank_id to empty string.
  • OBP-30216: Entitlement already exists for the user.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.0.0, function_name: by addScope, operation_id: OBPv3.0.0-addScope Tags: Scope, Role, New-Style,

获取消费者范围

获取由CONSUMER_ID指定的使用者的所有范围

身份验证是强制性的

Typical Successful Response:

								
									
{ "list":[{ "scope_id":"88625da4-a671-435e-9d24-e5b6e5cc404f", "role_name":"CanGetEntitlementsForAnyUserAtOneBank", "bank_id":"GENODEM1GLS" }] }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20050: Current User is not a Super Admin!
  • OBP-30212: EntitlementId not found
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.0.0, function_name: by getScopes, operation_id: OBPv3.0.0-getScopes Tags: Scope, Role, Entitlement, New-Style,

创建常规

创建一个帐户的常规订单。

当->频率= {'YEARLY','MONTHLY,'WEEKLY','BI-WEEKLY',DAILY'}
当->详细信息= {'FIRST_MONDAY','FIRST_DAY','LAST_DAY'}}

身份验证是强制性的

Typical Successful Response:

								
									
{ "standing_order_id":"aa0533bd-eb22-4bff-af75-d45240361b05", "bank_id":"GENODEM1GLS", "account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "counterparty_id":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh", "amount":{ "currency":"EUR", "amount":"10" }, "date_signed":"2019-12-02T09:27:34Z", "date_starts":"2019-12-02T09:27:34Z", "date_expires":"2019-12-02T09:27:34Z", "date_cancelled":"2019-12-02T09:27:34Z", "active":true }
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-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:
  • OBP-10001: Incorrect json format.
  • OBP-10002: Invalid Number. Could not convert value to a number.
  • OBP-10003: Invalid Currency Value. It should be three letters ISO Currency Code.
  • OBP-30046: Customer not found. Please specify a valid value for CUSTOMER_ID.
  • OBP-20057: User not found by userId.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by createStandingOrder, operation_id: OBPv4.0.0-createStandingOrder Tags: Standing-Order, Account, New-Style,

创建常规订单(管理)

创建一个帐户的常规订单。

当->频率= {'YEARLY','MONTHLY,'WEEKLY','BI-WEEKLY',DAILY'}
当->详细信息= {'FIRST_MONDAY','FIRST_DAY','LAST_DAY'}}

身份验证是强制性的

Typical Successful Response:

								
									
{ "standing_order_id":"aa0533bd-eb22-4bff-af75-d45240361b05", "bank_id":"GENODEM1GLS", "account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "counterparty_id":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh", "amount":{ "currency":"EUR", "amount":"10" }, "date_signed":"2019-12-02T09:27:34Z", "date_starts":"2019-12-02T09:27:34Z", "date_expires":"2019-12-02T09:27:34Z", "date_cancelled":"2019-12-02T09:27:34Z", "active":true }
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-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:
  • OBP-10001: Incorrect json format.
  • OBP-10002: Invalid Number. Could not convert value to a number.
  • OBP-10003: Invalid Currency Value. It should be three letters ISO Currency Code.
  • OBP-30046: Customer not found. Please specify a valid value for CUSTOMER_ID.
  • OBP-20057: User not found by userId.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by createStandingOrderManagement, operation_id: OBPv4.0.0-createStandingOrderManagement Tags: Standing-Order, Account, New-Style,

创建系统视图。

映射(类型->字符串)
Typical Successful Response:

								
									
{ "id":"1234", "short_name":"short_name", "description":"description", "metadata_view":"owner", "is_public":true, "alias":"No", "hide_metadata_if_alias_used":true, "can_add_comment":true, "can_add_corporate_location":true, "can_add_image":true, "can_add_image_url":true, "can_add_more_info":true, "can_add_open_corporates_url":true, "can_add_physical_location":true, "can_add_private_alias":true, "can_add_public_alias":true, "can_add_tag":true, "can_add_url":true, "can_add_where_tag":true, "can_delete_comment":true, "can_add_counterparty":true, "can_delete_corporate_location":true, "can_delete_image":true, "can_delete_physical_location":true, "can_delete_tag":true, "can_delete_where_tag":true, "can_edit_owner_comment":true, "can_see_bank_account_balance":true, "can_query_available_funds":true, "can_see_bank_account_bank_name":true, "can_see_bank_account_currency":true, "can_see_bank_account_iban":true, "can_see_bank_account_label":true, "can_see_bank_account_national_identifier":true, "can_see_bank_account_number":true, "can_see_bank_account_owners":true, "can_see_bank_account_swift_bic":true, "can_see_bank_account_type":true, "can_see_comments":true, "can_see_corporate_location":true, "can_see_image_url":true, "can_see_images":true, "can_see_more_info":true, "can_see_open_corporates_url":true, "can_see_other_account_bank_name":true, "can_see_other_account_iban":true, "can_see_other_account_kind":true, "can_see_other_account_metadata":true, "can_see_other_account_national_identifier":true, "can_see_other_account_number":true, "can_see_other_account_swift_bic":true, "can_see_owner_comment":true, "can_see_physical_location":true, "can_see_private_alias":true, "can_see_public_alias":true, "can_see_tags":true, "can_see_transaction_amount":true, "can_see_transaction_balance":true, "can_see_transaction_currency":true, "can_see_transaction_description":true, "can_see_transaction_finish_date":true, "can_see_transaction_metadata":true, "can_see_transaction_other_bank_account":true, "can_see_transaction_start_date":true, "can_see_transaction_this_bank_account":true, "can_see_transaction_type":true, "can_see_url":true, "can_see_where_tag":true, "can_see_bank_routing_scheme":true, "can_see_bank_routing_address":true, "can_see_bank_account_routing_scheme":true, "can_see_bank_account_routing_address":true, "can_see_other_bank_routing_scheme":true, "can_see_other_bank_routing_address":true, "can_see_other_account_routing_scheme":true, "can_see_other_account_routing_address":true, "can_add_transaction_request_to_own_account":true, "can_add_transaction_request_to_any_account":true, "can_see_bank_account_credit_limit":true, "can_create_direct_debit":true, "can_create_standing_order":true }
Required Roles:
  • CanCreateSystemView - 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-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.1.0, function_name: by createSystemView, operation_id: OBPv3.1.0-createSystemView Tags: System-View, New-Style,

删除系统视图

删除VIEW_ID指定的系统视图。

Typical Successful Response:

								
									
{ "jsonString":"{}" }
Required Roles:
  • CanCreateSystemView - 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-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
  • OBP-50000: Unknown Error.
  • user does not have owner access
Connector Methods:
Version: OBPv3.1.0, function_name: by deleteSystemView, operation_id: OBPv3.1.0-deleteSystemView Tags: System-View, New-Style,

更新系统视图。

映射(类型->字符串)
Typical Successful Response:

								
									
{ "id":"1234", "short_name":"short_name", "description":"description", "metadata_view":"owner", "is_public":true, "alias":"No", "hide_metadata_if_alias_used":true, "can_add_comment":true, "can_add_corporate_location":true, "can_add_image":true, "can_add_image_url":true, "can_add_more_info":true, "can_add_open_corporates_url":true, "can_add_physical_location":true, "can_add_private_alias":true, "can_add_public_alias":true, "can_add_tag":true, "can_add_url":true, "can_add_where_tag":true, "can_delete_comment":true, "can_add_counterparty":true, "can_delete_corporate_location":true, "can_delete_image":true, "can_delete_physical_location":true, "can_delete_tag":true, "can_delete_where_tag":true, "can_edit_owner_comment":true, "can_see_bank_account_balance":true, "can_query_available_funds":true, "can_see_bank_account_bank_name":true, "can_see_bank_account_currency":true, "can_see_bank_account_iban":true, "can_see_bank_account_label":true, "can_see_bank_account_national_identifier":true, "can_see_bank_account_number":true, "can_see_bank_account_owners":true, "can_see_bank_account_swift_bic":true, "can_see_bank_account_type":true, "can_see_comments":true, "can_see_corporate_location":true, "can_see_image_url":true, "can_see_images":true, "can_see_more_info":true, "can_see_open_corporates_url":true, "can_see_other_account_bank_name":true, "can_see_other_account_iban":true, "can_see_other_account_kind":true, "can_see_other_account_metadata":true, "can_see_other_account_national_identifier":true, "can_see_other_account_number":true, "can_see_other_account_swift_bic":true, "can_see_owner_comment":true, "can_see_physical_location":true, "can_see_private_alias":true, "can_see_public_alias":true, "can_see_tags":true, "can_see_transaction_amount":true, "can_see_transaction_balance":true, "can_see_transaction_currency":true, "can_see_transaction_description":true, "can_see_transaction_finish_date":true, "can_see_transaction_metadata":true, "can_see_transaction_other_bank_account":true, "can_see_transaction_start_date":true, "can_see_transaction_this_bank_account":true, "can_see_transaction_type":true, "can_see_url":true, "can_see_where_tag":true, "can_see_bank_routing_scheme":true, "can_see_bank_routing_address":true, "can_see_bank_account_routing_scheme":true, "can_see_bank_account_routing_address":true, "can_see_other_bank_routing_scheme":true, "can_see_other_bank_routing_address":true, "can_see_other_account_routing_scheme":true, "can_see_other_account_routing_address":true, "can_add_transaction_request_to_own_account":true, "can_add_transaction_request_to_any_account":true, "can_see_bank_account_credit_limit":true, "can_create_direct_debit":true, "can_create_standing_order":true }
Required Roles:
  • CanUpdateSystemView - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-10001: Incorrect json format.
  • 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-50000: Unknown Error.
Connector Methods:
Version: OBPv3.1.0, function_name: by updateSystemView, operation_id: OBPv3.1.0-updateSystemView Tags: System-View, New-Style,

获取系统视图

映射(类型->字符串)
Typical Successful Response:

								
									
{ "id":"1234", "short_name":"short_name", "description":"description", "is_public":true, "alias":"No", "hide_metadata_if_alias_used":true, "can_add_comment":true, "can_add_corporate_location":true, "can_add_image":true, "can_add_image_url":true, "can_add_more_info":true, "can_add_open_corporates_url":true, "can_add_physical_location":true, "can_add_private_alias":true, "can_add_public_alias":true, "can_add_tag":true, "can_add_url":true, "can_add_where_tag":true, "can_delete_comment":true, "can_add_counterparty":true, "can_delete_corporate_location":true, "can_delete_image":true, "can_delete_physical_location":true, "can_delete_tag":true, "can_delete_where_tag":true, "can_edit_owner_comment":true, "can_see_bank_account_balance":true, "can_see_bank_account_bank_name":true, "can_see_bank_account_currency":true, "can_see_bank_account_iban":true, "can_see_bank_account_label":true, "can_see_bank_account_national_identifier":true, "can_see_bank_account_number":true, "can_see_bank_account_owners":true, "can_see_bank_account_swift_bic":true, "can_see_bank_account_type":true, "can_see_comments":true, "can_see_corporate_location":true, "can_see_image_url":true, "can_see_images":true, "can_see_more_info":true, "can_see_open_corporates_url":true, "can_see_other_account_bank_name":true, "can_see_other_account_iban":true, "can_see_other_account_kind":true, "can_see_other_account_metadata":true, "can_see_other_account_national_identifier":true, "can_see_other_account_number":true, "can_see_other_account_swift_bic":true, "can_see_owner_comment":true, "can_see_physical_location":true, "can_see_private_alias":true, "can_see_public_alias":true, "can_see_tags":true, "can_see_transaction_amount":true, "can_see_transaction_balance":true, "can_see_transaction_currency":true, "can_see_transaction_description":true, "can_see_transaction_finish_date":true, "can_see_transaction_metadata":true, "can_see_transaction_other_bank_account":true, "can_see_transaction_start_date":true, "can_see_transaction_this_bank_account":true, "can_see_transaction_type":true, "can_see_url":true, "can_see_where_tag":true }
Required Roles:
  • CanGetSystemView - 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-50000: Unknown Error.
Connector Methods:
Version: OBPv3.1.0, function_name: by getSystemView, operation_id: OBPv3.1.0-getSystemView Tags: System-View, New-Style,

获取其他交易帐户

获取交易的其他帐户。
返回由视图 (VIEW_ID)主持的交易中涉及的另一方的详细信息。
如果视图不是公开的,则需要通过OAuth进行身份验证。

Typical Successful Response:

								
									
{ "id":"5995d6a2-01b3-423c-a173-5481df49bdaf", "holder":{ "name":"OBP", "is_alias":true }, "number":"123", "kind":"3456", "IBAN":"UK234DB", "swift_bic":"UK12321DB", "bank":{ "national_identifier":"OBP", "name":"OBP" }, "metadata":{ "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" } } } }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv1.2.1, function_name: by getOtherAccountForTransaction, operation_id: OBPv1.2.1-getOtherAccountForTransaction Tags: Transaction, Counterparty,

获取帐户交易(完整)

映射(类型->字符串)
Typical Successful Response:

								
									
{ "transactions":[{ "id":"String", "this_account":{ "id":"String", "bank_routing":{ "scheme":"Bank_ID", "address":"gh.29.uk" }, "account_routings":[{ "scheme":"AccountNumber", "address":"4930396" }], "holders":[{ "name":"OBP", "is_alias":true }] }, "other_account":{ "id":"5995d6a2-01b3-423c-a173-5481df49bdaf", "holder":{ "name":"OBP", "is_alias":true }, "bank_routing":{ "scheme":"Bank_ID", "address":"gh.29.uk" }, "account_routings":[{ "scheme":"AccountNumber", "address":"4930396" }], "metadata":{ "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" } } } }, "details":{ "type":"AC", "description":"this is for family", "posted":"2017-09-18T22:00:00Z", "completed":"2017-09-18T22:00:00Z", "new_balance":{ "currency":"EUR", "amount":"10" }, "value":{ "currency":"EUR", "amount":"10" } }, "metadata":{ "narrative":"NONE", "comments":[{ "id":"5995d6a2-01b3-423c-a173-5481df49bdaf", "value":"OBP", "date":"2017-09-18T22:00:00Z", "user":{ "id":"5995d6a2-01b3-423c-a173-5481df49bdaf", "provider":"http://127.0.0.1:8080", "display_name":"OBP" } }], "tags":[{ "id":"5995d6a2-01b3-423c-a173-5481df49bdaf", "value":"OBP", "date":"2017-09-18T22:00:00Z", "user":{ "id":"5995d6a2-01b3-423c-a173-5481df49bdaf", "provider":"http://127.0.0.1:8080", "display_name":"OBP" } }], "images":[{ "id":"5995d6a2-01b3-423c-a173-5481df49bdaf", "label":"NONE", "URL":"www.openbankproject.com", "date":"2017-09-18T22:00:00Z", "user":{ "id":"5995d6a2-01b3-423c-a173-5481df49bdaf", "provider":"http://127.0.0.1:8080", "display_name":"OBP" } }], "where":{ "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" } } } }] }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-10023: obp_sort_direction parameter can only take two values: DESC or ASC!
  • OBP-10024: wrong value for obp_offset parameter. Please send a positive integer (=>0)!
  • OBP-10025: wrong value for obp_limit parameter. Please send a positive integer (=>1)!
  • OBP-10026: Failed to parse date string. Please use this format yyyy-MM-dd'T'HH:mm:ss.SSS'Z'!
  • 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-30005: View not found for Account. Please specify a valid value for VIEW_ID
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.0.0, function_name: by getTransactionsForBankAccount, operation_id: OBPv3.0.0-getTransactionsForBankAccount Tags: Transaction, Account, New-Style,

获取帐户交易(核心)

映射(类型->字符串)
Typical Successful Response:

								
									
{ "transactions":[{ "id":"5995d6a2-01b3-423c-a173-5481df49bdaf", "this_account":{ "id":"String", "bank_routing":{ "scheme":"Bank_ID", "address":"gh.29.uk" }, "account_routings":[{ "scheme":"AccountNumber", "address":"4930396" }], "holders":[{ "name":"OBP", "is_alias":true }] }, "other_account":{ "id":"5995d6a2-01b3-423c-a173-5481df49bdaf", "holder":{ "name":"OBP", "is_alias":true }, "bank_routing":{ "scheme":"Bank_ID", "address":"gh.29.uk" }, "account_routings":[{ "scheme":"AccountNumber", "address":"4930396" }] }, "details":{ "type":"AC", "description":"OBP", "posted":"2017-09-18T22:00:00Z", "completed":"2017-09-18T22:00:00Z", "new_balance":{ "currency":"EUR", "amount":"10" }, "value":{ "currency":"EUR", "amount":"10" } } }] }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-10023: obp_sort_direction parameter can only take two values: DESC or ASC!
  • OBP-10024: wrong value for obp_offset parameter. Please send a positive integer (=>0)!
  • OBP-10025: wrong value for obp_limit parameter. Please send a positive integer (=>1)!
  • OBP-10026: Failed to parse date string. Please use this format yyyy-MM-dd'T'HH:mm:ss.SSS'Z'!
  • 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-30005: View not found for Account. Please specify a valid value for VIEW_ID
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.0.0, function_name: by getCoreTransactionsForBankAccount, operation_id: OBPv3.0.0-getCoreTransactionsForBankAccount Tags: Transaction, Account Information Service (AIS), Account, New-Style,

获取帐户的Firehose交易

映射(类型->字符串)
Typical Successful Response:

								
									
{ "transactions":[{ "id":"String", "this_account":{ "id":"String", "bank_routing":{ "scheme":"Bank_ID", "address":"gh.29.uk" }, "account_routings":[{ "scheme":"AccountNumber", "address":"4930396" }], "holders":[{ "name":"OBP", "is_alias":true }] }, "other_account":{ "id":"5995d6a2-01b3-423c-a173-5481df49bdaf", "holder":{ "name":"OBP", "is_alias":true }, "bank_routing":{ "scheme":"Bank_ID", "address":"gh.29.uk" }, "account_routings":[{ "scheme":"AccountNumber", "address":"4930396" }], "metadata":{ "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" } } } }, "details":{ "type":"AC", "description":"this is for family", "posted":"2017-09-18T22:00:00Z", "completed":"2017-09-18T22:00:00Z", "new_balance":{ "currency":"EUR", "amount":"10" }, "value":{ "currency":"EUR", "amount":"10" } }, "metadata":{ "narrative":"NONE", "comments":[{ "id":"5995d6a2-01b3-423c-a173-5481df49bdaf", "value":"OBP", "date":"2017-09-18T22:00:00Z", "user":{ "id":"5995d6a2-01b3-423c-a173-5481df49bdaf", "provider":"http://127.0.0.1:8080", "display_name":"OBP" } }], "tags":[{ "id":"5995d6a2-01b3-423c-a173-5481df49bdaf", "value":"OBP", "date":"2017-09-18T22:00:00Z", "user":{ "id":"5995d6a2-01b3-423c-a173-5481df49bdaf", "provider":"http://127.0.0.1:8080", "display_name":"OBP" } }], "images":[{ "id":"5995d6a2-01b3-423c-a173-5481df49bdaf", "label":"NONE", "URL":"www.openbankproject.com", "date":"2017-09-18T22:00:00Z", "user":{ "id":"5995d6a2-01b3-423c-a173-5481df49bdaf", "provider":"http://127.0.0.1:8080", "display_name":"OBP" } }], "where":{ "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 Roles:
  • CanUseFirehoseAtAnyBank - 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-00009: Account firehose is not allowed on this instance. Please set allow_account_firehose = true in props files.
  • OBP-00012: Customer firehose is not allowed on this instance. Please set allow_customer_firehose = true in props files.
  • OBP-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.0.0, function_name: by getFirehoseTransactionsForBankAccount, operation_id: OBPv3.0.0-getFirehoseTransactionsForBankAccount Tags: Transaction, Account-Firehose, Transaction-Firehose, FirehoseData, New-Style,

通过ID获取交易。

映射(类型->字符串)
Typical Successful Response:

								
									
{ "id":"5995d6a2-01b3-423c-a173-5481df49bdaf", "this_account":{ "id":"5995d6a2-01b3-423c-a173-5481df49bdaf", "holders":[{ "name":"OBP", "is_alias":true }], "number":"123", "kind":"AC", "IBAN":"UK1234AD", "swift_bic":"UK1234AD", "bank":{ "national_identifier":"OBP", "name":"OBP" } }, "other_account":{ "id":"5995d6a2-01b3-423c-a173-5481df49bdaf", "holder":{ "name":"OBP", "is_alias":true }, "number":"123", "kind":"3456", "IBAN":"UK234DB", "swift_bic":"UK12321DB", "bank":{ "national_identifier":"OBP", "name":"OBP" }, "metadata":{ "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" } } } }, "details":{ "type":"AC", "description":"this is for family", "posted":"2017-09-18T22:00:00Z", "completed":"2017-09-18T22:00:00Z", "new_balance":{ "currency":"EUR", "amount":"10" }, "value":{ "currency":"EUR", "amount":"10" } }, "metadata":{ "narrative":"NONE", "comments":[{ "id":"5995d6a2-01b3-423c-a173-5481df49bdaf", "value":"OBP", "date":"2017-09-18T22:00:00Z", "user":{ "id":"5995d6a2-01b3-423c-a173-5481df49bdaf", "provider":"http://127.0.0.1:8080", "display_name":"OBP" } }], "tags":[{ "id":"5995d6a2-01b3-423c-a173-5481df49bdaf", "value":"OBP", "date":"2017-09-18T22:00:00Z", "user":{ "id":"5995d6a2-01b3-423c-a173-5481df49bdaf", "provider":"http://127.0.0.1:8080", "display_name":"OBP" } }], "images":[{ "id":"5995d6a2-01b3-423c-a173-5481df49bdaf", "label":"NONE", "URL":"www.openbankproject.com", "date":"2017-09-18T22:00:00Z", "user":{ "id":"5995d6a2-01b3-423c-a173-5481df49bdaf", "provider":"http://127.0.0.1:8080", "display_name":"OBP" } }], "where":{ "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" } } } }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • 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-30005: View not found for Account. Please specify a valid value for VIEW_ID
  • OBP-20017: Current user does not have access to the view. Please specify a valid value for VIEW_ID.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.1.0, function_name: by getTransactionByIdForBankAccount, operation_id: OBPv3.1.0-getTransactionByIdForBankAccount Tags: Transaction, New-Style,

删除where标记。

删除在view上进行的事务TRANSACTION_ID的where标记。

身份验证是强制性的

该用户必须对此帐户拥有所有者特权,或者必须是发布了地理位置标记的用户。

Typical Successful Response:

								
									
{ "jsonString":"{}" }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • 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:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID
  • there is no tag to delete
  • Delete not completed
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv1.2.1, function_name: by deleteWhereTagForViewOnTransaction, operation_id: OBPv1.2.1-deleteWhereTagForViewOnTransaction Tags: Transaction-Metadata, Transaction,

删除叙述。

删除事务TRANSACTION_ID的描述。

如果视图不是公开的,则需要通过OAuth进行身份验证。

Typical Successful Response:

								
									
{ "jsonString":"{}" }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • 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:
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv1.2.1, function_name: by deleteTransactionNarrative, operation_id: OBPv1.2.1-deleteTransactionNarrative Tags: Transaction-Metadata, Transaction,

删除图片

删除有关在view上进行的交易TRANSACTION_ID的图像IMAGE_ID。

需要通过OAuth进行身份验证。该用户必须对此帐户具有所有者特权,或者必须是发布该图像的用户。

Typical Successful Response:

								
									
{ "jsonString":"{}" }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • 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:
  • OBP-20001: User not logged in. Authentication is required!
  • You must be able to see images in order to delete them
  • Image not found for this transaction
  • Deleting images not permitted for this view
  • Deleting images not permitted for the current user
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv1.2.1, function_name: by deleteImageForViewOnTransaction, operation_id: OBPv1.2.1-deleteImageForViewOnTransaction Tags: Transaction-Metadata, Transaction,

删除标签。

删除有关在view上进行的交易TRANSACTION_ID的标签TAG_ID。
需要通过OAuth进行身份验证。用户必须对此帐户拥有所有者权限,
或必须是发布标签的用户。

Typical Successful Response:

								
									
{ "jsonString":"{}" }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • 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
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv1.2.1, function_name: by deleteTagForViewOnTransaction, operation_id: OBPv1.2.1-deleteTagForViewOnTransaction Tags: Transaction-Metadata, Transaction,

删除评论。

删除有关在view上进行的交易TRANSACTION_ID的评论COMMENT_ID。

需要通过OAuth进行身份验证。该用户必须对此帐户具有所有者特权,或者必须是发布评论的用户。

Typical Successful Response:

								
									
{ "jsonString":"{}" }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • 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:
  • OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv1.2.1, function_name: by deleteCommentForViewOnTransaction, operation_id: OBPv1.2.1-deleteCommentForViewOnTransaction Tags: Transaction-Metadata, Transaction,

更新where标记。

视图中更新事务TRANSACTION_ID上的“ where”地理标签。

身份验证是强制性的

地理位置标记与用户链接。

Typical Successful Response:

								
									
{ "success":"Success" }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • 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-30005: View not found for Account. Please specify a valid value for VIEW_ID
  • OBP-30022: The current view does not have the permission:
  • Coordinates not possible
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv1.2.1, function_name: by updateWhereTagForViewOnTransaction, operation_id: OBPv1.2.1-updateWhereTagForViewOnTransaction Tags: Transaction-Metadata, Transaction,

更新叙述。

更新事务TRANSACTION_ID的描述。

如果视图不是公开的,则需要通过OAuth进行身份验证。

Typical Successful Response:

								
									
{ "success":"Success" }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-10001: Incorrect json format.
  • 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:
  • OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv1.2.1, function_name: by updateTransactionNarrative, operation_id: OBPv1.2.1-updateTransactionNarrative Tags: Transaction-Metadata, Transaction,

添加where标记。

视图中的交易TRANSACTION_ID上创建一个“ where”地理标签。

身份验证是强制性的

地理位置标记与用户链接。

Typical Successful Response:

								
									
{ "success":"Success" }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • 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-30005: View not found for Account. Please specify a valid value for VIEW_ID
  • OBP-30022: The current view does not have the permission:
  • Coordinates not possible
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv1.2.1, function_name: by addWhereTagForViewOnTransaction, operation_id: OBPv1.2.1-addWhereTagForViewOnTransaction Tags: Transaction-Metadata, Transaction,

添加叙述。

创建事务TRANSACTION_ID的描述。

注意:与元数据的其他项目不同,每个事务在所有视图中只有一个“叙述”。
如果您通过视图(例如view-x)设置叙述,则将通过view-y看到(只要view-y有权查看该叙述)。

身份验证是可选的
如果视图不是公共的,则需要认证。

Typical Successful Response:

								
									
{ "success":"Success" }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-10001: Incorrect json format.
  • 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:
  • OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv1.2.1, function_name: by addTransactionNarrative, operation_id: OBPv1.2.1-addTransactionNarrative Tags: Transaction-Metadata, Transaction,

添加图像。

视图 VIEW_ID上发布有关交易TRANSACTION_ID的图像。

身份验证是强制性的

该图像与用户链接。

Typical Successful Response:

								
									
{ "id":"5995d6a2-01b3-423c-a173-5481df49bdaf", "label":"NONE", "URL":"www.openbankproject.com", "date":"2017-09-18T22:00:00Z", "user":{ "id":"5995d6a2-01b3-423c-a173-5481df49bdaf", "provider":"http://127.0.0.1:8080", "display_name":"OBP" } }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-10001: Incorrect json format.
  • 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:
  • OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID
  • OBP-10017: Incorrect URL Format.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv1.2.1, function_name: by addImageForViewOnTransaction, operation_id: OBPv1.2.1-addImageForViewOnTransaction Tags: Transaction-Metadata, Transaction,

添加标签。

视图 VIEW_ID上发布有关交易TRANSACTION_ID的标签。

身份验证是强制性的

由于标签与用户链接,因此需要进行身份验证。

Typical Successful Response:

								
									
{ "id":"5995d6a2-01b3-423c-a173-5481df49bdaf", "value":"OBP", "date":"2017-09-18T22:00:00Z", "user":{ "id":"5995d6a2-01b3-423c-a173-5481df49bdaf", "provider":"http://127.0.0.1:8080", "display_name":"OBP" } }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • 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
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv1.2.1, function_name: by addTagForViewOnTransaction, operation_id: OBPv1.2.1-addTagForViewOnTransaction Tags: Transaction-Metadata, Transaction,

添加评论。

视图 VIEW_ID上发布有关交易TRANSACTION_ID的评论。

$ {authenticationRequiredMessage(false)}

由于注释与用户链接,因此需要验证。

Typical Successful Response:

								
									
{ "id":"5995d6a2-01b3-423c-a173-5481df49bdaf", "value":"OBP", "date":"2017-09-18T22:00:00Z", "user":{ "id":"5995d6a2-01b3-423c-a173-5481df49bdaf", "provider":"http://127.0.0.1:8080", "display_name":"OBP" } }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-10001: Incorrect json format.
  • 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:
  • OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv1.2.1, function_name: by addCommentForViewOnTransaction, operation_id: OBPv1.2.1-addCommentForViewOnTransaction Tags: Transaction-Metadata, Transaction,

获取图像。

返回在视图 (VIEW_ID)上生成的交易TRANSACTION_ID图片。
如果视图不是公开的,则需要通过OAuth进行身份验证。

Typical Successful Response:

								
									
{ "images":[{ "id":"5995d6a2-01b3-423c-a173-5481df49bdaf", "label":"NONE", "URL":"www.openbankproject.com", "date":"2017-09-18T22:00:00Z", "user":{ "id":"5995d6a2-01b3-423c-a173-5481df49bdaf", "provider":"http://127.0.0.1:8080", "display_name":"OBP" } }] }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • 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:
  • OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv1.2.1, function_name: by getImagesForViewOnTransaction, operation_id: OBPv1.2.1-getImagesForViewOnTransaction Tags: Transaction-Metadata, Transaction,

获取标签。

返回在视图 (VIEW_ID)上进行的交易TRANSACTION_ID标签。
如果视图不是公开的,则需要通过OAuth进行身份验证。

Typical Successful Response:

								
									
{ "id":"5995d6a2-01b3-423c-a173-5481df49bdaf", "value":"OBP", "date":"2017-09-18T22:00:00Z", "user":{ "id":"5995d6a2-01b3-423c-a173-5481df49bdaf", "provider":"http://127.0.0.1:8080", "display_name":"OBP" } }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • 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:
  • OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv1.2.1, function_name: by getTagsForViewOnTransaction, operation_id: OBPv1.2.1-getTagsForViewOnTransaction Tags: Transaction-Metadata, Transaction,

获取标签。

返回添加到在视图 (VIEW_ID)上进行的交易TRANSACTION_ID的“ where”地理标签。
它代表交易已开始的位置。

如果视图不是公开的,则需要通过OAuth进行身份验证。

Typical Successful Response:

								
									
{ "where":{ "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" } } }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • 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:
  • OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv1.2.1, function_name: by getWhereTagForViewOnTransaction, operation_id: OBPv1.2.1-getWhereTagForViewOnTransaction Tags: Transaction-Metadata, Transaction,

获取评论。

返回在视图 (VIEW_ID)上进行的交易TRANSACTION_ID注释。

如果视图不是公开的,则需要通过OAuth进行身份验证。

Typical Successful Response:

								
									
{ "comments":[{ "id":"5995d6a2-01b3-423c-a173-5481df49bdaf", "value":"OBP", "date":"2017-09-18T22:00:00Z", "user":{ "id":"5995d6a2-01b3-423c-a173-5481df49bdaf", "provider":"http://127.0.0.1:8080", "display_name":"OBP" } }] }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • 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:
  • OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv1.2.1, function_name: by getCommentsForViewOnTransaction, operation_id: OBPv1.2.1-getCommentsForViewOnTransaction Tags: Transaction-Metadata, Transaction,

获得叙述。

返回视图主持的交易的帐户所有者描述。

如果视图不是公开的,则需要通过OAuth进行身份验证。

Typical Successful Response:

								
									
{ "narrative":"narative" }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • 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:
  • OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv1.2.1, function_name: by getTransactionNarrative, operation_id: OBPv1.2.1-getTransactionNarrative Tags: Transaction-Metadata, Transaction,

保存历史交易

映射(类型->字符串)
Typical Successful Response:

								
									
{ "transaction_id":"123", "from":{ "bank_id":"GENODEM1GLS", "account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0" }, "to":{ "bank_id":"GENODEM1GLS", "account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0" }, "value":{ "currency":"EUR", "amount":"10" }, "description":"this is for work", "posted":"2017-09-18T22:00:00Z", "completed":"2017-09-18T22:00:00Z", "transaction_request_type":"SANDBOX_TAN", "charge_policy":"SHARED" }
Required Roles:
  • CanCreateHistoricalTransaction - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-30111: Invalid Bank Id. The BANK_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.
  • OBP-30110: Invalid Account Id. The ACCOUNT_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.
  • OBP-10001: Incorrect json format.
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-30003: Account not found. Please specify a valid value for ACCOUNT_ID.
  • OBP-10002: Invalid Number. Could not convert value to a number.
  • OBP-40008: Can't send a payment with a value of 0 or less.
  • OBP-40003: Transaction Request Currency must be the same as From Account Currency.
  • OBP-00003: Transaction Requests is disabled in this API instance.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.1.0, function_name: by saveHistoricalTransaction, operation_id: OBPv3.1.0-saveHistoricalTransaction Tags: Transaction-Request,

映射(类型->字符串)

映射(类型->字符串)
Typical Successful Response:

								
									
{ "transaction_requests_with_charges":[{ "id":"4050046c-63b3-4868-8a22-14b4181d33a6", "type":"SANDBOX_TAN", "from":{ "bank_id":"GENODEM1GLS", "account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0" }, "details":{ "to_sandbox_tan":{ "bank_id":"String", "account_id":"String" }, "to_sepa":{ "iban":"String" }, "to_counterparty":{ "counterparty_id":"String" }, "to_transfer_to_phone":{ "value":{ "currency":"EUR", "amount":"10" }, "description":"String", "message":"String", "from":{ "mobile_phone_number":"+44 07972 444 876", "nickname":"String" }, "to":{ "mobile_phone_number":"+44 07972 444 876" } }, "to_transfer_to_atm":{ "value":{ "currency":"EUR", "amount":"10" }, "description":"String", "message":"String", "from":{ "mobile_phone_number":"+44 07972 444 876", "nickname":"String" }, "to":{ "legal_name":"Eveline Tripman", "date_of_birth":"20181230", "mobile_phone_number":"+44 07972 444 876", "kyc_document":{ "type":"String", "number":"String" } } }, "to_transfer_to_account":{ "value":{ "currency":"EUR", "amount":"10" }, "description":"String", "transfer_type":"String", "future_date":"20181230", "to":{ "name":"String", "bank_code":"String", "branch_number":"String", "account":{ "number":"String", "iban":"String" } } }, "to_sepa_credit_transfers":{ "debtorAccount":{ "iban":"12345" }, "instructedAmount":{ "currency":"EUR", "amount":"10" }, "creditorAccount":{ "iban":"54321" }, "creditorName":"John Miles" }, "value":{ "currency":"EUR", "amount":"100" }, "description":"String" }, "transaction_ids":["902ba3bb-dedd-45e7-9319-2fd3f2cd98a1"], "status":"COMPLETED", "start_date":"2017-09-18T22:00:00Z", "end_date":"2017-09-18T22:00:00Z", "challenge":{ "id":"be1a183d-b301-4b83-b855-5eeffdd3526f", "allowed_attempts":3, "challenge_type":"SANDBOX_TAN" }, "charge":{ "summary":"Rent the flat", "value":{ "currency":"EUR", "amount":"10" } } }] }
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-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
  • OBP-20017: Current user does not have access to the view. Please specify a valid value for VIEW_ID.
  • OBP-20019: User does not have access to owner view.
  • OBP-60010: Get Transaction Requests Exception.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.1.0, function_name: by getTransactionRequests, operation_id: OBPv3.1.0-getTransactionRequests Tags: Transaction-Request, Payment Initiation Service (PIS), New-Style,

映射(类型->字符串)

返回由ACCOUNT_ID指定的帐户和VIEW_ID指定的视图有权访问的转换请求类型。

这些是API服务器可以通过交易请求创建交易的方式
(与“交易类型”相反,“交易类型”也包括外部类型,例如用于核心银行业务创建的交易等)

事务请求类型在内部确定:

  • 所需的交易请求“正文”,即定义交易请求的“内容”和“至”的字段,
  • 在进行交易请求之前可能引发的安全挑战的类型,以及
  • 挑战的起点。

例如,在“ SANDBOX_TAN”交易请求中,对于金额超过1000个货币单位的交易,用户必须提供正整数才能完成交易请求并创建交易。

这种方法旨在仅提供一个用于发起事务的端点,一个用于处理挑战的端点,同时仍然允许有效负载和内部逻辑的灵活性。

Typical Successful Response:

								
									
{ "transaction_request_types":[{ "value":"10", "charge":{ "summary":"The bank fixed charge", "value":{ "currency":"EUR", "amount":"10" } } }] }
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-30003: Account not found. Please specify a valid value for ACCOUNT_ID.
  • Please specify a valid value for CURRENCY of your Bank Account.
  • Current user does not have access to the view
  • account not found at bank
  • user does not have access to owner view
  • OBP-40018: Sorry, Transaction Requests are not enabled in this API instance.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv1.4.0, function_name: by getTransactionRequestTypes, operation_id: OBPv1.4.0-getTransactionRequestTypes Tags: Transaction-Request, Payment Initiation Service (PIS),

映射(类型->字符串)

映射(类型->字符串)
Typical Successful Response:

								
									
{ "id":"4050046c-63b3-4868-8a22-14b4181d33a6", "type":"SANDBOX_TAN", "from":{ "bank_id":"GENODEM1GLS", "account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0" }, "details":{ "to_sandbox_tan":{ "bank_id":"String", "account_id":"String" }, "to_sepa":{ "iban":"String" }, "to_counterparty":{ "counterparty_id":"String" }, "to_transfer_to_phone":{ "value":{ "currency":"EUR", "amount":"10" }, "description":"String", "message":"String", "from":{ "mobile_phone_number":"+44 07972 444 876", "nickname":"String" }, "to":{ "mobile_phone_number":"+44 07972 444 876" } }, "to_transfer_to_atm":{ "value":{ "currency":"EUR", "amount":"10" }, "description":"String", "message":"String", "from":{ "mobile_phone_number":"+44 07972 444 876", "nickname":"String" }, "to":{ "legal_name":"Eveline Tripman", "date_of_birth":"20181230", "mobile_phone_number":"+44 07972 444 876", "kyc_document":{ "type":"String", "number":"String" } } }, "to_transfer_to_account":{ "value":{ "currency":"EUR", "amount":"10" }, "description":"String", "transfer_type":"String", "future_date":"20181230", "to":{ "name":"String", "bank_code":"String", "branch_number":"String", "account":{ "number":"String", "iban":"String" } } }, "to_sepa_credit_transfers":{ "debtorAccount":{ "iban":"12345" }, "instructedAmount":{ "currency":"EUR", "amount":"10" }, "creditorAccount":{ "iban":"54321" }, "creditorName":"John Miles" }, "value":{ "currency":"EUR", "amount":"100" }, "description":"String" }, "transaction_ids":["902ba3bb-dedd-45e7-9319-2fd3f2cd98a1"], "status":"COMPLETED", "start_date":"2017-09-18T22:00:00Z", "end_date":"2017-09-18T22:00:00Z", "challenge":{ "id":"be1a183d-b301-4b83-b855-5eeffdd3526f", "allowed_attempts":3, "challenge_type":"SANDBOX_TAN" }, "charge":{ "summary":"Rent the flat", "value":{ "currency":"EUR", "amount":"10" } } }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-30111: Invalid Bank Id. The BANK_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.
  • OBP-30110: Invalid Account Id. The ACCOUNT_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.
  • OBP-10001: Incorrect json format.
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-30003: Account not found. Please specify a valid value for ACCOUNT_ID.
  • OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID
  • OBP-40002: Insufficient authorisation to create TransactionRequest. The Transaction Request could not be created because you don't have access to the owner view of the from account or you don't have access to canCreateAnyTransactionRequest.
  • OBP-20017: Current user does not have access to the view. Please specify a valid value for VIEW_ID.
  • OBP-40001: Invalid value for TRANSACTION_REQUEST_TYPE
  • OBP-10001: Incorrect json format.
  • OBP-10002: Invalid Number. Could not convert value to a number.
  • OBP-40008: Can't send a payment with a value of 0 or less.
  • OBP-40003: Transaction Request Currency must be the same as From Account Currency.
  • OBP-00003: Transaction Requests is disabled in this API instance.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv2.1.0, function_name: by createTransactionRequestSandboxTan, operation_id: OBPv2.1.0-createTransactionRequestSandboxTan Tags: Transaction-Request, Payment Initiation Service (PIS),

映射(类型->字符串)

映射(类型->字符串)
Typical Successful Response:

								
									
{ "id":"4050046c-63b3-4868-8a22-14b4181d33a6", "type":"SANDBOX_TAN", "from":{ "bank_id":"GENODEM1GLS", "account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0" }, "details":{ "to_sandbox_tan":{ "bank_id":"String", "account_id":"String" }, "to_sepa":{ "iban":"String" }, "to_counterparty":{ "counterparty_id":"String" }, "to_transfer_to_phone":{ "value":{ "currency":"EUR", "amount":"10" }, "description":"String", "message":"String", "from":{ "mobile_phone_number":"+44 07972 444 876", "nickname":"String" }, "to":{ "mobile_phone_number":"+44 07972 444 876" } }, "to_transfer_to_atm":{ "value":{ "currency":"EUR", "amount":"10" }, "description":"String", "message":"String", "from":{ "mobile_phone_number":"+44 07972 444 876", "nickname":"String" }, "to":{ "legal_name":"Eveline Tripman", "date_of_birth":"20181230", "mobile_phone_number":"+44 07972 444 876", "kyc_document":{ "type":"String", "number":"String" } } }, "to_transfer_to_account":{ "value":{ "currency":"EUR", "amount":"10" }, "description":"String", "transfer_type":"String", "future_date":"20181230", "to":{ "name":"String", "bank_code":"String", "branch_number":"String", "account":{ "number":"String", "iban":"String" } } }, "to_sepa_credit_transfers":{ "debtorAccount":{ "iban":"12345" }, "instructedAmount":{ "currency":"EUR", "amount":"10" }, "creditorAccount":{ "iban":"54321" }, "creditorName":"John Miles" }, "value":{ "currency":"EUR", "amount":"100" }, "description":"String" }, "transaction_ids":["902ba3bb-dedd-45e7-9319-2fd3f2cd98a1"], "status":"COMPLETED", "start_date":"2017-09-18T22:00:00Z", "end_date":"2017-09-18T22:00:00Z", "challenge":{ "id":"be1a183d-b301-4b83-b855-5eeffdd3526f", "allowed_attempts":3, "challenge_type":"SANDBOX_TAN" }, "charge":{ "summary":"Rent the flat", "value":{ "currency":"EUR", "amount":"10" } } }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-30111: Invalid Bank Id. The BANK_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.
  • OBP-30110: Invalid Account Id. The ACCOUNT_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.
  • OBP-10001: Incorrect json format.
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-30003: Account not found. Please specify a valid value for ACCOUNT_ID.
  • OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID
  • OBP-40002: Insufficient authorisation to create TransactionRequest. The Transaction Request could not be created because you don't have access to the owner view of the from account or you don't have access to canCreateAnyTransactionRequest.
  • OBP-20017: Current user does not have access to the view. Please specify a valid value for VIEW_ID.
  • OBP-40001: Invalid value for TRANSACTION_REQUEST_TYPE
  • OBP-10001: Incorrect json format.
  • OBP-10002: Invalid Number. Could not convert value to a number.
  • OBP-40008: Can't send a payment with a value of 0 or less.
  • OBP-40003: Transaction Request Currency must be the same as From Account Currency.
  • OBP-00003: Transaction Requests is disabled in this API instance.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by createTransactionRequestAccountOtp, operation_id: OBPv4.0.0-createTransactionRequestAccountOtp Tags: Transaction-Request, Payment Initiation Service (PIS), New-Style,

映射(类型->字符串)

映射(类型->字符串)
Typical Successful Response:

								
									
{ "id":"4050046c-63b3-4868-8a22-14b4181d33a6", "type":"SANDBOX_TAN", "from":{ "bank_id":"GENODEM1GLS", "account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0" }, "details":{ "to_sandbox_tan":{ "bank_id":"String", "account_id":"String" }, "to_sepa":{ "iban":"String" }, "to_counterparty":{ "counterparty_id":"String" }, "to_transfer_to_phone":{ "value":{ "currency":"EUR", "amount":"10" }, "description":"String", "message":"String", "from":{ "mobile_phone_number":"+44 07972 444 876", "nickname":"String" }, "to":{ "mobile_phone_number":"+44 07972 444 876" } }, "to_transfer_to_atm":{ "value":{ "currency":"EUR", "amount":"10" }, "description":"String", "message":"String", "from":{ "mobile_phone_number":"+44 07972 444 876", "nickname":"String" }, "to":{ "legal_name":"Eveline Tripman", "date_of_birth":"20181230", "mobile_phone_number":"+44 07972 444 876", "kyc_document":{ "type":"String", "number":"String" } } }, "to_transfer_to_account":{ "value":{ "currency":"EUR", "amount":"10" }, "description":"String", "transfer_type":"String", "future_date":"20181230", "to":{ "name":"String", "bank_code":"String", "branch_number":"String", "account":{ "number":"String", "iban":"String" } } }, "to_sepa_credit_transfers":{ "debtorAccount":{ "iban":"12345" }, "instructedAmount":{ "currency":"EUR", "amount":"10" }, "creditorAccount":{ "iban":"54321" }, "creditorName":"John Miles" }, "value":{ "currency":"EUR", "amount":"100" }, "description":"String" }, "transaction_ids":["902ba3bb-dedd-45e7-9319-2fd3f2cd98a1"], "status":"COMPLETED", "start_date":"2017-09-18T22:00:00Z", "end_date":"2017-09-18T22:00:00Z", "challenge":{ "id":"be1a183d-b301-4b83-b855-5eeffdd3526f", "allowed_attempts":3, "challenge_type":"SANDBOX_TAN" }, "charge":{ "summary":"Rent the flat", "value":{ "currency":"EUR", "amount":"10" } } }
Required Roles:
  • CanCreateAnyTransactionRequest - 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-20001: User not logged in. Authentication is required!
  • OBP-30111: Invalid Bank Id. The BANK_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.
  • OBP-30110: Invalid Account Id. The ACCOUNT_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.
  • OBP-10001: Incorrect json format.
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-30003: Account not found. Please specify a valid value for ACCOUNT_ID.
  • OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID
  • OBP-40002: Insufficient authorisation to create TransactionRequest. The Transaction Request could not be created because you don't have access to the owner view of the from account or you don't have access to canCreateAnyTransactionRequest.
  • OBP-20017: Current user does not have access to the view. Please specify a valid value for VIEW_ID.
  • OBP-40001: Invalid value for TRANSACTION_REQUEST_TYPE
  • OBP-10001: Incorrect json format.
  • OBP-10002: Invalid Number. Could not convert value to a number.
  • OBP-40008: Can't send a payment with a value of 0 or less.
  • OBP-40003: Transaction Request Currency must be the same as From Account Currency.
  • OBP-00003: Transaction Requests is disabled in this API instance.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by createTransactionRequestFreeForm, operation_id: OBPv4.0.0-createTransactionRequestFreeForm Tags: Transaction-Request, Payment Initiation Service (PIS), New-Style,

映射(类型->字符串)

映射(类型->字符串)
Typical Successful Response:

								
									
{ "id":"82f92531-9c63-4246-abfc-96c20ec46188", "type":"SANDBOX_TAN", "from":{ "bank_id":"GENODEM1GLS", "account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0" }, "details":{ "to":{ "bank_id":"String", "account_id":"String" }, "value":{ "currency":"EUR", "amount":"100" }, "description":"String" }, "transaction_ids":"666666-9c63-4246-abfc-96c20ec46188", "status":"COMPLETED", "start_date":"2017-09-18T22:00:00Z", "end_date":"2017-09-18T22:00:00Z", "challenge":{ "id":"be1a183d-b301-4b83-b855-5eeffdd3526f", "allowed_attempts":3, "challenge_type":"SANDBOX_TAN" }, "charge":{ "summary":"Rent the flat", "value":{ "currency":"EUR", "amount":"10" } } }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-30111: Invalid Bank Id. The BANK_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.
  • OBP-30110: Invalid Account Id. The ACCOUNT_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.
  • OBP-10001: Incorrect json format.
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-20017: Current user does not have access to the view. Please specify a valid value for VIEW_ID.
  • OBP-40011: Transaction Request Status is not INITIATED.
  • OBP-40009: The TRANSACTION_REQUEST_TYPE has changed.
  • OBP-40010: Invalid Challenge Id. Please specify a valid value for CHALLENGE_ID.
  • OBP-40014: Sorry, you've used up your allowed attempts.
  • OBP-00003: Transaction Requests is disabled in this API instance.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by answerTransactionRequestChallenge, operation_id: OBPv4.0.0-answerTransactionRequestChallenge Tags: Transaction-Request, Payment Initiation Service (PIS), New-Style,

映射(类型->字符串)

映射(类型->字符串)
Typical Successful Response:

								
									
{ "id":"4050046c-63b3-4868-8a22-14b4181d33a6", "type":"SANDBOX_TAN", "from":{ "bank_id":"GENODEM1GLS", "account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0" }, "details":{ "to_sandbox_tan":{ "bank_id":"String", "account_id":"String" }, "to_sepa":{ "iban":"String" }, "to_counterparty":{ "counterparty_id":"String" }, "to_transfer_to_phone":{ "value":{ "currency":"EUR", "amount":"10" }, "description":"String", "message":"String", "from":{ "mobile_phone_number":"+44 07972 444 876", "nickname":"String" }, "to":{ "mobile_phone_number":"+44 07972 444 876" } }, "to_transfer_to_atm":{ "value":{ "currency":"EUR", "amount":"10" }, "description":"String", "message":"String", "from":{ "mobile_phone_number":"+44 07972 444 876", "nickname":"String" }, "to":{ "legal_name":"Eveline Tripman", "date_of_birth":"20181230", "mobile_phone_number":"+44 07972 444 876", "kyc_document":{ "type":"String", "number":"String" } } }, "to_transfer_to_account":{ "value":{ "currency":"EUR", "amount":"10" }, "description":"String", "transfer_type":"String", "future_date":"20181230", "to":{ "name":"String", "bank_code":"String", "branch_number":"String", "account":{ "number":"String", "iban":"String" } } }, "to_sepa_credit_transfers":{ "debtorAccount":{ "iban":"12345" }, "instructedAmount":{ "currency":"EUR", "amount":"10" }, "creditorAccount":{ "iban":"54321" }, "creditorName":"John Miles" }, "value":{ "currency":"EUR", "amount":"100" }, "description":"String" }, "transaction_ids":["902ba3bb-dedd-45e7-9319-2fd3f2cd98a1"], "status":"COMPLETED", "start_date":"2017-09-18T22:00:00Z", "end_date":"2017-09-18T22:00:00Z", "challenge":{ "id":"be1a183d-b301-4b83-b855-5eeffdd3526f", "allowed_attempts":3, "challenge_type":"SANDBOX_TAN" }, "charge":{ "summary":"Rent the flat", "value":{ "currency":"EUR", "amount":"10" } } }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-30111: Invalid Bank Id. The BANK_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.
  • OBP-30110: Invalid Account Id. The ACCOUNT_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.
  • OBP-10001: Incorrect json format.
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-30003: Account not found. Please specify a valid value for ACCOUNT_ID.
  • OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID
  • OBP-40002: Insufficient authorisation to create TransactionRequest. The Transaction Request could not be created because you don't have access to the owner view of the from account or you don't have access to canCreateAnyTransactionRequest.
  • OBP-20017: Current user does not have access to the view. Please specify a valid value for VIEW_ID.
  • OBP-40001: Invalid value for TRANSACTION_REQUEST_TYPE
  • OBP-10001: Incorrect json format.
  • OBP-10002: Invalid Number. Could not convert value to a number.
  • OBP-40008: Can't send a payment with a value of 0 or less.
  • OBP-40003: Transaction Request Currency must be the same as From Account Currency.
  • OBP-00003: Transaction Requests is disabled in this API instance.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by createTransactionRequestSepa, operation_id: OBPv4.0.0-createTransactionRequestSepa Tags: Transaction-Request, Payment Initiation Service (PIS), New-Style,

映射(类型->字符串)

映射(类型->字符串)
Typical Successful Response:

								
									
{ "id":"4050046c-63b3-4868-8a22-14b4181d33a6", "type":"SANDBOX_TAN", "from":{ "bank_id":"GENODEM1GLS", "account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0" }, "details":{ "to_sandbox_tan":{ "bank_id":"String", "account_id":"String" }, "to_sepa":{ "iban":"String" }, "to_counterparty":{ "counterparty_id":"String" }, "to_transfer_to_phone":{ "value":{ "currency":"EUR", "amount":"10" }, "description":"String", "message":"String", "from":{ "mobile_phone_number":"+44 07972 444 876", "nickname":"String" }, "to":{ "mobile_phone_number":"+44 07972 444 876" } }, "to_transfer_to_atm":{ "value":{ "currency":"EUR", "amount":"10" }, "description":"String", "message":"String", "from":{ "mobile_phone_number":"+44 07972 444 876", "nickname":"String" }, "to":{ "legal_name":"Eveline Tripman", "date_of_birth":"20181230", "mobile_phone_number":"+44 07972 444 876", "kyc_document":{ "type":"String", "number":"String" } } }, "to_transfer_to_account":{ "value":{ "currency":"EUR", "amount":"10" }, "description":"String", "transfer_type":"String", "future_date":"20181230", "to":{ "name":"String", "bank_code":"String", "branch_number":"String", "account":{ "number":"String", "iban":"String" } } }, "to_sepa_credit_transfers":{ "debtorAccount":{ "iban":"12345" }, "instructedAmount":{ "currency":"EUR", "amount":"10" }, "creditorAccount":{ "iban":"54321" }, "creditorName":"John Miles" }, "value":{ "currency":"EUR", "amount":"100" }, "description":"String" }, "transaction_ids":["902ba3bb-dedd-45e7-9319-2fd3f2cd98a1"], "status":"COMPLETED", "start_date":"2017-09-18T22:00:00Z", "end_date":"2017-09-18T22:00:00Z", "challenge":{ "id":"be1a183d-b301-4b83-b855-5eeffdd3526f", "allowed_attempts":3, "challenge_type":"SANDBOX_TAN" }, "charge":{ "summary":"Rent the flat", "value":{ "currency":"EUR", "amount":"10" } } }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-30111: Invalid Bank Id. The BANK_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.
  • OBP-30110: Invalid Account Id. The ACCOUNT_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.
  • OBP-10001: Incorrect json format.
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-30003: Account not found. Please specify a valid value for ACCOUNT_ID.
  • OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID
  • OBP-40002: Insufficient authorisation to create TransactionRequest. The Transaction Request could not be created because you don't have access to the owner view of the from account or you don't have access to canCreateAnyTransactionRequest.
  • OBP-20017: Current user does not have access to the view. Please specify a valid value for VIEW_ID.
  • OBP-40001: Invalid value for TRANSACTION_REQUEST_TYPE
  • OBP-10001: Incorrect json format.
  • OBP-10002: Invalid Number. Could not convert value to a number.
  • OBP-40008: Can't send a payment with a value of 0 or less.
  • OBP-40003: Transaction Request Currency must be the same as From Account Currency.
  • OBP-00003: Transaction Requests is disabled in this API instance.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by createTransactionRequestCounterparty, operation_id: OBPv4.0.0-createTransactionRequestCounterparty Tags: Transaction-Request, Payment Initiation Service (PIS), New-Style,

映射(类型->字符串)

映射(类型->字符串)
Typical Successful Response:

								
									
{ "id":"4050046c-63b3-4868-8a22-14b4181d33a6", "type":"SANDBOX_TAN", "from":{ "bank_id":"GENODEM1GLS", "account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0" }, "details":{ "to_sandbox_tan":{ "bank_id":"String", "account_id":"String" }, "to_sepa":{ "iban":"String" }, "to_counterparty":{ "counterparty_id":"String" }, "to_transfer_to_phone":{ "value":{ "currency":"EUR", "amount":"10" }, "description":"String", "message":"String", "from":{ "mobile_phone_number":"+44 07972 444 876", "nickname":"String" }, "to":{ "mobile_phone_number":"+44 07972 444 876" } }, "to_transfer_to_atm":{ "value":{ "currency":"EUR", "amount":"10" }, "description":"String", "message":"String", "from":{ "mobile_phone_number":"+44 07972 444 876", "nickname":"String" }, "to":{ "legal_name":"Eveline Tripman", "date_of_birth":"20181230", "mobile_phone_number":"+44 07972 444 876", "kyc_document":{ "type":"String", "number":"String" } } }, "to_transfer_to_account":{ "value":{ "currency":"EUR", "amount":"10" }, "description":"String", "transfer_type":"String", "future_date":"20181230", "to":{ "name":"String", "bank_code":"String", "branch_number":"String", "account":{ "number":"String", "iban":"String" } } }, "to_sepa_credit_transfers":{ "debtorAccount":{ "iban":"12345" }, "instructedAmount":{ "currency":"EUR", "amount":"10" }, "creditorAccount":{ "iban":"54321" }, "creditorName":"John Miles" }, "value":{ "currency":"EUR", "amount":"100" }, "description":"String" }, "transaction_ids":["902ba3bb-dedd-45e7-9319-2fd3f2cd98a1"], "status":"COMPLETED", "start_date":"2017-09-18T22:00:00Z", "end_date":"2017-09-18T22:00:00Z", "challenge":{ "id":"be1a183d-b301-4b83-b855-5eeffdd3526f", "allowed_attempts":3, "challenge_type":"SANDBOX_TAN" }, "charge":{ "summary":"Rent the flat", "value":{ "currency":"EUR", "amount":"10" } } }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-30111: Invalid Bank Id. The BANK_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.
  • OBP-30110: Invalid Account Id. The ACCOUNT_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.
  • OBP-10001: Incorrect json format.
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-30003: Account not found. Please specify a valid value for ACCOUNT_ID.
  • OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID
  • OBP-40002: Insufficient authorisation to create TransactionRequest. The Transaction Request could not be created because you don't have access to the owner view of the from account or you don't have access to canCreateAnyTransactionRequest.
  • OBP-20017: Current user does not have access to the view. Please specify a valid value for VIEW_ID.
  • OBP-40001: Invalid value for TRANSACTION_REQUEST_TYPE
  • OBP-10001: Incorrect json format.
  • OBP-10002: Invalid Number. Could not convert value to a number.
  • OBP-40008: Can't send a payment with a value of 0 or less.
  • OBP-40003: Transaction Request Currency must be the same as From Account Currency.
  • OBP-00003: Transaction Requests is disabled in this API instance.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by createTransactionRequestAccount, operation_id: OBPv4.0.0-createTransactionRequestAccount Tags: Transaction-Request, Payment Initiation Service (PIS), New-Style,

获取支持的交易请求类型

获取银行支持的交易请求类型列表。

身份验证是可选的

Typical Successful Response:

								
									
{ "transaction_request_types":[{ "transaction_request_type":"SandboxTan" }] }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv2.1.0, function_name: by getTransactionRequestTypesSupportedByBank, operation_id: OBPv2.1.0-getTransactionRequestTypesSupportedByBank Tags: Transaction-Request, Bank,

创建密码重置网址

创建密码重置网址。

身份验证是强制性的

Typical Successful Response:

								
									
{ "reset_password_url":"https://apisandbox.openbankproject.com/user_mgt/reset_password/QOL1CPNJPCZ4BRMPX3Z01DPOX1HMGU3L" }
Required Roles:
  • CanCreateResetPasswordUrl - 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-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by resetPasswordUrl, operation_id: OBPv4.0.0-resetPasswordUrl Tags: User, API, New-Style,

创建用户。

创建OBP用户。
无需授权(当前)。

模仿当前的Webform进行注册。

需要用户名(电子邮件)和密码。

如果用户名不唯一,则返回409错误。

可能需要验证电子邮件地址。

Typical Successful Response:

								
									
{ "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "email":"eveline@example.com", "provider_id":"Chris", "provider":"http://127.0.0.1:8080", "username":"felixsmith", "entitlements":{ "list":[{ "entitlement_id":"6fb17583-1e49-4435-bb74-a14fe0996723", "role_name":"CanQueryOtherUser", "bank_id":"GENODEM1GLS" }] } }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-10001: Incorrect json format.
  • OBP-30207: Invalid Password Format. Your password should EITHER be at least 10 characters long and contain mixed numbers and both upper and lower case letters and at least one special character, OR be longer than 16 characters.
  • Error occurred during user creation.
  • User with the same username already exists.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv2.0.0, function_name: by createUser, operation_id: OBPv2.0.0-createUser Tags: User, Onboarding,

创建用户身份验证上下文

创建用户身份验证上下文。这些键值对将通过连接器传播到适配器。通常用于映射OBP用户和
银行用户/客户。
身份验证是强制性的

Typical Successful Response:

								
									
{ "user_auth_context_id":"613c83ea-80f9-4560-8404-b9cd4ec42a7f", "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "key":"CUSTOMER_NUMBER", "value":"78987432" }
Required Roles:
  • CanCreateUserAuthContext - 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-10001: Incorrect json format.
  • OBP-30053: Could not insert the UserAuthContext
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.1.0, function_name: by createUserAuthContext, operation_id: OBPv3.1.0-createUserAuthContext Tags: User, New-Style,

创建用户身份验证上下文更新

创建用户身份验证上下文更新。
身份验证是强制性的

通过SCA_METHOD中定义的传输,将一次性密码(OTP)(又称为安全性挑战)发送给用户(OOB)
SCA_METHOD通常是“ SMS”或“ EMAIL”。 “ EMAIL”用于测试目的。

Typical Successful Response:

								
									
{ "user_auth_context_update_id":"613c83ea-80f9-4560-8404-b9cd4ec42a7f", "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "key":"CUSTOMER_NUMBER", "value":"78987432", "status":"INITIATED" }
Required Roles:
  • CanCreateUserAuthContextUpdate - 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-10001: Incorrect json format.
  • OBP-30053: Could not insert the UserAuthContext
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.1.0, function_name: by createUserAuthContextUpdate, operation_id: OBPv3.1.0-createUserAuthContextUpdate Tags: User, New-Style,

删除用户的身份验证上下文

删除由USER_ID指定的用户的身份验证上下文。

身份验证是强制性的

Typical Successful Response:

								
									
{ "jsonString":"{}" }
Required Roles:
  • CanDeleteUserAuthContext - 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.1.0, function_name: by deleteUserAuthContexts, operation_id: OBPv3.1.0-deleteUserAuthContexts Tags: User, New-Style,

删除用户身份验证上下文

删除由USER_AUTH_CONTEXT_ID指定的用户的用户AuthContext。

身份验证是强制性的

Typical Successful Response:

								
									
{ "jsonString":"{}" }
Required Roles:
  • CanDeleteUserAuthContext - 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.1.0, function_name: by deleteUserAuthContextById, operation_id: OBPv3.1.0-deleteUserAuthContextById Tags: User, New-Style,

刷新用户。

端点用于更新用户的帐户,视图,帐户所有者。
至于Json主体,可以将其保留为空。
该调用将从后端获取数据,无需在api端准备json主体。

身份验证是强制性的

Typical Successful Response:

								
									
{ "duration_time":"10 ms" }
Required Roles:
  • CanRefreshUser - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.1.0, function_name: by refreshUser, operation_id: OBPv3.1.0-refreshUser Tags: User, New-Style,

回答身份验证上下文更新挑战

回答身份验证上下文更新挑战。

Typical Successful Response:

								
									
{ "user_auth_context_update_id":"613c83ea-80f9-4560-8404-b9cd4ec42a7f", "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "key":"CUSTOMER_NUMBER", "value":"78987432", "status":"INITIATED" }
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-50200: Connector cannot return the data we requested.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.1.0, function_name: by answerUserAuthContextUpdateChallenge, operation_id: OBPv3.1.0-answerUserAuthContextUpdateChallenge Tags: User, New-Style,

获取所有用户

获取所有用户

身份验证是强制性的

必须具有CanGetAnyUser授权,

Typical Successful Response:

								
									
{ "users":[{ "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "email":"eveline@example.com", "provider_id":"Chris", "provider":"http://127.0.0.1:8080", "username":"felixsmith", "entitlements":{ "list":[{ "entitlement_id":"6fb17583-1e49-4435-bb74-a14fe0996723", "role_name":"CanQueryOtherUser", "bank_id":"GENODEM1GLS" }] } }] }
Required Roles:
  • CanGetAnyUser - 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 getUsers, operation_id: OBPv3.0.0-getUsers Tags: User, New-Style,

获取用户身份验证上下文

获取用户的用户身份验证上下文。

身份验证是强制性的

Typical Successful Response:

								
									
{ "user_auth_contexts":[{ "user_auth_context_id":"613c83ea-80f9-4560-8404-b9cd4ec42a7f", "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "key":"CUSTOMER_NUMBER", "value":"78987432" }] }
Required Roles:
  • CanGetUserAuthContext - 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-30053: Could not insert the UserAuthContext
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.1.0, function_name: by getUserAuthContexts, operation_id: OBPv3.1.0-getUserAuthContexts Tags: User, New-Style,

获取用户锁定状态

获取用户登录状态。
身份验证是强制性的

Typical Successful Response:

								
									
{ "username":"felixsmith", "bad_attempts_since_last_success_or_reset":0, "last_failure_date":"2017-09-18T22:00:00Z" }
Required Roles:
  • CanReadUserLockedStatus - 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-20027: User not found by username.
  • OBP-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.1.0, function_name: by getBadLoginStatus, operation_id: OBPv3.1.0-getBadLoginStatus Tags: User, New-Style,

获取用户(当前)

获取登录用户

身份验证是强制性的

Typical Successful Response:

								
									
{ "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "email":"eveline@example.com", "provider_id":"Chris", "provider":"http://127.0.0.1:8080", "username":"felixsmith", "entitlements":{ "list":[{ "entitlement_id":"6fb17583-1e49-4435-bb74-a14fe0996723", "role_name":"CanQueryOtherUser", "bank_id":"GENODEM1GLS" }] } }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.0.0, function_name: by getCurrentUser, operation_id: OBPv3.0.0-getCurrentUser Tags: User, New-Style,

解锁用户

解锁用户。

(也许由于多次登录尝试失败,用户已被锁定)

身份验证是强制性的

Typical Successful Response:

								
									
{ "username":"felixsmith", "bad_attempts_since_last_success_or_reset":0, "last_failure_date":"2017-09-18T22:00:00Z" }
Required Roles:
  • CanUnlockUser - 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-20027: User not found by username.
  • OBP-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.1.0, function_name: by unlockUser, operation_id: OBPv3.1.0-unlockUser Tags: User, New-Style,

通过USERNAME获取用户

通过USERNAME获取用户

身份验证是强制性的

必须具有CanGetAnyUser授权,

Typical Successful Response:

								
									
{ "users":[{ "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "email":"eveline@example.com", "provider_id":"Chris", "provider":"http://127.0.0.1:8080", "username":"felixsmith", "entitlements":{ "list":[{ "entitlement_id":"6fb17583-1e49-4435-bb74-a14fe0996723", "role_name":"CanQueryOtherUser", "bank_id":"GENODEM1GLS" }] } }] }
Required Roles:
  • CanGetAnyUser - 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-20027: User not found by username.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.0.0, function_name: by getUserByUsername, operation_id: OBPv3.0.0-getUserByUsername Tags: User, New-Style,

通过USER_ID获取用户

通过USER_ID获取用户

身份验证是强制性的
必须具有CanGetAnyUser授权,

Typical Successful Response:

								
									
{ "users":[{ "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "email":"eveline@example.com", "provider_id":"Chris", "provider":"http://127.0.0.1:8080", "username":"felixsmith", "entitlements":{ "list":[{ "entitlement_id":"6fb17583-1e49-4435-bb74-a14fe0996723", "role_name":"CanQueryOtherUser", "bank_id":"GENODEM1GLS" }] } }] }
Required Roles:
  • CanGetAnyUser - 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-20005: User not found. Please specify a valid value for USER_ID.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.0.0, function_name: by getUserByUserId, operation_id: OBPv3.0.0-getUserByUserId Tags: User, New-Style,

通过电子邮件地址获取用户

通过电子邮件地址获取用户

身份验证是强制性的
必须具有CanGetAnyUser授权,

Typical Successful Response:

								
									
{ "users":[{ "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "email":"eveline@example.com", "provider_id":"Chris", "provider":"http://127.0.0.1:8080", "username":"felixsmith", "entitlements":{ "list":[{ "entitlement_id":"6fb17583-1e49-4435-bb74-a14fe0996723", "role_name":"CanQueryOtherUser", "bank_id":"GENODEM1GLS" }] } }] }
Required Roles:
  • CanGetAnyUser - 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-20007: User not found by email.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.0.0, function_name: by getUser, operation_id: OBPv3.0.0-getUser Tags: User, New-Style,

创建视图。

映射(类型->字符串)
Typical Successful Response:

								
									
{ "id":"1234", "short_name":"short_name", "description":"description", "metadata_view":"owner", "is_public":true, "alias":"No", "hide_metadata_if_alias_used":true, "can_add_comment":true, "can_add_corporate_location":true, "can_add_image":true, "can_add_image_url":true, "can_add_more_info":true, "can_add_open_corporates_url":true, "can_add_physical_location":true, "can_add_private_alias":true, "can_add_public_alias":true, "can_add_tag":true, "can_add_url":true, "can_add_where_tag":true, "can_delete_comment":true, "can_add_counterparty":true, "can_delete_corporate_location":true, "can_delete_image":true, "can_delete_physical_location":true, "can_delete_tag":true, "can_delete_where_tag":true, "can_edit_owner_comment":true, "can_see_bank_account_balance":true, "can_query_available_funds":true, "can_see_bank_account_bank_name":true, "can_see_bank_account_currency":true, "can_see_bank_account_iban":true, "can_see_bank_account_label":true, "can_see_bank_account_national_identifier":true, "can_see_bank_account_number":true, "can_see_bank_account_owners":true, "can_see_bank_account_swift_bic":true, "can_see_bank_account_type":true, "can_see_comments":true, "can_see_corporate_location":true, "can_see_image_url":true, "can_see_images":true, "can_see_more_info":true, "can_see_open_corporates_url":true, "can_see_other_account_bank_name":true, "can_see_other_account_iban":true, "can_see_other_account_kind":true, "can_see_other_account_metadata":true, "can_see_other_account_national_identifier":true, "can_see_other_account_number":true, "can_see_other_account_swift_bic":true, "can_see_owner_comment":true, "can_see_physical_location":true, "can_see_private_alias":true, "can_see_public_alias":true, "can_see_tags":true, "can_see_transaction_amount":true, "can_see_transaction_balance":true, "can_see_transaction_currency":true, "can_see_transaction_description":true, "can_see_transaction_finish_date":true, "can_see_transaction_metadata":true, "can_see_transaction_other_bank_account":true, "can_see_transaction_start_date":true, "can_see_transaction_this_bank_account":true, "can_see_transaction_type":true, "can_see_url":true, "can_see_where_tag":true, "can_see_bank_routing_scheme":true, "can_see_bank_routing_address":true, "can_see_bank_account_routing_scheme":true, "can_see_bank_account_routing_address":true, "can_see_other_bank_routing_scheme":true, "can_see_other_bank_routing_address":true, "can_see_other_account_routing_scheme":true, "can_see_other_account_routing_address":true, "can_add_transaction_request_to_own_account":true, "can_add_transaction_request_to_any_account":true, "can_see_bank_account_credit_limit":true, "can_create_direct_debit":true, "can_create_standing_order":true }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-10001: Incorrect json format.
  • OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.0.0, function_name: by createViewForBankAccount, operation_id: OBPv3.0.0-createViewForBankAccount Tags: View, Account, New-Style,

删除检视

删除银行BANK_ID上ACCOUNT_ID指定的银行帐户上VIEW_ID指定的视图。

Typical Successful Response:

								
									
{ "jsonString":"{}" }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • 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-50000: Unknown Error.
  • user does not have owner access
Connector Methods:
Version: OBPv1.2.1, function_name: by deleteViewForBankAccount, operation_id: OBPv1.2.1-deleteViewForBankAccount Tags: View, Account,

授予用户访问视图列表的权限。

映射(类型->字符串)
Typical Successful Response:

								
									
{ "views":[{ "id":"123", "short_name":"short_name", "description":"description", "is_public":true, "alias":"None", "hide_metadata_if_alias_used":true, "can_add_comment":true, "can_add_corporate_location":true, "can_add_image":true, "can_add_image_url":true, "can_add_more_info":true, "can_add_open_corporates_url":true, "can_add_physical_location":true, "can_add_private_alias":true, "can_add_public_alias":true, "can_add_tag":true, "can_add_url":true, "can_add_where_tag":true, "can_delete_comment":true, "can_delete_corporate_location":true, "can_delete_image":true, "can_delete_physical_location":true, "can_delete_tag":true, "can_delete_where_tag":true, "can_edit_owner_comment":true, "can_see_bank_account_balance":true, "can_see_bank_account_bank_name":true, "can_see_bank_account_currency":true, "can_see_bank_account_iban":true, "can_see_bank_account_label":true, "can_see_bank_account_national_identifier":true, "can_see_bank_account_number":true, "can_see_bank_account_owners":true, "can_see_bank_account_swift_bic":true, "can_see_bank_account_type":true, "can_see_comments":true, "can_see_corporate_location":true, "can_see_image_url":true, "can_see_images":true, "can_see_more_info":true, "can_see_open_corporates_url":true, "can_see_other_account_bank_name":true, "can_see_other_account_iban":true, "can_see_other_account_kind":true, "can_see_other_account_metadata":true, "can_see_other_account_national_identifier":true, "can_see_other_account_number":true, "can_see_other_account_swift_bic":true, "can_see_owner_comment":true, "can_see_physical_location":true, "can_see_private_alias":true, "can_see_public_alias":true, "can_see_tags":true, "can_see_transaction_amount":true, "can_see_transaction_balance":true, "can_see_transaction_currency":true, "can_see_transaction_description":true, "can_see_transaction_finish_date":true, "can_see_transaction_metadata":true, "can_see_transaction_other_bank_account":true, "can_see_transaction_start_date":true, "can_see_transaction_this_bank_account":true, "can_see_transaction_type":true, "can_see_url":true, "can_see_where_tag":true }] }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • 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-50000: Unknown Error.
  • wrong format JSON
  • could not save the privilege
  • user does not have access to owner view on account
Connector Methods:
Version: OBPv1.2.1, function_name: by addPermissionForUserForBankAccountForMultipleViews, operation_id: OBPv1.2.1-addPermissionForUserForBankAccountForMultipleViews Tags: View, Account, User, OwnerViewRequired,

授予用户访问视图的权限。

映射(类型->字符串)
Typical Successful Response:

								
									
{ "id":"123", "short_name":"short_name", "description":"description", "is_public":true, "alias":"None", "hide_metadata_if_alias_used":true, "can_add_comment":true, "can_add_corporate_location":true, "can_add_image":true, "can_add_image_url":true, "can_add_more_info":true, "can_add_open_corporates_url":true, "can_add_physical_location":true, "can_add_private_alias":true, "can_add_public_alias":true, "can_add_tag":true, "can_add_url":true, "can_add_where_tag":true, "can_delete_comment":true, "can_delete_corporate_location":true, "can_delete_image":true, "can_delete_physical_location":true, "can_delete_tag":true, "can_delete_where_tag":true, "can_edit_owner_comment":true, "can_see_bank_account_balance":true, "can_see_bank_account_bank_name":true, "can_see_bank_account_currency":true, "can_see_bank_account_iban":true, "can_see_bank_account_label":true, "can_see_bank_account_national_identifier":true, "can_see_bank_account_number":true, "can_see_bank_account_owners":true, "can_see_bank_account_swift_bic":true, "can_see_bank_account_type":true, "can_see_comments":true, "can_see_corporate_location":true, "can_see_image_url":true, "can_see_images":true, "can_see_more_info":true, "can_see_open_corporates_url":true, "can_see_other_account_bank_name":true, "can_see_other_account_iban":true, "can_see_other_account_kind":true, "can_see_other_account_metadata":true, "can_see_other_account_national_identifier":true, "can_see_other_account_number":true, "can_see_other_account_swift_bic":true, "can_see_owner_comment":true, "can_see_physical_location":true, "can_see_private_alias":true, "can_see_public_alias":true, "can_see_tags":true, "can_see_transaction_amount":true, "can_see_transaction_balance":true, "can_see_transaction_currency":true, "can_see_transaction_description":true, "can_see_transaction_finish_date":true, "can_see_transaction_metadata":true, "can_see_transaction_other_bank_account":true, "can_see_transaction_start_date":true, "can_see_transaction_this_bank_account":true, "can_see_transaction_type":true, "can_see_url":true, "can_see_where_tag":true }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • 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-50000: Unknown Error.
  • could not save the privilege
  • user does not have access to owner view on account
Connector Methods:
Version: OBPv1.2.1, function_name: by addPermissionForUserForBankAccountForOneView, operation_id: OBPv1.2.1-addPermissionForUserForBankAccountForOneView Tags: View, Account, User, OwnerViewRequired,

撤消对一个视图的访问。

撤消对特定用户的帐户视图的访问权限。

用户在其PROVIDER处由PROVIDER_ID标识。

该帐户由BANK_ID和ACCOUNT_ID指定。

视图由VIEW_ID指定。

提供者(可能是URL)必须经过URL编码。

PROVIDER_ID通常等效于USERNAME。但是,请参阅“按ID获取用户”或“获取当前用户”以获取提供者信息。

尝试撤消对公共视图的访问将返回错误消息。

除非至少一个其他用户具有所有者视图访问权限,否则帐户所有者不能撤消对所有者视图的访问权限。

身份验证是强制性的,用户需要有权访问所有者视图。

Typical Successful Response:

								
									
{ "jsonString":"{}" }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • 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.
  • could not save the privilege
  • user does not have access to owner view on account
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv1.2.1, function_name: by removePermissionForUserForBankAccountForOneView, operation_id: OBPv1.2.1-removePermissionForUserForBankAccountForOneView Tags: View, Account, User, Entitlement, OwnerViewRequired,

撤消对帐户中所有视图的访问权限

“撤销对某个用户帐户中所有视图的访问权限。

用户在其PROVIDER处由PROVIDER_ID标识。

该帐户由BANK_ID和ACCOUNT_ID指定。

视图由VIEW_ID指定。

提供者(可能是URL)必须经过URL编码。

PROVIDER_ID通常等效于USERNAME。但是,请参阅“按ID获取用户”或“获取当前用户”以获取提供者信息。

尝试撤消对公共视图的访问将返回错误消息。

除非至少一个其他用户具有所有者视图访问权限,否则帐户所有者不能撤消对所有者视图的访问权限。

身份验证是强制性的,用户需要有权访问所有者视图。

Typical Successful Response:

								
									
{ "jsonString":"{}" }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • 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-50000: Unknown Error.
  • user does not have access to owner view on account
Connector Methods:
Version: OBPv1.2.1, function_name: by removePermissionForUserForBankAccountForAllViews, operation_id: OBPv1.2.1-removePermissionForUserForBankAccountForAllViews Tags: View, Account, User, OwnerViewRequired,

更新视图。

映射(类型->字符串)
Typical Successful Response:

								
									
{ "id":"1234", "short_name":"short_name", "description":"description", "metadata_view":"owner", "is_public":true, "alias":"No", "hide_metadata_if_alias_used":true, "can_add_comment":true, "can_add_corporate_location":true, "can_add_image":true, "can_add_image_url":true, "can_add_more_info":true, "can_add_open_corporates_url":true, "can_add_physical_location":true, "can_add_private_alias":true, "can_add_public_alias":true, "can_add_tag":true, "can_add_url":true, "can_add_where_tag":true, "can_delete_comment":true, "can_add_counterparty":true, "can_delete_corporate_location":true, "can_delete_image":true, "can_delete_physical_location":true, "can_delete_tag":true, "can_delete_where_tag":true, "can_edit_owner_comment":true, "can_see_bank_account_balance":true, "can_query_available_funds":true, "can_see_bank_account_bank_name":true, "can_see_bank_account_currency":true, "can_see_bank_account_iban":true, "can_see_bank_account_label":true, "can_see_bank_account_national_identifier":true, "can_see_bank_account_number":true, "can_see_bank_account_owners":true, "can_see_bank_account_swift_bic":true, "can_see_bank_account_type":true, "can_see_comments":true, "can_see_corporate_location":true, "can_see_image_url":true, "can_see_images":true, "can_see_more_info":true, "can_see_open_corporates_url":true, "can_see_other_account_bank_name":true, "can_see_other_account_iban":true, "can_see_other_account_kind":true, "can_see_other_account_metadata":true, "can_see_other_account_national_identifier":true, "can_see_other_account_number":true, "can_see_other_account_swift_bic":true, "can_see_owner_comment":true, "can_see_physical_location":true, "can_see_private_alias":true, "can_see_public_alias":true, "can_see_tags":true, "can_see_transaction_amount":true, "can_see_transaction_balance":true, "can_see_transaction_currency":true, "can_see_transaction_description":true, "can_see_transaction_finish_date":true, "can_see_transaction_metadata":true, "can_see_transaction_other_bank_account":true, "can_see_transaction_start_date":true, "can_see_transaction_this_bank_account":true, "can_see_transaction_type":true, "can_see_url":true, "can_see_where_tag":true, "can_see_bank_routing_scheme":true, "can_see_bank_routing_address":true, "can_see_bank_account_routing_scheme":true, "can_see_bank_account_routing_address":true, "can_see_other_bank_routing_scheme":true, "can_see_other_bank_routing_address":true, "can_see_other_account_routing_scheme":true, "can_see_other_account_routing_address":true, "can_add_transaction_request_to_own_account":true, "can_add_transaction_request_to_any_account":true, "can_see_bank_account_credit_limit":true, "can_create_direct_debit":true, "can_create_standing_order":true }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-10001: Incorrect json format.
  • 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-50000: Unknown Error.
Connector Methods:
Version: OBPv3.0.0, function_name: by updateViewForBankAccount, operation_id: OBPv3.0.0-updateViewForBankAccount Tags: View, Account, New-Style,

获取帐户视图。

映射(类型->字符串)
Typical Successful Response:

								
									
{ "views":[{ "id":"1234", "short_name":"short_name", "description":"description", "metadata_view":"owner", "is_public":true, "alias":"No", "hide_metadata_if_alias_used":true, "can_add_comment":true, "can_add_corporate_location":true, "can_add_image":true, "can_add_image_url":true, "can_add_more_info":true, "can_add_open_corporates_url":true, "can_add_physical_location":true, "can_add_private_alias":true, "can_add_public_alias":true, "can_add_tag":true, "can_add_url":true, "can_add_where_tag":true, "can_delete_comment":true, "can_add_counterparty":true, "can_delete_corporate_location":true, "can_delete_image":true, "can_delete_physical_location":true, "can_delete_tag":true, "can_delete_where_tag":true, "can_edit_owner_comment":true, "can_see_bank_account_balance":true, "can_query_available_funds":true, "can_see_bank_account_bank_name":true, "can_see_bank_account_currency":true, "can_see_bank_account_iban":true, "can_see_bank_account_label":true, "can_see_bank_account_national_identifier":true, "can_see_bank_account_number":true, "can_see_bank_account_owners":true, "can_see_bank_account_swift_bic":true, "can_see_bank_account_type":true, "can_see_comments":true, "can_see_corporate_location":true, "can_see_image_url":true, "can_see_images":true, "can_see_more_info":true, "can_see_open_corporates_url":true, "can_see_other_account_bank_name":true, "can_see_other_account_iban":true, "can_see_other_account_kind":true, "can_see_other_account_metadata":true, "can_see_other_account_national_identifier":true, "can_see_other_account_number":true, "can_see_other_account_swift_bic":true, "can_see_owner_comment":true, "can_see_physical_location":true, "can_see_private_alias":true, "can_see_public_alias":true, "can_see_tags":true, "can_see_transaction_amount":true, "can_see_transaction_balance":true, "can_see_transaction_currency":true, "can_see_transaction_description":true, "can_see_transaction_finish_date":true, "can_see_transaction_metadata":true, "can_see_transaction_other_bank_account":true, "can_see_transaction_start_date":true, "can_see_transaction_this_bank_account":true, "can_see_transaction_type":true, "can_see_url":true, "can_see_where_tag":true, "can_see_bank_routing_scheme":true, "can_see_bank_routing_address":true, "can_see_bank_account_routing_scheme":true, "can_see_bank_account_routing_address":true, "can_see_other_bank_routing_scheme":true, "can_see_other_bank_routing_address":true, "can_see_other_account_routing_scheme":true, "can_see_other_account_routing_address":true, "can_add_transaction_request_to_own_account":true, "can_add_transaction_request_to_any_account":true, "can_see_bank_account_credit_limit":true, "can_create_direct_debit":true, "can_create_standing_order":true }] }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • 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-50000: Unknown Error.
Connector Methods:
Version: OBPv3.0.0, function_name: by getViewsForBankAccount, operation_id: OBPv3.0.0-getViewsForBankAccount Tags: View, Account, New-Style,

获取用户的帐户访问权限。

映射(类型->字符串)
Typical Successful Response:

								
									
{ "views":[{ "id":"1234", "short_name":"short_name", "description":"description", "metadata_view":"owner", "is_public":true, "alias":"No", "hide_metadata_if_alias_used":true, "can_add_comment":true, "can_add_corporate_location":true, "can_add_image":true, "can_add_image_url":true, "can_add_more_info":true, "can_add_open_corporates_url":true, "can_add_physical_location":true, "can_add_private_alias":true, "can_add_public_alias":true, "can_add_tag":true, "can_add_url":true, "can_add_where_tag":true, "can_delete_comment":true, "can_add_counterparty":true, "can_delete_corporate_location":true, "can_delete_image":true, "can_delete_physical_location":true, "can_delete_tag":true, "can_delete_where_tag":true, "can_edit_owner_comment":true, "can_see_bank_account_balance":true, "can_query_available_funds":true, "can_see_bank_account_bank_name":true, "can_see_bank_account_currency":true, "can_see_bank_account_iban":true, "can_see_bank_account_label":true, "can_see_bank_account_national_identifier":true, "can_see_bank_account_number":true, "can_see_bank_account_owners":true, "can_see_bank_account_swift_bic":true, "can_see_bank_account_type":true, "can_see_comments":true, "can_see_corporate_location":true, "can_see_image_url":true, "can_see_images":true, "can_see_more_info":true, "can_see_open_corporates_url":true, "can_see_other_account_bank_name":true, "can_see_other_account_iban":true, "can_see_other_account_kind":true, "can_see_other_account_metadata":true, "can_see_other_account_national_identifier":true, "can_see_other_account_number":true, "can_see_other_account_swift_bic":true, "can_see_owner_comment":true, "can_see_physical_location":true, "can_see_private_alias":true, "can_see_public_alias":true, "can_see_tags":true, "can_see_transaction_amount":true, "can_see_transaction_balance":true, "can_see_transaction_currency":true, "can_see_transaction_description":true, "can_see_transaction_finish_date":true, "can_see_transaction_metadata":true, "can_see_transaction_other_bank_account":true, "can_see_transaction_start_date":true, "can_see_transaction_this_bank_account":true, "can_see_transaction_type":true, "can_see_url":true, "can_see_where_tag":true, "can_see_bank_routing_scheme":true, "can_see_bank_routing_address":true, "can_see_bank_account_routing_scheme":true, "can_see_bank_account_routing_address":true, "can_see_other_bank_routing_scheme":true, "can_see_other_bank_routing_address":true, "can_see_other_account_routing_scheme":true, "can_see_other_account_routing_address":true, "can_add_transaction_request_to_own_account":true, "can_add_transaction_request_to_any_account":true, "can_see_bank_account_credit_limit":true, "can_create_direct_debit":true, "can_create_standing_order":true }] }
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-30003: Account not found. Please specify a valid value for ACCOUNT_ID.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.0.0, function_name: by getPermissionForUserForBankAccount, operation_id: OBPv3.0.0-getPermissionForUserForBankAccount Tags: View, Account, User, New-Style,

获得访问权限。

映射(类型->字符串)
Typical Successful Response:

								
									
{ "permissions":[{ "user":{ "id":"5995d6a2-01b3-423c-a173-5481df49bdaf", "provider":"http://127.0.0.1:8080", "display_name":"OBP" }, "views":[{ "id":"123", "short_name":"short_name", "description":"description", "is_public":true, "alias":"None", "hide_metadata_if_alias_used":true, "can_add_comment":true, "can_add_corporate_location":true, "can_add_image":true, "can_add_image_url":true, "can_add_more_info":true, "can_add_open_corporates_url":true, "can_add_physical_location":true, "can_add_private_alias":true, "can_add_public_alias":true, "can_add_tag":true, "can_add_url":true, "can_add_where_tag":true, "can_delete_comment":true, "can_delete_corporate_location":true, "can_delete_image":true, "can_delete_physical_location":true, "can_delete_tag":true, "can_delete_where_tag":true, "can_edit_owner_comment":true, "can_see_bank_account_balance":true, "can_see_bank_account_bank_name":true, "can_see_bank_account_currency":true, "can_see_bank_account_iban":true, "can_see_bank_account_label":true, "can_see_bank_account_national_identifier":true, "can_see_bank_account_number":true, "can_see_bank_account_owners":true, "can_see_bank_account_swift_bic":true, "can_see_bank_account_type":true, "can_see_comments":true, "can_see_corporate_location":true, "can_see_image_url":true, "can_see_images":true, "can_see_more_info":true, "can_see_open_corporates_url":true, "can_see_other_account_bank_name":true, "can_see_other_account_iban":true, "can_see_other_account_kind":true, "can_see_other_account_metadata":true, "can_see_other_account_national_identifier":true, "can_see_other_account_number":true, "can_see_other_account_swift_bic":true, "can_see_owner_comment":true, "can_see_physical_location":true, "can_see_private_alias":true, "can_see_public_alias":true, "can_see_tags":true, "can_see_transaction_amount":true, "can_see_transaction_balance":true, "can_see_transaction_currency":true, "can_see_transaction_description":true, "can_see_transaction_finish_date":true, "can_see_transaction_metadata":true, "can_see_transaction_other_bank_account":true, "can_see_transaction_start_date":true, "can_see_transaction_this_bank_account":true, "can_see_transaction_type":true, "can_see_url":true, "can_see_where_tag":true }] }] }
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-30003: Account not found. Please specify a valid value for ACCOUNT_ID.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv2.0.0, function_name: by getPermissionsForBankAccount, operation_id: OBPv2.0.0-getPermissionsForBankAccount Tags: View, Account, User, Entitlement,

删除WebUiProps

删除由WEB_UI_PROPS_ID指定的WebUiProps。

身份验证是强制性的

Typical Successful Response:

								
									
{ "jsonString":"{}" }
Required Roles:
  • CanDeleteWebUiProps - 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.1.0, function_name: by deleteWebUiProps, operation_id: OBPv3.1.0-deleteWebUiProps Tags: WebUi-Props, API, New-Style,

添加WebUiProps

添加一个WebUiProps。

身份验证是强制性的

领域解释:

  • 名称为必填字符串值
  • 值是必需的字符串值

换行符和双引号应该可以转义,例如:

 {"name": "webui_some", "value": "this value have "line break" and double quotations."} 

应该这样逃避:

 {"name": "webui_some", "value": "this value\nhave \"line break\" and double quotations."} 

插入图片示例:

 // set width=100 and height=50 {"name": "webui_some_pic", "value": "here is a picture <img alt="hello" src="http://somedomain.com/images/pic.png" width="100" height="50" />"} // only set height=50 {"name": "webui_some_pic", "value": "here is a picture <img alt="hello" src="http://somedomain.com/images/pic.png" width="" height="50" />"} // only width=20% {"name": "webui_some_pic", "value": "here is a picture <img alt="hello" src="http://somedomain.com/images/pic.png" width="20%" height="" />"} 
Typical Successful Response:

								
									
{ "name":"webui_api_explorer_url", "value":"https://apiexplorer.openbankproject.com", "web_ui_props_id":"some-web-ui-props-id" }
Required Roles:
  • CanCreateWebUiProps - 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-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.1.0, function_name: by createWebUiProps, operation_id: OBPv3.1.0-createWebUiProps Tags: WebUi-Props, API, New-Style,

获取WebUiProps

获取所有WebUiProps键值,带有“ webui_”的那些props键可以存储在DB中,此端点从DB获取所有。

网址查询参数:
active:必须为布尔字符串。如果active = true,它将显示
显式(插入)+隐式(默认)method_routings的组合。

例如:
http:// localhost:8080 / obp / v3.1.0 / management / webui_props
http:// localhost:8080 / obp / v3.1.0 / management / webui_props?active = true

Typical Successful Response:

								
									
{ "webui_props":[{ "name":"webui_api_explorer_url", "value":"https://apiexplorer.openbankproject.com", "web_ui_props_id":"web-ui-props-id" }] }
Required Roles:
  • CanGetWebUiProps - 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.1.0, function_name: by getWebUiProps, operation_id: OBPv3.1.0-getWebUiProps Tags: WebUi-Props, API, New-Style,

创建一个帐户Webhook

创建一个帐户Webhook

当某些事件发生时,Webhooks用于调用外部URL。

帐户Webhooks专注于帐户事件。

例如,如果帐户中的余额发生变化,则可以使用Webhook通知外部服务。

此功能正在开发中!请注意,只有实现的触发器是:OnBalanceChange

Typical Successful Response:

								
									
{ "account_webhook_id":"613c83ea-80f9-4560-8404-b9cd4ec42a7f", "bank_id":"GENODEM1GLS", "account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "trigger_name":"OnBalanceChange", "url":"https://localhost.openbankproject.com", "http_method":"POST", "http_protocol":"HTTP/1.1", "created_by_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "is_active":true }
Required Roles:
  • CanCreateWebhook - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.1.0, function_name: by createAccountWebhook, operation_id: OBPv3.1.0-createAccountWebhook Tags: Webhook, Bank, New-Style,

启用/禁用帐户Webhook

启用/禁用帐户Webhook

当某些事件发生时,Webhooks用于调用外部URL。

帐户Webhooks专注于帐户事件。

例如,如果帐户中的余额发生变化,则可以使用Webhook通知外部服务。

此功能正在开发中!请注意,只有实现的触发器是:OnBalanceChange

Typical Successful Response:

								
									
{ "account_webhook_id":"613c83ea-80f9-4560-8404-b9cd4ec42a7f", "bank_id":"GENODEM1GLS", "account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "trigger_name":"OnBalanceChange", "url":"https://localhost.openbankproject.com", "http_method":"POST", "http_protocol":"HTTP/1.1", "created_by_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "is_active":true }
Required Roles:
  • CanUpdateWebhook - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.1.0, function_name: by enableDisableAccountWebhook, operation_id: OBPv3.1.0-enableDisableAccountWebhook Tags: Webhook, Bank, New-Style,

获取帐户Webhook

获取帐户Webhooks。

用于分页的可能的自定义URL参数:

  • 限制= NUM​​BER
  • 偏移量= NUM​​BER
  • account_id = STRING
  • user_id = STRING
Typical Successful Response:

								
									
{ "web_hooks":[{ "account_webhook_id":"613c83ea-80f9-4560-8404-b9cd4ec42a7f", "bank_id":"GENODEM1GLS", "account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "trigger_name":"OnBalanceChange", "url":"https://localhost.openbankproject.com", "http_method":"POST", "http_protocol":"HTTP/1.1", "created_by_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "is_active":true }] }
Required Roles:
  • CanGetWebhooks - 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.1.0, function_name: by getAccountWebhooks, operation_id: OBPv3.1.0-getAccountWebhooks Tags: Webhook, Bank, New-Style,