Go API client for formance

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.

Overview

This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

• API version: develop
• Package version: develop
• Build package: org.openapitools.codegen.languages.GoClientCodegen For more information, please visit https://www.formance.com

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/oauth2
go get golang.org/x/net/context

Put the package under your project folder and add the following in import:

import formance "github.com/formancehq/formance-sdk-go"

To use a proxy, set the environment variable HTTP_PROXY:

os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")

Configuration of Server URL

Default configuration comes with Servers field that contains server objects as defined in the OpenAPI specification.

Select Server Configuration

For using other server than the one defined on index 0 set context value sw.ContextServerIndex of type int.

ctx := context.WithValue(context.Background(), formance.ContextServerIndex, 1)

Templated Server URL

Templated server URL is formatted using default variables from configuration or from context value sw.ContextServerVariables of type map[string]string.

ctx := context.WithValue(context.Background(), formance.ContextServerVariables, map[string]string{
	"basePath": "v2",
})

Note, enum values are always validated and all unused variables are silently ignored.

URLs Configuration per Operation

Each operation can use different server URL defined using OperationServers map in the Configuration. An operation is uniquely identified by "{classname}Service.{nickname}" string. Similar rules for overriding default operation server index and variables applies by using sw.ContextOperationServerIndices and sw.ContextOperationServerVariables context maps.

ctx := context.WithValue(context.Background(), formance.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), formance.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})

Documentation for API Endpoints

All URIs are relative to http://localhost

Class	Method	HTTP request	Description
AccountsApi	AddMetadataToAccount	Post /api/ledger/{ledger}/accounts/{address}/metadata	Add metadata to an account
AccountsApi	CountAccounts	Head /api/ledger/{ledger}/accounts	Count the accounts from a ledger
AccountsApi	GetAccount	Get /api/ledger/{ledger}/accounts/{address}	Get account by its address
AccountsApi	ListAccounts	Get /api/ledger/{ledger}/accounts	List accounts from a ledger
BalancesApi	GetBalances	Get /api/ledger/{ledger}/balances	Get the balances from a ledger's account
BalancesApi	GetBalancesAggregated	Get /api/ledger/{ledger}/aggregate/balances	Get the aggregated balances from selected accounts
ClientsApi	AddScopeToClient	Put /api/auth/clients/{clientId}/scopes/{scopeId}	Add scope to client
ClientsApi	CreateClient	Post /api/auth/clients	Create client
ClientsApi	CreateSecret	Post /api/auth/clients/{clientId}/secrets	Add a secret to a client
ClientsApi	DeleteClient	Delete /api/auth/clients/{clientId}	Delete client
ClientsApi	DeleteScopeFromClient	Delete /api/auth/clients/{clientId}/scopes/{scopeId}	Delete scope from client
ClientsApi	DeleteSecret	Delete /api/auth/clients/{clientId}/secrets/{secretId}	Delete a secret from a client
ClientsApi	ListClients	Get /api/auth/clients	List clients
ClientsApi	ReadClient	Get /api/auth/clients/{clientId}	Read client
ClientsApi	UpdateClient	Put /api/auth/clients/{clientId}	Update client
DefaultApi	GetServerInfo	Get /api/auth/_info	Get server info
DefaultApi	PaymentsgetServerInfo	Get /api/payments/_info	Get server info
DefaultApi	SearchgetServerInfo	Get /api/search/_info	Get server info
LedgerApi	GetLedgerInfo	Get /api/ledger/{ledger}/_info	Get information about a ledger
LogsApi	ListLogs	Get /api/ledger/{ledger}/logs	List the logs from a ledger
MappingApi	GetMapping	Get /api/ledger/{ledger}/mapping	Get the mapping of a ledger
MappingApi	UpdateMapping	Put /api/ledger/{ledger}/mapping	Update the mapping of a ledger
OrchestrationApi	CancelEvent	Put /api/orchestration/instances/{instanceID}/abort	Cancel a running workflow
OrchestrationApi	CreateWorkflow	Post /api/orchestration/workflows	Create workflow
OrchestrationApi	GetInstance	Get /api/orchestration/instances/{instanceID}	Get a workflow instance by id
OrchestrationApi	GetInstanceHistory	Get /api/orchestration/instances/{instanceID}/history	Get a workflow instance history by id
OrchestrationApi	GetInstanceStageHistory	Get /api/orchestration/instances/{instanceID}/stages/{number}/history	Get a workflow instance stage history
OrchestrationApi	GetWorkflow	Get /api/orchestration/workflows/{flowId}	Get a flow by id
OrchestrationApi	ListInstances	Get /api/orchestration/instances	List instances of a workflow
OrchestrationApi	ListWorkflows	Get /api/orchestration/workflows	List registered workflows
OrchestrationApi	OrchestrationgetServerInfo	Get /api/orchestration/_info	Get server info
OrchestrationApi	RunWorkflow	Post /api/orchestration/workflows/{workflowID}/instances	Run workflow
OrchestrationApi	SendEvent	Post /api/orchestration/instances/{instanceID}/events	Send an event to a running workflow
PaymentsApi	ConnectorsStripeTransfer	Post /api/payments/connectors/stripe/transfers	Transfer funds between Stripe accounts
PaymentsApi	ConnectorsTransfer	Post /api/payments/connectors/{connector}/transfers	Transfer funds between Connector accounts
PaymentsApi	GetConnectorTask	Get /api/payments/connectors/{connector}/tasks/{taskId}	Read a specific task of the connector
PaymentsApi	GetPayment	Get /api/payments/payments/{paymentId}	Get a payment
PaymentsApi	InstallConnector	Post /api/payments/connectors/{connector}	Install a connector
PaymentsApi	ListAllConnectors	Get /api/payments/connectors	List all installed connectors
PaymentsApi	ListConfigsAvailableConnectors	Get /api/payments/connectors/configs	List the configs of each available connector
PaymentsApi	ListConnectorTasks	Get /api/payments/connectors/{connector}/tasks	List tasks from a connector
PaymentsApi	ListConnectorsTransfers	Get /api/payments/connectors/{connector}/transfers	List transfers and their statuses
PaymentsApi	ListPayments	Get /api/payments/payments	List payments
PaymentsApi	PaymentslistAccounts	Get /api/payments/accounts	List accounts
PaymentsApi	ReadConnectorConfig	Get /api/payments/connectors/{connector}/config	Read the config of a connector
PaymentsApi	ResetConnector	Post /api/payments/connectors/{connector}/reset	Reset a connector
PaymentsApi	UninstallConnector	Delete /api/payments/connectors/{connector}	Uninstall a connector
PaymentsApi	UpdateMetadata	Patch /api/payments/payments/{paymentId}/metadata	Update metadata
ScopesApi	AddTransientScope	Put /api/auth/scopes/{scopeId}/transient/{transientScopeId}	Add a transient scope to a scope
ScopesApi	CreateScope	Post /api/auth/scopes	Create scope
ScopesApi	DeleteScope	Delete /api/auth/scopes/{scopeId}	Delete scope
ScopesApi	DeleteTransientScope	Delete /api/auth/scopes/{scopeId}/transient/{transientScopeId}	Delete a transient scope from a scope
ScopesApi	ListScopes	Get /api/auth/scopes	List scopes
ScopesApi	ReadScope	Get /api/auth/scopes/{scopeId}	Read scope
ScopesApi	UpdateScope	Put /api/auth/scopes/{scopeId}	Update scope
ScriptApi	RunScript	Post /api/ledger/{ledger}/script	Execute a Numscript
SearchApi	Search	Post /api/search/	Search
ServerApi	GetInfo	Get /api/ledger/_info	Show server information
StatsApi	ReadStats	Get /api/ledger/{ledger}/stats	Get statistics from a ledger
TransactionsApi	AddMetadataOnTransaction	Post /api/ledger/{ledger}/transactions/{txid}/metadata	Set the metadata of a transaction by its ID
TransactionsApi	CountTransactions	Head /api/ledger/{ledger}/transactions	Count the transactions from a ledger
TransactionsApi	CreateTransaction	Post /api/ledger/{ledger}/transactions	Create a new transaction to a ledger
TransactionsApi	CreateTransactions	Post /api/ledger/{ledger}/transactions/batch	Create a new batch of transactions to a ledger
TransactionsApi	GetTransaction	Get /api/ledger/{ledger}/transactions/{txid}	Get transaction from a ledger by its ID
TransactionsApi	ListTransactions	Get /api/ledger/{ledger}/transactions	List transactions from a ledger
TransactionsApi	RevertTransaction	Post /api/ledger/{ledger}/transactions/{txid}/revert	Revert a ledger transaction by its ID
UsersApi	ListUsers	Get /api/auth/users	List users
UsersApi	ReadUser	Get /api/auth/users/{userId}	Read user
WalletsApi	ConfirmHold	Post /api/wallets/holds/{hold_id}/confirm	Confirm a hold
WalletsApi	CreateBalance	Post /api/wallets/wallets/{id}/balances	Create a balance
WalletsApi	CreateWallet	Post /api/wallets/wallets	Create a new wallet
WalletsApi	CreditWallet	Post /api/wallets/wallets/{id}/credit	Credit a wallet
WalletsApi	DebitWallet	Post /api/wallets/wallets/{id}/debit	Debit a wallet
WalletsApi	GetBalance	Get /api/wallets/wallets/{id}/balances/{balanceName}	Get detailed balance
WalletsApi	GetHold	Get /api/wallets/holds/{holdID}	Get a hold
WalletsApi	GetHolds	Get /api/wallets/holds	Get all holds for a wallet
WalletsApi	GetTransactions	Get /api/wallets/transactions
WalletsApi	GetWallet	Get /api/wallets/wallets/{id}	Get a wallet
WalletsApi	ListBalances	Get /api/wallets/wallets/{id}/balances	List balances of a wallet
WalletsApi	ListWallets	Get /api/wallets/wallets	List all wallets
WalletsApi	UpdateWallet	Patch /api/wallets/wallets/{id}	Update a wallet
WalletsApi	VoidHold	Post /api/wallets/holds/{hold_id}/void	Cancel a hold
WalletsApi	WalletsgetServerInfo	Get /api/wallets/_info	Get server info
WebhooksApi	ActivateConfig	Put /api/webhooks/configs/{id}/activate	Activate one config
WebhooksApi	ChangeConfigSecret	Put /api/webhooks/configs/{id}/secret/change	Change the signing secret of a config
WebhooksApi	DeactivateConfig	Put /api/webhooks/configs/{id}/deactivate	Deactivate one config
WebhooksApi	DeleteConfig	Delete /api/webhooks/configs/{id}	Delete one config
WebhooksApi	GetManyConfigs	Get /api/webhooks/configs	Get many configs
WebhooksApi	InsertConfig	Post /api/webhooks/configs	Insert a new config
WebhooksApi	TestConfig	Get /api/webhooks/configs/{id}/test	Test one config

Documentation For Models

• Account
• AccountResponse
• AccountWithVolumesAndBalances
• AccountsCursor
• AccountsCursorCursor
• AccountsCursorCursorAllOf
• AccountsCursorResponse
• AccountsCursorResponseCursor
• ActivityConfirmHold
• ActivityCreateTransaction
• ActivityCreditWallet
• ActivityDebitWallet
• ActivityGetAccount
• ActivityGetPayment
• ActivityGetWallet
• ActivityRevertTransaction
• ActivityVoidHold
• AggregateBalancesResponse
• AssetHolder
• Attempt
• AttemptResponse
• Balance
• BalanceWithAssets
• BalancesCursorResponse
• BalancesCursorResponseCursor
• BankingCircleConfig
• Client
• ClientAllOf
• ClientOptions
• ClientSecret
• Config
• ConfigChangeSecret
• ConfigInfo
• ConfigInfoResponse
• ConfigResponse
• ConfigUser
• ConfigsResponse
• ConfigsResponseCursor
• ConfigsResponseCursorAllOf
• ConfirmHoldRequest
• Connector
• ConnectorConfig
• ConnectorConfigResponse
• ConnectorsConfigsResponse
• ConnectorsConfigsResponseData
• ConnectorsConfigsResponseDataConnector
• ConnectorsConfigsResponseDataConnectorKey
• ConnectorsResponse
• ConnectorsResponseDataInner
• Contract
• CreateBalanceResponse
• CreateClientResponse
• CreateScopeResponse
• CreateSecretResponse
• CreateWalletRequest
• CreateWalletResponse
• CreateWorkflowResponse
• CreditWalletRequest
• CurrencyCloudConfig
• Cursor
• CursorBase
• DebitWalletRequest
• DebitWalletResponse
• DummyPayConfig
• Error
• ErrorResponse
• ErrorsEnum
• ExpandedDebitHold
• ExpandedDebitHoldAllOf
• GetBalanceResponse
• GetHoldResponse
• GetHoldsResponse
• GetHoldsResponseCursor
• GetHoldsResponseCursorAllOf
• GetTransactionsResponse
• GetTransactionsResponseCursor
• GetTransactionsResponseCursorAllOf
• GetWalletResponse
• GetWorkflowInstanceHistoryResponse
• GetWorkflowInstanceHistoryStageResponse
• GetWorkflowInstanceResponse
• GetWorkflowResponse
• Hold
• LedgerAccountSubject
• LedgerInfo
• LedgerInfoResponse
• LedgerInfoStorage
• LedgerStorage
• ListBalancesResponse
• ListBalancesResponseCursor
• ListBalancesResponseCursorAllOf
• ListClientsResponse
• ListRunsResponse
• ListScopesResponse
• ListUsersResponse
• ListWalletsResponse
• ListWalletsResponseCursor
• ListWalletsResponseCursorAllOf
• ListWorkflowsResponse
• Log
• LogsCursorResponse
• LogsCursorResponseCursor
• Mapping
• MappingResponse
• MigrationInfo
• ModulrConfig
• Monetary
• Payment
• PaymentAdjustment
• PaymentMetadata
• PaymentResponse
• PaymentStatus
• PaymentsAccount
• PaymentsCursor
• PaymentsCursorCursor
• PaymentsCursorCursorAllOf
• PostTransaction
• PostTransactionScript
• Posting
• Query
• ReadClientResponse
• ReadUserResponse
• ReadWorkflowResponse
• Response
• RunWorkflowResponse
• Scope
• ScopeAllOf
• ScopeOptions
• Script
• ScriptResponse
• Secret
• SecretAllOf
• SecretOptions
• SendEventRequest
• ServerInfo
• Stage
• StageDelay
• StageSend
• StageSendDestination
• StageSendDestinationPayment
• StageSendSource
• StageSendSourceAccount
• StageSendSourcePayment
• StageSendSourceWallet
• StageStatus
• StageWaitEvent
• Stats
• StatsResponse
• StripeConfig
• StripeTransferRequest
• Subject
• TaskBankingCircle
• TaskBankingCircleAllOf
• TaskBankingCircleAllOfDescriptor
• TaskBase
• TaskCurrencyCloud
• TaskCurrencyCloudAllOf
• TaskCurrencyCloudAllOfDescriptor
• TaskDummyPay
• TaskDummyPayAllOf
• TaskDummyPayAllOfDescriptor
• TaskModulr
• TaskModulrAllOf
• TaskModulrAllOfDescriptor
• TaskResponse
• TaskStripe
• TaskStripeAllOf
• TaskStripeAllOfDescriptor
• TaskWise
• TaskWiseAllOf
• TaskWiseAllOfDescriptor
• TasksCursor
• TasksCursorCursor
• TasksCursorCursorAllOf
• TasksCursorCursorAllOfDataInner
• Total
• Transaction
• TransactionData
• TransactionResponse
• Transactions
• TransactionsCursorResponse
• TransactionsCursorResponseCursor
• TransactionsResponse
• TransferRequest
• TransferResponse
• TransfersResponse
• TransfersResponseDataInner
• UpdateWalletRequest
• User
• Volume
• Wallet
• WalletSubject
• WalletWithBalances
• WalletWithBalancesBalances
• WalletsCursor
• WalletsErrorResponse
• WalletsTransaction
• WalletsVolume
• WebhooksConfig
• WiseConfig
• Workflow
• WorkflowConfig
• WorkflowInstance
• WorkflowInstanceHistory
• WorkflowInstanceHistoryStage
• WorkflowInstanceHistoryStageInput
• WorkflowInstanceHistoryStageOutput

Documentation For Authorization

Authorization

• Type: OAuth
• Flow: application
• Authorization URL:
• Scopes: N/A

Example

auth := context.WithValue(context.Background(), sw.ContextAccessToken, "ACCESSTOKENSTRING")
r, err := client.Service.Operation(auth, args)

Or via OAuth2 module to automatically refresh tokens and perform user authentication.

import "golang.org/x/oauth2"

/* Perform OAuth2 round trip request and obtain a token */

tokenSource := oauth2cfg.TokenSource(createContext(httpClient), &token)
auth := context.WithValue(oauth2.NoContext, sw.ContextOAuth2, tokenSource)
r, err := client.Service.Operation(auth, args)

Documentation for Utility Methods

Due to the fact that model structure members are all pointers, this package contains a number of utility functions to easily obtain pointers to values of basic types. Each of these functions takes a value of the given basic type and returns a pointer to it:

• PtrBool
• PtrInt
• PtrInt32
• PtrInt64
• PtrFloat
• PtrFloat32
• PtrFloat64
• PtrString
• PtrTime

Author

[email protected]