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