Metadata-Version: 2.1
Name: formance-sdk-python
Version: 4.0.0
Summary: Python Client SDK Generated by Speakeasy
Home-page: https://github.com/formancehq/formance-sdk-python.git
Author: Formance
License: UNKNOWN
Description: # formance-sdk-python
        
        <div align="left">
            <a href="https://speakeasyapi.dev/"><img src="https://custom-icon-badges.demolab.com/badge/-Built%20By%20Speakeasy-212015?style=for-the-badge&logoColor=FBE331&logo=speakeasy&labelColor=545454" /></a>
            <a href="https://opensource.org/licenses/MIT">
                <img src="https://img.shields.io/badge/License-MIT-blue.svg" style="width: 100px; height: 28px;" />
            </a>
        </div>
        
        
        ## 🏗 **Welcome to your new SDK!** 🏗
        
        It has been generated successfully based on your OpenAPI spec. However, it is not yet ready for production use. Here are some next steps:
        - [ ] 🛠 Make your SDK feel handcrafted by [customizing it](https://www.speakeasyapi.dev/docs/customize-sdks)
        - [ ] ♻️ Refine your SDK quickly by iterating locally with the [Speakeasy CLI](https://github.com/speakeasy-api/speakeasy)
        - [ ] 🎁 Publish your SDK to package managers by [configuring automatic publishing](https://www.speakeasyapi.dev/docs/productionize-sdks/publish-sdks)
        - [ ] ✨ When ready to productionize, delete this section from the README
        
        <!-- Start Summary [summary] -->
        ## Summary
        
        Formance Stack API: Open, modular foundation for unique payments flows
        
        # Introduction
        This API is documented in **OpenAPI format**.
        
        # Authentication
        Formance Stack offers one forms of authentication:
          - OAuth2
        OAuth2 - an open protocol to allow secure authorization in a simple
        and standard method from web, mobile and desktop applications.
        <SecurityDefinitions />
        <!-- End Summary [summary] -->
        
        <!-- Start Table of Contents [toc] -->
        ## Table of Contents
        
        * [SDK Installation](https://github.com/formancehq/formance-sdk-python/blob/master/#sdk-installation)
        * [SDK Example Usage](https://github.com/formancehq/formance-sdk-python/blob/master/#sdk-example-usage)
        * [Available Resources and Operations](https://github.com/formancehq/formance-sdk-python/blob/master/#available-resources-and-operations)
        * [Error Handling](https://github.com/formancehq/formance-sdk-python/blob/master/#error-handling)
        * [Server Selection](https://github.com/formancehq/formance-sdk-python/blob/master/#server-selection)
        * [Custom HTTP Client](https://github.com/formancehq/formance-sdk-python/blob/master/#custom-http-client)
        * [Authentication](https://github.com/formancehq/formance-sdk-python/blob/master/#authentication)
        <!-- End Table of Contents [toc] -->
        
        <!-- Start SDK Installation [installation] -->
        ## SDK Installation
        
        The SDK can be installed using the *pip* package manager, with dependencies and metadata stored in the `setup.py` file.
        
        ```bash
        pip install formance-sdk-python
        ```
        <!-- End SDK Installation [installation] -->
        
        <!-- Start SDK Example Usage [usage] -->
        ## SDK Example Usage
        
        ### Example
        
        ```python
        import sdk
        from sdk.models import shared
        
        s = sdk.SDK(
            security=shared.Security(
                client_id="<YOUR_CLIENT_ID_HERE>",
                client_secret="<YOUR_CLIENT_SECRET_HERE>",
            ),
        )
        
        
        res = s.get_oidc_well_knowns()
        
        if res is not None:
            # handle response
            pass
        
        ```
        <!-- End SDK Example Usage [usage] -->
        
        <!-- Start Available Resources and Operations [operations] -->
        ## Available Resources and Operations
        
        <details open>
        <summary>Available methods</summary>
        
        ### [auth](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/auth/README.md)
        
        * [create_client](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/auth/README.md#create_client) - Create client
        * [create_secret](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/auth/README.md#create_secret) - Add a secret to a client
        * [delete_client](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/auth/README.md#delete_client) - Delete client
        * [delete_secret](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/auth/README.md#delete_secret) - Delete a secret from a client
        * [list_clients](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/auth/README.md#list_clients) - List clients
        * [list_users](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/auth/README.md#list_users) - List users
        * [read_client](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/auth/README.md#read_client) - Read client
        * [read_user](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/auth/README.md#read_user) - Read user
        * [update_client](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/auth/README.md#update_client) - Update client
        
        ### [ledger](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/ledger/README.md)
        
        * [create_transactions](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/ledger/README.md#create_transactions) - Create a new batch of transactions to a ledger
        * [add_metadata_on_transaction](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/ledger/README.md#add_metadata_on_transaction) - Set the metadata of a transaction by its ID
        * [add_metadata_to_account](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/ledger/README.md#add_metadata_to_account) - Add metadata to an account
        * [count_accounts](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/ledger/README.md#count_accounts) - Count the accounts from a ledger
        * [count_transactions](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/ledger/README.md#count_transactions) - Count the transactions from a ledger
        * [create_transaction](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/ledger/README.md#create_transaction) - Create a new transaction to a ledger
        * [get_account](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/ledger/README.md#get_account) - Get account by its address
        * [get_balances](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/ledger/README.md#get_balances) - Get the balances from a ledger's account
        * [get_balances_aggregated](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/ledger/README.md#get_balances_aggregated) - Get the aggregated balances from selected accounts
        * [get_info](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/ledger/README.md#get_info) - Show server information
        * [get_ledger_info](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/ledger/README.md#get_ledger_info) - Get information about a ledger
        * [get_mapping](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/ledger/README.md#get_mapping) - Get the mapping of a ledger
        * [get_transaction](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/ledger/README.md#get_transaction) - Get transaction from a ledger by its ID
        * [list_accounts](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/ledger/README.md#list_accounts) - List accounts from a ledger
        * [list_logs](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/ledger/README.md#list_logs) - List the logs from a ledger
        * [list_transactions](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/ledger/README.md#list_transactions) - List transactions from a ledger
        * [read_stats](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/ledger/README.md#read_stats) - Get statistics from a ledger
        * [revert_transaction](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/ledger/README.md#revert_transaction) - Revert a ledger transaction by its ID
        * [~~run_script~~](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/ledger/README.md#run_script) - Execute a Numscript :warning: **Deprecated**
        * [update_mapping](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/ledger/README.md#update_mapping) - Update the mapping of a ledger
        * [v2_add_metadata_on_transaction](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/ledger/README.md#v2_add_metadata_on_transaction) - Set the metadata of a transaction by its ID
        * [v2_add_metadata_to_account](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/ledger/README.md#v2_add_metadata_to_account) - Add metadata to an account
        * [v2_count_accounts](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/ledger/README.md#v2_count_accounts) - Count the accounts from a ledger
        * [v2_count_transactions](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/ledger/README.md#v2_count_transactions) - Count the transactions from a ledger
        * [v2_create_bulk](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/ledger/README.md#v2_create_bulk) - Bulk request
        * [v2_create_ledger](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/ledger/README.md#v2_create_ledger) - Create a ledger
        * [v2_create_transaction](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/ledger/README.md#v2_create_transaction) - Create a new transaction to a ledger
        * [v2_delete_account_metadata](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/ledger/README.md#v2_delete_account_metadata) - Delete metadata by key
        * [v2_delete_ledger_metadata](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/ledger/README.md#v2_delete_ledger_metadata) - Delete ledger metadata by key
        * [v2_delete_transaction_metadata](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/ledger/README.md#v2_delete_transaction_metadata) - Delete metadata by key
        * [v2_get_account](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/ledger/README.md#v2_get_account) - Get account by its address
        * [v2_get_balances_aggregated](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/ledger/README.md#v2_get_balances_aggregated) - Get the aggregated balances from selected accounts
        * [v2_get_info](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/ledger/README.md#v2_get_info) - Show server information
        * [v2_get_ledger](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/ledger/README.md#v2_get_ledger) - Get a ledger
        * [v2_get_ledger_info](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/ledger/README.md#v2_get_ledger_info) - Get information about a ledger
        * [v2_get_transaction](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/ledger/README.md#v2_get_transaction) - Get transaction from a ledger by its ID
        * [v2_get_volumes_with_balances](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/ledger/README.md#v2_get_volumes_with_balances) - Get list of volumes with balances for (account/asset)
        * [v2_list_accounts](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/ledger/README.md#v2_list_accounts) - List accounts from a ledger
        * [v2_list_ledgers](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/ledger/README.md#v2_list_ledgers) - List ledgers
        * [v2_list_logs](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/ledger/README.md#v2_list_logs) - List the logs from a ledger
        * [v2_list_transactions](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/ledger/README.md#v2_list_transactions) - List transactions from a ledger
        * [v2_read_stats](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/ledger/README.md#v2_read_stats) - Get statistics from a ledger
        * [v2_revert_transaction](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/ledger/README.md#v2_revert_transaction) - Revert a ledger transaction by its ID
        * [v2_update_ledger_metadata](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/ledger/README.md#v2_update_ledger_metadata) - Update ledger metadata
        
        ### [orchestration](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/orchestration/README.md)
        
        * [cancel_event](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/orchestration/README.md#cancel_event) - Cancel a running workflow
        * [create_trigger](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/orchestration/README.md#create_trigger) - Create trigger
        * [create_workflow](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/orchestration/README.md#create_workflow) - Create workflow
        * [delete_trigger](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/orchestration/README.md#delete_trigger) - Delete trigger
        * [delete_workflow](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/orchestration/README.md#delete_workflow) - Delete a flow by id
        * [get_instance](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/orchestration/README.md#get_instance) - Get a workflow instance by id
        * [get_instance_history](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/orchestration/README.md#get_instance_history) - Get a workflow instance history by id
        * [get_instance_stage_history](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/orchestration/README.md#get_instance_stage_history) - Get a workflow instance stage history
        * [get_workflow](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/orchestration/README.md#get_workflow) - Get a flow by id
        * [list_instances](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/orchestration/README.md#list_instances) - List instances of a workflow
        * [list_triggers](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/orchestration/README.md#list_triggers) - List triggers
        * [list_triggers_occurrences](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/orchestration/README.md#list_triggers_occurrences) - List triggers occurrences
        * [list_workflows](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/orchestration/README.md#list_workflows) - List registered workflows
        * [orchestrationget_server_info](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/orchestration/README.md#orchestrationget_server_info) - Get server info
        * [read_trigger](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/orchestration/README.md#read_trigger) - Read trigger
        * [run_workflow](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/orchestration/README.md#run_workflow) - Run workflow
        * [send_event](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/orchestration/README.md#send_event) - Send an event to a running workflow
        * [test_trigger](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/orchestration/README.md#test_trigger) - Test trigger
        * [v2_cancel_event](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/orchestration/README.md#v2_cancel_event) - Cancel a running workflow
        * [v2_create_trigger](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/orchestration/README.md#v2_create_trigger) - Create trigger
        * [v2_create_workflow](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/orchestration/README.md#v2_create_workflow) - Create workflow
        * [v2_delete_trigger](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/orchestration/README.md#v2_delete_trigger) - Delete trigger
        * [v2_delete_workflow](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/orchestration/README.md#v2_delete_workflow) - Delete a flow by id
        * [v2_get_instance](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/orchestration/README.md#v2_get_instance) - Get a workflow instance by id
        * [v2_get_instance_history](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/orchestration/README.md#v2_get_instance_history) - Get a workflow instance history by id
        * [v2_get_instance_stage_history](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/orchestration/README.md#v2_get_instance_stage_history) - Get a workflow instance stage history
        * [v2_get_server_info](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/orchestration/README.md#v2_get_server_info) - Get server info
        * [v2_get_workflow](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/orchestration/README.md#v2_get_workflow) - Get a flow by id
        * [v2_list_instances](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/orchestration/README.md#v2_list_instances) - List instances of a workflow
        * [v2_list_triggers](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/orchestration/README.md#v2_list_triggers) - List triggers
        * [v2_list_triggers_occurrences](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/orchestration/README.md#v2_list_triggers_occurrences) - List triggers occurrences
        * [v2_list_workflows](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/orchestration/README.md#v2_list_workflows) - List registered workflows
        * [v2_read_trigger](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/orchestration/README.md#v2_read_trigger) - Read trigger
        * [v2_run_workflow](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/orchestration/README.md#v2_run_workflow) - Run workflow
        * [v2_send_event](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/orchestration/README.md#v2_send_event) - Send an event to a running workflow
        
        ### [payments](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/payments/README.md)
        
        * [add_account_to_pool](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/payments/README.md#add_account_to_pool) - Add an account to a pool
        * [connectors_transfer](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/payments/README.md#connectors_transfer) - Transfer funds between Connector accounts
        * [create_account](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/payments/README.md#create_account) - Create an account
        * [create_bank_account](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/payments/README.md#create_bank_account) - Create a BankAccount in Payments and on the PSP
        * [create_payment](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/payments/README.md#create_payment) - Create a payment
        * [create_pool](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/payments/README.md#create_pool) - Create a Pool
        * [create_transfer_initiation](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/payments/README.md#create_transfer_initiation) - Create a TransferInitiation
        * [delete_pool](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/payments/README.md#delete_pool) - Delete a Pool
        * [delete_transfer_initiation](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/payments/README.md#delete_transfer_initiation) - Delete a transfer initiation
        * [forward_bank_account](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/payments/README.md#forward_bank_account) - Forward a bank account to a connector
        * [get_account_balances](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/payments/README.md#get_account_balances) - Get account balances
        * [get_bank_account](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/payments/README.md#get_bank_account) - Get a bank account created by user on Formance
        * [~~get_connector_task~~](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/payments/README.md#get_connector_task) - Read a specific task of the connector :warning: **Deprecated**
        * [get_connector_task_v1](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/payments/README.md#get_connector_task_v1) - Read a specific task of the connector
        * [get_payment](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/payments/README.md#get_payment) - Get a payment
        * [get_pool](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/payments/README.md#get_pool) - Get a Pool
        * [get_pool_balances](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/payments/README.md#get_pool_balances) - Get pool balances
        * [get_transfer_initiation](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/payments/README.md#get_transfer_initiation) - Get a transfer initiation
        * [install_connector](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/payments/README.md#install_connector) - Install a connector
        * [list_all_connectors](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/payments/README.md#list_all_connectors) - List all installed connectors
        * [list_bank_accounts](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/payments/README.md#list_bank_accounts) - List bank accounts created by user on Formance
        * [list_configs_available_connectors](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/payments/README.md#list_configs_available_connectors) - List the configs of each available connector
        * [~~list_connector_tasks~~](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/payments/README.md#list_connector_tasks) - List tasks from a connector :warning: **Deprecated**
        * [list_connector_tasks_v1](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/payments/README.md#list_connector_tasks_v1) - List tasks from a connector
        * [list_payments](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/payments/README.md#list_payments) - List payments
        * [list_pools](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/payments/README.md#list_pools) - List Pools
        * [list_transfer_initiations](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/payments/README.md#list_transfer_initiations) - List Transfer Initiations
        * [paymentsget_account](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/payments/README.md#paymentsget_account) - Get an account
        * [paymentsget_server_info](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/payments/README.md#paymentsget_server_info) - Get server info
        * [paymentslist_accounts](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/payments/README.md#paymentslist_accounts) - List accounts
        * [~~read_connector_config~~](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/payments/README.md#read_connector_config) - Read the config of a connector :warning: **Deprecated**
        * [read_connector_config_v1](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/payments/README.md#read_connector_config_v1) - Read the config of a connector
        * [remove_account_from_pool](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/payments/README.md#remove_account_from_pool) - Remove an account from a pool
        * [~~reset_connector~~](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/payments/README.md#reset_connector) - Reset a connector :warning: **Deprecated**
        * [reset_connector_v1](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/payments/README.md#reset_connector_v1) - Reset a connector
        * [retry_transfer_initiation](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/payments/README.md#retry_transfer_initiation) - Retry a failed transfer initiation
        * [reverse_transfer_initiation](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/payments/README.md#reverse_transfer_initiation) - Reverse a transfer initiation
        * [udpate_transfer_initiation_status](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/payments/README.md#udpate_transfer_initiation_status) - Update the status of a transfer initiation
        * [~~uninstall_connector~~](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/payments/README.md#uninstall_connector) - Uninstall a connector :warning: **Deprecated**
        * [uninstall_connector_v1](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/payments/README.md#uninstall_connector_v1) - Uninstall a connector
        * [update_bank_account_metadata](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/payments/README.md#update_bank_account_metadata) - Update metadata of a bank account
        * [update_connector_config_v1](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/payments/README.md#update_connector_config_v1) - Update the config of a connector
        * [update_metadata](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/payments/README.md#update_metadata) - Update metadata
        
        ### [reconciliation](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/reconciliation/README.md)
        
        * [create_policy](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/reconciliation/README.md#create_policy) - Create a policy
        * [delete_policy](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/reconciliation/README.md#delete_policy) - Delete a policy
        * [get_policy](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/reconciliation/README.md#get_policy) - Get a policy
        * [get_reconciliation](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/reconciliation/README.md#get_reconciliation) - Get a reconciliation
        * [list_policies](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/reconciliation/README.md#list_policies) - List policies
        * [list_reconciliations](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/reconciliation/README.md#list_reconciliations) - List reconciliations
        * [reconcile](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/reconciliation/README.md#reconcile) - Reconcile using a policy
        * [reconciliationget_server_info](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/reconciliation/README.md#reconciliationget_server_info) - Get server info
        
        ### [SDK](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/sdk/README.md)
        
        * [get_oidc_well_knowns](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/sdk/README.md#get_oidc_well_knowns) - Retrieve OpenID connect well-knowns.
        * [get_versions](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/sdk/README.md#get_versions) - Show stack version information
        
        ### [search](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/search/README.md)
        
        * [search](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/search/README.md#search) - Search
        * [searchget_server_info](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/search/README.md#searchget_server_info) - Get server info
        
        ### [wallets](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/wallets/README.md)
        
        * [confirm_hold](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/wallets/README.md#confirm_hold) - Confirm a hold
        * [create_balance](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/wallets/README.md#create_balance) - Create a balance
        * [create_wallet](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/wallets/README.md#create_wallet) - Create a new wallet
        * [credit_wallet](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/wallets/README.md#credit_wallet) - Credit a wallet
        * [debit_wallet](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/wallets/README.md#debit_wallet) - Debit a wallet
        * [get_balance](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/wallets/README.md#get_balance) - Get detailed balance
        * [get_hold](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/wallets/README.md#get_hold) - Get a hold
        * [get_holds](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/wallets/README.md#get_holds) - Get all holds for a wallet
        * [get_transactions](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/wallets/README.md#get_transactions)
        * [get_wallet](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/wallets/README.md#get_wallet) - Get a wallet
        * [get_wallet_summary](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/wallets/README.md#get_wallet_summary) - Get wallet summary
        * [list_balances](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/wallets/README.md#list_balances) - List balances of a wallet
        * [list_wallets](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/wallets/README.md#list_wallets) - List all wallets
        * [update_wallet](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/wallets/README.md#update_wallet) - Update a wallet
        * [void_hold](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/wallets/README.md#void_hold) - Cancel a hold
        * [walletsget_server_info](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/wallets/README.md#walletsget_server_info) - Get server info
        
        ### [webhooks](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/webhooks/README.md)
        
        * [activate_config](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/webhooks/README.md#activate_config) - Activate one config
        * [change_config_secret](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/webhooks/README.md#change_config_secret) - Change the signing secret of a config
        * [deactivate_config](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/webhooks/README.md#deactivate_config) - Deactivate one config
        * [delete_config](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/webhooks/README.md#delete_config) - Delete one config
        * [get_many_configs](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/webhooks/README.md#get_many_configs) - Get many configs
        * [insert_config](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/webhooks/README.md#insert_config) - Insert a new config
        * [test_config](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/webhooks/README.md#test_config) - Test one config
        
        </details>
        <!-- End Available Resources and Operations [operations] -->
        
        <!-- Start Error Handling [errors] -->
        ## Error Handling
        
        Handling errors in this SDK should largely match your expectations.  All operations return a response object or raise an error.  If Error objects are specified in your OpenAPI Spec, the SDK will raise the appropriate Error type.
        
        | Error Object         | Status Code          | Content Type         |
        | -------------------- | -------------------- | -------------------- |
        | errors.ErrorResponse | default              | application/json     |
        | errors.SDKError      | 4xx-5xx              | */*                  |
        
        ### Example
        
        ```python
        import sdk
        from sdk.models import errors, operations, shared
        
        s = sdk.SDK(
            security=shared.Security(
                client_id="<YOUR_CLIENT_ID_HERE>",
                client_secret="<YOUR_CLIENT_SECRET_HERE>",
            ),
        )
        
        res = None
        try:
            res = s.ledger.create_transactions(request=operations.CreateTransactionsRequest(
            transactions=shared.Transactions(
                transactions=[
                    shared.TransactionData(
                        postings=[
                            shared.Posting(
                                amount=100,
                                asset='COIN',
                                destination='users:002',
                                source='users:001',
                            ),
                            shared.Posting(
                                amount=100,
                                asset='COIN',
                                destination='users:002',
                                source='users:001',
                            ),
                            shared.Posting(
                                amount=100,
                                asset='COIN',
                                destination='users:002',
                                source='users:001',
                            ),
                        ],
                        reference='ref:001',
                    ),
                ],
            ),
            ledger='ledger001',
        ))
        
        except errors.ErrorResponse as e:
            # handle exception
            raise(e)
        except errors.SDKError as e:
            # handle exception
            raise(e)
        
        if res.transactions_response is not None:
            # handle response
            pass
        
        ```
        <!-- End Error Handling [errors] -->
        
        <!-- Start Server Selection [server] -->
        ## Server Selection
        
        ### Select Server by Index
        
        You can override the default server globally by passing a server index to the `server_idx: int` optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:
        
        | # | Server | Variables |
        | - | ------ | --------- |
        | 0 | `http://localhost` | None |
        
        #### Example
        
        ```python
        import sdk
        from sdk.models import shared
        
        s = sdk.SDK(
            server_idx=0,
            security=shared.Security(
                client_id="<YOUR_CLIENT_ID_HERE>",
                client_secret="<YOUR_CLIENT_SECRET_HERE>",
            ),
        )
        
        
        res = s.get_oidc_well_knowns()
        
        if res is not None:
            # handle response
            pass
        
        ```
        
        
        ### Override Server URL Per-Client
        
        The default server can also be overridden globally by passing a URL to the `server_url: str` optional parameter when initializing the SDK client instance. For example:
        ```python
        import sdk
        from sdk.models import shared
        
        s = sdk.SDK(
            server_url="http://localhost",
            security=shared.Security(
                client_id="<YOUR_CLIENT_ID_HERE>",
                client_secret="<YOUR_CLIENT_SECRET_HERE>",
            ),
        )
        
        
        res = s.get_oidc_well_knowns()
        
        if res is not None:
            # handle response
            pass
        
        ```
        <!-- End Server Selection [server] -->
        
        <!-- Start Custom HTTP Client [http-client] -->
        ## Custom HTTP Client
        
        The Python SDK makes API calls using the [requests](https://pypi.org/project/requests/) HTTP library.  In order to provide a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration, you can initialize the SDK client with a custom `requests.Session` object.
        
        For example, you could specify a header for every request that this sdk makes as follows:
        ```python
        import sdk
        import requests
        
        http_client = requests.Session()
        http_client.headers.update({'x-custom-header': 'someValue'})
        s = sdk.SDK(client=http_client)
        ```
        <!-- End Custom HTTP Client [http-client] -->
        
        <!-- Start Authentication [security] -->
        ## Authentication
        
        ### Per-Client Security Schemes
        
        This SDK supports the following security scheme globally:
        
        | Name                           | Type                           | Scheme                         |
        | ------------------------------ | ------------------------------ | ------------------------------ |
        | `client_id` `client_secret`    | oauth2                         | OAuth2 Client Credentials Flow |
        
        You can set the security parameters through the `security` optional parameter when initializing the SDK client instance. For example:
        ```python
        import sdk
        from sdk.models import shared
        
        s = sdk.SDK(
            security=shared.Security(
                client_id="<YOUR_CLIENT_ID_HERE>",
                client_secret="<YOUR_CLIENT_SECRET_HERE>",
            ),
        )
        
        
        res = s.get_oidc_well_knowns()
        
        if res is not None:
            # handle response
            pass
        
        ```
        <!-- End Authentication [security] -->
        
        <!-- Placeholder for Future Speakeasy SDK Sections -->
        
        # Development
        
        ## Maturity
        
        This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage
        to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally
        looking for the latest version.
        
        ## Contributions
        
        While we value open-source contributions to this SDK, this library is generated programmatically.
        Feel free to open a PR or a Github issue as a proof of concept and we'll do our best to include it in a future release!
        
        ### SDK Created by [Speakeasy](https://docs.speakeasyapi.dev/docs/using-speakeasy/client-sdks)
        
Platform: UNKNOWN
Requires-Python: >=3.8
Description-Content-Type: text/markdown
Provides-Extra: dev
