openbankproject_client.extended_bank module
Extended Bank endpoints for the OpenBankProject API Client.
- class openbankproject_client.extended_bank.ExtendedBankEndpoints(client)[source]
Bases:
objectExtended Bank-related API endpoints.
- __init__(client)[source]
Initialize the endpoint group.
- Parameters:
client – OpenBankProjectClient instance
- get_bank_accounts(bank_id: str) Dict[source]
Get accounts at a specific bank (Authenticated access).
- Parameters:
bank_id – Bank identifier
- Returns:
Dict containing account information
- get_bank_account(bank_id: str, account_id: str) Dict[source]
Get account by ID at a specific bank.
- Parameters:
bank_id – Bank identifier
account_id – Account identifier
- Returns:
Dict containing account information
- get_bank_account_balances(bank_id: str, account_id: str) Dict[source]
Get account balances.
- Parameters:
bank_id – Bank identifier
account_id – Account identifier
- Returns:
Dict containing account balance information
- get_bank_account_transactions(bank_id: str, account_id: str, params: Dict | None = None) Dict[source]
Get transactions for an account.
- Parameters:
bank_id – Bank identifier
account_id – Account identifier
params – Optional query parameters like from_date, to_date, limit, offset, etc.
- Returns:
Dict containing transaction information
- get_transaction(bank_id: str, account_id: str, transaction_id: str) Dict[source]
Get transaction by ID.
- Parameters:
bank_id – Bank identifier
account_id – Account identifier
transaction_id – Transaction identifier
- Returns:
Dict containing transaction information
- create_transaction_request(bank_id: str, account_id: str, view_id: str, data: Dict) Dict[source]
Create a transaction request.
- Parameters:
bank_id – Bank identifier
account_id – Account identifier
view_id – View identifier
data – Transaction request data
- Returns:
Dict containing transaction request information
- get_bank_customers(bank_id: str) Dict[source]
Get customers at a specific bank.
- Parameters:
bank_id – Bank identifier
- Returns:
Dict containing customer information
- get_customer(bank_id: str, customer_id: str) Dict[source]
Get customer by ID.
- Parameters:
bank_id – Bank identifier
customer_id – Customer identifier
- Returns:
Dict containing customer information
- create_customer(bank_id: str, data: Dict) Dict[source]
Create a customer.
- Parameters:
bank_id – Bank identifier
data – Customer data
- Returns:
Dict containing created customer information
- update_customer(bank_id: str, customer_id: str, data: Dict) Dict[source]
Update a customer.
- Parameters:
bank_id – Bank identifier
customer_id – Customer identifier
data – Updated customer data
- Returns:
Dict containing updated customer information
- get_bank_branches(bank_id: str) Dict[source]
Get branches for a bank.
- Parameters:
bank_id – Bank identifier
- Returns:
Dict containing branch information
- get_bank_atms(bank_id: str) Dict[source]
Get ATMs for a bank.
- Parameters:
bank_id – Bank identifier
- Returns:
Dict containing ATM information
- get_bank_products(bank_id: str) Dict[source]
Get products for a bank.
- Parameters:
bank_id – Bank identifier
- Returns:
Dict containing product information
- get_bank_product(bank_id: str, product_id: str) Dict[source]
Get product by ID.
- Parameters:
bank_id – Bank identifier
product_id – Product identifier
- Returns:
Dict containing product information
- get_bank_attributes(bank_id: str) Dict[source]
Get attributes for a bank.
- Parameters:
bank_id – Bank identifier
- Returns:
Dict containing bank attribute information
- add_bank_attribute(bank_id: str, data: Dict) Dict[source]
Add an attribute to a bank.
- Parameters:
bank_id – Bank identifier
data – Attribute data
- Returns:
Dict containing added attribute information
- update_bank_attribute(bank_id: str, attribute_id: str, data: Dict) Dict[source]
Update an attribute of a bank.
- Parameters:
bank_id – Bank identifier
attribute_id – Attribute identifier
data – Updated attribute data
- Returns:
Dict containing updated attribute information