openbankproject_client.counterparty_metadata module

Counterparty Metadata endpoints for the OpenBankProject API Client.

class openbankproject_client.counterparty_metadata.CounterpartyMetadataEndpoints(client)[source]

Bases: object

Counterparty Metadata-related API endpoints.

__init__(client)[source]

Initialize the endpoint group.

Parameters:

client – OpenBankProjectClient instance

add_corporate_location_to_counterparty(bank_id: str, account_id: str, view_id: str, other_account_id: str, data: Dict) → Dict[source]

Add Corporate Location to Counterparty.

Parameters:

  • bank_id – Bank identifier

  • account_id – Account identifier

  • view_id – View identifier

  • other_account_id – Other account identifier

  • data – Corporate location data

Returns:

Dict containing created corporate location information

add_counterparty_more_info(bank_id: str, account_id: str, view_id: str, other_account_id: str, data: Dict) → Dict[source]

Add Counterparty More Info.

Parameters:

  • bank_id – Bank identifier

  • account_id – Account identifier

  • view_id – View identifier

  • other_account_id – Other account identifier

  • data – More info data

Returns:

Dict containing created more info information

add_open_corporates_url_to_counterparty(bank_id: str, account_id: str, view_id: str, other_account_id: str, data: Dict) → Dict[source]

Add Open Corporates URL to Counterparty.

Parameters:

  • bank_id – Bank identifier

  • account_id – Account identifier

  • view_id – View identifier

  • other_account_id – Other account identifier

  • data – Open Corporates URL data

Returns:

Dict containing created Open Corporates URL information

add_image_url_to_other_bank_account(bank_id: str, account_id: str, view_id: str, other_account_id: str, data: Dict) → Dict[source]

Add image url to other bank account.

Parameters:

  • bank_id – Bank identifier

  • account_id – Account identifier

  • view_id – View identifier

  • other_account_id – Other account identifier

  • data – Image URL data

Returns:

Dict containing created image URL information

add_physical_location_to_other_bank_account(bank_id: str, account_id: str, view_id: str, other_account_id: str, data: Dict) → Dict[source]

Add physical location to other bank account.

Parameters:

  • bank_id – Bank identifier

  • account_id – Account identifier

  • view_id – View identifier

  • other_account_id – Other account identifier

  • data – Physical location data

Returns:

Dict containing created physical location information

add_public_alias_to_other_bank_account(bank_id: str, account_id: str, view_id: str, other_account_id: str, data: Dict) → Dict[source]

Add public alias to other bank account.

Parameters:

  • bank_id – Bank identifier

  • account_id – Account identifier

  • view_id – View identifier

  • other_account_id – Other account identifier

  • data – Public alias data

Returns:

Dict containing created public alias information

add_url_to_other_bank_account(bank_id: str, account_id: str, view_id: str, other_account_id: str, data: Dict) → Dict[source]

Add url to other bank account.

Parameters:

  • bank_id – Bank identifier

  • account_id – Account identifier

  • view_id – View identifier

  • other_account_id – Other account identifier

  • data – URL data

Returns:

Dict containing created URL information

create_other_account_private_alias(bank_id: str, account_id: str, view_id: str, other_account_id: str, data: Dict) → Dict[source]

Create Other Account Private Alias.

Parameters:

  • bank_id – Bank identifier

  • account_id – Account identifier

  • view_id – View identifier

  • other_account_id – Other account identifier

  • data – Private alias data

Returns:

Dict containing created private alias information

get_other_account_metadata(bank_id: str, account_id: str, view_id: str, other_account_id: str) → Dict[source]

Get Other Account Metadata.

Parameters:

  • bank_id – Bank identifier

  • account_id – Account identifier

  • view_id – View identifier

  • other_account_id – Other account identifier

Returns:

Dict containing metadata information

get_other_account_private_alias(bank_id: str, account_id: str, view_id: str, other_account_id: str) → Dict[source]

Get Other Account Private Alias.

Parameters:

  • bank_id – Bank identifier

  • account_id – Account identifier

  • view_id – View identifier

  • other_account_id – Other account identifier

Returns:

Dict containing private alias information

get_public_alias_of_other_bank_account(bank_id: str, account_id: str, view_id: str, other_account_id: str) → Dict[source]

Get public alias of other bank account.

Parameters:

  • bank_id – Bank identifier

  • account_id – Account identifier

  • view_id – View identifier

  • other_account_id – Other account identifier

Returns:

Dict containing public alias information

update_counterparty_corporate_location(bank_id: str, account_id: str, view_id: str, other_account_id: str, data: Dict) → Dict[source]

Update Counterparty Corporate Location.

Parameters:

  • bank_id – Bank identifier

  • account_id – Account identifier

  • view_id – View identifier

  • other_account_id – Other account identifier

  • data – Updated corporate location data

Returns:

Dict containing updated corporate location information

update_counterparty_image_url(bank_id: str, account_id: str, view_id: str, other_account_id: str, data: Dict) → Dict[source]

Update Counterparty Image Url.

Parameters:

  • bank_id – Bank identifier

  • account_id – Account identifier

  • view_id – View identifier

  • other_account_id – Other account identifier

  • data – Updated image URL data

Returns:

Dict containing updated image URL information

update_counterparty_more_info(bank_id: str, account_id: str, view_id: str, other_account_id: str, data: Dict) → Dict[source]

Update Counterparty More Info.

Parameters:

  • bank_id – Bank identifier

  • account_id – Account identifier

  • view_id – View identifier

  • other_account_id – Other account identifier

  • data – Updated more info data

Returns:

Dict containing updated more info information

update_counterparty_physical_location(bank_id: str, account_id: str, view_id: str, other_account_id: str, data: Dict) → Dict[source]

Update Counterparty Physical Location.

Parameters:

  • bank_id – Bank identifier

  • account_id – Account identifier

  • view_id – View identifier

  • other_account_id – Other account identifier

  • data – Updated physical location data

Returns:

Dict containing updated physical location information

update_counterparty_private_alias(bank_id: str, account_id: str, view_id: str, other_account_id: str, data: Dict) → Dict[source]

Update Counterparty Private Alias.

Parameters:

  • bank_id – Bank identifier

  • account_id – Account identifier

  • view_id – View identifier

  • other_account_id – Other account identifier

  • data – Updated private alias data

Returns:

Dict containing updated private alias information

update_open_corporates_url_of_counterparty(bank_id: str, account_id: str, view_id: str, other_account_id: str, data: Dict) → Dict[source]

Update Open Corporates Url of Counterparty.

Parameters:

  • bank_id – Bank identifier

  • account_id – Account identifier

  • view_id – View identifier

  • other_account_id – Other account identifier

  • data – Updated Open Corporates URL data

Returns:

Dict containing updated Open Corporates URL information

update_public_alias_of_other_bank_account(bank_id: str, account_id: str, view_id: str, other_account_id: str, data: Dict) → Dict[source]

Update public alias of other bank account.

Parameters:

  • bank_id – Bank identifier

  • account_id – Account identifier

  • view_id – View identifier

  • other_account_id – Other account identifier

  • data – Updated public alias data

Returns:

Dict containing updated public alias information

update_url_of_other_bank_account(bank_id: str, account_id: str, view_id: str, other_account_id: str, data: Dict) → Dict[source]

Update url of other bank account.

Parameters:

  • bank_id – Bank identifier

  • account_id – Account identifier

  • view_id – View identifier

  • other_account_id – Other account identifier

  • data – Updated URL data

Returns:

Dict containing updated URL information

delete_counterparty_corporate_location(bank_id: str, account_id: str, view_id: str, other_account_id: str) → Dict[source]

Delete Counterparty Corporate Location.

Parameters:

  • bank_id – Bank identifier

  • account_id – Account identifier

  • view_id – View identifier

  • other_account_id – Other account identifier

Returns:

Dict containing deletion status

delete_counterparty_image_url(bank_id: str, account_id: str, view_id: str, other_account_id: str) → Dict[source]

Delete Counterparty Image URL.

Parameters:

  • bank_id – Bank identifier

  • account_id – Account identifier

  • view_id – View identifier

  • other_account_id – Other account identifier

Returns:

Dict containing deletion status

delete_counterparty_open_corporates_url(bank_id: str, account_id: str, view_id: str, other_account_id: str) → Dict[source]

Delete Counterparty Open Corporates URL.

Parameters:

  • bank_id – Bank identifier

  • account_id – Account identifier

  • view_id – View identifier

  • other_account_id – Other account identifier

Returns:

Dict containing deletion status

delete_counterparty_physical_location(bank_id: str, account_id: str, view_id: str, other_account_id: str) → Dict[source]

Delete Counterparty Physical Location.

Parameters:

  • bank_id – Bank identifier

  • account_id – Account identifier

  • view_id – View identifier

  • other_account_id – Other account identifier

Returns:

Dict containing deletion status

delete_counterparty_private_alias(bank_id: str, account_id: str, view_id: str, other_account_id: str) → Dict[source]

Delete Counterparty Private Alias.

Parameters:

  • bank_id – Bank identifier

  • account_id – Account identifier

  • view_id – View identifier

  • other_account_id – Other account identifier

Returns:

Dict containing deletion status

delete_counterparty_public_alias(bank_id: str, account_id: str, view_id: str, other_account_id: str) → Dict[source]

Delete Counterparty Public Alias.

Parameters:

  • bank_id – Bank identifier

  • account_id – Account identifier

  • view_id – View identifier

  • other_account_id – Other account identifier

Returns:

Dict containing deletion status

delete_more_info_of_other_bank_account(bank_id: str, account_id: str, view_id: str, other_account_id: str) → Dict[source]

Delete more info of other bank account.

Parameters:

  • bank_id – Bank identifier

  • account_id – Account identifier

  • view_id – View identifier

  • other_account_id – Other account identifier

Returns:

Dict containing deletion status

delete_url_of_other_bank_account(bank_id: str, account_id: str, view_id: str, other_account_id: str) → Dict[source]

Delete url of other bank account.

Parameters:

  • bank_id – Bank identifier

  • account_id – Account identifier

  • view_id – View identifier

  • other_account_id – Other account identifier

Returns:

Dict containing deletion status