formance-sdk-python 6.5.0
Python Client SDK Generated by Speakeasy
Requires Python: >=3.9.2

# 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)
* [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)

* [get_info](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/ledger/README.md#get_info) - Show server information
* [get_metrics](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/ledger/README.md#get_metrics) - Read in memory metrics

#### [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_exporter](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/ledgerv2/README.md#create_exporter) - Create exporter
* [create_ledger](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/ledgerv2/README.md#create_ledger) - Create a ledger
* [create_pipeline](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/ledgerv2/README.md#create_pipeline) - Create pipeline
* [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_exporter](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/ledgerv2/README.md#delete_exporter) - Delete exporter
* [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_pipeline](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/ledgerv2/README.md#delete_pipeline) - Delete pipeline
* [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_exporter_state](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/ledgerv2/README.md#get_exporter_state) - Get exporter state
* [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_pipeline_state](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/ledgerv2/README.md#get_pipeline_state) - Get pipeline state
* [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_exporters](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/ledgerv2/README.md#list_exporters) - List exporters
* [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_pipelines](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/ledgerv2/README.md#list_pipelines) - List pipelines
* [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
* [reset_pipeline](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/ledgerv2/README.md#reset_pipeline) - Reset pipeline
* [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
* [start_pipeline](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/ledgerv2/README.md#start_pipeline) - Start pipeline
* [stop_pipeline](https://github.com/formancehq/formance-sdk-python/blob/master/./docs/sdks/ledgerv2/README.md#stop_pipeline) - Stop pipeline
* [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_paym