openbankproject_client.examples module

Usage examples for the OpenBankProject API Client.

This module provides examples of how to use the OpenBankProject API client for common banking operations.

openbankproject_client.examples.authenticate_with_direct_login()[source]

Example of authenticating with DirectLogin.

openbankproject_client.examples.authenticate_with_gateway_login()[source]

Example of authenticating with GatewayLogin.

openbankproject_client.examples.get_banks_example(client)[source]

Example of getting a list of banks.

openbankproject_client.examples.get_accounts_example(client, bank_id)[source]

Example of getting accounts for a bank.

openbankproject_client.examples.get_transactions_example(client, bank_id, account_id)[source]

Example of getting transactions for an account.

openbankproject_client.examples.create_transaction_request_example(client, bank_id, account_id, counterparty_id)[source]

Example of creating a transaction request.

openbankproject_client.examples.create_counterparty_example(client, bank_id, account_id)[source]

Example of creating a counterparty.

openbankproject_client.examples.get_customer_example(client, bank_id, customer_id)[source]

Example of getting customer information.

openbankproject_client.examples.create_meeting_example(client, bank_id, customer_id)[source]

Example of creating a customer meeting.

Example of creating a consent.

openbankproject_client.examples.create_standing_order_example(client, bank_id, account_id)[source]

Example of creating a standing order.

openbankproject_client.examples.create_direct_debit_example(client, bank_id, account_id)[source]

Example of creating a direct debit.

openbankproject_client.examples.error_handling_example()[source]

Example of handling API errors.

openbankproject_client.examples.main()[source]

Run all examples.