openbankproject_client.extended_account module

Extended Account endpoints for the OpenBankProject API Client.

class openbankproject_client.extended_account.ExtendedAccountEndpoints(client)

Bases: object

Extended Account-related API endpoints.

__init__(client)

Initialize the endpoint group.

Parameters:

client – OpenBankProjectClient instance

get_account_by_id(account_id: str) → Dict

Get account by ID (across all banks).

Parameters:

account_id – Account identifier

Returns:

Dict containing account information

get_account_views(bank_id: str, account_id: str) → Dict

Get views for an account.

Parameters:

• bank_id – Bank identifier

• account_id – Account identifier

Returns:

Dict containing view information

create_account_view(bank_id: str, account_id: str, data: Dict) → Dict

Create a view for an account.

Parameters:

• bank_id – Bank identifier

• account_id – Account identifier

• data – View data

Returns:

Dict containing created view information

update_account_view(bank_id: str, account_id: str, view_id: str, data: Dict) → Dict

Update a view for an account.

Parameters:

• bank_id – Bank identifier

• account_id – Account identifier

• view_id – View identifier

• data – Updated view data

Returns:

Dict containing updated view information

delete_account_view(bank_id: str, account_id: str, view_id: str) → Dict

Delete a view for an account.

Parameters:

• bank_id – Bank identifier

• account_id – Account identifier

• view_id – View identifier

Returns:

Dict containing deletion status

get_account_permissions(bank_id: str, account_id: str) → Dict

Get permissions for an account.

Parameters:

• bank_id – Bank identifier

• account_id – Account identifier

Returns:

Dict containing permission information

grant_account_access(bank_id: str, account_id: str, data: Dict) → Dict

Grant access to an account.

Parameters:

• bank_id – Bank identifier

• account_id – Account identifier

• data – Access grant data

Returns:

Dict containing grant status

revoke_account_access(bank_id: str, account_id: str, provider: str, user_id: str) → Dict

Revoke access to an account.

Parameters:

• bank_id – Bank identifier

• account_id – Account identifier

• provider – Provider identifier

• user_id – User identifier

Returns:

Dict containing revocation status

create_account(bank_id: str, data: Dict) → Dict

Create a new account.

Parameters:

• bank_id – Bank identifier

• data – Account data

Returns:

Dict containing created account information

close_account(bank_id: str, account_id: str) → Dict

Close an account.

Parameters:

• bank_id – Bank identifier

• account_id – Account identifier

Returns:

Dict containing closure status

check_available_funds(bank_id: str, account_id: str, view_id: str, amount: str, currency: str) → Dict

Check if an account has available funds.

Parameters:

• bank_id – Bank identifier

• account_id – Account identifier

• view_id – View identifier

• amount – Amount to check

• currency – Currency of the amount

Returns:

Dict containing available funds information

get_account_with_balance(bank_id: str, account_id: str) → Dict

Get account by ID with balance.

Parameters:

• bank_id – Bank identifier

• account_id – Account identifier

Returns:

Dict containing account information with balance

update_account_label(bank_id: str, account_id: str, data: Dict) → Dict

Update account label.

Parameters:

• bank_id – Bank identifier

• account_id – Account identifier

• data – Updated label data

Returns:

Dict containing updated account information

get_account_attributes(bank_id: str, account_id: str) → Dict

Get attributes for an account.

Parameters:

• bank_id – Bank identifier

• account_id – Account identifier

Returns:

Dict containing account attribute information

add_account_attribute(bank_id: str, account_id: str, data: Dict) → Dict

Add an attribute to an account.

Parameters:

• bank_id – Bank identifier

• account_id – Account identifier

• data – Attribute data

Returns:

Dict containing added attribute information

update_account_attribute(bank_id: str, account_id: str, attribute_id: str, data: Dict) → Dict

Update an attribute of an account.

Parameters:

• bank_id – Bank identifier

• account_id – Account identifier

• attribute_id – Attribute identifier

• data – Updated attribute data

Returns:

Dict containing updated attribute information

delete_account_attribute(bank_id: str, account_id: str, attribute_id: str) → Dict

Delete an attribute from an account.

Parameters:

• bank_id – Bank identifier

• account_id – Account identifier

• attribute_id – Attribute identifier

Returns:

Dict containing deletion status

get_account_tags(bank_id: str, account_id: str, view_id: str) → Dict

Get tags for an account.

Parameters:

• bank_id – Bank identifier

• account_id – Account identifier

• view_id – View identifier

Returns:

Dict containing account tag information

add_account_tag(bank_id: str, account_id: str, view_id: str, data: Dict) → Dict

Add a tag to an account.

Parameters:

• bank_id – Bank identifier

• account_id – Account identifier

• view_id – View identifier

• data – Tag data

Returns:

Dict containing added tag information

delete_account_tag(bank_id: str, account_id: str, view_id: str, tag_id: str) → Dict

Delete a tag from an account.

Parameters:

• bank_id – Bank identifier

• account_id – Account identifier

• view_id – View identifier

• tag_id – Tag identifier

Returns:

Dict containing deletion status

get_account_metadata(bank_id: str, account_id: str, view_id: str) → Dict

Get metadata for an account.

Parameters:

• bank_id – Bank identifier

• account_id – Account identifier

• view_id – View identifier

Returns:

Dict containing account metadata information

get_account_by_iban(iban: str) → Dict

Get account by IBAN.

Parameters:

iban – IBAN identifier

Returns:

Dict containing account information

get_firehose_accounts(bank_id: str) → Dict

Get firehose accounts at a specific bank.

Parameters:

bank_id – Bank identifier

Returns:

Dict containing firehose account information

get_firehose_transactions(bank_id: str, account_id: str) → Dict

Get firehose transactions for an account.

Parameters:

• bank_id – Bank identifier

• account_id – Account identifier

Returns:

Dict containing firehose transaction information

get_firehose_bank_transactions(bank_id: str) → Dict

Get firehose transactions for a bank.

Parameters:

bank_id – Bank identifier

Returns:

Dict containing firehose bank transaction information

get_account_statistics(bank_id: str, account_id: str, view_id: str) → Dict

Get statistics for an account.

Parameters:

• bank_id – Bank identifier

• account_id – Account identifier

• view_id – View identifier

Returns:

Dict containing account statistics information

get_account_statements(bank_id: str, account_id: str) → Dict

Get statements for an account.

Parameters:

• bank_id – Bank identifier

• account_id – Account identifier

Returns:

Dict containing account statement information

get_account_statement(bank_id: str, account_id: str, statement_id: str) → Dict

Get statement by ID for an account.

Parameters:

• bank_id – Bank identifier

• account_id – Account identifier

• statement_id – Statement identifier

Returns:

Dict containing account statement information

get_account_statement_transactions(bank_id: str, account_id: str, statement_id: str) → Dict

Get transactions for a statement.

Parameters:

• bank_id – Bank identifier

• account_id – Account identifier

• statement_id – Statement identifier

Returns:

Dict containing statement transaction information

generate_account_statement_pdf(bank_id: str, account_id: str, statement_id: str) → Dict

Generate PDF for a statement.

Parameters:

• bank_id – Bank identifier

• account_id – Account identifier

• statement_id – Statement identifier

Returns:

Dict containing PDF generation information