SDK Installation

NPM

npm add @speakeasy-sdks/formance

Yarn

yarn add @speakeasy-sdks/formance

SDK Example Usage

import { Formance } from "@speakeasy-sdks/formance";
import { GetVersionsResponse } from "@speakeasy-sdks/formance/dist/sdk/models/operations";

const sdk = new Formance({
  security: {
    authorization: "",
  },
});

sdk.getVersions().then((res: GetVersionsResponse) => {
  if (res.statusCode == 200) {
    // handle response
  }
});

Available Resources and Operations

Formance SDK

• getVersions - Show stack version information

accounts

• addMetadataToAccount - Add metadata to an account
• countAccounts - Count the accounts from a ledger
• getAccount - Get account by its address
• listAccounts - List accounts from a ledger

auth

• addScopeToClient - Add scope to client
• addTransientScope - Add a transient scope to a scope
• createClient - Create client
• createScope - Create scope
• createSecret - Add a secret to a client
• deleteClient - Delete client
• deleteScope - Delete scope
• deleteScopeFromClient - Delete scope from client
• deleteSecret - Delete a secret from a client
• deleteTransientScope - Delete a transient scope from a scope
• getServerInfo - Get server info
• listClients - List clients
• listScopes - List scopes
• listUsers - List users
• readClient - Read client
• readScope - Read scope
• readUser - Read user
• updateClient - Update client
• updateScope - Update scope

balances

• getBalances - Get the balances from a ledger's account
• getBalancesAggregated - Get the aggregated balances from selected accounts

clients

• addScopeToClient - Add scope to client
• createClient - Create client
• createSecret - Add a secret to a client
• deleteClient - Delete client
• deleteScopeFromClient - Delete scope from client
• deleteSecret - Delete a secret from a client
• listClients - List clients
• readClient - Read client
• updateClient - Update client

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
• 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

logs

• listLogs - List the logs from a ledger

orchestration

• cancelEvent - Cancel a running workflow
• createWorkflow - Create workflow
• 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
• listWorkflows - List registered workflows
• orchestrationgetServerInfo - Get server info
• runWorkflow - Run workflow
• sendEvent - Send an event to a running workflow

payments

• connectorsStripeTransfer - Transfer funds between Stripe accounts
• connectorsTransfer - Transfer funds between Connector accounts
• getConnectorTask - Read a specific task of the connector
• getPayment - Get a payment
• installConnector - Install a connector
• listAllConnectors - List all installed connectors
• listConfigsAvailableConnectors - List the configs of each available connector
• listConnectorTasks - List tasks from a connector
• listConnectorsTransfers - List transfers and their statuses
• listPayments - List payments
• paymentsgetServerInfo - Get server info
• paymentslistAccounts - List accounts
• readConnectorConfig - Read the config of a connector
• resetConnector - Reset a connector
• uninstallConnector - Uninstall a connector
• updateMetadata - Update metadata

scopes

• addTransientScope - Add a transient scope to a scope
• createScope - Create scope
• deleteScope - Delete scope
• deleteTransientScope - Delete a transient scope from a scope
• listScopes - List scopes
• readScope - Read scope
• updateScope - Update scope

search

• search - Search
• searchgetServerInfo - Get server info

server

• getInfo - Show server information

stats

• readStats - Get statistics from a ledger

transactions

• addMetadataOnTransaction - Set the metadata of a transaction by its ID
• countTransactions - Count the transactions from a ledger
• createTransaction - Create a new transaction to a ledger
• getTransaction - Get transaction from a ledger by its ID
• listTransactions - List transactions from a ledger
• revertTransaction - Revert a ledger transaction by its ID

users

• listUsers - List users
• readUser - Read user

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

SDK Generated by Speakeasy