openbankproject_client.webhook module

Webhook endpoints for the OpenBankProject API Client.

class openbankproject_client.webhook.WebhookEndpoints(client)[source]

Bases: object

Webhook-related API endpoints.

__init__(client)[source]

Initialize the endpoint group.

Parameters:

client – OpenBankProjectClient instance

create_account_webhook(bank_id: str, account_id: str, data: Dict) → Dict[source]

Create an Account Webhook.

Parameters:

  • bank_id – Bank identifier

  • account_id – Account identifier

  • data – Webhook data

Returns:

Dict containing created webhook information

create_bank_account_notification_webhook(bank_id: str, data: Dict) → Dict[source]

Create bank level Account Notification Webhook.

Parameters:

  • bank_id – Bank identifier

  • data – Webhook data

Returns:

Dict containing created webhook information

create_system_account_notification_webhook(data: Dict) → Dict[source]

Create system level Account Notification Webhook.

Parameters:

data – Webhook data

Returns:

Dict containing created webhook information

enable_disable_account_webhook(bank_id: str, account_id: str, webhook_id: str, data: Dict) → Dict[source]

Enable/Disable an Account Webhook.

Parameters:

  • bank_id – Bank identifier

  • account_id – Account identifier

  • webhook_id – Webhook identifier

  • data – Enable/disable data

Returns:

Dict containing updated webhook information

get_account_webhooks(bank_id: str, account_id: str) → Dict[source]

Get Account Webhooks.

Parameters:

  • bank_id – Bank identifier

  • account_id – Account identifier

Returns:

Dict containing webhooks information