payments/pkg/client

openapi

Developer-friendly & type-safe Go SDK specifically catered to leverage openapi API.

Important

This SDK is not yet ready for production use. To complete setup please follow the steps outlined in your workspace. Delete this section before > publishing to a package manager.

Summary

Table of Contents

• openapi
  • SDK Installation
  • SDK Example Usage
  • Authentication
  • Available Resources and Operations
  • Retries
  • Error Handling
  • Custom HTTP Client
• Development
  • Maturity
  • Contributions

SDK Installation

To add the SDK as a dependency to your project:

go get github.com/formancehq/payments/pkg/client

SDK Example Usage

Example

package main

import (
	"context"
	"github.com/formancehq/payments/pkg/client"
	"log"
	"os"
)

func main() {
	ctx := context.Background()

	s := client.New(
		"https://api.example.com",
		client.WithSecurity(os.Getenv("FORMANCE_AUTHORIZATION")),
	)

	res, err := s.Payments.V1.GetServerInfo(ctx)
	if err != nil {
		log.Fatal(err)
	}
	if res.ServerInfo != nil {
		// handle response
	}
}

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

Name	Type	Scheme	Environment Variable
Authorization	apiKey	API key	FORMANCE_AUTHORIZATION

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

package main

import (
	"context"
	"github.com/formancehq/payments/pkg/client"
	"log"
	"os"
)

func main() {
	ctx := context.Background()

	s := client.New(
		"https://api.example.com",
		client.WithSecurity(os.Getenv("FORMANCE_AUTHORIZATION")),
	)

	res, err := s.Payments.V1.GetServerInfo(ctx)
	if err != nil {
		log.Fatal(err)
	}
	if res.ServerInfo != nil {
		// handle response
	}
}

Available Resources and Operations

Available methods

Payments

Payments.V1

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

Payments.V3

• CreateAccount - Create a formance account object. This object will not be forwarded to the connector. It is only used for internal purposes.

• ListAccounts - List all accounts

• GetAccount - Get an account by ID

• GetAccountBalances - Get account balances

• CreateBankAccount - Create a formance bank account object. This object will not be forwarded to the connector until you called the forwardBankAccount method.

• ListBankAccounts - List all bank accounts

• GetBankAccount - Get a Bank Account by ID

• UpdateBankAccountMetadata - Update a bank account's metadata

• ForwardBankAccount - Forward a Bank Account to a PSP for creation

• ListConnectors - List all connectors

• InstallConnector - Install a connector

• ListConnectorConfigs - List all connector configurations

• UninstallConnector - Uninstall a connector

• GetConnectorConfig - Get a connector configuration by ID

• V3UpdateConnectorConfig - Update the config of a connector

• ResetConnector - Reset a connector. Be aware that this will delete all data and stop all existing tasks like payment initiations and bank account creations.

• ListConnectorSchedules - List all connector schedules

• GetConnectorSchedule - Get a connector schedule by ID

• ListConnectorScheduleInstances - List all connector schedule instances

• CreatePayment - Create a formance payment object. This object will not be forwarded to the connector. It is only used for internal purposes.

• ListPayments - List all payments

• GetPayment - Get a payment by ID

• UpdatePaymentMetadata - Update a payment's metadata

• InitiatePayment - Initiate a payment

• ListPaymentInitiations - List all payment initiations

• DeletePaymentInitiation - Delete a payment initiation by ID

• GetPaymentInitiation - Get a payment initiation by ID

• RetryPaymentInitiation - Retry a payment initiation

• ApprovePaymentInitiation - Approve a payment initiation

• RejectPaymentInitiation - Reject a payment initiation

• ReversePaymentInitiation - Reverse a payment initiation

• ListPaymentInitiationAdjustments - List all payment initiation adjustments

• ListPaymentInitiationRelatedPayments - List all payments related to a payment initiation

• CreatePaymentServiceUser - Create a formance payment service user object

• ListPaymentServiceUsers - List all payment service users

• GetPaymentServiceUser - Get a payment service user by ID

• DeletePaymentServiceUser - Delete a payment service user by ID

• ListPaymentServiceUserConnections - List all connections for a payment service user

• DeletePaymentServiceUserConnector - Remove a payment service user from a connector, the PSU will still exist in Formance

• ForwardPaymentServiceUserToProvider - Register/forward a payment service user on/to a connector

• CreateLinkForPaymentServiceUser - Create an authentication link for a payment service user on a connector, for oauth flow

• ListPaymentServiceUserConnectionsFromConnectorID - List enabled connections for a payment service user on a connector (i.e. the various banks PSUser has enabled on the connector)

• ListPaymentServiceUserLinkAttemptsFromConnectorID - List all link attempts for a payment service user on a connector. Allows to check if users used the link and completed the oauth flow.

• GetPaymentServiceUserLinkAttemptFromConnectorID - Get a link attempt for a payment service user on a connector

• DeletePaymentServiceUserConnectionFromConnectorID - Delete a connection for a payment service user on a connector

• UpdateLinkForPaymentServiceUserOnConnector - Update/Regenerate a link for a payment service user on a connector

• AddBankAccountToPaymentServiceUser - Add a bank account to a payment service user

• ForwardPaymentServiceUserBankAccount - Forward a payment service user's bank account to a connector

• CreatePool - Create a formance pool object

• ListPools - List all pools

• GetPool - Get a pool by ID

• DeletePool - Delete a pool by ID

• UpdatePoolQuery - Update the query of a pool

• GetPoolBalances - Get historical pool balances from a particular point in time

• GetPoolBalancesLatest - Get latest pool balances

• AddAccountToPool - Add an account to a pool

• RemoveAccountFromPool - Remove an account from a pool

• GetTask - Get a task and its result by ID

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"
	"github.com/formancehq/payments/pkg/client"
	"github.com/formancehq/payments/pkg/client/retry"
	"log"
	"models/operations"
	"os"
)

func main() {
	ctx := context.Background()

	s := client.New(
		"https://api.example.com",
		client.WithSecurity(os.Getenv("FORMANCE_AUTHORIZATION")),
	)

	res, err := s.Payments.V1.GetServerInfo(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.ServerInfo != 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"
	"github.com/formancehq/payments/pkg/client"
	"github.com/formancehq/payments/pkg/client/retry"
	"log"
	"os"
)

func main() {
	ctx := context.Background()

	s := client.New(
		"https://api.example.com",
		client.WithRetryConfig(
			retry.Config{
				Strategy: "backoff",
				Backoff: &retry.BackoffStrategy{
					InitialInterval: 1,
					MaxInterval:     50,
					Exponent:        1.1,
					MaxElapsedTime:  100,
				},
				RetryConnectionErrors: false,
			}),
		client.WithSecurity(os.Getenv("FORMANCE_AUTHORIZATION")),
	)

	res, err := s.Payments.V1.GetServerInfo(ctx)
	if err != nil {
		log.Fatal(err)
	}
	if res.ServerInfo != nil {
		// handle response
	}
}

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 GetServerInfo function may return the following errors:

Error Type	Status Code	Content Type
sdkerrors.SDKError	4XX, 5XX	*/*

Example

package main

import (
	"context"
	"errors"
	"github.com/formancehq/payments/pkg/client"
	"github.com/formancehq/payments/pkg/client/models/sdkerrors"
	"log"
	"os"
)

func main() {
	ctx := context.Background()

	s := client.New(
		"https://api.example.com",
		client.WithSecurity(os.Getenv("FORMANCE_AUTHORIZATION")),
	)

	res, err := s.Payments.V1.GetServerInfo(ctx)
	if err != nil {

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

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.

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. Any manual changes added to internal files will be overwritten on the next generation. We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.

SDK Created by Speakeasy