formance-sdk-python 1.0.20230713

Python Client SDK Generated by Speakeasy

formance-sdk-python

SDK Installation

pip install formance-sdk-python

SDK Example Usage

import sdk


s = sdk.SDK(
    security=shared.Security(
        authorization="",
    ),
)


res = s.get_versions()

if res.get_versions_response is not None:
    # handle response

Available Resources and Operations

SDK

• get_versions - Show stack version information

auth

• add_scope_to_client - Add scope to client
• add_transient_scope - Add a transient scope to a scope
• create_client - Create client
• create_scope - Create scope
• create_secret - Add a secret to a client
• delete_client - Delete client
• delete_scope - Delete scope
• delete_scope_from_client - Delete scope from client
• delete_secret - Delete a secret from a client
• delete_transient_scope - Delete a transient scope from a scope
• get_server_info - Get server info
• list_clients - List clients
• list_scopes - List scopes
• list_users - List users
• read_client - Read client
• read_scope - Read scope
• read_user - Read user
• update_client - Update client
• update_scope - Update scope

flows

• flowsget_server_info - Get server info
• cancel_event - Cancel a running workflow
• create_workflow - Create workflow
• get_instance - Get a workflow instance by id
• get_instance_history - Get a workflow instance history by id
• get_instance_stage_history - Get a workflow instance stage history
• get_workflow - Get a flow by id
• list_instances - List instances of a workflow
• list_workflows - List registered workflows
• run_workflow - Run workflow
• send_event - Send an event to a running workflow

ledger

• create_transactions - Create a new batch of transactions to a ledger
• add_metadata_on_transaction - Set the metadata of a transaction by its ID
• add_metadata_to_account - Add metadata to an account
• count_accounts - Count the accounts from a ledger
• count_transactions - Count the transactions from a ledger
• create_transaction - Create a new transaction to a ledger
• get_account - Get account by its address
• get_balances - Get the balances from a ledger's account
• get_balances_aggregated - Get the aggregated balances from selected accounts
• get_info - Show server information
• get_ledger_info - Get information about a ledger
• get_mapping - Get the mapping of a ledger
• get_transaction - Get transaction from a ledger by its ID
• list_accounts - List accounts from a ledger
• list_logs - List the logs from a ledger
• list_transactions - List transactions from a ledger
• read_stats - Get statistics from a ledger
• revert_transaction - Revert a ledger transaction by its ID
• run_script - Execute a Numscript :warning: Deprecated
• update_mapping - Update the mapping of a ledger

payments

• connectors_stripe_transfer - Transfer funds between Stripe accounts
• connectors_transfer - Transfer funds between Connector accounts
• get_connector_task - Read a specific task of the connector
• get_payment - Get a payment
• install_connector - Install a connector
• list_all_connectors - List all installed connectors
• list_configs_available_connectors - List the configs of each available connector
• list_connector_tasks - List tasks from a connector
• list_connectors_transfers - List transfers and their statuses
• list_payments - List payments
• paymentsget_server_info - Get server info
• paymentslist_accounts - List accounts
• read_connector_config - Read the config of a connector
• reset_connector - Reset a connector
• uninstall_connector - Uninstall a connector
• update_metadata - Update metadata

search

• search - Search
• searchget_server_info - Get server info

wallets

• confirm_hold - Confirm a hold
• create_balance - Create a balance
• create_wallet - Create a new wallet
• credit_wallet - Credit a wallet
• debit_wallet - Debit a wallet
• get_balance - Get detailed balance
• get_hold - Get a hold
• get_holds - Get all holds for a wallet
• get_transactions
• get_wallet - Get a wallet
• get_wallet_summary - Get wallet summary
• list_balances - List balances of a wallet
• list_wallets - List all wallets
• update_wallet - Update a wallet
• void_hold - Cancel a hold
• walletsget_server_info - Get server info

webhooks

• activate_config - Activate one config
• change_config_secret - Change the signing secret of a config
• deactivate_config - Deactivate one config
• delete_config - Delete one config
• get_many_configs - Get many configs
• insert_config - Insert a new config
• test_config - Test one config

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