openbankproject_client.transaction module

Transaction endpoints for the OpenBankProject API Client.

class openbankproject_client.transaction.TransactionEndpoints(client)

Bases: object

Transaction-related API endpoints.

__init__(client)

Initialize the endpoint group.

Parameters:

client – OpenBankProjectClient instance

get_transactions(bank_id: str, account_id: str, view_id: str, params: Dict | None = None) → Dict

Get transactions for an account.

Parameters:

• bank_id – Bank identifier

• account_id – Account identifier

• view_id – View 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, view_id: str, transaction_id: str) → Dict

Get transaction by ID.

Parameters:

• bank_id – Bank identifier

• account_id – Account identifier

• view_id – View identifier

• transaction_id – Transaction identifier

Returns:

Dict containing transaction information

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

Create a transaction.

Parameters:

• bank_id – Bank identifier

• account_id – Account identifier

• view_id – View identifier

• data – Transaction data

Returns:

Dict containing created transaction information

update_transaction(bank_id: str, account_id: str, view_id: str, transaction_id: str, data: Dict) → Dict

Update a transaction.

Parameters:

• bank_id – Bank identifier

• account_id – Account identifier

• view_id – View identifier

• transaction_id – Transaction identifier

• data – Updated transaction data

Returns:

Dict containing updated transaction information

delete_transaction(bank_id: str, account_id: str, view_id: str, transaction_id: str) → Dict

Delete a transaction.

Parameters:

• bank_id – Bank identifier

• account_id – Account identifier

• view_id – View identifier

• transaction_id – Transaction identifier

Returns:

Dict containing deletion status

get_transaction_attributes(bank_id: str, account_id: str, view_id: str, transaction_id: str) → Dict

Get attributes for a transaction.

Parameters:

• bank_id – Bank identifier

• account_id – Account identifier

• view_id – View identifier

• transaction_id – Transaction identifier

Returns:

Dict containing transaction attribute information

add_transaction_attribute(bank_id: str, account_id: str, view_id: str, transaction_id: str, data: Dict) → Dict

Add an attribute to a transaction.

Parameters:

• bank_id – Bank identifier

• account_id – Account identifier

• view_id – View identifier

• transaction_id – Transaction identifier

• data – Attribute data

Returns:

Dict containing added attribute information

update_transaction_attribute(bank_id: str, account_id: str, view_id: str, transaction_id: str, attribute_id: str, data: Dict) → Dict

Update an attribute of a transaction.

Parameters:

• bank_id – Bank identifier

• account_id – Account identifier

• view_id – View identifier

• transaction_id – Transaction identifier

• attribute_id – Attribute identifier

• data – Updated attribute data

Returns:

Dict containing updated attribute information

delete_transaction_attribute(bank_id: str, account_id: str, view_id: str, transaction_id: str, attribute_id: str) → Dict

Delete an attribute from a transaction.

Parameters:

• bank_id – Bank identifier

• account_id – Account identifier

• view_id – View identifier

• transaction_id – Transaction identifier

• attribute_id – Attribute identifier

Returns:

Dict containing deletion status

get_transaction_tags(bank_id: str, account_id: str, view_id: str, transaction_id: str) → Dict

Get tags for a transaction.

Parameters:

• bank_id – Bank identifier

• account_id – Account identifier

• view_id – View identifier

• transaction_id – Transaction identifier

Returns:

Dict containing transaction tag information

add_transaction_tag(bank_id: str, account_id: str, view_id: str, transaction_id: str, data: Dict) → Dict

Add a tag to a transaction.

Parameters:

• bank_id – Bank identifier

• account_id – Account identifier

• view_id – View identifier

• transaction_id – Transaction identifier

• data – Tag data

Returns:

Dict containing added tag information

delete_transaction_tag(bank_id: str, account_id: str, view_id: str, transaction_id: str, tag_id: str) → Dict

Delete a tag from a transaction.

Parameters:

• bank_id – Bank identifier

• account_id – Account identifier

• view_id – View identifier

• transaction_id – Transaction identifier

• tag_id – Tag identifier

Returns:

Dict containing deletion status

get_transaction_images(bank_id: str, account_id: str, view_id: str, transaction_id: str) → Dict

Get images for a transaction.

Parameters:

• bank_id – Bank identifier

• account_id – Account identifier

• view_id – View identifier

• transaction_id – Transaction identifier

Returns:

Dict containing transaction image information

add_transaction_image(bank_id: str, account_id: str, view_id: str, transaction_id: str, data: Dict) → Dict

Add an image to a transaction.

Parameters:

• bank_id – Bank identifier

• account_id – Account identifier

• view_id – View identifier

• transaction_id – Transaction identifier

• data – Image data

Returns:

Dict containing added image information

delete_transaction_image(bank_id: str, account_id: str, view_id: str, transaction_id: str, image_id: str) → Dict

Delete an image from a transaction.

Parameters:

• bank_id – Bank identifier

• account_id – Account identifier

• view_id – View identifier

• transaction_id – Transaction identifier

• image_id – Image identifier

Returns:

Dict containing deletion status

get_transaction_comments(bank_id: str, account_id: str, view_id: str, transaction_id: str) → Dict

Get comments for a transaction.

Parameters:

• bank_id – Bank identifier

• account_id – Account identifier

• view_id – View identifier

• transaction_id – Transaction identifier

Returns:

Dict containing transaction comment information

add_transaction_comment(bank_id: str, account_id: str, view_id: str, transaction_id: str, data: Dict) → Dict

Add a comment to a transaction.

Parameters:

• bank_id – Bank identifier

• account_id – Account identifier

• view_id – View identifier

• transaction_id – Transaction identifier

• data – Comment data

Returns:

Dict containing added comment information

delete_transaction_comment(bank_id: str, account_id: str, view_id: str, transaction_id: str, comment_id: str) → Dict

Delete a comment from a transaction.

Parameters:

• bank_id – Bank identifier

• account_id – Account identifier

• view_id – View identifier

• transaction_id – Transaction identifier

• comment_id – Comment identifier

Returns:

Dict containing deletion status

get_transaction_narratives(bank_id: str, account_id: str, view_id: str, transaction_id: str) → Dict

Get narratives for a transaction.

Parameters:

• bank_id – Bank identifier

• account_id – Account identifier

• view_id – View identifier

• transaction_id – Transaction identifier

Returns:

Dict containing transaction narrative information

add_transaction_narrative(bank_id: str, account_id: str, view_id: str, transaction_id: str, data: Dict) → Dict

Add a narrative to a transaction.

Parameters:

• bank_id – Bank identifier

• account_id – Account identifier

• view_id – View identifier

• transaction_id – Transaction identifier

• data – Narrative data

Returns:

Dict containing added narrative information

update_transaction_narrative(bank_id: str, account_id: str, view_id: str, transaction_id: str, data: Dict) → Dict

Update the narrative of a transaction.

Parameters:

• bank_id – Bank identifier

• account_id – Account identifier

• view_id – View identifier

• transaction_id – Transaction identifier

• data – Updated narrative data

Returns:

Dict containing updated narrative information

delete_transaction_narrative(bank_id: str, account_id: str, view_id: str, transaction_id: str) → Dict

Delete the narrative from a transaction.

Parameters:

• bank_id – Bank identifier

• account_id – Account identifier

• view_id – View identifier

• transaction_id – Transaction identifier

Returns:

Dict containing deletion status

get_transaction_types() → Dict

Get all transaction types.

Returns:

Dict containing transaction type information

get_transaction_status(bank_id: str, account_id: str, view_id: str, transaction_id: str) → Dict

Get the status of a transaction.

Parameters:

• bank_id – Bank identifier

• account_id – Account identifier

• view_id – View identifier

• transaction_id – Transaction identifier

Returns:

Dict containing transaction status information

get_transaction_challenges(bank_id: str, account_id: str, view_id: str, transaction_id: str) → Dict

Get challenges for a transaction.

Parameters:

• bank_id – Bank identifier

• account_id – Account identifier

• view_id – View identifier

• transaction_id – Transaction identifier

Returns:

Dict containing transaction challenge information

answer_transaction_challenge(bank_id: str, account_id: str, view_id: str, transaction_id: str, challenge_id: str, data: Dict) → Dict

Answer a challenge for a transaction.

Parameters:

• bank_id – Bank identifier

• account_id – Account identifier

• view_id – View identifier

• transaction_id – Transaction identifier

• challenge_id – Challenge identifier

• data – Challenge answer data

Returns:

Dict containing challenge response information