right logo image
right logo image
Log on
⯆

API Explorer

Log off

v5.1.0 (267 APIs)

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

创建一个帐户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,