Formance

Formance builds open-source financial infrastructure for money movement. The platform pairs a programmable double-entry Ledger (with the Numscript DSL) with a unified Payments connectivity layer and Flows orchestration, plus Wallets, Reconciliation, Auth, and Webhooks. It is delivered as open-source components and as a managed multi-tenant Formance Cloud, exposing REST APIs secured with OAuth2 client-credentials Bearer tokens.

8 APIs 0 Features
Financial InfrastructureLedgerDouble-Entry AccountingPaymentsOrchestrationMoney MovementOpen SourceFintech

APIs

Formance Ledger API

The programmable, open-source double-entry Ledger (v2). Create ledgers, post immutable transactions with multi-posting sources and destinations, read accounts, balances, aggrega...

Formance Payments API

Unified Payments connectivity layer. Install and configure connectors to payment processors and banks (Stripe, Wise, Mangopay, Adyen, and more), ingest payments and accounts, ma...

Formance Orchestration API

Flows orchestration engine (v2) for composing durable financial workflows across the Ledger, Payments, and Wallets. Define and run workflows, inspect workflow instances and thei...

Formance Wallets API

White-label Wallets service built on top of the Ledger. Create and list wallets and named balances, credit and debit wallets, place and confirm or void holds (authorization-then...

Formance Reconciliation API

Reconciliation toolkit for auditing assets under management. Define reconciliation policies, run reconciliations that compare Ledger balances against payments-side balances at a...

Formance Auth API

OAuth2 / OIDC authorization server for the platform. Issue client-credentials access tokens, manage OAuth clients and their secrets, list users, and read the OpenID Connect well...

Formance Webhooks API

Manage webhook subscriptions that deliver platform events (ledger, payments, wallets, and orchestration) to your endpoints. Insert and list configs, activate or deactivate them,...

Formance Search API

Full-platform Search service that indexes ledger transactions and accounts, payments, and other resources so they can be queried across modules from a single endpoint, with a ta...

Collections

Formance Platform API

OPEN

Pricing Plans

Formance Plans Pricing

3 plans

PLANS

Rate Limits

Formance Rate Limits

3 limits

RATE LIMITS

FinOps

Formance Finops

FINOPS

Resources

🔗
VulnerabilityDisclosure
VulnerabilityDisclosure
🔗
DomainSecurity
DomainSecurity
🔑
Authentication
Authentication
🔑
OAuthScopes
OAuthScopes
👥
GitHubOrganization
GitHubOrganization
🔗
LinkedIn
LinkedIn
🔗
Website
Website
🔗
Documentation
Documentation
🔗
Plans
Plans
🔗
RateLimits
RateLimits
🔗
FinOps
FinOps
📰
Blog
Blog

Sources

Raw ↑ 
opencollection: 1.0.0
info:
  name: Formance Platform API
  version: v1
request:
  auth:
    type: bearer
    token: '{{bearerToken}}'
items:
- info:
    name: Auth
    type: folder
  items:
  - info:
      name: Request an OAuth2 access token (client_credentials).
      type: http
    http:
      method: POST
      url: https://{{organization}}.{{environment}}.formance.cloud/api/auth/oauth/token
      body:
        type: form-urlencoded
        data:
        - name: grant_type
          value: client_credentials
        - name: client_id
          value: '{{clientId}}'
        - name: client_secret
          value: '{{clientSecret}}'
    docs: Exchange a client id and secret for a Bearer access token used on every other call.
  - info:
      name: List OAuth clients.
      type: http
    http:
      method: GET
      url: https://{{organization}}.{{environment}}.formance.cloud/api/auth/clients
    docs: List OAuth clients.
  - info:
      name: Create an OAuth client.
      type: http
    http:
      method: POST
      url: https://{{organization}}.{{environment}}.formance.cloud/api/auth/clients
      body:
        type: json
        data: '{}'
    docs: Create an OAuth client.
- info:
    name: Ledger
    type: folder
  items:
  - info:
      name: List ledgers.
      type: http
    http:
      method: GET
      url: https://{{organization}}.{{environment}}.formance.cloud/api/ledger/v2
    docs: List ledgers.
  - info:
      name: Create a ledger.
      type: http
    http:
      method: POST
      url: https://{{organization}}.{{environment}}.formance.cloud/api/ledger/v2/:ledger
      params:
      - name: ledger
        value: main
        type: path
        description: Name of the ledger.
      body:
        type: json
        data: '{}'
    docs: Create a ledger.
  - info:
      name: Create a new transaction.
      type: http
    http:
      method: POST
      url: https://{{organization}}.{{environment}}.formance.cloud/api/ledger/v2/:ledger/transactions
      params:
      - name: ledger
        value: main
        type: path
        description: Name of the ledger.
      body:
        type: json
        data: "{\n  \"postings\": [\n    { \"amount\": 100, \"asset\": \"USD/2\", \"source\": \"world\", \"destination\":\
          \ \"users:001\" }\n  ]\n}"
    docs: Post a double-entry transaction with explicit postings or a Numscript script.
  - info:
      name: List accounts from a ledger.
      type: http
    http:
      method: GET
      url: https://{{organization}}.{{environment}}.formance.cloud/api/ledger/v2/:ledger/accounts
      params:
      - name: ledger
        value: main
        type: path
        description: Name of the ledger.
    docs: List accounts from a ledger.
  - info:
      name: Get the aggregated balances from selected accounts.
      type: http
    http:
      method: GET
      url: https://{{organization}}.{{environment}}.formance.cloud/api/ledger/v2/:ledger/aggregate/balances
      params:
      - name: ledger
        value: main
        type: path
        description: Name of the ledger.
    docs: Get the aggregated balances from selected accounts.
- info:
    name: Payments
    type: folder
  items:
  - info:
      name: List all installed connectors.
      type: http
    http:
      method: GET
      url: https://{{organization}}.{{environment}}.formance.cloud/api/payments/v1/connectors
    docs: List all installed connectors.
  - info:
      name: List payments.
      type: http
    http:
      method: GET
      url: https://{{organization}}.{{environment}}.formance.cloud/api/payments/v1/payments
    docs: List payments.
  - info:
      name: Create a transfer initiation.
      type: http
    http:
      method: POST
      url: https://{{organization}}.{{environment}}.formance.cloud/api/payments/v1/transfer-initiations
      body:
        type: json
        data: '{}'
    docs: Create a transfer initiation.
  - info:
      name: List pools.
      type: http
    http:
      method: GET
      url: https://{{organization}}.{{environment}}.formance.cloud/api/payments/v1/pools
    docs: List pools.
- info:
    name: Orchestration
    type: folder
  items:
  - info:
      name: List registered workflows.
      type: http
    http:
      method: GET
      url: https://{{organization}}.{{environment}}.formance.cloud/api/orchestration/v2/workflows
    docs: List registered workflows.
  - info:
      name: Run a workflow.
      type: http
    http:
      method: POST
      url: https://{{organization}}.{{environment}}.formance.cloud/api/orchestration/v2/workflows/:flowId/instances
      params:
      - name: flowId
        value: ''
        type: path
        description: The workflow id to run.
      body:
        type: json
        data: '{}'
    docs: Run a workflow and start an instance.
  - info:
      name: List triggers.
      type: http
    http:
      method: GET
      url: https://{{organization}}.{{environment}}.formance.cloud/api/orchestration/v2/triggers
    docs: List triggers.
- info:
    name: Wallets
    type: folder
  items:
  - info:
      name: List all wallets.
      type: http
    http:
      method: GET
      url: https://{{organization}}.{{environment}}.formance.cloud/api/wallets/v1/wallets
    docs: List all wallets.
  - info:
      name: Debit a wallet.
      type: http
    http:
      method: POST
      url: https://{{organization}}.{{environment}}.formance.cloud/api/wallets/v1/wallets/:id/debit
      params:
      - name: id
        value: ''
        type: path
        description: The wallet id.
      body:
        type: json
        data: '{}'
    docs: Debit a wallet; set pending=true to create a hold to confirm or void later.
- info:
    name: Reconciliation
    type: folder
  items:
  - info:
      name: List reconciliation policies.
      type: http
    http:
      method: GET
      url: https://{{organization}}.{{environment}}.formance.cloud/api/reconciliation/v1/policies
    docs: List reconciliation policies.
  - info:
      name: Reconcile using a policy.
      type: http
    http:
      method: POST
      url: https://{{organization}}.{{environment}}.formance.cloud/api/reconciliation/v1/policies/:policyID/reconciliation
      params:
      - name: policyID
        value: ''
        type: path
        description: The policy id.
      body:
        type: json
        data: '{}'
    docs: Run a reconciliation using a policy.
- info:
    name: Webhooks
    type: folder
  items:
  - info:
      name: Get many configs.
      type: http
    http:
      method: GET
      url: https://{{organization}}.{{environment}}.formance.cloud/api/webhooks/configs
    docs: Get many webhook configs.
  - info:
      name: Insert a new config.
      type: http
    http:
      method: POST
      url: https://{{organization}}.{{environment}}.formance.cloud/api/webhooks/configs
      body:
        type: json
        data: '{}'
    docs: Insert a new webhook config.
- info:
    name: Search
    type: folder
  items:
  - info:
      name: Search across the platform.
      type: http
    http:
      method: POST
      url: https://{{organization}}.{{environment}}.formance.cloud/api/search/
      body:
        type: json
        data: "{\n  \"target\": \"TRANSACTION\",\n  \"terms\": []\n}"
    docs: Query indexed ledger, payments, and other resources across modules.
bundled: true