@formance/formance-sdk NPM

@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

SDK Installation

NPM

npm add @formance/formance-sdk

Yarn

yarn add @formance/formance-sdk

Requirements

For supported JavaScript runtimes, please consult RUNTIMES.md.

SDK Example Usage

Example

import { SDK } from "@formance/formance-sdk";

const sdk = new SDK({
    authorization: "<YOUR_AUTHORIZATION_HERE>",
});

async function run() {
    const result = await sdk.getOIDCWellKnowns();

    // Handle the result
    console.log(result);
}

run();

Available Resources and Operations

SDK

getOIDCWellKnowns - Retrieve OpenID connect well-knowns.
getVersions - Show stack version information

auth

createClient - Create client
createSecret - Add a secret to a client
deleteClient - Delete client
deleteSecret - Delete a secret from a client
listClients - List clients
listUsers - List users
readClient - Read client
readUser - Read user
updateClient - Update client

ledger

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
v2AddMetadataOnTransaction - Set the metadata of a transaction by its ID
v2AddMetadataToAccount - Add metadata to an account
v2CountAccounts - Count the accounts from a ledger
v2CountTransactions - Count the transactions from a ledger
v2CreateBulk - Bulk request
v2CreateLedger - Create a ledger
v2CreateTransaction - Create a new transaction to a ledger
v2DeleteAccountMetadata - Delete metadata by key
v2DeleteLedgerMetadata - Delete ledger metadata by key
v2DeleteTransactionMetadata - Delete metadata by key
v2GetAccount - Get account by its address
v2GetBalancesAggregated - Get the aggregated balances from selected accounts
v2GetInfo - Show server information
v2GetLedger - Get a ledger
v2GetLedgerInfo - Get information about a ledger
v2GetTransaction - Get transaction from a ledger by its ID
v2GetVolumesWithBalances - Get list of volumes with balances for (account/asset)
v2ListAccounts - List accounts from a ledger
v2ListLedgers - List ledgers
v2ListLogs - List the logs from a ledger
v2ListTransactions - List transactions from a ledger
v2ReadStats - Get statistics from a ledger
v2RevertTransaction - Revert a ledger transaction by its ID
v2UpdateLedgerMetadata - Update ledger metadata

orchestration

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
testTrigger - Test trigger
v2CancelEvent - Cancel a running workflow
v2CreateTrigger - Create trigger
v2CreateWorkflow - Create workflow
v2DeleteTrigger - Delete trigger
v2DeleteWorkflow - Delete a flow by id
v2GetInstance - Get a workflow instance by id
v2GetInstanceHistory - Get a workflow instance history by id
v2GetInstanceStageHistory - Get a workflow instance stage history
v2GetServerInfo - Get server info
v2GetWorkflow - Get a flow by id
v2ListInstances - List instances of a workflow
v2ListTriggers - List triggers
v2ListTriggersOccurrences - List triggers occurrences
v2ListWorkflows - List registered workflows
v2ReadTrigger - Read trigger
v2RunWorkflow - Run workflow
v2SendEvent - Send an event to a running workflow

payments

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
paymentslistAccounts - List accounts
~~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

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 - Search
searchgetServerInfo - Get server info

wallets

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

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 * as errors from "@formance/formance-sdk/sdk/models/errors";

const sdk = new SDK({
    authorization: "<YOUR_AUTHORIZATION_HERE>",
});

async function run() {
    let result;
    try {
        result = await sdk.ledger.createTransactions({
            transactions: {
                transactions: [
                    {
                        postings: [
                            {
                                amount: BigInt("100"),
                                asset: "COIN",
                                destination: "users:002",
                                source: "users:001",
                            },
                        ],
                        reference: "ref:001",
                    },
                ],
            },
            ledger: "ledger001",
        });
    } catch (err) {
        switch (true) {
            case err instanceof errors.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 errors.ErrorResponse: {
                console.error(err); // handle exception
                return;
            }
            default: {
                throw err;
            }
        }
    }

    // Handle the result
    console.log(result);
}

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

import { SDK } from "@formance/formance-sdk";

const sdk = new SDK({
    serverIdx: 0,
    authorization: "<YOUR_AUTHORIZATION_HERE>",
});

async function run() {
    const result = await sdk.getOIDCWellKnowns();

    // Handle the result
    console.log(result);
}

run();

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",
    authorization: "<YOUR_AUTHORIZATION_HERE>",
});

async function run() {
    const result = await sdk.getOIDCWellKnowns();

    // 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
`authorization`	oauth2	OAuth2 token

To authenticate with the API the authorization parameter must be set when initializing the SDK client instance. For example:

import { SDK } from "@formance/formance-sdk";

const sdk = new SDK({
    authorization: "<YOUR_AUTHORIZATION_HERE>",
});

async function run() {
    const result = await sdk.getOIDCWellKnowns();

    // Handle the result
    console.log(result);
}

run();

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!