openbankproject_client.transaction_request module

Transaction Request endpoints for the OpenBankProject API Client.

class openbankproject_client.transaction_request.TransactionRequestEndpoints(client)[source]

Bases: object

Transaction Request-related API endpoints.

__init__(client)[source]

Initialize the endpoint group.

Parameters:: client – OpenBankProjectClient instance

create_transaction_request_account(bank_id: str, account_id: str, view_id: str, data: Dict) → Dict[source]

Create Transaction Request (ACCOUNT).

Parameters:

bank_id – Bank identifier
account_id – Account identifier
view_id – View identifier
data – Transaction request data

Returns:

Dict containing created transaction request information

create_transaction_request_account_otp(bank_id: str, account_id: str, view_id: str, data: Dict) → Dict[source]

Create Transaction Request (ACCOUNT_OTP).

Parameters:

bank_id – Bank identifier
account_id – Account identifier
view_id – View identifier
data – Transaction request data with OTP

Returns:

Dict containing created transaction request information

create_transaction_request_agent_cash_withdrawal(bank_id: str, account_id: str, view_id: str, data: Dict) → Dict[source]

Create Transaction Request (AGENT_CASH_WITHDRAWAL).

Parameters:

bank_id – Bank identifier
account_id – Account identifier
view_id – View identifier
data – Transaction request data for agent cash withdrawal

Returns:

Dict containing created transaction request information

create_transaction_request_card(bank_id: str, account_id: str, view_id: str, data: Dict) → Dict[source]

Create Transaction Request (CARD).

Parameters:

bank_id – Bank identifier
account_id – Account identifier
view_id – View identifier
data – Transaction request data for card

Returns:

Dict containing created transaction request information

create_transaction_request_counterparty(bank_id: str, account_id: str, view_id: str, data: Dict) → Dict[source]

Create Transaction Request (COUNTERPARTY).

Parameters:

bank_id – Bank identifier
account_id – Account identifier
view_id – View identifier
data – Transaction request data for counterparty

Returns:

Dict containing created transaction request information

create_transaction_request_free_form(bank_id: str, account_id: str, view_id: str, data: Dict) → Dict[source]

Create Transaction Request (FREE_FORM).

Parameters:

bank_id – Bank identifier
account_id – Account identifier
view_id – View identifier
data – Transaction request data in free form

Returns:

Dict containing created transaction request information

create_transaction_request_refund(bank_id: str, account_id: str, view_id: str, data: Dict) → Dict[source]

Create Transaction Request (REFUND).

Parameters:

bank_id – Bank identifier
account_id – Account identifier
view_id – View identifier
data – Transaction request data for refund

Returns:

Dict containing created transaction request information

create_transaction_request_sandbox_tan(bank_id: str, account_id: str, view_id: str, data: Dict) → Dict[source]

Create Transaction Request (SANDBOX_TAN).

Parameters:

bank_id – Bank identifier
account_id – Account identifier
view_id – View identifier
data – Transaction request data for sandbox TAN

Returns:

Dict containing created transaction request information

create_transaction_request_sepa(bank_id: str, account_id: str, view_id: str, data: Dict) → Dict[source]

Create Transaction Request (SEPA).

Parameters:

bank_id – Bank identifier
account_id – Account identifier
view_id – View identifier
data – Transaction request data for SEPA

Returns:

Dict containing created transaction request information

create_transaction_request_simple(bank_id: str, account_id: str, view_id: str, data: Dict) → Dict[source]

Create Transaction Request (SIMPLE).

Parameters:

bank_id – Bank identifier
account_id – Account identifier
view_id – View identifier
data – Transaction request data for simple transfer

Returns:

Dict containing created transaction request information

get_transaction_request(bank_id: str, account_id: str, view_id: str, transaction_request_id: str) → Dict[source]

Get Transaction Request.

Parameters:

bank_id – Bank identifier
account_id – Account identifier
view_id – View identifier
transaction_request_id – Transaction request identifier

Returns:

Dict containing transaction request information

get_transaction_request_by_id(transaction_request_id: str) → Dict[source]

Get Transaction Request by ID.

Parameters:: transaction_request_id – Transaction request identifier
Returns:: Dict containing transaction request information

get_transaction_requests(bank_id: str, account_id: str, view_id: str) → Dict[source]

Get Transaction Requests.

Parameters:

bank_id – Bank identifier
account_id – Account identifier
view_id – View identifier

Returns:

Dict containing transaction requests information

get_transaction_request_types_at_bank(bank_id: str) → Dict[source]

Get Transaction Request Types at Bank.

Parameters:: bank_id – Bank identifier
Returns:: Dict containing transaction request types information

get_transaction_request_types_for_account(bank_id: str, account_id: str, view_id: str) → Dict[source]

Get Transaction Request Types for Account.

Parameters:

bank_id – Bank identifier
account_id – Account identifier
view_id – View identifier

Returns:

Dict containing transaction request types information

create_transaction_request_attribute(bank_id: str, account_id: str, view_id: str, transaction_request_id: str, data: Dict) → Dict[source]

Create Transaction Request Attribute.

Parameters:

bank_id – Bank identifier
account_id – Account identifier
view_id – View identifier
transaction_request_id – Transaction request identifier
data – Attribute data

Returns:

Dict containing created attribute information

update_transaction_request_attribute(bank_id: str, account_id: str, view_id: str, transaction_request_id: str, attribute_id: str, data: Dict) → Dict[source]

Update Transaction Request Attribute.

Parameters:

bank_id – Bank identifier
account_id – Account identifier
view_id – View identifier
transaction_request_id – Transaction request identifier
attribute_id – Attribute identifier
data – Updated attribute data

Returns:

Dict containing updated attribute information

get_transaction_request_attribute_by_id(bank_id: str, account_id: str, view_id: str, transaction_request_id: str, attribute_id: str) → Dict[source]

Get Transaction Request Attribute By Id.

Parameters:

bank_id – Bank identifier
account_id – Account identifier
view_id – View identifier
transaction_request_id – Transaction request identifier
attribute_id – Attribute identifier

Returns:

Dict containing attribute information

get_transaction_request_attributes(bank_id: str, account_id: str, view_id: str, transaction_request_id: str) → Dict[source]

Get Transaction Request Attributes.

Parameters:

bank_id – Bank identifier
account_id – Account identifier
view_id – View identifier
transaction_request_id – Transaction request identifier

Returns:

Dict containing attributes information

get_transaction_request_attribute_definition(bank_id: str) → Dict[source]

Get Transaction Request Attribute Definition.

Parameters:: bank_id – Bank identifier
Returns:: Dict containing attribute definition information

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

Create or Update Transaction Request Attribute Definition.

Parameters:

bank_id – Bank identifier
data – Attribute definition data

Returns:

Dict containing created or updated attribute definition information

delete_transaction_request_attribute_definition(bank_id: str, attribute_definition_id: str) → Dict[source]

Delete Transaction Request Attribute Definition.

Parameters:

bank_id – Bank identifier
attribute_definition_id – Attribute definition identifier

Returns:

Dict containing deletion status

update_transaction_request_status(bank_id: str, account_id: str, view_id: str, transaction_request_id: str, data: Dict) → Dict[source]

Update Transaction Request Status.

Parameters:

bank_id – Bank identifier
account_id – Account identifier
view_id – View identifier
transaction_request_id – Transaction request identifier
data – Updated status data

Returns:

Dict containing updated transaction request information

answer_transaction_request_challenge(bank_id: str, account_id: str, view_id: str, transaction_request_id: str, challenge_id: str, data: Dict) → Dict[source]

Answer Transaction Request Challenge.

Parameters:

bank_id – Bank identifier
account_id – Account identifier
view_id – View identifier
transaction_request_id – Transaction request identifier
challenge_id – Challenge identifier
data – Challenge answer data

Returns:

Dict containing challenge response information

create_historical_transactions(bank_id: str, account_id: str, view_id: str, data: Dict) → Dict[source]

Create Historical Transactions.

Parameters:

bank_id – Bank identifier
account_id – Account identifier
view_id – View identifier
data – Historical transactions data

Returns:

Dict containing created transactions information

save_historical_transactions(bank_id: str, account_id: str, view_id: str, data: Dict) → Dict[source]

Save Historical Transactions.

Parameters:

bank_id – Bank identifier
account_id – Account identifier
view_id – View identifier
data – Historical transactions data

Returns:

Dict containing saved transactions information