It has been generated successfully based on your OpenAPI spec. However, it is not yet ready for production use. Here are some next steps:
Formance Stack API: Open, modular foundation for unique payments flows
This API is documented in OpenAPI format.
Formance Stack offers one forms of authentication:
[!NOTE] Python version upgrade policy
Once a Python version reaches its official end of life date, 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 either pip or poetry package managers.
PIP is the default package installer for Python, enabling easy installation and management of packages from PyPI via the command line.
pip install formance-sdk-python
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.
poetry add formance-sdk-python
uvYou can use this SDK in a Python shell with uv and the uvx command that comes with it like so:
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:
#!/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.
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.
# 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)
The same SDK client can also be used to make asychronous requests by importing asyncio.
# 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())
add_account_to_pool - Add an account to a pool
approve_payment_initiation - Approve a payment initiation
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 - Create a formance bank account object. This object will not be forwarded to the connector until you called the forwardBankAccount method.
create_payment - Create a formance payment object. This object will not be forwarded to the connector. It is only used for internal purposes.
create_pool - Create a formance pool object
delete_payment_initiation - Delete a payment initiation by ID
delete_pool - Delete a pool by ID
forward_bank_account - Forward a Bank Account to a PSP for creation
get_account - Get an account by ID
get_account_balances - Get account balances
get_bank_account - Get a Bank Account by ID
get_connector_config - Get a connector configuration by ID
get_connector_schedule - Get a connector schedule by ID
get_payment - Get a payment by ID
get_payment_initiation - Get a payment initiation by ID
get_pool - Get a pool by ID
get_pool_balances - Get pool balances
get_task - Get a task and its result by ID
initiate_payment - Initiate a payment
install_connector - Install a connector
list_accounts - List all accounts
list_bank_accounts - List all bank accounts
list_connector_configs - List all connector configurations
list_connector_schedule_instances - List all connector schedule instances
list_connector_schedules - List all connector schedules
list_connectors - List all connectors
list_payment_initiation_adjustments - List all payment initiation adjustments
list_payment_initiation_related_payments - List all payments related to a payment initiation
list_payment_initiations - List all payment initiations
list_payments - List all payments
list_pools - List all pools
reject_payment_initiation - Reject a payment initiation
remove_account_from_pool - Remove an account from a pool
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 - Retry a payment initiation
reverse_payment_initiation - Reverse a payment initiation
uninstall_connector - Uninstall a connector
update_bank_account_metadata - Update a bank account's metadata
update_payment_metadata - Update a payment's metadata
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:
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:
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)
Handling errors in this SDK should largely match your expectations. All operations return a response object or raise an exception.
By default, an API error will raise a errors.SDKError exception, which has the following properties:
| Property | Type | Description |
|---|---|---|
.status_code | int | The HTTP status code |
.message | str | The error message |
.raw_response | httpx.Response | The raw HTTP response |
.body | str | The response content |
When custom error responses are specified for an operation, the SDK may also raise their associated exceptions. You can refer to respective Errors tables in SDK docs for more details on possible exception types for each operation. For example, the add_metadata_on_transaction_async method may raise the following exceptions:
| Error Type | Status Code | Content Type |
|---|---|---|
| errors.V2ErrorResponse | default | application/json |
| errors.SDKError | 4XX, 5XX | */* |
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={
"id": 1234,
"ledger": "ledger001",
"request_body": {
"admin": "true",
},
"dry_run": True,
})
assert res is not None
# Handle response
print(res)
except errors.V2ErrorResponse as e:
# handle e.data: errors.V2ErrorResponseData
raise(e)
except errors.SDKError as e:
# handle exception
raise(e)
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 | environmentorganization | 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"- "sandbox"- "eu-west-1"- "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. |
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)
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:
from formance_sdk_python import SDK
from formance_sdk_python.models import shared
with SDK(
server_url="http://localhost",
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)
The Python SDK makes API calls using the httpx 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:
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:
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()))
This SDK supports the following security scheme globally:
| Name | Type | Scheme |
|---|---|---|
client_idclient_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:
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)
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 and reuse it across the application.
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...
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.
from formance_sdk_python import SDK
import logging
logging.basicConfig(level=logging.DEBUG)
s = SDK(debug_logger=logging.getLogger("formance_sdk_python"))
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.
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!
FAQs
Python Client SDK Generated by Speakeasy
We found that formance-sdk-python demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
Malicious Go packages are impersonating popular libraries to install hidden loader malware on Linux and macOS, targeting developers with obfuscated payloads.
Security News
Bybit's $1.46B hack by North Korea's Lazarus Group pushes 2025 crypto losses to $1.6B in just two months, already surpassing all of 2024's $1.49B total.
Security News
OpenSSF has published OSPS Baseline, an initiative designed to establish a minimum set of security-related best practices for open source software projects.