formance-sdk-python

Name	formance-sdk-python JSON
Version	6.4.0 JSON
	download
home_page	https://github.com/formancehq/formance-sdk-python.git
Summary	Python Client SDK Generated by Speakeasy
upload_time	2025-09-17 08:26:57
maintainer	None
docs_url	None
author	Speakeasy
requires_python	>=3.9.2
license	None
keywords
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # 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>

<!-- 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
<!-- $toc-max-depth=2 -->
* [formance-sdk-python](https://github.com/formancehq/formance-sdk-python/blob/master/./#formance-sdk-python)
  * [🏗 **Welcome to your new SDK!** 🏗](https://github.com/formancehq/formance-sdk-python/blob/master/./#welcome-to-your-new-sdk)
* [Introduction](https://github.com/formancehq/formance-sdk-python/blob/master/./#introduction)
* [Authentication](https://github.com/formancehq/formance-sdk-python/blob/master/./#authentication)
  * [SDK Installation](https://github.com/formancehq/formance-sdk-python/blob/master/./#sdk-installation)
  * [IDE Support](https://github.com/formancehq/formance-sdk-python/blob/master/./#ide-support)
  * [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)
  * [File uploads](https://github.com/formancehq/formance-sdk-python/blob/master/./#file-uploads)
  * [Retries](https://github.com/formancehq/formance-sdk-python/blob/master/./#retries)
  * [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-1)
  * [Resource Management](https://github.com/formancehq/formance-sdk-python/blob/master/./#resource-management)
  * [Debugging](https://github.com/formancehq/formance-sdk-python/blob/master/./#debugging)
* [Development](https://github.com/formancehq/formance-sdk-python/blob/master/./#development)
  * [Maturity](https://github.com/formancehq/formance-sdk-python/blob/master/./#maturity)
  * [Contributions](https://github.com/formancehq/formance-sdk-python/blob/master/./#contributions)

<!-- End Table of Contents [toc] -->

<!-- Start SDK Installation [installation] -->
## SDK Installation

> [!NOTE]
> **Python version upgrade policy**
>
> Once a Python version reaches its [official end of life date](https://devguide.python.org/versions/), a 3-month grace period is provided for users to upgrade. Following this grace period, the minimum python version supported in the SDK will be updated.

The SDK can be installed with *uv*, *pip*, or *poetry* package managers.

### uv

*uv* is a fast Python package installer and resolver, designed as a drop-in replacement for pip and pip-tools. It's recommended for its speed and modern Python tooling capabilities.

```bash
uv add formance-sdk-python
```

### PIP

*PIP* is the default package installer for Python, enabling easy installation and management of packages from PyPI via the command line.

```bash
pip install formance-sdk-python
```

### Poetry

*Poetry* is a modern tool that simplifies dependency management and package publishing by using a single `pyproject.toml` file to handle project metadata and dependencies.

```bash
poetry add formance-sdk-python
```

### Shell and script usage with `uv`

You can use this SDK in a Python shell with [uv](https://docs.astral.sh/uv/) and the `uvx` command that comes with it like so:

```shell
uvx --from formance-sdk-python python
```

It's also possible to write a standalone Python script without needing to set up a whole project like so:

```python
#!/usr/bin/env -S uv run --script
# /// script
# requires-python = ">=3.9"
# dependencies = [
#     "formance-sdk-python",
# ]
# ///

from formance_sdk_python import SDK

sdk = SDK(
  # SDK arguments
)

# Rest of script here...
```

Once that is saved to a file, you can run it with `uv run script.py` where
`script.py` can be replaced with the actual file name.
<!-- End SDK Installation [installation] -->

<!-- Start IDE Support [idesupport] -->
## IDE Support

### PyCharm

Generally, the SDK will work well with most IDEs out of the box. However, when using PyCharm, you can enjoy much better integration with Pydantic by installing an additional plugin.

- [PyCharm Pydantic Plugin](https://docs.pydantic.dev/latest/integrations/pycharm/)
<!-- End IDE Support [idesupport] -->

<!-- Start SDK Example Usage [usage] -->
## SDK Example Usage

### Example

```python
# Synchronous Example
from formance_sdk_python import SDK
from formance_sdk_python.models import shared


with SDK(
    security=shared.Security(
        client_id="<YOUR_CLIENT_ID_HERE>",
        client_secret="<YOUR_CLIENT_SECRET_HERE>",
    ),
) as sdk:

    res = sdk.get_versions()

    assert res.get_versions_response is not None

    # Handle response
    print(res.get_versions_response)
```

</br>

The same SDK client can also be used to make asynchronous requests by importing asyncio.
```python
# Asynchronous Example
import asyncio
from formance_sdk_python import SDK
from formance_sdk_python.models import shared

async def main():

    async with SDK(
        security=shared.Security(
            client_id="<YOUR_CLIENT_ID_HERE>",
            client_secret="<YOUR_CLIENT_SECRET_HERE>",
        ),
    ) as sdk:

        res = await sdk.get_versions_async()

        assert res.get_versions_response is not None

        # Handle response
        print(res.get_versions_response)

asyncio.run(main())
```
<!-- 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)


#### [auth.v1](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/authv1/README.md)

* [create_client](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/authv1/README.md#create_client) - Create client
* [create_secret](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/authv1/README.md#create_secret) - Add a secret to a client
* [delete_client](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/authv1/README.md#delete_client) - Delete client
* [delete_secret](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/authv1/README.md#delete_secret) - Delete a secret from a client
* [get_oidc_well_knowns](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/authv1/README.md#get_oidc_well_knowns) - Retrieve OpenID connect well-knowns.
* [get_server_info](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/authv1/README.md#get_server_info) - Get server info
* [list_clients](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/authv1/README.md#list_clients) - List clients
* [list_users](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/authv1/README.md#list_users) - List users
* [read_client](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/authv1/README.md#read_client) - Read client
* [read_user](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/authv1/README.md#read_user) - Read user
* [update_client](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/authv1/README.md#update_client) - Update client

### [ledger](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/ledger/README.md)


#### [ledger.v1](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/ledgerv1/README.md)

* [create_transactions](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/ledgerv1/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/ledgerv1/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/ledgerv1/README.md#add_metadata_to_account) - Add metadata to an account
* [count_accounts](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/ledgerv1/README.md#count_accounts) - Count the accounts from a ledger
* [count_transactions](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/ledgerv1/README.md#count_transactions) - Count the transactions from a ledger
* [create_transaction](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/ledgerv1/README.md#create_transaction) - Create a new transaction to a ledger
* [get_account](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/ledgerv1/README.md#get_account) - Get account by its address
* [get_balances](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/ledgerv1/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/ledgerv1/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/ledgerv1/README.md#get_info) - Show server information
* [get_ledger_info](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/ledgerv1/README.md#get_ledger_info) - Get information about a ledger
* [get_mapping](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/ledgerv1/README.md#get_mapping) - Get the mapping of a ledger
* [get_transaction](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/ledgerv1/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/ledgerv1/README.md#list_accounts) - List accounts from a ledger
* [list_logs](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/ledgerv1/README.md#list_logs) - List the logs from a ledger
* [list_transactions](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/ledgerv1/README.md#list_transactions) - List transactions from a ledger
* [read_stats](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/ledgerv1/README.md#read_stats) - Get statistics from a ledger
* [revert_transaction](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/ledgerv1/README.md#revert_transaction) - Revert a ledger transaction by its ID
* [~~run_script~~](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/ledgerv1/README.md#run_script) - Execute a Numscript :warning: **Deprecated**
* [update_mapping](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/ledgerv1/README.md#update_mapping) - Update the mapping of a ledger

#### [ledger.v2](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/ledgerv2/README.md)

* [add_metadata_on_transaction](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/ledgerv2/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/ledgerv2/README.md#add_metadata_to_account) - Add metadata to an account
* [count_accounts](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/ledgerv2/README.md#count_accounts) - Count the accounts from a ledger
* [count_transactions](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/ledgerv2/README.md#count_transactions) - Count the transactions from a ledger
* [create_bulk](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/ledgerv2/README.md#create_bulk) - Bulk request
* [create_ledger](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/ledgerv2/README.md#create_ledger) - Create a ledger
* [create_transaction](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/ledgerv2/README.md#create_transaction) - Create a new transaction to a ledger
* [delete_account_metadata](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/ledgerv2/README.md#delete_account_metadata) - Delete metadata by key
* [delete_ledger_metadata](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/ledgerv2/README.md#delete_ledger_metadata) - Delete ledger metadata by key
* [delete_transaction_metadata](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/ledgerv2/README.md#delete_transaction_metadata) - Delete metadata by key
* [export_logs](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/ledgerv2/README.md#export_logs) - Export logs
* [get_account](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/ledgerv2/README.md#get_account) - Get account by its address
* [get_balances_aggregated](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/ledgerv2/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/ledgerv2/README.md#get_info) - Show server information
* [get_ledger](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/ledgerv2/README.md#get_ledger) - Get a ledger
* [get_ledger_info](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/ledgerv2/README.md#get_ledger_info) - Get information about a ledger
* [get_metrics](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/ledgerv2/README.md#get_metrics) - Read in memory metrics
* [get_transaction](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/ledgerv2/README.md#get_transaction) - Get transaction from a ledger by its ID
* [get_volumes_with_balances](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/ledgerv2/README.md#get_volumes_with_balances) - Get list of volumes with balances for (account/asset)
* [import_logs](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/ledgerv2/README.md#import_logs)
* [list_accounts](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/ledgerv2/README.md#list_accounts) - List accounts from a ledger
* [list_ledgers](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/ledgerv2/README.md#list_ledgers) - List ledgers
* [list_logs](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/ledgerv2/README.md#list_logs) - List the logs from a ledger
* [list_transactions](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/ledgerv2/README.md#list_transactions) - List transactions from a ledger
* [read_stats](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/ledgerv2/README.md#read_stats) - Get statistics from a ledger
* [revert_transaction](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/ledgerv2/README.md#revert_transaction) - Revert a ledger transaction by its ID
* [update_ledger_metadata](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/ledgerv2/README.md#update_ledger_metadata) - Update ledger metadata

### [orchestration](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/orchestration/README.md)


#### [orchestration.v1](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/orchestrationv1/README.md)

* [cancel_event](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/orchestrationv1/README.md#cancel_event) - Cancel a running workflow
* [create_trigger](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/orchestrationv1/README.md#create_trigger) - Create trigger
* [create_workflow](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/orchestrationv1/README.md#create_workflow) - Create workflow
* [delete_trigger](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/orchestrationv1/README.md#delete_trigger) - Delete trigger
* [delete_workflow](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/orchestrationv1/README.md#delete_workflow) - Delete a flow by id
* [get_instance](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/orchestrationv1/README.md#get_instance) - Get a workflow instance by id
* [get_instance_history](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/orchestrationv1/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/orchestrationv1/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/orchestrationv1/README.md#get_workflow) - Get a flow by id
* [list_instances](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/orchestrationv1/README.md#list_instances) - List instances of a workflow
* [list_triggers](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/orchestrationv1/README.md#list_triggers) - List triggers
* [list_triggers_occurrences](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/orchestrationv1/README.md#list_triggers_occurrences) - List triggers occurrences
* [list_workflows](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/orchestrationv1/README.md#list_workflows) - List registered workflows
* [orchestrationget_server_info](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/orchestrationv1/README.md#orchestrationget_server_info) - Get server info
* [read_trigger](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/orchestrationv1/README.md#read_trigger) - Read trigger
* [run_workflow](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/orchestrationv1/README.md#run_workflow) - Run workflow
* [send_event](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/orchestrationv1/README.md#send_event) - Send an event to a running workflow

#### [orchestration.v2](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/orchestrationv2/README.md)

* [cancel_event](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/orchestrationv2/README.md#cancel_event) - Cancel a running workflow
* [create_trigger](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/orchestrationv2/README.md#create_trigger) - Create trigger
* [create_workflow](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/orchestrationv2/README.md#create_workflow) - Create workflow
* [delete_trigger](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/orchestrationv2/README.md#delete_trigger) - Delete trigger
* [delete_workflow](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/orchestrationv2/README.md#delete_workflow) - Delete a flow by id
* [get_instance](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/orchestrationv2/README.md#get_instance) - Get a workflow instance by id
* [get_instance_history](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/orchestrationv2/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/orchestrationv2/README.md#get_instance_stage_history) - Get a workflow instance stage history
* [get_server_info](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/orchestrationv2/README.md#get_server_info) - Get server info
* [get_workflow](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/orchestrationv2/README.md#get_workflow) - Get a flow by id
* [list_instances](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/orchestrationv2/README.md#list_instances) - List instances of a workflow
* [list_triggers](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/orchestrationv2/README.md#list_triggers) - List triggers
* [list_triggers_occurrences](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/orchestrationv2/README.md#list_triggers_occurrences) - List triggers occurrences
* [list_workflows](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/orchestrationv2/README.md#list_workflows) - List registered workflows
* [read_trigger](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/orchestrationv2/README.md#read_trigger) - Read trigger
* [run_workflow](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/orchestrationv2/README.md#run_workflow) - Run workflow
* [send_event](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/orchestrationv2/README.md#send_event) - Send an event to a running workflow
* [test_trigger](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/orchestrationv2/README.md#test_trigger) - Test trigger

### [payments](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/payments/README.md)


#### [payments.v1](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/paymentsv1/README.md)

* [add_account_to_pool](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/paymentsv1/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/paymentsv1/README.md#connectors_transfer) - Transfer funds between Connector accounts
* [create_account](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/paymentsv1/README.md#create_account) - Create an account
* [create_bank_account](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/paymentsv1/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/paymentsv1/README.md#create_payment) - Create a payment
* [create_pool](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/paymentsv1/README.md#create_pool) - Create a Pool
* [create_transfer_initiation](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/paymentsv1/README.md#create_transfer_initiation) - Create a TransferInitiation
* [delete_pool](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/paymentsv1/README.md#delete_pool) - Delete a Pool
* [delete_transfer_initiation](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/paymentsv1/README.md#delete_transfer_initiation) - Delete a transfer initiation
* [forward_bank_account](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/paymentsv1/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/paymentsv1/README.md#get_account_balances) - Get account balances
* [get_bank_account](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/paymentsv1/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/paymentsv1/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/paymentsv1/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/paymentsv1/README.md#get_payment) - Get a payment
* [get_pool](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/paymentsv1/README.md#get_pool) - Get a Pool
* [get_pool_balances](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/paymentsv1/README.md#get_pool_balances) - Get historical pool balances at a particular point in time
* [get_pool_balances_latest](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/paymentsv1/README.md#get_pool_balances_latest) - Get latest pool balances
* [get_transfer_initiation](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/paymentsv1/README.md#get_transfer_initiation) - Get a transfer initiation
* [install_connector](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/paymentsv1/README.md#install_connector) - Install a connector
* [list_all_connectors](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/paymentsv1/README.md#list_all_connectors) - List all installed connectors
* [list_bank_accounts](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/paymentsv1/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/paymentsv1/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/paymentsv1/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/paymentsv1/README.md#list_connector_tasks_v1) - List tasks from a connector
* [list_payments](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/paymentsv1/README.md#list_payments) - List payments
* [list_pools](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/paymentsv1/README.md#list_pools) - List Pools
* [list_transfer_initiations](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/paymentsv1/README.md#list_transfer_initiations) - List Transfer Initiations
* [paymentsget_account](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/paymentsv1/README.md#paymentsget_account) - Get an account
* [paymentsget_server_info](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/paymentsv1/README.md#paymentsget_server_info) - Get server info
* [paymentslist_accounts](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/paymentsv1/README.md#paymentslist_accounts) - List accounts
* [~~read_connector_config~~](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/paymentsv1/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/paymentsv1/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/paymentsv1/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/paymentsv1/README.md#reset_connector) - Reset a connector :warning: **Deprecated**
* [reset_connector_v1](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/paymentsv1/README.md#reset_connector_v1) - Reset a connector
* [retry_transfer_initiation](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/paymentsv1/README.md#retry_transfer_initiation) - Retry a failed transfer initiation
* [reverse_transfer_initiation](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/paymentsv1/README.md#reverse_transfer_initiation) - Reverse a transfer initiation
* [~~uninstall_connector~~](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/paymentsv1/README.md#uninstall_connector) - Uninstall a connector :warning: **Deprecated**
* [uninstall_connector_v1](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/paymentsv1/README.md#uninstall_connector_v1) - Uninstall a connector
* [update_bank_account_metadata](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/paymentsv1/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/paymentsv1/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/paymentsv1/README.md#update_metadata) - Update metadata
* [update_transfer_initiation_status](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/paymentsv1/README.md#update_transfer_initiation_status) - Update the status of a transfer initiation

#### [payments.v3](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/v3/README.md)

* [add_account_to_pool](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/v3/README.md#add_account_to_pool) - Add an account to a pool
* [add_bank_account_to_payment_service_user](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/v3/README.md#add_bank_account_to_payment_service_user) - Add a bank account to a payment service user
* [approve_payment_initiation](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/v3/README.md#approve_payment_initiation) - Approve a payment initiation
* [create_account](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/v3/README.md#create_account) - Create a formance account object. This object will not be forwarded to the connector. It is only used for internal purposes.

* [create_bank_account](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/v3/README.md#create_bank_account) - Create a formance bank account object. This object will not be forwarded to the connector until you called the forwardBankAccount method.

* [create_payment](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/v3/README.md#create_payment) - Create a formance payment object. This object will not be forwarded to the connector. It is only used for internal purposes.

* [create_payment_service_user](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/v3/README.md#create_payment_service_user) - Create a formance payment service user object
* [create_pool](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/v3/README.md#create_pool) - Create a formance pool object
* [delete_payment_initiation](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/v3/README.md#delete_payment_initiation) - Delete a payment initiation by ID
* [delete_pool](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/v3/README.md#delete_pool) - Delete a pool by ID
* [forward_bank_account](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/v3/README.md#forward_bank_account) - Forward a Bank Account to a PSP for creation
* [forward_payment_service_user_bank_account](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/v3/README.md#forward_payment_service_user_bank_account) - Forward a payment service user's bank account to a connector
* [get_account](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/v3/README.md#get_account) - Get an account by ID
* [get_account_balances](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/v3/README.md#get_account_balances) - Get account balances
* [get_bank_account](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/v3/README.md#get_bank_account) - Get a Bank Account by ID
* [get_connector_config](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/v3/README.md#get_connector_config) - Get a connector configuration by ID
* [get_connector_schedule](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/v3/README.md#get_connector_schedule) - Get a connector schedule by ID
* [get_payment](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/v3/README.md#get_payment) - Get a payment by ID
* [get_payment_initiation](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/v3/README.md#get_payment_initiation) - Get a payment initiation by ID
* [get_payment_service_user](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/v3/README.md#get_payment_service_user) - Get a payment service user by ID
* [get_pool](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/v3/README.md#get_pool) - Get a pool by ID
* [get_pool_balances](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/v3/README.md#get_pool_balances) - Get historical pool balances from a particular point in time
* [get_pool_balances_latest](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/v3/README.md#get_pool_balances_latest) - Get latest pool balances
* [get_task](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/v3/README.md#get_task) - Get a task and its result by ID
* [initiate_payment](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/v3/README.md#initiate_payment) - Initiate a payment
* [install_connector](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/v3/README.md#install_connector) - Install a connector
* [list_accounts](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/v3/README.md#list_accounts) - List all accounts
* [list_bank_accounts](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/v3/README.md#list_bank_accounts) - List all bank accounts
* [list_connector_configs](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/v3/README.md#list_connector_configs) - List all connector configurations
* [list_connector_schedule_instances](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/v3/README.md#list_connector_schedule_instances) - List all connector schedule instances
* [list_connector_schedules](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/v3/README.md#list_connector_schedules) - List all connector schedules
* [list_connectors](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/v3/README.md#list_connectors) - List all connectors
* [list_payment_initiation_adjustments](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/v3/README.md#list_payment_initiation_adjustments) - List all payment initiation adjustments
* [list_payment_initiation_related_payments](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/v3/README.md#list_payment_initiation_related_payments) - List all payments related to a payment initiation
* [list_payment_initiations](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/v3/README.md#list_payment_initiations) - List all payment initiations
* [list_payment_service_users](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/v3/README.md#list_payment_service_users) - List all payment service users
* [list_payments](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/v3/README.md#list_payments) - List all payments
* [list_pools](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/v3/README.md#list_pools) - List all pools
* [reject_payment_initiation](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/v3/README.md#reject_payment_initiation) - Reject a payment initiation
* [remove_account_from_pool](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/v3/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/v3/README.md#reset_connector) - Reset a connector. Be aware that this will delete all data and stop all existing tasks like payment initiations and bank account creations.
* [retry_payment_initiation](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/v3/README.md#retry_payment_initiation) - Retry a payment initiation
* [reverse_payment_initiation](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/v3/README.md#reverse_payment_initiation) - Reverse a payment initiation
* [uninstall_connector](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/v3/README.md#uninstall_connector) - Uninstall a connector
* [update_bank_account_metadata](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/v3/README.md#update_bank_account_metadata) - Update a bank account's metadata
* [update_payment_metadata](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/v3/README.md#update_payment_metadata) - Update a payment's metadata
* [v3_update_connector_config](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/v3/README.md#v3_update_connector_config) - Update the config of a connector

### [reconciliation](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/reconciliation/README.md)


#### [reconciliation.v1](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/reconciliationv1/README.md)

* [create_policy](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/reconciliationv1/README.md#create_policy) - Create a policy
* [delete_policy](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/reconciliationv1/README.md#delete_policy) - Delete a policy
* [get_policy](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/reconciliationv1/README.md#get_policy) - Get a policy
* [get_reconciliation](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/reconciliationv1/README.md#get_reconciliation) - Get a reconciliation
* [list_policies](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/reconciliationv1/README.md#list_policies) - List policies
* [list_reconciliations](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/reconciliationv1/README.md#list_reconciliations) - List reconciliations
* [reconcile](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/reconciliationv1/README.md#reconcile) - Reconcile using a policy
* [reconciliationget_server_info](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/reconciliationv1/README.md#reconciliationget_server_info) - Get server info

### [SDK](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/sdk/README.md)

* [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.v1~~](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/searchv1/README.md)

* [~~search~~](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/searchv1/README.md#search) - search.v1 :warning: **Deprecated**
* [~~searchget_server_info~~](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/searchv1/README.md#searchget_server_info) - Get server info :warning: **Deprecated**

### [wallets](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/wallets/README.md)


#### [wallets.v1](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/walletsv1/README.md)

* [confirm_hold](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/walletsv1/README.md#confirm_hold) - Confirm a hold
* [create_balance](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/walletsv1/README.md#create_balance) - Create a balance
* [create_wallet](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/walletsv1/README.md#create_wallet) - Create a new wallet
* [credit_wallet](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/walletsv1/README.md#credit_wallet) - Credit a wallet
* [debit_wallet](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/walletsv1/README.md#debit_wallet) - Debit a wallet
* [get_balance](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/walletsv1/README.md#get_balance) - Get detailed balance
* [get_hold](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/walletsv1/README.md#get_hold) - Get a hold
* [get_holds](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/walletsv1/README.md#get_holds) - Get all holds for a wallet
* [get_transactions](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/walletsv1/README.md#get_transactions)
* [get_wallet](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/walletsv1/README.md#get_wallet) - Get a wallet
* [get_wallet_summary](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/walletsv1/README.md#get_wallet_summary) - Get wallet summary
* [list_balances](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/walletsv1/README.md#list_balances) - List balances of a wallet
* [list_wallets](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/walletsv1/README.md#list_wallets) - List all wallets
* [update_wallet](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/walletsv1/README.md#update_wallet) - Update a wallet
* [void_hold](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/walletsv1/README.md#void_hold) - Cancel a hold
* [walletsget_server_info](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/walletsv1/README.md#walletsget_server_info) - Get server info

### [webhooks](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/webhooks/README.md)


#### [webhooks.v1](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/webhooksv1/README.md)

* [activate_config](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/webhooksv1/README.md#activate_config) - Activate one config
* [change_config_secret](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/webhooksv1/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/webhooksv1/README.md#deactivate_config) - Deactivate one config
* [delete_config](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/webhooksv1/README.md#delete_config) - Delete one config
* [get_many_configs](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/webhooksv1/README.md#get_many_configs) - Get many configs
* [insert_config](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/webhooksv1/README.md#insert_config) - Insert a new config
* [test_config](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/webhooksv1/README.md#test_config) - Test one config
* [update_config](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/webhooksv1/README.md#update_config) - Update one config

</details>
<!-- End Available Resources and Operations [operations] -->

<!-- Start File uploads [file-upload] -->
## File uploads

Certain SDK methods accept file objects as part of a request body or multi-part request. It is possible and typically recommended to upload files as a stream rather than reading the entire contents into memory. This avoids excessive memory consumption and potentially crashing with out-of-memory errors when working with very large files. The following example demonstrates how to attach a file stream to a request.

> [!TIP]
>
> For endpoints that handle file uploads bytes arrays can also be used. However, using streams is recommended for large files.
>

```python
from formance_sdk_python import SDK
from formance_sdk_python.models import shared


with SDK(
    security=shared.Security(
        client_id="<YOUR_CLIENT_ID_HERE>",
        client_secret="<YOUR_CLIENT_SECRET_HERE>",
    ),
) as sdk:

    res = sdk.ledger.v2.import_logs(request={
        "v2_import_logs_request": open("example.file", "rb"),
        "ledger": "ledger001",
    })

    assert res is not None

    # Handle response
    print(res)

```
<!-- End File uploads [file-upload] -->

<!-- Start Retries [retries] -->
## Retries

Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.

To change the default retry strategy for a single API call, simply provide a `RetryConfig` object to the call:
```python
from formance_sdk_python import SDK
from formance_sdk_python.models import shared
from formance_sdk_python.utils import BackoffStrategy, RetryConfig


with SDK(
    security=shared.Security(
        client_id="<YOUR_CLIENT_ID_HERE>",
        client_secret="<YOUR_CLIENT_SECRET_HERE>",
    ),
) as sdk:

    res = sdk.get_versions(,
        RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False))

    assert res.get_versions_response is not None

    # Handle response
    print(res.get_versions_response)

```

If you'd like to override the default retry strategy for all operations that support retries, you can use the `retry_config` optional parameter when initializing the SDK:
```python
from formance_sdk_python import SDK
from formance_sdk_python.models import shared
from formance_sdk_python.utils import BackoffStrategy, RetryConfig


with SDK(
    retry_config=RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False),
    security=shared.Security(
        client_id="<YOUR_CLIENT_ID_HERE>",
        client_secret="<YOUR_CLIENT_SECRET_HERE>",
    ),
) as sdk:

    res = sdk.get_versions()

    assert res.get_versions_response is not None

    # Handle response
    print(res.get_versions_response)

```
<!-- End Retries [retries] -->

<!-- Start Error Handling [errors] -->
## Error Handling

[`SDKBaseError`](https://github.com/formancehq/formance-sdk-python/blob/master/././src/formance_sdk_python/models/errors/sdkbaseerror.py) is the base class for all HTTP error responses. It has the following properties:

| Property           | Type             | Description                                                                             |
| ------------------ | ---------------- | --------------------------------------------------------------------------------------- |
| `err.message`      | `str`            | Error message                                                                           |
| `err.status_code`  | `int`            | HTTP response status code eg `404`                                                      |
| `err.headers`      | `httpx.Headers`  | HTTP response headers                                                                   |
| `err.body`         | `str`            | HTTP body. Can be empty string if no body is returned.                                  |
| `err.raw_response` | `httpx.Response` | Raw HTTP response                                                                       |
| `err.data`         |                  | Optional. Some errors may contain structured data. [See Error Classes](https://github.com/formancehq/formance-sdk-python/blob/master/./#error-classes). |

### Example
```python
from formance_sdk_python import SDK
from formance_sdk_python.models import errors, shared


with SDK(
    security=shared.Security(
        client_id="<YOUR_CLIENT_ID_HERE>",
        client_secret="<YOUR_CLIENT_SECRET_HERE>",
    ),
) as sdk:
    res = None
    try:

        res = sdk.ledger.v2.add_metadata_on_transaction(request={
            "request_body": {
                "admin": "true",
            },
            "dry_run": True,
            "id": 1234,
            "ledger": "ledger001",
        })

        assert res is not None

        # Handle response
        print(res)


    except errors.SDKBaseError as e:
        # The base class for HTTP error responses
        print(e.message)
        print(e.status_code)
        print(e.body)
        print(e.headers)
        print(e.raw_response)

        # Depending on the method different errors may be thrown
        if isinstance(e, errors.V2ErrorResponse):
            print(e.data.details)  # Optional[str]
            print(e.data.error_code)  # shared.V2ErrorsEnum
            print(e.data.error_message)  # str
```

### Error Classes
**Primary error:**
* [`SDKBaseError`](https://github.com/formancehq/formance-sdk-python/blob/master/././src/formance_sdk_python/models/errors/sdkbaseerror.py): The base class for HTTP error responses.

<details><summary>Less common errors (14)</summary>

<br />

**Network errors:**
* [`httpx.RequestError`](https://www.python-httpx.org/exceptions/#httpx.RequestError): Base class for request errors.
    * [`httpx.ConnectError`](https://www.python-httpx.org/exceptions/#httpx.ConnectError): HTTP client was unable to make a request to a server.
    * [`httpx.TimeoutException`](https://www.python-httpx.org/exceptions/#httpx.TimeoutException): HTTP request timed out.


**Inherit from [`SDKBaseError`](https://github.com/formancehq/formance-sdk-python/blob/master/././src/formance_sdk_python/models/errors/sdkbaseerror.py)**:
* [`V3ErrorResponse`](https://github.com/formancehq/formance-sdk-python/blob/master/././src/formance_sdk_python/models/errors/v3errorresponse.py): Error. Applicable to 46 of 219 methods.*
* [`PaymentsErrorResponse`](https://github.com/formancehq/formance-sdk-python/blob/master/././src/formance_sdk_python/models/errors/paymentserrorresponse.py): Error. Applicable to 45 of 219 methods.*
* [`V2ErrorResponse`](https://github.com/formancehq/formance-sdk-python/blob/master/././src/formance_sdk_python/models/errors/v2errorresponse.py): Error. Applicable to 26 of 219 methods.*
* [`ErrorResponse`](https://github.com/formancehq/formance-sdk-python/blob/master/././src/formance_sdk_python/models/errors/errorresponse.py): Applicable to 19 of 219 methods.*
* [`V2Error`](https://github.com/formancehq/formance-sdk-python/blob/master/././src/formance_sdk_python/models/errors/v2error.py): General error. Applicable to 18 of 219 methods.*
* [`Error`](https://github.com/formancehq/formance-sdk-python/blob/master/././src/formance_sdk_python/models/errors/error.py): General error. Applicable to 17 of 219 methods.*
* [`WalletsErrorResponse`](https://github.com/formancehq/formance-sdk-python/blob/master/././src/formance_sdk_python/models/errors/walletserrorresponse.py): Applicable to 15 of 219 methods.*
* [`ReconciliationErrorResponse`](https://github.com/formancehq/formance-sdk-python/blob/master/././src/formance_sdk_python/models/errors/reconciliationerrorresponse.py): Error response. Applicable to 8 of 219 methods.*
* [`WebhooksErrorResponse`](https://github.com/formancehq/formance-sdk-python/blob/master/././src/formance_sdk_python/models/errors/webhookserrorresponse.py): Error. Applicable to 8 of 219 methods.*
* [`ResponseValidationError`](https://github.com/formancehq/formance-sdk-python/blob/master/././src/formance_sdk_python/models/errors/responsevalidationerror.py): Type mismatch between the response data and the expected Pydantic model. Provides access to the Pydantic validation error via the `cause` attribute.

</details>

\* Check [the method documentation](https://github.com/formancehq/formance-sdk-python/blob/master/./#available-resources-and-operations) to see if the error is applicable.
<!-- 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                        | Description                                |
| --- | ----------------------------------------------------- | -------------------------------- | ------------------------------------------ |
| 0   | `http://localhost`                                    |                                  | local server                               |
| 1   | `https://{organization}.{environment}.formance.cloud` | `environment`<br/>`organization` | A per-organization and per-environment API |

If the selected server has variables, you may override its default values through the additional parameters made available in the SDK constructor:

| Variable       | Parameter                               | Supported Values                                                           | Default           | Description                                                   |
| -------------- | --------------------------------------- | -------------------------------------------------------------------------- | ----------------- | ------------------------------------------------------------- |
| `environment`  | `environment: models.ServerEnvironment` | - `"eu.sandbox"`<br/>- `"sandbox"`<br/>- `"eu-west-1"`<br/>- `"us-east-1"` | `"eu.sandbox"`    | The environment name. Defaults to the production environment. |
| `organization` | `organization: str`                     | str                                                                        | `"orgID-stackID"` | The organization name. Defaults to a generic organization.    |

#### Example

```python
from formance_sdk_python import SDK
from formance_sdk_python.models import shared


with SDK(
    server_idx=1,
    environment="us-east-1"
    organization="<value>"
    security=shared.Security(
        client_id="<YOUR_CLIENT_ID_HERE>",
        client_secret="<YOUR_CLIENT_SECRET_HERE>",
    ),
) as sdk:

    res = sdk.get_versions()

    assert res.get_versions_response is not None

    # Handle response
    print(res.get_versions_response)

```

### 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
from formance_sdk_python import SDK
from formance_sdk_python.models import shared


with SDK(
    server_url="https://orgID-stackID.eu.sandbox.formance.cloud",
    security=shared.Security(
        client_id="<YOUR_CLIENT_ID_HERE>",
        client_secret="<YOUR_CLIENT_SECRET_HERE>",
    ),
) as sdk:

    res = sdk.get_versions()

    assert res.get_versions_response is not None

    # Handle response
    print(res.get_versions_response)

```
<!-- End Server Selection [server] -->

<!-- Start Custom HTTP Client [http-client] -->
## Custom HTTP Client

The Python SDK makes API calls using the [httpx](https://www.python-httpx.org/) 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 your own HTTP client instance.
Depending on whether you are using the sync or async version of the SDK, you can pass an instance of `HttpClient` or `AsyncHttpClient` respectively, which are Protocol's ensuring that the client has the necessary methods to make API calls.
This allows you to wrap the client with your own custom logic, such as adding custom headers, logging, or error handling, or you can just pass an instance of `httpx.Client` or `httpx.AsyncClient` directly.

For example, you could specify a header for every request that this sdk makes as follows:
```python
from formance_sdk_python import SDK
import httpx

http_client = httpx.Client(headers={"x-custom-header": "someValue"})
s = SDK(client=http_client)
```

or you could wrap the client with your own custom logic:
```python
from formance_sdk_python import SDK
from formance_sdk_python.httpclient import AsyncHttpClient
import httpx

class CustomClient(AsyncHttpClient):
    client: AsyncHttpClient

    def __init__(self, client: AsyncHttpClient):
        self.client = client

    async def send(
        self,
        request: httpx.Request,
        *,
        stream: bool = False,
        auth: Union[
            httpx._types.AuthTypes, httpx._client.UseClientDefault, None
        ] = httpx.USE_CLIENT_DEFAULT,
        follow_redirects: Union[
            bool, httpx._client.UseClientDefault
        ] = httpx.USE_CLIENT_DEFAULT,
    ) -> httpx.Response:
        request.headers["Client-Level-Header"] = "added by client"

        return await self.client.send(
            request, stream=stream, auth=auth, follow_redirects=follow_redirects
        )

    def build_request(
        self,
        method: str,
        url: httpx._types.URLTypes,
        *,
        content: Optional[httpx._types.RequestContent] = None,
        data: Optional[httpx._types.RequestData] = None,
        files: Optional[httpx._types.RequestFiles] = None,
        json: Optional[Any] = None,
        params: Optional[httpx._types.QueryParamTypes] = None,
        headers: Optional[httpx._types.HeaderTypes] = None,
        cookies: Optional[httpx._types.CookieTypes] = None,
        timeout: Union[
            httpx._types.TimeoutTypes, httpx._client.UseClientDefault
        ] = httpx.USE_CLIENT_DEFAULT,
        extensions: Optional[httpx._types.RequestExtensions] = None,
    ) -> httpx.Request:
        return self.client.build_request(
            method,
            url,
            content=content,
            data=data,
            files=files,
            json=json,
            params=params,
            headers=headers,
            cookies=cookies,
            timeout=timeout,
            extensions=extensions,
        )

s = SDK(async_client=CustomClient(httpx.AsyncClient()))
```
<!-- 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`<br/>`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
from formance_sdk_python import SDK
from formance_sdk_python.models import shared


with SDK(
    security=shared.Security(
        client_id="<YOUR_CLIENT_ID_HERE>",
        client_secret="<YOUR_CLIENT_SECRET_HERE>",
    ),
) as sdk:

    res = sdk.get_versions()

    assert res.get_versions_response is not None

    # Handle response
    print(res.get_versions_response)

```
<!-- End Authentication [security] -->

<!-- Start Resource Management [resource-management] -->
## Resource Management

The `SDK` class implements the context manager protocol and registers a finalizer function to close the underlying sync and async HTTPX clients it uses under the hood. This will close HTTP connections, release memory and free up other resources held by the SDK. In short-lived Python programs and notebooks that make a few SDK method calls, resource management may not be a concern. However, in longer-lived programs, it is beneficial to create a single SDK instance via a [context manager][context-manager] and reuse it across the application.

[context-manager]: https://docs.python.org/3/reference/datamodel.html#context-managers

```python
from formance_sdk_python import SDK
from formance_sdk_python.models import shared
def main():

    with SDK(
        security=shared.Security(
            client_id="<YOUR_CLIENT_ID_HERE>",
            client_secret="<YOUR_CLIENT_SECRET_HERE>",
        ),
    ) as sdk:
        # Rest of application here...


# Or when using async:
async def amain():

    async with SDK(
        security=shared.Security(
            client_id="<YOUR_CLIENT_ID_HERE>",
            client_secret="<YOUR_CLIENT_SECRET_HERE>",
        ),
    ) as sdk:
        # Rest of application here...
```
<!-- End Resource Management [resource-management] -->

<!-- Start Debugging [debug] -->
## Debugging

You can setup your SDK to emit debug logs for SDK requests and responses.

You can pass your own logger class directly into your SDK.
```python
from formance_sdk_python import SDK
import logging

logging.basicConfig(level=logging.DEBUG)
s = SDK(debug_logger=logging.getLogger("formance_sdk_python"))
```
<!-- End Debugging [debug] -->

<!-- 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)

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/formancehq/formance-sdk-python.git",
    "name": "formance-sdk-python",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.9.2",
    "maintainer_email": null,
    "keywords": null,
    "author": "Speakeasy",
    "author_email": null,
    "download_url": "https://files.pythonhosted.org/packages/92/c0/fd7daf6e6d8c9ca86450fe432e41c61b60bb0464fdf46fd780a2814b5030/formance_sdk_python-6.4.0.tar.gz",
    "platform": null,
    "description": "# formance-sdk-python\n\n<div align=\"left\">\n    <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>\n    <a href=\"https://opensource.org/licenses/MIT\">\n        <img src=\"https://img.shields.io/badge/License-MIT-blue.svg\" style=\"width: 100px; height: 28px;\" />\n    </a>\n</div>\n\n<!-- Start Summary [summary] -->\n## Summary\n\nFormance Stack API: Open, modular foundation for unique payments flows\n\n# Introduction\nThis API is documented in **OpenAPI format**.\n\n# Authentication\nFormance Stack offers one forms of authentication:\n  - OAuth2\nOAuth2 - an open protocol to allow secure authorization in a simple\nand standard method from web, mobile and desktop applications.\n<SecurityDefinitions />\n<!-- End Summary [summary] -->\n\n<!-- Start Table of Contents [toc] -->\n## Table of Contents\n<!-- $toc-max-depth=2 -->\n* [formance-sdk-python](https://github.com/formancehq/formance-sdk-python/blob/master/./#formance-sdk-python)\n  * [\ud83c\udfd7 **Welcome to your new SDK!** \ud83c\udfd7](https://github.com/formancehq/formance-sdk-python/blob/master/./#welcome-to-your-new-sdk)\n* [Introduction](https://github.com/formancehq/formance-sdk-python/blob/master/./#introduction)\n* [Authentication](https://github.com/formancehq/formance-sdk-python/blob/master/./#authentication)\n  * [SDK Installation](https://github.com/formancehq/formance-sdk-python/blob/master/./#sdk-installation)\n  * [IDE Support](https://github.com/formancehq/formance-sdk-python/blob/master/./#ide-support)\n  * [SDK Example Usage](https://github.com/formancehq/formance-sdk-python/blob/master/./#sdk-example-usage)\n  * [Available Resources and Operations](https://github.com/formancehq/formance-sdk-python/blob/master/./#available-resources-and-operations)\n  * [File uploads](https://github.com/formancehq/formance-sdk-python/blob/master/./#file-uploads)\n  * [Retries](https://github.com/formancehq/formance-sdk-python/blob/master/./#retries)\n  * [Error Handling](https://github.com/formancehq/formance-sdk-python/blob/master/./#error-handling)\n  * [Server Selection](https://github.com/formancehq/formance-sdk-python/blob/master/./#server-selection)\n  * [Custom HTTP Client](https://github.com/formancehq/formance-sdk-python/blob/master/./#custom-http-client)\n  * [Authentication](https://github.com/formancehq/formance-sdk-python/blob/master/./#authentication-1)\n  * [Resource Management](https://github.com/formancehq/formance-sdk-python/blob/master/./#resource-management)\n  * [Debugging](https://github.com/formancehq/formance-sdk-python/blob/master/./#debugging)\n* [Development](https://github.com/formancehq/formance-sdk-python/blob/master/./#development)\n  * [Maturity](https://github.com/formancehq/formance-sdk-python/blob/master/./#maturity)\n  * [Contributions](https://github.com/formancehq/formance-sdk-python/blob/master/./#contributions)\n\n<!-- End Table of Contents [toc] -->\n\n<!-- Start SDK Installation [installation] -->\n## SDK Installation\n\n> [!NOTE]\n> **Python version upgrade policy**\n>\n> Once a Python version reaches its [official end of life date](https://devguide.python.org/versions/), a 3-month grace period is provided for users to upgrade. Following this grace period, the minimum python version supported in the SDK will be updated.\n\nThe SDK can be installed with *uv*, *pip*, or *poetry* package managers.\n\n### uv\n\n*uv* is a fast Python package installer and resolver, designed as a drop-in replacement for pip and pip-tools. It's recommended for its speed and modern Python tooling capabilities.\n\n```bash\nuv add formance-sdk-python\n```\n\n### PIP\n\n*PIP* is the default package installer for Python, enabling easy installation and management of packages from PyPI via the command line.\n\n```bash\npip install formance-sdk-python\n```\n\n### Poetry\n\n*Poetry* is a modern tool that simplifies dependency management and package publishing by using a single `pyproject.toml` file to handle project metadata and dependencies.\n\n```bash\npoetry add formance-sdk-python\n```\n\n### Shell and script usage with `uv`\n\nYou can use this SDK in a Python shell with [uv](https://docs.astral.sh/uv/) and the `uvx` command that comes with it like so:\n\n```shell\nuvx --from formance-sdk-python python\n```\n\nIt's also possible to write a standalone Python script without needing to set up a whole project like so:\n\n```python\n#!/usr/bin/env -S uv run --script\n# /// script\n# requires-python = \">=3.9\"\n# dependencies = [\n#     \"formance-sdk-python\",\n# ]\n# ///\n\nfrom formance_sdk_python import SDK\n\nsdk = SDK(\n  # SDK arguments\n)\n\n# Rest of script here...\n```\n\nOnce that is saved to a file, you can run it with `uv run script.py` where\n`script.py` can be replaced with the actual file name.\n<!-- End SDK Installation [installation] -->\n\n<!-- Start IDE Support [idesupport] -->\n## IDE Support\n\n### PyCharm\n\nGenerally, the SDK will work well with most IDEs out of the box. However, when using PyCharm, you can enjoy much better integration with Pydantic by installing an additional plugin.\n\n- [PyCharm Pydantic Plugin](https://docs.pydantic.dev/latest/integrations/pycharm/)\n<!-- End IDE Support [idesupport] -->\n\n<!-- Start SDK Example Usage [usage] -->\n## SDK Example Usage\n\n### Example\n\n```python\n# Synchronous Example\nfrom formance_sdk_python import SDK\nfrom formance_sdk_python.models import shared\n\n\nwith SDK(\n    security=shared.Security(\n        client_id=\"<YOUR_CLIENT_ID_HERE>\",\n        client_secret=\"<YOUR_CLIENT_SECRET_HERE>\",\n    ),\n) as sdk:\n\n    res = sdk.get_versions()\n\n    assert res.get_versions_response is not None\n\n    # Handle response\n    print(res.get_versions_response)\n```\n\n</br>\n\nThe same SDK client can also be used to make asynchronous requests by importing asyncio.\n```python\n# Asynchronous Example\nimport asyncio\nfrom formance_sdk_python import SDK\nfrom formance_sdk_python.models import shared\n\nasync def main():\n\n    async with SDK(\n        security=shared.Security(\n            client_id=\"<YOUR_CLIENT_ID_HERE>\",\n            client_secret=\"<YOUR_CLIENT_SECRET_HERE>\",\n        ),\n    ) as sdk:\n\n        res = await sdk.get_versions_async()\n\n        assert res.get_versions_response is not None\n\n        # Handle response\n        print(res.get_versions_response)\n\nasyncio.run(main())\n```\n<!-- End SDK Example Usage [usage] -->\n\n<!-- Start Available Resources and Operations [operations] -->\n## Available Resources and Operations\n\n<details open>\n<summary>Available methods</summary>\n\n### [auth](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/auth/README.md)\n\n\n#### [auth.v1](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/authv1/README.md)\n\n* [create_client](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/authv1/README.md#create_client) - Create client\n* [create_secret](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/authv1/README.md#create_secret) - Add a secret to a client\n* [delete_client](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/authv1/README.md#delete_client) - Delete client\n* [delete_secret](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/authv1/README.md#delete_secret) - Delete a secret from a client\n* [get_oidc_well_knowns](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/authv1/README.md#get_oidc_well_knowns) - Retrieve OpenID connect well-knowns.\n* [get_server_info](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/authv1/README.md#get_server_info) - Get server info\n* [list_clients](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/authv1/README.md#list_clients) - List clients\n* [list_users](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/authv1/README.md#list_users) - List users\n* [read_client](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/authv1/README.md#read_client) - Read client\n* [read_user](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/authv1/README.md#read_user) - Read user\n* [update_client](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/authv1/README.md#update_client) - Update client\n\n### [ledger](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/ledger/README.md)\n\n\n#### [ledger.v1](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/ledgerv1/README.md)\n\n* [create_transactions](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/ledgerv1/README.md#create_transactions) - Create a new batch of transactions to a ledger\n* [add_metadata_on_transaction](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/ledgerv1/README.md#add_metadata_on_transaction) - Set the metadata of a transaction by its ID\n* [add_metadata_to_account](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/ledgerv1/README.md#add_metadata_to_account) - Add metadata to an account\n* [count_accounts](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/ledgerv1/README.md#count_accounts) - Count the accounts from a ledger\n* [count_transactions](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/ledgerv1/README.md#count_transactions) - Count the transactions from a ledger\n* [create_transaction](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/ledgerv1/README.md#create_transaction) - Create a new transaction to a ledger\n* [get_account](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/ledgerv1/README.md#get_account) - Get account by its address\n* [get_balances](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/ledgerv1/README.md#get_balances) - Get the balances from a ledger's account\n* [get_balances_aggregated](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/ledgerv1/README.md#get_balances_aggregated) - Get the aggregated balances from selected accounts\n* [get_info](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/ledgerv1/README.md#get_info) - Show server information\n* [get_ledger_info](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/ledgerv1/README.md#get_ledger_info) - Get information about a ledger\n* [get_mapping](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/ledgerv1/README.md#get_mapping) - Get the mapping of a ledger\n* [get_transaction](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/ledgerv1/README.md#get_transaction) - Get transaction from a ledger by its ID\n* [list_accounts](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/ledgerv1/README.md#list_accounts) - List accounts from a ledger\n* [list_logs](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/ledgerv1/README.md#list_logs) - List the logs from a ledger\n* [list_transactions](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/ledgerv1/README.md#list_transactions) - List transactions from a ledger\n* [read_stats](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/ledgerv1/README.md#read_stats) - Get statistics from a ledger\n* [revert_transaction](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/ledgerv1/README.md#revert_transaction) - Revert a ledger transaction by its ID\n* [~~run_script~~](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/ledgerv1/README.md#run_script) - Execute a Numscript :warning: **Deprecated**\n* [update_mapping](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/ledgerv1/README.md#update_mapping) - Update the mapping of a ledger\n\n#### [ledger.v2](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/ledgerv2/README.md)\n\n* [add_metadata_on_transaction](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/ledgerv2/README.md#add_metadata_on_transaction) - Set the metadata of a transaction by its ID\n* [add_metadata_to_account](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/ledgerv2/README.md#add_metadata_to_account) - Add metadata to an account\n* [count_accounts](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/ledgerv2/README.md#count_accounts) - Count the accounts from a ledger\n* [count_transactions](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/ledgerv2/README.md#count_transactions) - Count the transactions from a ledger\n* [create_bulk](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/ledgerv2/README.md#create_bulk) - Bulk request\n* [create_ledger](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/ledgerv2/README.md#create_ledger) - Create a ledger\n* [create_transaction](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/ledgerv2/README.md#create_transaction) - Create a new transaction to a ledger\n* [delete_account_metadata](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/ledgerv2/README.md#delete_account_metadata) - Delete metadata by key\n* [delete_ledger_metadata](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/ledgerv2/README.md#delete_ledger_metadata) - Delete ledger metadata by key\n* [delete_transaction_metadata](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/ledgerv2/README.md#delete_transaction_metadata) - Delete metadata by key\n* [export_logs](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/ledgerv2/README.md#export_logs) - Export logs\n* [get_account](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/ledgerv2/README.md#get_account) - Get account by its address\n* [get_balances_aggregated](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/ledgerv2/README.md#get_balances_aggregated) - Get the aggregated balances from selected accounts\n* [get_info](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/ledgerv2/README.md#get_info) - Show server information\n* [get_ledger](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/ledgerv2/README.md#get_ledger) - Get a ledger\n* [get_ledger_info](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/ledgerv2/README.md#get_ledger_info) - Get information about a ledger\n* [get_metrics](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/ledgerv2/README.md#get_metrics) - Read in memory metrics\n* [get_transaction](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/ledgerv2/README.md#get_transaction) - Get transaction from a ledger by its ID\n* [get_volumes_with_balances](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/ledgerv2/README.md#get_volumes_with_balances) - Get list of volumes with balances for (account/asset)\n* [import_logs](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/ledgerv2/README.md#import_logs)\n* [list_accounts](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/ledgerv2/README.md#list_accounts) - List accounts from a ledger\n* [list_ledgers](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/ledgerv2/README.md#list_ledgers) - List ledgers\n* [list_logs](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/ledgerv2/README.md#list_logs) - List the logs from a ledger\n* [list_transactions](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/ledgerv2/README.md#list_transactions) - List transactions from a ledger\n* [read_stats](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/ledgerv2/README.md#read_stats) - Get statistics from a ledger\n* [revert_transaction](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/ledgerv2/README.md#revert_transaction) - Revert a ledger transaction by its ID\n* [update_ledger_metadata](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/ledgerv2/README.md#update_ledger_metadata) - Update ledger metadata\n\n### [orchestration](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/orchestration/README.md)\n\n\n#### [orchestration.v1](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/orchestrationv1/README.md)\n\n* [cancel_event](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/orchestrationv1/README.md#cancel_event) - Cancel a running workflow\n* [create_trigger](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/orchestrationv1/README.md#create_trigger) - Create trigger\n* [create_workflow](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/orchestrationv1/README.md#create_workflow) - Create workflow\n* [delete_trigger](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/orchestrationv1/README.md#delete_trigger) - Delete trigger\n* [delete_workflow](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/orchestrationv1/README.md#delete_workflow) - Delete a flow by id\n* [get_instance](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/orchestrationv1/README.md#get_instance) - Get a workflow instance by id\n* [get_instance_history](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/orchestrationv1/README.md#get_instance_history) - Get a workflow instance history by id\n* [get_instance_stage_history](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/orchestrationv1/README.md#get_instance_stage_history) - Get a workflow instance stage history\n* [get_workflow](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/orchestrationv1/README.md#get_workflow) - Get a flow by id\n* [list_instances](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/orchestrationv1/README.md#list_instances) - List instances of a workflow\n* [list_triggers](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/orchestrationv1/README.md#list_triggers) - List triggers\n* [list_triggers_occurrences](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/orchestrationv1/README.md#list_triggers_occurrences) - List triggers occurrences\n* [list_workflows](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/orchestrationv1/README.md#list_workflows) - List registered workflows\n* [orchestrationget_server_info](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/orchestrationv1/README.md#orchestrationget_server_info) - Get server info\n* [read_trigger](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/orchestrationv1/README.md#read_trigger) - Read trigger\n* [run_workflow](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/orchestrationv1/README.md#run_workflow) - Run workflow\n* [send_event](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/orchestrationv1/README.md#send_event) - Send an event to a running workflow\n\n#### [orchestration.v2](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/orchestrationv2/README.md)\n\n* [cancel_event](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/orchestrationv2/README.md#cancel_event) - Cancel a running workflow\n* [create_trigger](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/orchestrationv2/README.md#create_trigger) - Create trigger\n* [create_workflow](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/orchestrationv2/README.md#create_workflow) - Create workflow\n* [delete_trigger](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/orchestrationv2/README.md#delete_trigger) - Delete trigger\n* [delete_workflow](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/orchestrationv2/README.md#delete_workflow) - Delete a flow by id\n* [get_instance](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/orchestrationv2/README.md#get_instance) - Get a workflow instance by id\n* [get_instance_history](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/orchestrationv2/README.md#get_instance_history) - Get a workflow instance history by id\n* [get_instance_stage_history](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/orchestrationv2/README.md#get_instance_stage_history) - Get a workflow instance stage history\n* [get_server_info](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/orchestrationv2/README.md#get_server_info) - Get server info\n* [get_workflow](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/orchestrationv2/README.md#get_workflow) - Get a flow by id\n* [list_instances](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/orchestrationv2/README.md#list_instances) - List instances of a workflow\n* [list_triggers](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/orchestrationv2/README.md#list_triggers) - List triggers\n* [list_triggers_occurrences](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/orchestrationv2/README.md#list_triggers_occurrences) - List triggers occurrences\n* [list_workflows](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/orchestrationv2/README.md#list_workflows) - List registered workflows\n* [read_trigger](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/orchestrationv2/README.md#read_trigger) - Read trigger\n* [run_workflow](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/orchestrationv2/README.md#run_workflow) - Run workflow\n* [send_event](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/orchestrationv2/README.md#send_event) - Send an event to a running workflow\n* [test_trigger](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/orchestrationv2/README.md#test_trigger) - Test trigger\n\n### [payments](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/payments/README.md)\n\n\n#### [payments.v1](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/paymentsv1/README.md)\n\n* [add_account_to_pool](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/paymentsv1/README.md#add_account_to_pool) - Add an account to a pool\n* [connectors_transfer](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/paymentsv1/README.md#connectors_transfer) - Transfer funds between Connector accounts\n* [create_account](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/paymentsv1/README.md#create_account) - Create an account\n* [create_bank_account](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/paymentsv1/README.md#create_bank_account) - Create a BankAccount in Payments and on the PSP\n* [create_payment](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/paymentsv1/README.md#create_payment) - Create a payment\n* [create_pool](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/paymentsv1/README.md#create_pool) - Create a Pool\n* [create_transfer_initiation](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/paymentsv1/README.md#create_transfer_initiation) - Create a TransferInitiation\n* [delete_pool](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/paymentsv1/README.md#delete_pool) - Delete a Pool\n* [delete_transfer_initiation](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/paymentsv1/README.md#delete_transfer_initiation) - Delete a transfer initiation\n* [forward_bank_account](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/paymentsv1/README.md#forward_bank_account) - Forward a bank account to a connector\n* [get_account_balances](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/paymentsv1/README.md#get_account_balances) - Get account balances\n* [get_bank_account](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/paymentsv1/README.md#get_bank_account) - Get a bank account created by user on Formance\n* [~~get_connector_task~~](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/paymentsv1/README.md#get_connector_task) - Read a specific task of the connector :warning: **Deprecated**\n* [get_connector_task_v1](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/paymentsv1/README.md#get_connector_task_v1) - Read a specific task of the connector\n* [get_payment](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/paymentsv1/README.md#get_payment) - Get a payment\n* [get_pool](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/paymentsv1/README.md#get_pool) - Get a Pool\n* [get_pool_balances](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/paymentsv1/README.md#get_pool_balances) - Get historical pool balances at a particular point in time\n* [get_pool_balances_latest](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/paymentsv1/README.md#get_pool_balances_latest) - Get latest pool balances\n* [get_transfer_initiation](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/paymentsv1/README.md#get_transfer_initiation) - Get a transfer initiation\n* [install_connector](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/paymentsv1/README.md#install_connector) - Install a connector\n* [list_all_connectors](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/paymentsv1/README.md#list_all_connectors) - List all installed connectors\n* [list_bank_accounts](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/paymentsv1/README.md#list_bank_accounts) - List bank accounts created by user on Formance\n* [list_configs_available_connectors](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/paymentsv1/README.md#list_configs_available_connectors) - List the configs of each available connector\n* [~~list_connector_tasks~~](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/paymentsv1/README.md#list_connector_tasks) - List tasks from a connector :warning: **Deprecated**\n* [list_connector_tasks_v1](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/paymentsv1/README.md#list_connector_tasks_v1) - List tasks from a connector\n* [list_payments](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/paymentsv1/README.md#list_payments) - List payments\n* [list_pools](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/paymentsv1/README.md#list_pools) - List Pools\n* [list_transfer_initiations](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/paymentsv1/README.md#list_transfer_initiations) - List Transfer Initiations\n* [paymentsget_account](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/paymentsv1/README.md#paymentsget_account) - Get an account\n* [paymentsget_server_info](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/paymentsv1/README.md#paymentsget_server_info) - Get server info\n* [paymentslist_accounts](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/paymentsv1/README.md#paymentslist_accounts) - List accounts\n* [~~read_connector_config~~](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/paymentsv1/README.md#read_connector_config) - Read the config of a connector :warning: **Deprecated**\n* [read_connector_config_v1](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/paymentsv1/README.md#read_connector_config_v1) - Read the config of a connector\n* [remove_account_from_pool](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/paymentsv1/README.md#remove_account_from_pool) - Remove an account from a pool\n* [~~reset_connector~~](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/paymentsv1/README.md#reset_connector) - Reset a connector :warning: **Deprecated**\n* [reset_connector_v1](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/paymentsv1/README.md#reset_connector_v1) - Reset a connector\n* [retry_transfer_initiation](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/paymentsv1/README.md#retry_transfer_initiation) - Retry a failed transfer initiation\n* [reverse_transfer_initiation](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/paymentsv1/README.md#reverse_transfer_initiation) - Reverse a transfer initiation\n* [~~uninstall_connector~~](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/paymentsv1/README.md#uninstall_connector) - Uninstall a connector :warning: **Deprecated**\n* [uninstall_connector_v1](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/paymentsv1/README.md#uninstall_connector_v1) - Uninstall a connector\n* [update_bank_account_metadata](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/paymentsv1/README.md#update_bank_account_metadata) - Update metadata of a bank account\n* [update_connector_config_v1](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/paymentsv1/README.md#update_connector_config_v1) - Update the config of a connector\n* [update_metadata](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/paymentsv1/README.md#update_metadata) - Update metadata\n* [update_transfer_initiation_status](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/paymentsv1/README.md#update_transfer_initiation_status) - Update the status of a transfer initiation\n\n#### [payments.v3](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/v3/README.md)\n\n* [add_account_to_pool](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/v3/README.md#add_account_to_pool) - Add an account to a pool\n* [add_bank_account_to_payment_service_user](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/v3/README.md#add_bank_account_to_payment_service_user) - Add a bank account to a payment service user\n* [approve_payment_initiation](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/v3/README.md#approve_payment_initiation) - Approve a payment initiation\n* [create_account](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/v3/README.md#create_account) - Create a formance account object. This object will not be forwarded to the connector. It is only used for internal purposes.\n\n* [create_bank_account](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/v3/README.md#create_bank_account) - Create a formance bank account object. This object will not be forwarded to the connector until you called the forwardBankAccount method.\n\n* [create_payment](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/v3/README.md#create_payment) - Create a formance payment object. This object will not be forwarded to the connector. It is only used for internal purposes.\n\n* [create_payment_service_user](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/v3/README.md#create_payment_service_user) - Create a formance payment service user object\n* [create_pool](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/v3/README.md#create_pool) - Create a formance pool object\n* [delete_payment_initiation](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/v3/README.md#delete_payment_initiation) - Delete a payment initiation by ID\n* [delete_pool](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/v3/README.md#delete_pool) - Delete a pool by ID\n* [forward_bank_account](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/v3/README.md#forward_bank_account) - Forward a Bank Account to a PSP for creation\n* [forward_payment_service_user_bank_account](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/v3/README.md#forward_payment_service_user_bank_account) - Forward a payment service user's bank account to a connector\n* [get_account](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/v3/README.md#get_account) - Get an account by ID\n* [get_account_balances](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/v3/README.md#get_account_balances) - Get account balances\n* [get_bank_account](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/v3/README.md#get_bank_account) - Get a Bank Account by ID\n* [get_connector_config](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/v3/README.md#get_connector_config) - Get a connector configuration by ID\n* [get_connector_schedule](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/v3/README.md#get_connector_schedule) - Get a connector schedule by ID\n* [get_payment](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/v3/README.md#get_payment) - Get a payment by ID\n* [get_payment_initiation](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/v3/README.md#get_payment_initiation) - Get a payment initiation by ID\n* [get_payment_service_user](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/v3/README.md#get_payment_service_user) - Get a payment service user by ID\n* [get_pool](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/v3/README.md#get_pool) - Get a pool by ID\n* [get_pool_balances](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/v3/README.md#get_pool_balances) - Get historical pool balances from a particular point in time\n* [get_pool_balances_latest](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/v3/README.md#get_pool_balances_latest) - Get latest pool balances\n* [get_task](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/v3/README.md#get_task) - Get a task and its result by ID\n* [initiate_payment](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/v3/README.md#initiate_payment) - Initiate a payment\n* [install_connector](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/v3/README.md#install_connector) - Install a connector\n* [list_accounts](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/v3/README.md#list_accounts) - List all accounts\n* [list_bank_accounts](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/v3/README.md#list_bank_accounts) - List all bank accounts\n* [list_connector_configs](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/v3/README.md#list_connector_configs) - List all connector configurations\n* [list_connector_schedule_instances](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/v3/README.md#list_connector_schedule_instances) - List all connector schedule instances\n* [list_connector_schedules](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/v3/README.md#list_connector_schedules) - List all connector schedules\n* [list_connectors](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/v3/README.md#list_connectors) - List all connectors\n* [list_payment_initiation_adjustments](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/v3/README.md#list_payment_initiation_adjustments) - List all payment initiation adjustments\n* [list_payment_initiation_related_payments](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/v3/README.md#list_payment_initiation_related_payments) - List all payments related to a payment initiation\n* [list_payment_initiations](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/v3/README.md#list_payment_initiations) - List all payment initiations\n* [list_payment_service_users](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/v3/README.md#list_payment_service_users) - List all payment service users\n* [list_payments](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/v3/README.md#list_payments) - List all payments\n* [list_pools](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/v3/README.md#list_pools) - List all pools\n* [reject_payment_initiation](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/v3/README.md#reject_payment_initiation) - Reject a payment initiation\n* [remove_account_from_pool](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/v3/README.md#remove_account_from_pool) - Remove an account from a pool\n* [reset_connector](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/v3/README.md#reset_connector) - Reset a connector. Be aware that this will delete all data and stop all existing tasks like payment initiations and bank account creations.\n* [retry_payment_initiation](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/v3/README.md#retry_payment_initiation) - Retry a payment initiation\n* [reverse_payment_initiation](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/v3/README.md#reverse_payment_initiation) - Reverse a payment initiation\n* [uninstall_connector](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/v3/README.md#uninstall_connector) - Uninstall a connector\n* [update_bank_account_metadata](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/v3/README.md#update_bank_account_metadata) - Update a bank account's metadata\n* [update_payment_metadata](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/v3/README.md#update_payment_metadata) - Update a payment's metadata\n* [v3_update_connector_config](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/v3/README.md#v3_update_connector_config) - Update the config of a connector\n\n### [reconciliation](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/reconciliation/README.md)\n\n\n#### [reconciliation.v1](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/reconciliationv1/README.md)\n\n* [create_policy](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/reconciliationv1/README.md#create_policy) - Create a policy\n* [delete_policy](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/reconciliationv1/README.md#delete_policy) - Delete a policy\n* [get_policy](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/reconciliationv1/README.md#get_policy) - Get a policy\n* [get_reconciliation](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/reconciliationv1/README.md#get_reconciliation) - Get a reconciliation\n* [list_policies](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/reconciliationv1/README.md#list_policies) - List policies\n* [list_reconciliations](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/reconciliationv1/README.md#list_reconciliations) - List reconciliations\n* [reconcile](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/reconciliationv1/README.md#reconcile) - Reconcile using a policy\n* [reconciliationget_server_info](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/reconciliationv1/README.md#reconciliationget_server_info) - Get server info\n\n### [SDK](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/sdk/README.md)\n\n* [get_versions](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/sdk/README.md#get_versions) - Show stack version information\n\n### [~~search~~](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/search/README.md)\n\n\n#### [~~search.v1~~](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/searchv1/README.md)\n\n* [~~search~~](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/searchv1/README.md#search) - search.v1 :warning: **Deprecated**\n* [~~searchget_server_info~~](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/searchv1/README.md#searchget_server_info) - Get server info :warning: **Deprecated**\n\n### [wallets](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/wallets/README.md)\n\n\n#### [wallets.v1](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/walletsv1/README.md)\n\n* [confirm_hold](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/walletsv1/README.md#confirm_hold) - Confirm a hold\n* [create_balance](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/walletsv1/README.md#create_balance) - Create a balance\n* [create_wallet](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/walletsv1/README.md#create_wallet) - Create a new wallet\n* [credit_wallet](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/walletsv1/README.md#credit_wallet) - Credit a wallet\n* [debit_wallet](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/walletsv1/README.md#debit_wallet) - Debit a wallet\n* [get_balance](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/walletsv1/README.md#get_balance) - Get detailed balance\n* [get_hold](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/walletsv1/README.md#get_hold) - Get a hold\n* [get_holds](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/walletsv1/README.md#get_holds) - Get all holds for a wallet\n* [get_transactions](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/walletsv1/README.md#get_transactions)\n* [get_wallet](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/walletsv1/README.md#get_wallet) - Get a wallet\n* [get_wallet_summary](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/walletsv1/README.md#get_wallet_summary) - Get wallet summary\n* [list_balances](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/walletsv1/README.md#list_balances) - List balances of a wallet\n* [list_wallets](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/walletsv1/README.md#list_wallets) - List all wallets\n* [update_wallet](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/walletsv1/README.md#update_wallet) - Update a wallet\n* [void_hold](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/walletsv1/README.md#void_hold) - Cancel a hold\n* [walletsget_server_info](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/walletsv1/README.md#walletsget_server_info) - Get server info\n\n### [webhooks](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/webhooks/README.md)\n\n\n#### [webhooks.v1](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/webhooksv1/README.md)\n\n* [activate_config](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/webhooksv1/README.md#activate_config) - Activate one config\n* [change_config_secret](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/webhooksv1/README.md#change_config_secret) - Change the signing secret of a config\n* [deactivate_config](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/webhooksv1/README.md#deactivate_config) - Deactivate one config\n* [delete_config](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/webhooksv1/README.md#delete_config) - Delete one config\n* [get_many_configs](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/webhooksv1/README.md#get_many_configs) - Get many configs\n* [insert_config](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/webhooksv1/README.md#insert_config) - Insert a new config\n* [test_config](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/webhooksv1/README.md#test_config) - Test one config\n* [update_config](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/webhooksv1/README.md#update_config) - Update one config\n\n</details>\n<!-- End Available Resources and Operations [operations] -->\n\n<!-- Start File uploads [file-upload] -->\n## File uploads\n\nCertain SDK methods accept file objects as part of a request body or multi-part request. It is possible and typically recommended to upload files as a stream rather than reading the entire contents into memory. This avoids excessive memory consumption and potentially crashing with out-of-memory errors when working with very large files. The following example demonstrates how to attach a file stream to a request.\n\n> [!TIP]\n>\n> For endpoints that handle file uploads bytes arrays can also be used. However, using streams is recommended for large files.\n>\n\n```python\nfrom formance_sdk_python import SDK\nfrom formance_sdk_python.models import shared\n\n\nwith SDK(\n    security=shared.Security(\n        client_id=\"<YOUR_CLIENT_ID_HERE>\",\n        client_secret=\"<YOUR_CLIENT_SECRET_HERE>\",\n    ),\n) as sdk:\n\n    res = sdk.ledger.v2.import_logs(request={\n        \"v2_import_logs_request\": open(\"example.file\", \"rb\"),\n        \"ledger\": \"ledger001\",\n    })\n\n    assert res is not None\n\n    # Handle response\n    print(res)\n\n```\n<!-- End File uploads [file-upload] -->\n\n<!-- Start Retries [retries] -->\n## Retries\n\nSome of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.\n\nTo change the default retry strategy for a single API call, simply provide a `RetryConfig` object to the call:\n```python\nfrom formance_sdk_python import SDK\nfrom formance_sdk_python.models import shared\nfrom formance_sdk_python.utils import BackoffStrategy, RetryConfig\n\n\nwith SDK(\n    security=shared.Security(\n        client_id=\"<YOUR_CLIENT_ID_HERE>\",\n        client_secret=\"<YOUR_CLIENT_SECRET_HERE>\",\n    ),\n) as sdk:\n\n    res = sdk.get_versions(,\n        RetryConfig(\"backoff\", BackoffStrategy(1, 50, 1.1, 100), False))\n\n    assert res.get_versions_response is not None\n\n    # Handle response\n    print(res.get_versions_response)\n\n```\n\nIf you'd like to override the default retry strategy for all operations that support retries, you can use the `retry_config` optional parameter when initializing the SDK:\n```python\nfrom formance_sdk_python import SDK\nfrom formance_sdk_python.models import shared\nfrom formance_sdk_python.utils import BackoffStrategy, RetryConfig\n\n\nwith SDK(\n    retry_config=RetryConfig(\"backoff\", BackoffStrategy(1, 50, 1.1, 100), False),\n    security=shared.Security(\n        client_id=\"<YOUR_CLIENT_ID_HERE>\",\n        client_secret=\"<YOUR_CLIENT_SECRET_HERE>\",\n    ),\n) as sdk:\n\n    res = sdk.get_versions()\n\n    assert res.get_versions_response is not None\n\n    # Handle response\n    print(res.get_versions_response)\n\n```\n<!-- End Retries [retries] -->\n\n<!-- Start Error Handling [errors] -->\n## Error Handling\n\n[`SDKBaseError`](https://github.com/formancehq/formance-sdk-python/blob/master/././src/formance_sdk_python/models/errors/sdkbaseerror.py) is the base class for all HTTP error responses. It has the following properties:\n\n| Property           | Type             | Description                                                                             |\n| ------------------ | ---------------- | --------------------------------------------------------------------------------------- |\n| `err.message`      | `str`            | Error message                                                                           |\n| `err.status_code`  | `int`            | HTTP response status code eg `404`                                                      |\n| `err.headers`      | `httpx.Headers`  | HTTP response headers                                                                   |\n| `err.body`         | `str`            | HTTP body. Can be empty string if no body is returned.                                  |\n| `err.raw_response` | `httpx.Response` | Raw HTTP response                                                                       |\n| `err.data`         |                  | Optional. Some errors may contain structured data. [See Error Classes](https://github.com/formancehq/formance-sdk-python/blob/master/./#error-classes). |\n\n### Example\n```python\nfrom formance_sdk_python import SDK\nfrom formance_sdk_python.models import errors, shared\n\n\nwith SDK(\n    security=shared.Security(\n        client_id=\"<YOUR_CLIENT_ID_HERE>\",\n        client_secret=\"<YOUR_CLIENT_SECRET_HERE>\",\n    ),\n) as sdk:\n    res = None\n    try:\n\n        res = sdk.ledger.v2.add_metadata_on_transaction(request={\n            \"request_body\": {\n                \"admin\": \"true\",\n            },\n            \"dry_run\": True,\n            \"id\": 1234,\n            \"ledger\": \"ledger001\",\n        })\n\n        assert res is not None\n\n        # Handle response\n        print(res)\n\n\n    except errors.SDKBaseError as e:\n        # The base class for HTTP error responses\n        print(e.message)\n        print(e.status_code)\n        print(e.body)\n        print(e.headers)\n        print(e.raw_response)\n\n        # Depending on the method different errors may be thrown\n        if isinstance(e, errors.V2ErrorResponse):\n            print(e.data.details)  # Optional[str]\n            print(e.data.error_code)  # shared.V2ErrorsEnum\n            print(e.data.error_message)  # str\n```\n\n### Error Classes\n**Primary error:**\n* [`SDKBaseError`](https://github.com/formancehq/formance-sdk-python/blob/master/././src/formance_sdk_python/models/errors/sdkbaseerror.py): The base class for HTTP error responses.\n\n<details><summary>Less common errors (14)</summary>\n\n<br />\n\n**Network errors:**\n* [`httpx.RequestError`](https://www.python-httpx.org/exceptions/#httpx.RequestError): Base class for request errors.\n    * [`httpx.ConnectError`](https://www.python-httpx.org/exceptions/#httpx.ConnectError): HTTP client was unable to make a request to a server.\n    * [`httpx.TimeoutException`](https://www.python-httpx.org/exceptions/#httpx.TimeoutException): HTTP request timed out.\n\n\n**Inherit from [`SDKBaseError`](https://github.com/formancehq/formance-sdk-python/blob/master/././src/formance_sdk_python/models/errors/sdkbaseerror.py)**:\n* [`V3ErrorResponse`](https://github.com/formancehq/formance-sdk-python/blob/master/././src/formance_sdk_python/models/errors/v3errorresponse.py): Error. Applicable to 46 of 219 methods.*\n* [`PaymentsErrorResponse`](https://github.com/formancehq/formance-sdk-python/blob/master/././src/formance_sdk_python/models/errors/paymentserrorresponse.py): Error. Applicable to 45 of 219 methods.*\n* [`V2ErrorResponse`](https://github.com/formancehq/formance-sdk-python/blob/master/././src/formance_sdk_python/models/errors/v2errorresponse.py): Error. Applicable to 26 of 219 methods.*\n* [`ErrorResponse`](https://github.com/formancehq/formance-sdk-python/blob/master/././src/formance_sdk_python/models/errors/errorresponse.py): Applicable to 19 of 219 methods.*\n* [`V2Error`](https://github.com/formancehq/formance-sdk-python/blob/master/././src/formance_sdk_python/models/errors/v2error.py): General error. Applicable to 18 of 219 methods.*\n* [`Error`](https://github.com/formancehq/formance-sdk-python/blob/master/././src/formance_sdk_python/models/errors/error.py): General error. Applicable to 17 of 219 methods.*\n* [`WalletsErrorResponse`](https://github.com/formancehq/formance-sdk-python/blob/master/././src/formance_sdk_python/models/errors/walletserrorresponse.py): Applicable to 15 of 219 methods.*\n* [`ReconciliationErrorResponse`](https://github.com/formancehq/formance-sdk-python/blob/master/././src/formance_sdk_python/models/errors/reconciliationerrorresponse.py): Error response. Applicable to 8 of 219 methods.*\n* [`WebhooksErrorResponse`](https://github.com/formancehq/formance-sdk-python/blob/master/././src/formance_sdk_python/models/errors/webhookserrorresponse.py): Error. Applicable to 8 of 219 methods.*\n* [`ResponseValidationError`](https://github.com/formancehq/formance-sdk-python/blob/master/././src/formance_sdk_python/models/errors/responsevalidationerror.py): Type mismatch between the response data and the expected Pydantic model. Provides access to the Pydantic validation error via the `cause` attribute.\n\n</details>\n\n\\* Check [the method documentation](https://github.com/formancehq/formance-sdk-python/blob/master/./#available-resources-and-operations) to see if the error is applicable.\n<!-- End Error Handling [errors] -->\n\n<!-- Start Server Selection [server] -->\n## Server Selection\n\n### Select Server by Index\n\nYou 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:\n\n| #   | Server                                                | Variables                        | Description                                |\n| --- | ----------------------------------------------------- | -------------------------------- | ------------------------------------------ |\n| 0   | `http://localhost`                                    |                                  | local server                               |\n| 1   | `https://{organization}.{environment}.formance.cloud` | `environment`<br/>`organization` | A per-organization and per-environment API |\n\nIf the selected server has variables, you may override its default values through the additional parameters made available in the SDK constructor:\n\n| Variable       | Parameter                               | Supported Values                                                           | Default           | Description                                                   |\n| -------------- | --------------------------------------- | -------------------------------------------------------------------------- | ----------------- | ------------------------------------------------------------- |\n| `environment`  | `environment: models.ServerEnvironment` | - `\"eu.sandbox\"`<br/>- `\"sandbox\"`<br/>- `\"eu-west-1\"`<br/>- `\"us-east-1\"` | `\"eu.sandbox\"`    | The environment name. Defaults to the production environment. |\n| `organization` | `organization: str`                     | str                                                                        | `\"orgID-stackID\"` | The organization name. Defaults to a generic organization.    |\n\n#### Example\n\n```python\nfrom formance_sdk_python import SDK\nfrom formance_sdk_python.models import shared\n\n\nwith SDK(\n    server_idx=1,\n    environment=\"us-east-1\"\n    organization=\"<value>\"\n    security=shared.Security(\n        client_id=\"<YOUR_CLIENT_ID_HERE>\",\n        client_secret=\"<YOUR_CLIENT_SECRET_HERE>\",\n    ),\n) as sdk:\n\n    res = sdk.get_versions()\n\n    assert res.get_versions_response is not None\n\n    # Handle response\n    print(res.get_versions_response)\n\n```\n\n### Override Server URL Per-Client\n\nThe 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:\n```python\nfrom formance_sdk_python import SDK\nfrom formance_sdk_python.models import shared\n\n\nwith SDK(\n    server_url=\"https://orgID-stackID.eu.sandbox.formance.cloud\",\n    security=shared.Security(\n        client_id=\"<YOUR_CLIENT_ID_HERE>\",\n        client_secret=\"<YOUR_CLIENT_SECRET_HERE>\",\n    ),\n) as sdk:\n\n    res = sdk.get_versions()\n\n    assert res.get_versions_response is not None\n\n    # Handle response\n    print(res.get_versions_response)\n\n```\n<!-- End Server Selection [server] -->\n\n<!-- Start Custom HTTP Client [http-client] -->\n## Custom HTTP Client\n\nThe Python SDK makes API calls using the [httpx](https://www.python-httpx.org/) 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 your own HTTP client instance.\nDepending on whether you are using the sync or async version of the SDK, you can pass an instance of `HttpClient` or `AsyncHttpClient` respectively, which are Protocol's ensuring that the client has the necessary methods to make API calls.\nThis allows you to wrap the client with your own custom logic, such as adding custom headers, logging, or error handling, or you can just pass an instance of `httpx.Client` or `httpx.AsyncClient` directly.\n\nFor example, you could specify a header for every request that this sdk makes as follows:\n```python\nfrom formance_sdk_python import SDK\nimport httpx\n\nhttp_client = httpx.Client(headers={\"x-custom-header\": \"someValue\"})\ns = SDK(client=http_client)\n```\n\nor you could wrap the client with your own custom logic:\n```python\nfrom formance_sdk_python import SDK\nfrom formance_sdk_python.httpclient import AsyncHttpClient\nimport httpx\n\nclass CustomClient(AsyncHttpClient):\n    client: AsyncHttpClient\n\n    def __init__(self, client: AsyncHttpClient):\n        self.client = client\n\n    async def send(\n        self,\n        request: httpx.Request,\n        *,\n        stream: bool = False,\n        auth: Union[\n            httpx._types.AuthTypes, httpx._client.UseClientDefault, None\n        ] = httpx.USE_CLIENT_DEFAULT,\n        follow_redirects: Union[\n            bool, httpx._client.UseClientDefault\n        ] = httpx.USE_CLIENT_DEFAULT,\n    ) -> httpx.Response:\n        request.headers[\"Client-Level-Header\"] = \"added by client\"\n\n        return await self.client.send(\n            request, stream=stream, auth=auth, follow_redirects=follow_redirects\n        )\n\n    def build_request(\n        self,\n        method: str,\n        url: httpx._types.URLTypes,\n        *,\n        content: Optional[httpx._types.RequestContent] = None,\n        data: Optional[httpx._types.RequestData] = None,\n        files: Optional[httpx._types.RequestFiles] = None,\n        json: Optional[Any] = None,\n        params: Optional[httpx._types.QueryParamTypes] = None,\n        headers: Optional[httpx._types.HeaderTypes] = None,\n        cookies: Optional[httpx._types.CookieTypes] = None,\n        timeout: Union[\n            httpx._types.TimeoutTypes, httpx._client.UseClientDefault\n        ] = httpx.USE_CLIENT_DEFAULT,\n        extensions: Optional[httpx._types.RequestExtensions] = None,\n    ) -> httpx.Request:\n        return self.client.build_request(\n            method,\n            url,\n            content=content,\n            data=data,\n            files=files,\n            json=json,\n            params=params,\n            headers=headers,\n            cookies=cookies,\n            timeout=timeout,\n            extensions=extensions,\n        )\n\ns = SDK(async_client=CustomClient(httpx.AsyncClient()))\n```\n<!-- End Custom HTTP Client [http-client] -->\n\n<!-- Start Authentication [security] -->\n## Authentication\n\n### Per-Client Security Schemes\n\nThis SDK supports the following security scheme globally:\n\n| Name                            | Type   | Scheme                         |\n| ------------------------------- | ------ | ------------------------------ |\n| `client_id`<br/>`client_secret` | oauth2 | OAuth2 Client Credentials Flow |\n\nYou can set the security parameters through the `security` optional parameter when initializing the SDK client instance. For example:\n```python\nfrom formance_sdk_python import SDK\nfrom formance_sdk_python.models import shared\n\n\nwith SDK(\n    security=shared.Security(\n        client_id=\"<YOUR_CLIENT_ID_HERE>\",\n        client_secret=\"<YOUR_CLIENT_SECRET_HERE>\",\n    ),\n) as sdk:\n\n    res = sdk.get_versions()\n\n    assert res.get_versions_response is not None\n\n    # Handle response\n    print(res.get_versions_response)\n\n```\n<!-- End Authentication [security] -->\n\n<!-- Start Resource Management [resource-management] -->\n## Resource Management\n\nThe `SDK` class implements the context manager protocol and registers a finalizer function to close the underlying sync and async HTTPX clients it uses under the hood. This will close HTTP connections, release memory and free up other resources held by the SDK. In short-lived Python programs and notebooks that make a few SDK method calls, resource management may not be a concern. However, in longer-lived programs, it is beneficial to create a single SDK instance via a [context manager][context-manager] and reuse it across the application.\n\n[context-manager]: https://docs.python.org/3/reference/datamodel.html#context-managers\n\n```python\nfrom formance_sdk_python import SDK\nfrom formance_sdk_python.models import shared\ndef main():\n\n    with SDK(\n        security=shared.Security(\n            client_id=\"<YOUR_CLIENT_ID_HERE>\",\n            client_secret=\"<YOUR_CLIENT_SECRET_HERE>\",\n        ),\n    ) as sdk:\n        # Rest of application here...\n\n\n# Or when using async:\nasync def amain():\n\n    async with SDK(\n        security=shared.Security(\n            client_id=\"<YOUR_CLIENT_ID_HERE>\",\n            client_secret=\"<YOUR_CLIENT_SECRET_HERE>\",\n        ),\n    ) as sdk:\n        # Rest of application here...\n```\n<!-- End Resource Management [resource-management] -->\n\n<!-- Start Debugging [debug] -->\n## Debugging\n\nYou can setup your SDK to emit debug logs for SDK requests and responses.\n\nYou can pass your own logger class directly into your SDK.\n```python\nfrom formance_sdk_python import SDK\nimport logging\n\nlogging.basicConfig(level=logging.DEBUG)\ns = SDK(debug_logger=logging.getLogger(\"formance_sdk_python\"))\n```\n<!-- End Debugging [debug] -->\n\n<!-- Placeholder for Future Speakeasy SDK Sections -->\n\n# Development\n\n## Maturity\n\nThis SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage\nto a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally\nlooking for the latest version.\n\n## Contributions\n\nWhile we value open-source contributions to this SDK, this library is generated programmatically.\nFeel 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!\n\n### SDK Created by [Speakeasy](https://docs.speakeasyapi.dev/docs/using-speakeasy/client-sdks)\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "Python Client SDK Generated by Speakeasy",
    "version": "6.4.0",
    "project_urls": {
        "Homepage": "https://github.com/formancehq/formance-sdk-python.git",
        "Repository": "https://github.com/formancehq/formance-sdk-python.git"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "bc68c82e049aa457791f831ac9b657e7877f8cf9aca8c8c3b634e673c353cb27",
                "md5": "b1a272dc4e6eaa2a8a421734a3969b36",
                "sha256": "90e0bb25c88ba98c1f8fd2ed2083e4a0ccacc2bd7f0dba5ef08601c05d9f20de"
            },
            "downloads": -1,
            "filename": "formance_sdk_python-6.4.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "b1a272dc4e6eaa2a8a421734a3969b36",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9.2",
            "size": 577722,
            "upload_time": "2025-09-17T08:26:55",
            "upload_time_iso_8601": "2025-09-17T08:26:55.616333Z",
            "url": "https://files.pythonhosted.org/packages/bc/68/c82e049aa457791f831ac9b657e7877f8cf9aca8c8c3b634e673c353cb27/formance_sdk_python-6.4.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "92c0fd7daf6e6d8c9ca86450fe432e41c61b60bb0464fdf46fd780a2814b5030",
                "md5": "a09f83c24168beb11e21e203113508d4",
                "sha256": "1f75e6f94e51cfcc8db2748635c8bcf168050b037f7130fe177db610d95ddf59"
            },
            "downloads": -1,
            "filename": "formance_sdk_python-6.4.0.tar.gz",
            "has_sig": false,
            "md5_digest": "a09f83c24168beb11e21e203113508d4",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9.2",
            "size": 195346,
            "upload_time": "2025-09-17T08:26:57",
            "upload_time_iso_8601": "2025-09-17T08:26:57.104010Z",
            "url": "https://files.pythonhosted.org/packages/92/c0/fd7daf6e6d8c9ca86450fe432e41c61b60bb0464fdf46fd780a2814b5030/formance_sdk_python-6.4.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-09-17 08:26:57",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "formancehq",
    "github_project": "formance-sdk-python",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "formance-sdk-python"
}