openbankproject_client.account_holder module

Account Holder endpoints for the OpenBankProject API Client.

class openbankproject_client.account_holder.AccountHolderEndpoints(client)[source]

Bases: object

Account Holder-related API endpoints.

__init__(client)[source]

Initialize the endpoint group.

Parameters:

client – OpenBankProjectClient instance

get_account_holders_at_bank(bank_id: str) → Dict[source]

Get Account Holders at Bank.

Parameters:

bank_id – Bank identifier

Returns:

Dict containing account holders information

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

Get Account Holders by Account Id.

Parameters:

  • bank_id – Bank identifier

  • account_id – Account identifier

Returns:

Dict containing account holders information

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

Create Account Holder.

Parameters:

  • bank_id – Bank identifier

  • account_id – Account identifier

  • data – Account holder data

Returns:

Dict containing created account holder information

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

Delete Account Holder.

Parameters:

  • bank_id – Bank identifier

  • account_id – Account identifier

  • user_id – User identifier

Returns:

Dict containing deletion status