openbankproject_client.counterparty module
Counterparty endpoints for the OpenBankProject API Client.
- class openbankproject_client.counterparty.CounterpartyEndpoints(client)[source]
Bases:
objectCounterparty-related API endpoints.
- __init__(client)[source]
Initialize the endpoint group.
- Parameters:
client – OpenBankProjectClient instance
- create_counterparty_explicit(bank_id: str, account_id: str, view_id: str, data: Dict) Dict[source]
Create Counterparty (Explicit).
- Parameters:
bank_id – Bank identifier
account_id – Account identifier
view_id – View identifier
data – Counterparty data
- Returns:
Dict containing created counterparty information
- create_counterparty_for_any_account(bank_id: str, account_id: str, view_id: str, data: Dict) Dict[source]
Create Counterparty for any account (Explicit).
- Parameters:
bank_id – Bank identifier
account_id – Account identifier
view_id – View identifier
data – Counterparty data
- Returns:
Dict containing created counterparty information
- get_counterparties_explicit(bank_id: str, account_id: str, view_id: str) Dict[source]
Get Counterparties (Explicit).
- Parameters:
bank_id – Bank identifier
account_id – Account identifier
view_id – View identifier
- Returns:
Dict containing counterparties information
- get_counterparties_for_any_account(bank_id: str, account_id: str, view_id: str) Dict[source]
Get Counterparties for any account (Explicit).
- Parameters:
bank_id – Bank identifier
account_id – Account identifier
view_id – View identifier
- Returns:
Dict containing counterparties information
- get_counterparty_by_id_explicit(bank_id: str, account_id: str, view_id: str, counterparty_id: str) Dict[source]
Get Counterparty by Id (Explicit).
- Parameters:
bank_id – Bank identifier
account_id – Account identifier
view_id – View identifier
counterparty_id – Counterparty identifier
- Returns:
Dict containing counterparty information
- get_counterparty_by_id_for_any_account(bank_id: str, account_id: str, view_id: str, counterparty_id: str) Dict[source]
Get Counterparty by Id for any account (Explicit).
- Parameters:
bank_id – Bank identifier
account_id – Account identifier
view_id – View identifier
counterparty_id – Counterparty identifier
- Returns:
Dict containing counterparty information
- get_counterparty_by_name_for_any_account(bank_id: str, account_id: str, view_id: str, name: str) Dict[source]
Get Counterparty by name for any account (Explicit).
- Parameters:
bank_id – Bank identifier
account_id – Account identifier
view_id – View identifier
name – Counterparty name
- Returns:
Dict containing counterparty information
- get_other_account_by_id(bank_id: str, account_id: str, view_id: str, other_account_id: str) Dict[source]
Get Other Account by Id.
- Parameters:
bank_id – Bank identifier
account_id – Account identifier
view_id – View identifier
other_account_id – Other account identifier
- Returns:
Dict containing other account information
- get_other_accounts_of_one_account(bank_id: str, account_id: str, view_id: str) Dict[source]
Get Other Accounts of one Account.
- Parameters:
bank_id – Bank identifier
account_id – Account identifier
view_id – View identifier
- Returns:
Dict containing other accounts information
- delete_counterparty_explicit(bank_id: str, account_id: str, view_id: str, counterparty_id: str) Dict[source]
Delete Counterparty (Explicit).
- Parameters:
bank_id – Bank identifier
account_id – Account identifier
view_id – View identifier
counterparty_id – Counterparty identifier
- Returns:
Dict containing deletion status
- delete_counterparty_for_any_account(bank_id: str, account_id: str, view_id: str, counterparty_id: str) Dict[source]
Delete Counterparty for any account (Explicit).
- Parameters:
bank_id – Bank identifier
account_id – Account identifier
view_id – View identifier
counterparty_id – Counterparty identifier
- Returns:
Dict containing deletion status