_Docs/
Get StartedModulesPlatformDeployCookbookChangelogReference
_Reference
  • Membership API
  • Stack API Reference
  1. Stack API Reference
Reference

Stack API Reference

The Formance Platform exposes a unified REST API across all modules. All endpoints use JSON for request and response bodies, and authentication is handled via OAuth2 bearer tokens.

Set your base URL once and use it everywhere:

Bash
export FORMANCE_API_URL=https://<your-stack>.sandbox.formance.cloud
export FORMANCE_TOKEN=$(fctl cloud generate-personal-token)

All Operations#

Auth 11Ledger 65Orchestration 35Other 1Payments 103Reconciliation 8Search 2Wallets 16Webhooks 8

auth11

GET
v1/api/auth/_infoGet Server Info
GET
v1/api/auth/.well-known/openid-configurationGet OpenID Configuration

Clients7

GET
v1/api/auth/clientsList Clients
POST
v1/api/auth/clientsCreate Client
DELETE
v1/api/auth/clients/{clientId}Delete Client
GET
v1/api/auth/clients/{clientId}Read Client
PUT
v1/api/auth/clients/{clientId}Update Client
POST
v1/api/auth/clients/{clientId}/secretsCreate Secret
DELETE
v1/api/auth/clients/{clientId}/secrets/{secretId}Delete Secret

Users2

GET
v1/api/auth/usersList Users
GET
v1/api/auth/users/{userId}Read User

ledger65

Accounts5

GET
v2/api/ledger/v2/{ledger}/accountsList Accounts
HEAD
v2/api/ledger/v2/{ledger}/accountsCount Accounts
GET
v2/api/ledger/v2/{ledger}/accounts/{address}Get Account
POST
v2/api/ledger/v2/{ledger}/accounts/{address}/metadataAdd Account Metadata
DELETE
v2/api/ledger/v2/{ledger}/accounts/{address}/metadata/{key}Delete Account Metadata

Balances & Volumes2

GET
v2/api/ledger/v2/{ledger}/aggregate/balancesGet Aggregate Balances
GET
v2/api/ledger/v2/{ledger}/volumesList Volumes

Bulk Operations1

POST
v2/api/ledger/v2/{ledger}/_bulkBulk Operations

Exporters5

GET
v2/api/ledger/v2/_/exportersList Exporters
POST
v2/api/ledger/v2/_/exportersCreate Exporter
DELETE
v2/api/ledger/v2/_/exporters/{exporterID}Delete Exporter
GET
v2/api/ledger/v2/_/exporters/{exporterID}Get Exporter State
PUT
v2/api/ledger/v2/_/exporters/{exporterID}Update Exporter

Ledger Management12

GET
v2/api/ledger/v2List Ledgers
DELETE
v2/api/ledger/v2/_/buckets/{bucket}Delete bucket
POST
v2/api/ledger/v2/_/buckets/{bucket}/restoreRestore bucket
GET
v2/api/ledger/v2/{ledger}Get Ledger
POST
v2/api/ledger/v2/{ledger}Create Ledger
GET
v2/api/ledger/v2/{ledger}/_infoGet Ledger Info
POST
v2/api/ledger/v2/{ledger}/queries/{id}/runRun a query template
GET
v2/api/ledger/v2/{ledger}/schemasList all schemas for a ledger
GET
v2/api/ledger/v2/{ledger}/schemas/{version}Get a schema for a ledger by version
POST
v2/api/ledger/v2/{ledger}/schemas/{version}Insert a schema for a ledger
GET
/api/ledger/_/infoShow server information
GET
/api/ledger/_/metricsRead in memory metrics

Logs3

GET
v2/api/ledger/v2/{ledger}/logsList Logs
POST
v2/api/ledger/v2/{ledger}/logs/exportExport Logs
POST
v2/api/ledger/v2/{ledger}/logs/importImport Logs

Metadata2

PUT
v2/api/ledger/v2/{ledger}/metadataUpdate Ledger Metadata
DELETE
v2/api/ledger/v2/{ledger}/metadata/{key}Delete Ledger Metadata

Pipelines7

GET
v2/api/ledger/v2/{ledger}/pipelinesList Pipelines
POST
v2/api/ledger/v2/{ledger}/pipelinesCreate Pipeline
DELETE
v2/api/ledger/v2/{ledger}/pipelines/{pipelineID}Delete Pipeline
GET
v2/api/ledger/v2/{ledger}/pipelines/{pipelineID}Get Pipeline State
POST
v2/api/ledger/v2/{ledger}/pipelines/{pipelineID}/resetReset Pipeline
POST
v2/api/ledger/v2/{ledger}/pipelines/{pipelineID}/startStart Pipeline
POST
v2/api/ledger/v2/{ledger}/pipelines/{pipelineID}/stopStop Pipeline

Stats1

GET
v2/api/ledger/v2/{ledger}/statsGet Ledger Stats

Transactions7

GET
v2/api/ledger/v2/{ledger}/transactionsList Transactions
HEAD
v2/api/ledger/v2/{ledger}/transactionsCount Transactions
POST
v2/api/ledger/v2/{ledger}/transactionsCreate Transaction
GET
v2/api/ledger/v2/{ledger}/transactions/{id}Get Transaction
POST
v2/api/ledger/v2/{ledger}/transactions/{id}/metadataAdd Transaction Metadata
DELETE
v2/api/ledger/v2/{ledger}/transactions/{id}/metadata/{key}Delete Transaction Metadata
POST
v2/api/ledger/v2/{ledger}/transactions/{id}/revertRevert Transaction

v1 (deprecated)20

GET
v1/api/ledger/_infoShow server information
GET
v1/api/ledger/{ledger}/_infoGet information about a ledger
GET
v1/api/ledger/{ledger}/accountsList accounts from a ledger
HEAD
v1/api/ledger/{ledger}/accountsCount the accounts from a ledger
GET
v1/api/ledger/{ledger}/accounts/{address}Get account by its address
POST
v1/api/ledger/{ledger}/accounts/{address}/metadataAdd metadata to an account
GET
v1/api/ledger/{ledger}/aggregate/balancesGet the aggregated balances from selected accounts
GET
v1/api/ledger/{ledger}/balancesGet the balances from a ledger's account
GET
v1/api/ledger/{ledger}/logsList the logs from a ledger
GET
v1/api/ledger/{ledger}/mappingGet the mapping of a ledger
PUT
v1/api/ledger/{ledger}/mappingUpdate the mapping of a ledger
POST
v1/api/ledger/{ledger}/scriptExecute a Numscript
GET
v1/api/ledger/{ledger}/statsGet statistics from a ledger
GET
v1/api/ledger/{ledger}/transactionsList transactions from a ledger
HEAD
v1/api/ledger/{ledger}/transactionsCount the transactions from a ledger
POST
v1/api/ledger/{ledger}/transactionsCreate a new transaction to a ledger
GET
v1/api/ledger/{ledger}/transactions/{txid}Get transaction from a ledger by its ID
POST
v1/api/ledger/{ledger}/transactions/{txid}/metadataSet the metadata of a transaction by its ID
POST
v1/api/ledger/{ledger}/transactions/{txid}/revertRevert a ledger transaction by its ID
POST
v1/api/ledger/{ledger}/transactions/batchCreate a new batch of transactions to a ledger

orchestration35

GET
v2/api/orchestration/v2/_infoGet server info

Instances6

GET
v2/api/orchestration/v2/instancesList instances
GET
v2/api/orchestration/v2/instances/{instanceID}Get instance
PUT
v2/api/orchestration/v2/instances/{instanceID}/abortAbort workflow
POST
v2/api/orchestration/v2/instances/{instanceID}/eventsSend event
GET
v2/api/orchestration/v2/instances/{instanceID}/historyGet instance history
GET
v2/api/orchestration/v2/instances/{instanceID}/stages/{number}/historyGet stage history

Triggers6

GET
v2/api/orchestration/v2/triggersList triggers
POST
v2/api/orchestration/v2/triggersCreate trigger
DELETE
v2/api/orchestration/v2/triggers/{triggerID}Delete trigger
GET
v2/api/orchestration/v2/triggers/{triggerID}Read trigger
GET
v2/api/orchestration/v2/triggers/{triggerID}/occurrencesList trigger occurrences
POST
v2/api/orchestration/v2/triggers/{triggerID}/testTest trigger

v1 (deprecated)17

GET
v1/api/orchestration/_infoGet server info
GET
v1/api/orchestration/instancesList instances of a workflow
GET
v1/api/orchestration/instances/{instanceID}Get a workflow instance by id
PUT
v1/api/orchestration/instances/{instanceID}/abortCancel a running workflow
POST
v1/api/orchestration/instances/{instanceID}/eventsSend an event to a running workflow
GET
v1/api/orchestration/instances/{instanceID}/historyGet a workflow instance history by id
GET
v1/api/orchestration/instances/{instanceID}/stages/{number}/historyGet a workflow instance stage history
GET
v1/api/orchestration/triggersList triggers
POST
v1/api/orchestration/triggersCreate trigger
DELETE
v1/api/orchestration/triggers/{triggerID}Delete trigger
GET
v1/api/orchestration/triggers/{triggerID}Read trigger
GET
v1/api/orchestration/triggers/{triggerID}/occurrencesList triggers occurrences
GET
v1/api/orchestration/workflowsList registered workflows
POST
v1/api/orchestration/workflowsCreate workflow
DELETE
v1/api/orchestration/workflows/{flowId}Delete a flow by id
GET
v1/api/orchestration/workflows/{flowId}Get a flow by id
POST
v1/api/orchestration/workflows/{workflowID}/instancesRun workflow

Workflows5

GET
v2/api/orchestration/v2/workflowsList workflows
POST
v2/api/orchestration/v2/workflowsCreate workflow
DELETE
v2/api/orchestration/v2/workflows/{flowId}Delete workflow
GET
v2/api/orchestration/v2/workflows/{flowId}Get workflow
POST
v2/api/orchestration/v2/workflows/{workflowID}/instancesRun workflow

other1

GET
/versionsShow stack version information

payments103

Accounts6

GET
v3/api/payments/v3/accountsList Accounts
POST
v3/api/payments/v3/accountsCreate Account
GET
v3/api/payments/v3/accounts/{accountID}Get Account
GET
v3/api/payments/v3/accounts/{accountID}/balancesGet Account Balances
DELETE
v3/api/payments/v3/pools/{poolID}/accounts/{accountID}Remove Account from Pool
POST
v3/api/payments/v3/pools/{poolID}/accounts/{accountID}Add an account to a pool

Bank Accounts7

GET
v3/api/payments/v3/bank-accountsList Bank Accounts
POST
v3/api/payments/v3/bank-accountsCreate Bank Account
GET
v3/api/payments/v3/bank-accounts/{bankAccountID}Get Bank Account
POST
v3/api/payments/v3/bank-accounts/{bankAccountID}/forwardForward Bank Account
PATCH
v3/api/payments/v3/bank-accounts/{bankAccountID}/metadataUpdate Bank Account Metadata
POST
v3/api/payments/v3/payment-service-users/{paymentServiceUserID}/bank-accounts/{bankAccountID}Add a bank account to a payment service user
POST
v3/api/payments/v3/payment-service-users/{paymentServiceUserID}/bank-accounts/{bankAccountID}/forwardForward a payment service user's bank account to a connector

Connectors18

GET
v3/api/payments/v3/connectorsList Connectors
DELETE
v3/api/payments/v3/connectors/{connectorID}Uninstall Connector
GET
v3/api/payments/v3/connectors/{connectorID}/configGet Connector Config
PATCH
v3/api/payments/v3/connectors/{connectorID}/configUpdate Connector Config
POST
v3/api/payments/v3/connectors/{connectorID}/resetReset Connector
GET
v3/api/payments/v3/connectors/{connectorID}/schedulesList Connector Schedules
GET
v3/api/payments/v3/connectors/{connectorID}/schedules/{scheduleID}Get Connector Schedule
GET
v3/api/payments/v3/connectors/{connectorID}/schedules/{scheduleID}/instancesList Schedule Instances
GET
v3/api/payments/v3/connectors/configsList Connector Configs
POST
v3/api/payments/v3/connectors/install/{connector}Install Connector
DELETE
v3/api/payments/v3/payment-service-users/{paymentServiceUserID}/connectors/{connectorID}Remove a payment service user from a connector, the PSU will still exist in Formance
GET
v3/api/payments/v3/payment-service-users/{paymentServiceUserID}/connectors/{connectorID}/connectionsList enabled connections for a payment service user on a connector (i.e. the various banks PSUser has enabled on the connector)
DELETE
v3/api/payments/v3/payment-service-users/{paymentServiceUserID}/connectors/{connectorID}/connections/{connectionID}Delete a connection for a payment service user on a connector
POST
v3/api/payments/v3/payment-service-users/{paymentServiceUserID}/connectors/{connectorID}/connections/{connectionID}/update-linkUpdate/Regenerate a link for a payment service user on a connector
POST
v3/api/payments/v3/payment-service-users/{paymentServiceUserID}/connectors/{connectorID}/create-linkCreate an authentication link for a payment service user on a connector, for oauth flow
POST
v3/api/payments/v3/payment-service-users/{paymentServiceUserID}/connectors/{connectorID}/forwardRegister/forward a payment service user on/to a connector
GET
v3/api/payments/v3/payment-service-users/{paymentServiceUserID}/connectors/{connectorID}/link-attemptsList all link attempts for a payment service user on a connector. Allows to check if users used the link and completed the oauth flow.
GET
v3/api/payments/v3/payment-service-users/{paymentServiceUserID}/connectors/{connectorID}/link-attempts/{attemptID}Get a link attempt for a payment service user on a connector

Payment Initiations10

GET
v3/api/payments/v3/payment-initiationsList Payment Initiations
POST
v3/api/payments/v3/payment-initiationsInitiate Payment
DELETE
v3/api/payments/v3/payment-initiations/{paymentInitiationID}Delete Payment Initiation
GET
v3/api/payments/v3/payment-initiations/{paymentInitiationID}Get Payment Initiation
GET
v3/api/payments/v3/payment-initiations/{paymentInitiationID}/adjustmentsList Payment Initiation Adjustments
POST
v3/api/payments/v3/payment-initiations/{paymentInitiationID}/approveApprove Payment Initiation
GET
v3/api/payments/v3/payment-initiations/{paymentInitiationID}/paymentsList Related Payments
POST
v3/api/payments/v3/payment-initiations/{paymentInitiationID}/rejectReject Payment Initiation
POST
v3/api/payments/v3/payment-initiations/{paymentInitiationID}/retryRetry Payment Initiation
POST
v3/api/payments/v3/payment-initiations/{paymentInitiationID}/reverseReverse Payment Initiation

Payment Service Users5

GET
v3/api/payments/v3/payment-service-usersList Payment Service Users
POST
v3/api/payments/v3/payment-service-usersCreate Payment Service User
DELETE
v3/api/payments/v3/payment-service-users/{paymentServiceUserID}Delete Payment Service User
GET
v3/api/payments/v3/payment-service-users/{paymentServiceUserID}Get Payment Service User
GET
v3/api/payments/v3/payment-service-users/{paymentServiceUserID}/connectionsList all connections for a payment service user

Payments4

GET
v3/api/payments/v3/paymentsList Payments
POST
v3/api/payments/v3/paymentsCreate Payment
GET
v3/api/payments/v3/payments/{paymentID}Get Payment
PATCH
v3/api/payments/v3/payments/{paymentID}/metadataUpdate Payment Metadata

Pools7

GET
v3/api/payments/v3/poolsList Pools
POST
v3/api/payments/v3/poolsCreate Pool
DELETE
v3/api/payments/v3/pools/{poolID}Delete Pool
GET
v3/api/payments/v3/pools/{poolID}Get Pool
GET
v3/api/payments/v3/pools/{poolID}/balancesGet Pool Balances
GET
v3/api/payments/v3/pools/{poolID}/balances/latestGet Pool Balances (Latest)
PATCH
v3/api/payments/v3/pools/{poolID}/queryUpdate the query of a pool

Tasks1

GET
v3/api/payments/v3/tasks/{taskID}Get Task

v1 (deprecated)45

GET
v1/api/payments/_infoGet server info
GET
v1/api/payments/accountsList accounts
POST
v1/api/payments/accountsCreate an account
GET
v1/api/payments/accounts/{accountId}Get an account
GET
v1/api/payments/accounts/{accountId}/balancesGet account balances
GET
v1/api/payments/bank-accountsList bank accounts created by user on Formance
POST
v1/api/payments/bank-accountsCreate a BankAccount in Payments and on the PSP
GET
v1/api/payments/bank-accounts/{bankAccountId}Get a bank account created by user on Formance
POST
v1/api/payments/bank-accounts/{bankAccountId}/forwardForward a bank account to a connector
PATCH
v1/api/payments/bank-accounts/{bankAccountId}/metadataUpdate metadata of a bank account
GET
v1/api/payments/connectorsList all installed connectors
DELETE
v1/api/payments/connectors/{connector}Uninstall a connector
POST
v1/api/payments/connectors/{connector}Install a connector
DELETE
v1/api/payments/connectors/{connector}/{connectorId}Uninstall a connector
GET
v1/api/payments/connectors/{connector}/{connectorId}/configRead the config of a connector
POST
v1/api/payments/connectors/{connector}/{connectorId}/configUpdate the config of a connector
POST
v1/api/payments/connectors/{connector}/{connectorId}/resetReset a connector
GET
v1/api/payments/connectors/{connector}/{connectorId}/tasksList tasks from a connector
GET
v1/api/payments/connectors/{connector}/{connectorId}/tasks/{taskId}Read a specific task of the connector
GET
v1/api/payments/connectors/{connector}/configRead the config of a connector
POST
v1/api/payments/connectors/{connector}/resetReset a connector
GET
v1/api/payments/connectors/{connector}/tasksList tasks from a connector
GET
v1/api/payments/connectors/{connector}/tasks/{taskId}Read a specific task of the connector
POST
v1/api/payments/connectors/{connector}/transfersTransfer funds between Connector accounts
GET
v1/api/payments/connectors/configsList the configs of each available connector
GET
v1/api/payments/paymentsList payments
POST
v1/api/payments/paymentsCreate a payment
GET
v1/api/payments/payments/{paymentId}Get a payment
PATCH
v1/api/payments/payments/{paymentId}/metadataUpdate metadata
GET
v1/api/payments/poolsList Pools
POST
v1/api/payments/poolsCreate a Pool
DELETE
v1/api/payments/pools/{poolId}Delete a Pool
GET
v1/api/payments/pools/{poolId}Get a Pool
POST
v1/api/payments/pools/{poolId}/accountsAdd an account to a pool
DELETE
v1/api/payments/pools/{poolId}/accounts/{accountId}Remove an account from a pool
GET
v1/api/payments/pools/{poolId}/balancesGet historical pool balances at a particular point in time
GET
v1/api/payments/pools/{poolId}/balances/latestGet latest pool balances
PATCH
v1/api/payments/pools/{poolId}/queryUpdate the query of a pool
GET
v1/api/payments/transfer-initiationsList Transfer Initiations
POST
v1/api/payments/transfer-initiationsCreate a TransferInitiation
DELETE
v1/api/payments/transfer-initiations/{transferId}Delete a transfer initiation
GET
v1/api/payments/transfer-initiations/{transferId}Get a transfer initiation
POST
v1/api/payments/transfer-initiations/{transferId}/retryRetry a failed transfer initiation
POST
v1/api/payments/transfer-initiations/{transferId}/reverseReverse a transfer initiation
POST
v1/api/payments/transfer-initiations/{transferId}/statusUpdate the status of a transfer initiation

reconciliation8

GET
v1/api/reconciliation/_infoGet server info

Policies5

GET
v1/api/reconciliation/policiesList policies
POST
v1/api/reconciliation/policiesCreate a policy
DELETE
v1/api/reconciliation/policies/{policyID}Delete a policy
GET
v1/api/reconciliation/policies/{policyID}Get a policy
POST
v1/api/reconciliation/policies/{policyID}/reconciliationReconcile using a policy

Reconciliations2

GET
v1/api/reconciliation/reconciliationsList reconciliations
GET
v1/api/reconciliation/reconciliations/{reconciliationID}Get a reconciliation

search2

POST
v1/api/search/search.v1
GET
v1/api/search/_infoGet server info

wallets16

Holds4

GET
v1/api/wallets/holdsList Holds
POST
v1/api/wallets/holds/{hold_id}/confirmConfirm Hold
POST
v1/api/wallets/holds/{hold_id}/voidVoid Hold
GET
v1/api/wallets/holds/{holdID}Get Hold

Transactions1

GET
v1/api/wallets/transactionsList Wallet Transactions

Wallets11

GET
v1/api/wallets/_infoGet Server Info
GET
v1/api/wallets/walletsList Wallets
POST
v1/api/wallets/walletsCreate Wallet
GET
v1/api/wallets/wallets/{id}Get Wallet
PATCH
v1/api/wallets/wallets/{id}Update Wallet
GET
v1/api/wallets/wallets/{id}/balancesList Wallet Balances
POST
v1/api/wallets/wallets/{id}/balancesCreate Balance
GET
v1/api/wallets/wallets/{id}/balances/{balanceName}Get Balance
POST
v1/api/wallets/wallets/{id}/creditCredit Wallet
POST
v1/api/wallets/wallets/{id}/debitDebit Wallet
GET
v1/api/wallets/wallets/{id}/summaryGet Wallet Summary

webhooks8

Webhook Configs8

GET
v1/api/webhooks/configsList Webhook Configs
POST
v1/api/webhooks/configsCreate Webhook Config
DELETE
v1/api/webhooks/configs/{id}Delete Webhook Config
PUT
v1/api/webhooks/configs/{id}Update Webhook Config
PUT
v1/api/webhooks/configs/{id}/activateActivate Webhook Config
PUT
v1/api/webhooks/configs/{id}/deactivateDeactivate Webhook Config
PUT
v1/api/webhooks/configs/{id}/secret/changeChange Webhook Secret
GET
v1/api/webhooks/configs/{id}/testTest Webhook Config
Membership API