openbankproject_client.branch module

Branch endpoints for the OpenBankProject API Client.

class openbankproject_client.branch.BranchEndpoints(client)[source]

Bases: object

Branch-related API endpoints.

__init__(client)[source]

Initialize the endpoint group.

Parameters:

client – OpenBankProjectClient instance

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

Create Branch.

Parameters:

  • bank_id – Bank identifier

  • data – Branch data

Returns:

Dict containing created branch information

get_branch(bank_id: str, branch_id: str) → Dict[source]

Get Branch.

Parameters:

  • bank_id – Bank identifier

  • branch_id – Branch identifier

Returns:

Dict containing branch information

get_branches_for_bank(bank_id: str) → Dict[source]

Get Branches for a Bank.

Parameters:

bank_id – Bank identifier

Returns:

Dict containing branches information

delete_branch(bank_id: str, branch_id: str) → Dict[source]

Delete Branch.

Parameters:

  • bank_id – Bank identifier

  • branch_id – Branch identifier

Returns:

Dict containing deletion status