github.com/formancehq/formance-sdk-go/v2

🏗 Welcome to your new SDK! 🏗

It has been generated successfully based on your OpenAPI spec. However, it is not yet ready for production use. Here are some next steps:

• 🛠 Make your SDK feel handcrafted by customizing it
• ♻️ Refine your SDK quickly by iterating locally with the Speakeasy CLI
• 🎁 Publish your SDK to package managers by configuring automatic publishing
• ✨ When ready to productionize, delete this section from the README

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.

Table of Contents

• SDK Installation
• SDK Example Usage
• Available Resources and Operations
• Retries
• Error Handling
• Server Selection
• Custom HTTP Client
• Authentication
• Special Types

SDK Installation

To add the SDK as a dependency to your project:

go get github.com/formancehq/formance-sdk-go

SDK Example Usage

Example

package main

import (
	"context"
	formancesdkgo "github.com/formancehq/formance-sdk-go/v3"
	"github.com/formancehq/formance-sdk-go/v3/pkg/models/shared"
	"log"
)

func main() {
	s := formancesdkgo.New(
		formancesdkgo.WithSecurity(shared.Security{
			ClientID:     formancesdkgo.String("<YOUR_CLIENT_ID_HERE>"),
			ClientSecret: formancesdkgo.String("<YOUR_CLIENT_SECRET_HERE>"),
		}),
	)

	ctx := context.Background()
	res, err := s.GetVersions(ctx)
	if err != nil {
		log.Fatal(err)
	}
	if res.GetVersionsResponse != nil {
		// handle response
	}
}

Available Resources and Operations

Available methods

Auth

Auth.V1

• CreateClient - Create client
• CreateSecret - Add a secret to a client
• DeleteClient - Delete client
• DeleteSecret - Delete a secret from a client
• GetOIDCWellKnowns - Retrieve OpenID connect well-knowns.
• GetServerInfo - Get server info
• ListClients - List clients
• ListUsers - List users
• ReadClient - Read client
• ReadUser - Read user
• UpdateClient - Update client

Formance SDK

• GetVersions - Show stack version information

Ledger

Ledger.V1

• CreateTransactions - Create a new batch of transactions to a ledger
• AddMetadataOnTransaction - Set the metadata of a transaction by its ID
• AddMetadataToAccount - Add metadata to an account
• CountAccounts - Count the accounts from a ledger
• CountTransactions - Count the transactions from a ledger
• CreateTransaction - Create a new transaction to a ledger
• GetAccount - Get account by its address
• GetBalances - Get the balances from a ledger's account
• GetBalancesAggregated - Get the aggregated balances from selected accounts
• GetInfo - Show server information
• GetLedgerInfo - Get information about a ledger
• GetMapping - Get the mapping of a ledger
• GetTransaction - Get transaction from a ledger by its ID
• ListAccounts - List accounts from a ledger
• ListLogs - List the logs from a ledger
• ListTransactions - List transactions from a ledger
• ReadStats - Get statistics from a ledger
• RevertTransaction - Revert a ledger transaction by its ID
• RunScript - Execute a Numscript ⚠️ Deprecated
• UpdateMapping - Update the mapping of a ledger

Ledger.V2

• AddMetadataOnTransaction - Set the metadata of a transaction by its ID
• AddMetadataToAccount - Add metadata to an account
• CountAccounts - Count the accounts from a ledger
• CountTransactions - Count the transactions from a ledger
• CreateBulk - Bulk request
• CreateLedger - Create a ledger
• CreateTransaction - Create a new transaction to a ledger
• DeleteAccountMetadata - Delete metadata by key
• DeleteLedgerMetadata - Delete ledger metadata by key
• DeleteTransactionMetadata - Delete metadata by key
• ExportLogs - Export logs
• GetAccount - Get account by its address
• GetBalancesAggregated - Get the aggregated balances from selected accounts
• GetInfo - Show server information
• GetLedger - Get a ledger
• GetLedgerInfo - Get information about a ledger
• GetTransaction - Get transaction from a ledger by its ID
• GetVolumesWithBalances - Get list of volumes with balances for (account/asset)
• ImportLogs
• ListAccounts - List accounts from a ledger
• ListLedgers - List ledgers
• ListLogs - List the logs from a ledger
• ListTransactions - List transactions from a ledger
• ReadStats - Get statistics from a ledger
• RevertTransaction - Revert a ledger transaction by its ID
• UpdateLedgerMetadata - Update ledger metadata

Orchestration

Orchestration.V1

• CancelEvent - Cancel a running workflow
• CreateTrigger - Create trigger
• CreateWorkflow - Create workflow
• DeleteTrigger - Delete trigger
• DeleteWorkflow - Delete a flow by id
• GetInstance - Get a workflow instance by id
• GetInstanceHistory - Get a workflow instance history by id
• GetInstanceStageHistory - Get a workflow instance stage history
• GetWorkflow - Get a flow by id
• ListInstances - List instances of a workflow
• ListTriggers - List triggers
• ListTriggersOccurrences - List triggers occurrences
• ListWorkflows - List registered workflows
• OrchestrationgetServerInfo - Get server info
• ReadTrigger - Read trigger
• RunWorkflow - Run workflow
• SendEvent - Send an event to a running workflow

Orchestration.V2

• CancelEvent - Cancel a running workflow
• CreateTrigger - Create trigger
• CreateWorkflow - Create workflow
• DeleteTrigger - Delete trigger
• DeleteWorkflow - Delete a flow by id
• GetInstance - Get a workflow instance by id
• GetInstanceHistory - Get a workflow instance history by id
• GetInstanceStageHistory - Get a workflow instance stage history
• GetServerInfo - Get server info
• GetWorkflow - Get a flow by id
• ListInstances - List instances of a workflow
• ListTriggers - List triggers
• ListTriggersOccurrences - List triggers occurrences
• ListWorkflows - List registered workflows
• ReadTrigger - Read trigger
• RunWorkflow - Run workflow
• SendEvent - Send an event to a running workflow
• TestTrigger - Test trigger

Payments

Payments.V1

• AddAccountToPool - Add an account to a pool
• ConnectorsTransfer - Transfer funds between Connector accounts
• CreateAccount - Create an account
• CreateBankAccount - Create a BankAccount in Payments and on the PSP
• CreatePayment - Create a payment
• CreatePool - Create a Pool
• CreateTransferInitiation - Create a TransferInitiation
• DeletePool - Delete a Pool
• DeleteTransferInitiation - Delete a transfer initiation
• ForwardBankAccount - Forward a bank account to a connector
• GetAccountBalances - Get account balances
• GetBankAccount - Get a bank account created by user on Formance
• GetConnectorTask - Read a specific task of the connector ⚠️ Deprecated
• GetConnectorTaskV1 - Read a specific task of the connector
• GetPayment - Get a payment
• GetPool - Get a Pool
• GetPoolBalances - Get pool balances
• GetTransferInitiation - Get a transfer initiation
• InstallConnector - Install a connector
• ListAllConnectors - List all installed connectors
• ListBankAccounts - List bank accounts created by user on Formance
• ListConfigsAvailableConnectors - List the configs of each available connector
• ListConnectorTasks - List tasks from a connector ⚠️ Deprecated
• ListConnectorTasksV1 - List tasks from a connector
• ListPayments - List payments
• ListPools - List Pools
• ListTransferInitiations - List Transfer Initiations
• PaymentsgetAccount - Get an account
• PaymentsgetServerInfo - Get server info
• PaymentslistAccounts - List accounts
• ReadConnectorConfig - Read the config of a connector ⚠️ Deprecated
• ReadConnectorConfigV1 - Read the config of a connector
• RemoveAccountFromPool - Remove an account from a pool
• ResetConnector - Reset a connector ⚠️ Deprecated
• ResetConnectorV1 - Reset a connector
• RetryTransferInitiation - Retry a failed transfer initiation
• ReverseTransferInitiation - Reverse a transfer initiation
• UdpateTransferInitiationStatus - Update the status of a transfer initiation
• UninstallConnector - Uninstall a connector ⚠️ Deprecated
• UninstallConnectorV1 - Uninstall a connector
• UpdateBankAccountMetadata - Update metadata of a bank account
• UpdateConnectorConfigV1 - Update the config of a connector
• UpdateMetadata - Update metadata

Reconciliation

Reconciliation.V1

• CreatePolicy - Create a policy
• DeletePolicy - Delete a policy
• GetPolicy - Get a policy
• GetReconciliation - Get a reconciliation
• ListPolicies - List policies
• ListReconciliations - List reconciliations
• Reconcile - Reconcile using a policy
• ReconciliationgetServerInfo - Get server info

Search

Search.V1

• Search - search.v1
• SearchgetServerInfo - Get server info

Wallets

Wallets.V1

• ConfirmHold - Confirm a hold
• CreateBalance - Create a balance
• CreateWallet - Create a new wallet
• CreditWallet - Credit a wallet
• DebitWallet - Debit a wallet
• GetBalance - Get detailed balance
• GetHold - Get a hold
• GetHolds - Get all holds for a wallet
• GetTransactions
• GetWallet - Get a wallet
• GetWalletSummary - Get wallet summary
• ListBalances - List balances of a wallet
• ListWallets - List all wallets
• UpdateWallet - Update a wallet
• VoidHold - Cancel a hold
• WalletsgetServerInfo - Get server info

Webhooks

Webhooks.V1

• ActivateConfig - Activate one config
• ChangeConfigSecret - Change the signing secret of a config
• DeactivateConfig - Deactivate one config
• DeleteConfig - Delete one config
• GetManyConfigs - Get many configs
• InsertConfig - Insert a new config
• TestConfig - Test one config

Error Handling

Handling errors in this SDK should largely match your expectations. All operations return a response object or an error, they will never return both.

By Default, an API error will return sdkerrors.SDKError. When custom error responses are specified for an operation, the SDK may also return their associated error. You can refer to respective Errors tables in SDK docs for more details on possible error types for each operation.

For example, the CreateTransactions function may return the following errors:

Error Type	Status Code	Content Type
sdkerrors.ErrorResponse	default	application/json
sdkerrors.SDKError	4XX, 5XX	*/*

Example

package main

import (
	"context"
	"errors"
	formancesdkgo "github.com/formancehq/formance-sdk-go/v3"
	"github.com/formancehq/formance-sdk-go/v3/pkg/models/operations"
	"github.com/formancehq/formance-sdk-go/v3/pkg/models/sdkerrors"
	"github.com/formancehq/formance-sdk-go/v3/pkg/models/shared"
	"log"
	"math/big"
)

func main() {
	s := formancesdkgo.New(
		formancesdkgo.WithSecurity(shared.Security{
			ClientID:     formancesdkgo.String("<YOUR_CLIENT_ID_HERE>"),
			ClientSecret: formancesdkgo.String("<YOUR_CLIENT_SECRET_HERE>"),
		}),
	)

	ctx := context.Background()
	res, err := s.Ledger.V1.CreateTransactions(ctx, operations.CreateTransactionsRequest{
		Transactions: shared.Transactions{
			Transactions: []shared.TransactionData{
				shared.TransactionData{
					Postings: []shared.Posting{
						shared.Posting{
							Amount:      big.NewInt(100),
							Asset:       "COIN",
							Destination: "users:002",
							Source:      "users:001",
						},
						shared.Posting{
							Amount:      big.NewInt(100),
							Asset:       "COIN",
							Destination: "users:002",
							Source:      "users:001",
						},
						shared.Posting{
							Amount:      big.NewInt(100),
							Asset:       "COIN",
							Destination: "users:002",
							Source:      "users:001",
						},
					},
					Reference: formancesdkgo.String("ref:001"),
				},
			},
		},
		Ledger: "ledger001",
	})
	if err != nil {

		var e *sdkerrors.ErrorResponse
		if errors.As(err, &e) {
			// handle error
			log.Fatal(e.Error())
		}

		var e *sdkerrors.SDKError
		if errors.As(err, &e) {
			// handle error
			log.Fatal(e.Error())
		}
	}
}

Server Selection

Select Server by Index

You can override the default server globally using the WithServerIndex option when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:

#	Server	Variables
0	http://localhost	None
1	https://{organization}.{environment}.formance.cloud	environment (default is sandbox), organization (default is orgID-stackID)

Example

package main

import (
	"context"
	formancesdkgo "github.com/formancehq/formance-sdk-go/v3"
	"github.com/formancehq/formance-sdk-go/v3/pkg/models/shared"
	"log"
)

func main() {
	s := formancesdkgo.New(
		formancesdkgo.WithServerIndex(1),
		formancesdkgo.WithSecurity(shared.Security{
			ClientID:     formancesdkgo.String("<YOUR_CLIENT_ID_HERE>"),
			ClientSecret: formancesdkgo.String("<YOUR_CLIENT_SECRET_HERE>"),
		}),
	)

	ctx := context.Background()
	res, err := s.GetVersions(ctx)
	if err != nil {
		log.Fatal(err)
	}
	if res.GetVersionsResponse != nil {
		// handle response
	}
}

Variables

Some of the server options above contain variables. If you want to set the values of those variables, the following options are provided for doing so:

• WithEnvironment formancesdkgo.ServerEnvironment
• WithOrganization string

Override Server URL Per-Client

The default server can also be overridden globally using the WithServerURL option when initializing the SDK client instance. For example:

package main

import (
	"context"
	formancesdkgo "github.com/formancehq/formance-sdk-go/v3"
	"github.com/formancehq/formance-sdk-go/v3/pkg/models/shared"
	"log"
)

func main() {
	s := formancesdkgo.New(
		formancesdkgo.WithServerURL("http://localhost"),
		formancesdkgo.WithSecurity(shared.Security{
			ClientID:     formancesdkgo.String("<YOUR_CLIENT_ID_HERE>"),
			ClientSecret: formancesdkgo.String("<YOUR_CLIENT_SECRET_HERE>"),
		}),
	)

	ctx := context.Background()
	res, err := s.GetVersions(ctx)
	if err != nil {
		log.Fatal(err)
	}
	if res.GetVersionsResponse != nil {
		// handle response
	}
}

Custom HTTP Client

The Go SDK makes API calls that wrap an internal HTTP client. The requirements for the HTTP client are very simple. It must match this interface:

type HTTPClient interface {
	Do(req *http.Request) (*http.Response, error)
}

The built-in net/http client satisfies this interface and a default client based on the built-in is provided by default. To replace this default with a client of your own, you can implement this interface yourself or provide your own client configured as desired. Here's a simple example, which adds a client with a 30 second timeout.

import (
	"net/http"
	"time"
	"github.com/myorg/your-go-sdk"
)

var (
	httpClient = &http.Client{Timeout: 30 * time.Second}
	sdkClient  = sdk.New(sdk.WithClient(httpClient))
)

This can be a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration.

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

Name	Type	Scheme
ClientID ClientSecret	oauth2	OAuth2 Client Credentials Flow

You can configure it using the WithSecurity option when initializing the SDK client instance. For example:

package main

import (
	"context"
	formancesdkgo "github.com/formancehq/formance-sdk-go/v3"
	"github.com/formancehq/formance-sdk-go/v3/pkg/models/shared"
	"log"
)

func main() {
	s := formancesdkgo.New(
		formancesdkgo.WithSecurity(shared.Security{
			ClientID:     formancesdkgo.String("<YOUR_CLIENT_ID_HERE>"),
			ClientSecret: formancesdkgo.String("<YOUR_CLIENT_SECRET_HERE>"),
		}),
	)

	ctx := context.Background()
	res, err := s.GetVersions(ctx)
	if err != nil {
		log.Fatal(err)
	}
	if res.GetVersionsResponse != nil {
		// handle response
	}
}

Special Types

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 retry.Config object to the call by using the WithRetries option:

package main

import (
	"context"
	formancesdkgo "github.com/formancehq/formance-sdk-go/v3"
	"github.com/formancehq/formance-sdk-go/v3/pkg/models/shared"
	"github.com/formancehq/formance-sdk-go/v3/pkg/retry"
	"log"
	"pkg/models/operations"
)

func main() {
	s := formancesdkgo.New(
		formancesdkgo.WithSecurity(shared.Security{
			ClientID:     formancesdkgo.String("<YOUR_CLIENT_ID_HERE>"),
			ClientSecret: formancesdkgo.String("<YOUR_CLIENT_SECRET_HERE>"),
		}),
	)

	ctx := context.Background()
	res, err := s.GetVersions(ctx, operations.WithRetries(
		retry.Config{
			Strategy: "backoff",
			Backoff: &retry.BackoffStrategy{
				InitialInterval: 1,
				MaxInterval:     50,
				Exponent:        1.1,
				MaxElapsedTime:  100,
			},
			RetryConnectionErrors: false,
		}))
	if err != nil {
		log.Fatal(err)
	}
	if res.GetVersionsResponse != nil {
		// handle response
	}
}

If you'd like to override the default retry strategy for all operations that support retries, you can use the WithRetryConfig option at SDK initialization:

package main

import (
	"context"
	formancesdkgo "github.com/formancehq/formance-sdk-go/v3"
	"github.com/formancehq/formance-sdk-go/v3/pkg/models/shared"
	"github.com/formancehq/formance-sdk-go/v3/pkg/retry"
	"log"
)

func main() {
	s := formancesdkgo.New(
		formancesdkgo.WithRetryConfig(
			retry.Config{
				Strategy: "backoff",
				Backoff: &retry.BackoffStrategy{
					InitialInterval: 1,
					MaxInterval:     50,
					Exponent:        1.1,
					MaxElapsedTime:  100,
				},
				RetryConnectionErrors: false,
			}),
		formancesdkgo.WithSecurity(shared.Security{
			ClientID:     formancesdkgo.String("<YOUR_CLIENT_ID_HERE>"),
			ClientSecret: formancesdkgo.String("<YOUR_CLIENT_SECRET_HERE>"),
		}),
	)

	ctx := context.Background()
	res, err := s.GetVersions(ctx)
	if err != nil {
		log.Fatal(err)
	}
	if res.GetVersionsResponse != nil {
		// handle response
	}
}

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