Welcome to OpenBankProject Client Documentation

This library provides a Python client for interacting with the OpenBankProject API. It supports various authentication methods and provides a comprehensive set of features for working with banks, accounts, transactions, and more.

Contents:

• Installation
  • Requirements
  • Optional Dependencies
  • Development Installation
• Quickstart Guide
  • Basic Usage
  • Authentication
  • Working with Accounts
  • Working with Transactions
  • Error Handling
• Authentication
  • OAuth1 Authentication
  • Getting Consumer Keys
  • Security Best Practices
  • Example with Environment Variables
  • Error Handling
• API Reference
  • Core Modules
  • Account Management
  • Bank Management
  • Transaction Management
  • Customer Management
  • API Management
  • User Management
  • Additional Features

Core Components

• openbankproject_client.client module
  • OpenBankProjectClient
• openbankproject_client.auth module
  • DirectLoginAuth
  • GatewayLoginAuth
  • Authentication
• openbankproject_client.errors module
  • ApiError
  • AuthenticationError
  • ResourceNotFoundError
  • ValidationError
  • PermissionError
  • RateLimitError
  • ServerError
  • ErrorHandler

Account Management

• openbankproject_client.extended_account module
  • ExtendedAccountEndpoints
• openbankproject_client.extended_bank module
  • ExtendedBankEndpoints
• openbankproject_client.account_holder module
  • AccountHolderEndpoints
• openbankproject_client.account_metadata module
  • AccountMetadataEndpoints
• openbankproject_client.account_public module
  • AccountPublicEndpoints
• openbankproject_client.account_application module
  • AccountApplicationEndpoints
• openbankproject_client.account_access module
  • AccountAccessEndpoints

Transaction Management

• openbankproject_client.transaction module
  • TransactionEndpoints
• openbankproject_client.transaction_metadata module
  • TransactionMetadataEndpoints
• openbankproject_client.transaction_request module
  • TransactionRequestEndpoints
• openbankproject_client.standing_order module
  • StandingOrderEndpoints
• openbankproject_client.direct_debit module
  • DirectDebitEndpoints

User Management

• openbankproject_client.user module
  • UserEndpoints
• openbankproject_client.customer module
  • CustomerEndpoints
• openbankproject_client.role module
  • RoleEndpoints
• openbankproject_client.kyc module
  • KycEndpoints
• openbankproject_client.user_invitation module
  • UserInvitationEndpoints

API Management

• openbankproject_client.api_management module
  • ApiManagementEndpoints
• openbankproject_client.api_favorite module
  • ApiFavoriteEndpoints
• openbankproject_client.api_collection module
  • ApiCollectionEndpoints
• openbankproject_client.api_configuration module
  • ApiConfigurationEndpoints
• openbankproject_client.dynamic_endpoint module
  • DynamicEndpointEndpoints
• openbankproject_client.dynamic_entity module
  • DynamicEntityEndpoints
• openbankproject_client.dynamic_message_doc module
  • DynamicMessageDocEndpoints
• openbankproject_client.dynamic_resource_doc module
  • DynamicResourceDocEndpoints

Additional Features

• openbankproject_client.atm module
  • AtmEndpoints
• openbankproject_client.branch module
  • BranchEndpoints
• openbankproject_client.card module
  • CardEndpoints
• openbankproject_client.consent module
  • ConsentEndpoints
• openbankproject_client.counterparty module
  • CounterpartyEndpoints
• openbankproject_client.counterparty_metadata module
  • CounterpartyMetadataEndpoints
• openbankproject_client.counterparty_limits module
  • CounterpartyLimitsEndpoints
• openbankproject_client.customer_meeting module
  • CustomerMeetingEndpoints
• openbankproject_client.customer_message module
  • CustomerMessageEndpoints
• openbankproject_client.fx module
  • FxEndpoints
• openbankproject_client.metric module
  • MetricEndpoints
• openbankproject_client.product module
  • ProductEndpoints
• openbankproject_client.scope module
  • ScopeEndpoints
• openbankproject_client.view_custom module
  • ViewCustomEndpoints
• openbankproject_client.view_system module
  • ViewSystemEndpoints
• openbankproject_client.webhook module
  • WebhookEndpoints
• openbankproject_client.webui_props module
  • WebUiPropsEndpoints

Examples

• openbankproject_client.examples module
  • authenticate_with_direct_login()
  • authenticate_with_gateway_login()
  • get_banks_example()
  • get_accounts_example()
  • get_transactions_example()
  • create_transaction_request_example()
  • create_counterparty_example()
  • get_customer_example()
  • create_meeting_example()
  • create_consent_example()
  • create_standing_order_example()
  • create_direct_debit_example()
  • error_handling_example()
  • main()

Indices and tables

• Index

• Module Index

• Search Page