@formance/formance-sdk
v3.1.1
Published
<div align="left"> <a href="https://speakeasyapi.dev/"><img src="https://custom-icon-badges.demolab.com/badge/-Built%20By%20Speakeasy-212015?style=for-the-badge&logoColor=FBE331&logo=speakeasy&labelColor=545454" /></a> <a href="https://opensource.
Downloads
2,397
Readme
@formance/formance-sdk
🏗 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
- Requirements
- SDK Example Usage
- Available Resources and Operations
- Standalone functions
- Retries
- Error Handling
- Server Selection
- Custom HTTP Client
- Authentication
- Debugging
SDK Installation
The SDK can be installed with either npm, pnpm, bun or yarn package managers.
NPM
npm add @formance/formance-sdk
PNPM
pnpm add @formance/formance-sdk
Bun
bun add @formance/formance-sdk
Yarn
yarn add @formance/formance-sdk zod
# Note that Yarn does not install peer dependencies automatically. You will need
# to install zod as shown above.
Requirements
For supported JavaScript runtimes, please consult RUNTIMES.md.
SDK Example Usage
Example
import { SDK } from "@formance/formance-sdk";
const sdk = new SDK({
security: {
clientID: "<YOUR_CLIENT_ID_HERE>",
clientSecret: "<YOUR_CLIENT_SECRET_HERE>",
},
});
async function run() {
const result = await sdk.getVersions();
// Handle the result
console.log(result);
}
run();
Available Resources and Operations
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
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 :warning: 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
- getInfo - Show server information
- getLedger - Get a ledger
- getLedgerInfo - Get information about a ledger
- getTransaction - Get transaction from a ledger by its ID
- importLogs
- listLedgers - List ledgers
- 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 :warning: 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 :warning: 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
- ~~readConnectorConfig~~ - Read the config of a connector :warning: Deprecated
- readConnectorConfigV1 - Read the config of a connector
- removeAccountFromPool - Remove an account from a pool
- ~~resetConnector~~ - Reset a connector :warning: 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 :warning: 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
SDK
- getVersions - Show stack version information
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
All SDK methods return a response object or throw an error. If Error objects are specified in your OpenAPI Spec, the SDK will throw the appropriate Error type.
| Error Object | Status Code | Content Type | | -------------------- | -------------------- | -------------------- | | errors.ErrorResponse | default | application/json | | errors.SDKError | 4xx-5xx | / |
Validation errors can also occur when either method arguments or data returned from the server do not match the expected format. The SDKValidationError
that is thrown as a result will capture the raw value that failed validation in an attribute called rawValue
. Additionally, a pretty()
method is available on this error that can be used to log a nicely formatted string since validation errors can list many issues and the plain error string may be difficult read when debugging.
import { SDK } from "@formance/formance-sdk";
import {
ErrorResponse,
SDKValidationError,
} from "@formance/formance-sdk/sdk/models/errors";
const sdk = new SDK({
security: {
clientID: "<YOUR_CLIENT_ID_HERE>",
clientSecret: "<YOUR_CLIENT_SECRET_HERE>",
},
});
async function run() {
let result;
try {
result = await sdk.ledger.v1.createTransactions({
transactions: {
transactions: [
{
postings: [
{
amount: BigInt("100"),
asset: "COIN",
destination: "users:002",
source: "users:001",
},
],
reference: "ref:001",
},
],
},
ledger: "ledger001",
});
// Handle the result
console.log(result);
} catch (err) {
switch (true) {
case (err instanceof SDKValidationError): {
// Validation errors can be pretty-printed
console.error(err.pretty());
// Raw value may also be inspected
console.error(err.rawValue);
return;
}
case (err instanceof ErrorResponse): {
// Handle err.data$: ErrorResponseData
console.error(err);
return;
}
default: {
throw err;
}
}
}
}
run();
Server Selection
Select Server by Index
You can override the default server globally by passing a server index to the serverIdx
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 |
| - | ------ | --------- |
| 0 | http://localhost
| None |
| 1 | https://{organization}.{environment}.formance.cloud
| environment
(default is sandbox
), organization
(default is orgID-stackID
) |
import { SDK } from "@formance/formance-sdk";
const sdk = new SDK({
serverIdx: 1,
security: {
clientID: "<YOUR_CLIENT_ID_HERE>",
clientSecret: "<YOUR_CLIENT_SECRET_HERE>",
},
});
async function run() {
const result = await sdk.getVersions();
// Handle the result
console.log(result);
}
run();
Variables
Some of the server options above contain variables. If you want to set the values of those variables, the following optional parameters are available when initializing the SDK client instance:
environment: models.ServerEnvironment
organization: string
Override Server URL Per-Client
The default server can also be overridden globally by passing a URL to the serverURL
optional parameter when initializing the SDK client instance. For example:
import { SDK } from "@formance/formance-sdk";
const sdk = new SDK({
serverURL: "http://localhost",
security: {
clientID: "<YOUR_CLIENT_ID_HERE>",
clientSecret: "<YOUR_CLIENT_SECRET_HERE>",
},
});
async function run() {
const result = await sdk.getVersions();
// Handle the result
console.log(result);
}
run();
Custom HTTP Client
The TypeScript SDK makes API calls using an HTTPClient
that wraps the native
Fetch API. This
client is a thin wrapper around fetch
and provides the ability to attach hooks
around the request lifecycle that can be used to modify the request or handle
errors and response.
The HTTPClient
constructor takes an optional fetcher
argument that can be
used to integrate a third-party HTTP client or when writing tests to mock out
the HTTP client and feed in fixtures.
The following example shows how to use the "beforeRequest"
hook to to add a
custom header and a timeout to requests and how to use the "requestError"
hook
to log errors:
import { SDK } from "@formance/formance-sdk";
import { HTTPClient } from "@formance/formance-sdk/lib/http";
const httpClient = new HTTPClient({
// fetcher takes a function that has the same signature as native `fetch`.
fetcher: (request) => {
return fetch(request);
}
});
httpClient.addHook("beforeRequest", (request) => {
const nextRequest = new Request(request, {
signal: request.signal || AbortSignal.timeout(5000)
});
nextRequest.headers.set("x-custom-header", "custom value");
return nextRequest;
});
httpClient.addHook("requestError", (error, request) => {
console.group("Request Error");
console.log("Reason:", `${error}`);
console.log("Endpoint:", `${request.method} ${request.url}`);
console.groupEnd();
});
const sdk = new SDK({ httpClient });
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 set the security parameters through the security
optional parameter when initializing the SDK client instance. For example:
import { SDK } from "@formance/formance-sdk";
const sdk = new SDK({
security: {
clientID: "<YOUR_CLIENT_ID_HERE>",
clientSecret: "<YOUR_CLIENT_SECRET_HERE>",
},
});
async function run() {
const result = await sdk.getVersions();
// Handle the result
console.log(result);
}
run();
Standalone functions
All the methods listed above are available as standalone functions. These functions are ideal for use in applications running in the browser, serverless runtimes or other environments where application bundle size is a primary concern. When using a bundler to build your application, all unused functionality will be either excluded from the final bundle or tree-shaken away.
To read more about standalone functions, check FUNCTIONS.md.
- authV1CreateClient
- authV1CreateSecret
- authV1DeleteClient
- authV1DeleteSecret
- authV1GetOIDCWellKnowns
- authV1GetServerInfo
- authV1ListClients
- authV1ListUsers
- authV1ReadClient
- authV1ReadUser
- authV1UpdateClient
- getVersions
- ledgerV1AddMetadataOnTransaction
- ledgerV1AddMetadataToAccount
- ledgerV1CountAccounts
- ledgerV1CountTransactions
- ledgerV1CreateTransaction
- ledgerV1CreateTransactions
- ledgerV1GetAccount
- ledgerV1GetBalancesAggregated
- ledgerV1GetBalances
- ledgerV1GetInfo
- ledgerV1GetLedgerInfo
- ledgerV1GetMapping
- ledgerV1GetTransaction
- ledgerV1ListAccounts
- ledgerV1ListLogs
- ledgerV1ListTransactions
- ledgerV1ReadStats
- ledgerV1RevertTransaction
- ledgerV1RunScript
- ledgerV1UpdateMapping
- ledgerV2AddMetadataOnTransaction
- ledgerV2AddMetadataToAccount
- ledgerV2CountAccounts
- ledgerV2CountTransactions
- ledgerV2CreateBulk
- ledgerV2CreateLedger
- ledgerV2CreateTransaction
- ledgerV2DeleteAccountMetadata
- ledgerV2DeleteLedgerMetadata
- ledgerV2DeleteTransactionMetadata
- ledgerV2ExportLogs
- ledgerV2GetAccount
- ledgerV2GetInfo
- ledgerV2GetLedgerInfo
- ledgerV2GetLedger
- ledgerV2GetTransaction
- ledgerV2ImportLogs
- ledgerV2ListLedgers
- ledgerV2ReadStats
- ledgerV2RevertTransaction
- ledgerV2UpdateLedgerMetadata
- orchestrationV1CancelEvent
- orchestrationV1CreateTrigger
- orchestrationV1CreateWorkflow
- orchestrationV1DeleteTrigger
- orchestrationV1DeleteWorkflow
- orchestrationV1GetInstanceHistory
- orchestrationV1GetInstanceStageHistory
- orchestrationV1GetInstance
- orchestrationV1GetWorkflow
- orchestrationV1ListInstances
- orchestrationV1ListTriggersOccurrences
- orchestrationV1ListTriggers
- orchestrationV1ListWorkflows
- orchestrationV1OrchestrationgetServerInfo
- orchestrationV1ReadTrigger
- orchestrationV1RunWorkflow
- orchestrationV1SendEvent
- orchestrationV2CancelEvent
- orchestrationV2CreateTrigger
- orchestrationV2CreateWorkflow
- orchestrationV2DeleteTrigger
- orchestrationV2DeleteWorkflow
- orchestrationV2GetInstanceHistory
- orchestrationV2GetInstanceStageHistory
- orchestrationV2GetInstance
- orchestrationV2GetServerInfo
- orchestrationV2GetWorkflow
- orchestrationV2ListInstances
- orchestrationV2ListTriggersOccurrences
- orchestrationV2ListTriggers
- orchestrationV2ListWorkflows
- orchestrationV2ReadTrigger
- orchestrationV2RunWorkflow
- orchestrationV2SendEvent
- orchestrationV2TestTrigger
- paymentsV1AddAccountToPool
- paymentsV1ConnectorsTransfer
- paymentsV1CreateAccount
- paymentsV1CreateBankAccount
- paymentsV1CreatePayment
- paymentsV1CreatePool
- paymentsV1CreateTransferInitiation
- paymentsV1DeletePool
- paymentsV1DeleteTransferInitiation
- paymentsV1ForwardBankAccount
- paymentsV1GetAccountBalances
- paymentsV1GetBankAccount
- paymentsV1GetConnectorTaskV1
- paymentsV1GetConnectorTask
- paymentsV1GetPayment
- paymentsV1GetPoolBalances
- paymentsV1GetPool
- paymentsV1GetTransferInitiation
- paymentsV1InstallConnector
- paymentsV1ListAllConnectors
- paymentsV1ListBankAccounts
- paymentsV1ListConfigsAvailableConnectors
- paymentsV1ListConnectorTasksV1
- paymentsV1ListConnectorTasks
- paymentsV1ListPayments
- paymentsV1ListPools
- paymentsV1ListTransferInitiations
- paymentsV1PaymentsgetAccount
- paymentsV1PaymentsgetServerInfo
- paymentsV1ReadConnectorConfigV1
- paymentsV1ReadConnectorConfig
- paymentsV1RemoveAccountFromPool
- paymentsV1ResetConnectorV1
- paymentsV1ResetConnector
- paymentsV1RetryTransferInitiation
- paymentsV1ReverseTransferInitiation
- paymentsV1UdpateTransferInitiationStatus
- paymentsV1UninstallConnectorV1
- paymentsV1UninstallConnector
- paymentsV1UpdateBankAccountMetadata
- paymentsV1UpdateConnectorConfigV1
- paymentsV1UpdateMetadata
- reconciliationV1CreatePolicy
- reconciliationV1DeletePolicy
- reconciliationV1GetPolicy
- reconciliationV1GetReconciliation
- reconciliationV1ListPolicies
- reconciliationV1ListReconciliations
- reconciliationV1Reconcile
- reconciliationV1ReconciliationgetServerInfo
- searchV1Search
- searchV1SearchgetServerInfo
- walletsV1ConfirmHold
- walletsV1CreateBalance
- walletsV1CreateWallet
- walletsV1CreditWallet
- walletsV1DebitWallet
- walletsV1GetBalance
- walletsV1GetHold
- walletsV1GetHolds
- walletsV1GetTransactions
- walletsV1GetWalletSummary
- walletsV1GetWallet
- walletsV1ListBalances
- walletsV1ListWallets
- walletsV1UpdateWallet
- walletsV1VoidHold
- walletsV1WalletsgetServerInfo
- webhooksV1ActivateConfig
- webhooksV1ChangeConfigSecret
- webhooksV1DeactivateConfig
- webhooksV1DeleteConfig
- webhooksV1GetManyConfigs
- webhooksV1InsertConfig
- webhooksV1TestConfig
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 retryConfig object to the call:
import { SDK } from "@formance/formance-sdk";
const sdk = new SDK({
security: {
clientID: "<YOUR_CLIENT_ID_HERE>",
clientSecret: "<YOUR_CLIENT_SECRET_HERE>",
},
});
async function run() {
const result = await sdk.getVersions({
retries: {
strategy: "backoff",
backoff: {
initialInterval: 1,
maxInterval: 50,
exponent: 1.1,
maxElapsedTime: 100,
},
retryConnectionErrors: false,
},
});
// Handle the result
console.log(result);
}
run();
If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization:
import { SDK } from "@formance/formance-sdk";
const sdk = new SDK({
retryConfig: {
strategy: "backoff",
backoff: {
initialInterval: 1,
maxInterval: 50,
exponent: 1.1,
maxElapsedTime: 100,
},
retryConnectionErrors: false,
},
security: {
clientID: "<YOUR_CLIENT_ID_HERE>",
clientSecret: "<YOUR_CLIENT_SECRET_HERE>",
},
});
async function run() {
const result = await sdk.getVersions();
// Handle the result
console.log(result);
}
run();
Debugging
You can setup your SDK to emit debug logs for SDK requests and responses.
You can pass a logger that matches console
's interface as an SDK option.
[!WARNING] Beware that debug logging will reveal secrets, like API tokens in headers, in log messages printed to a console or files. It's recommended to use this feature only during local development and not in production.
import { SDK } from "@formance/formance-sdk";
const sdk = new SDK({ debugLogger: console });
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!