DOCSEARCHbyAlgolia
Submit Docs

Formance Documentation

website·Indexed 34 days ago

https://docs-archive.formance.com/

Documentation for Formance, a financial microservices stack. Includes guides for the Ledger real-time money tracking service, Payments unified API, and other modules such as Wallets, Reconciliation, Orchestration, and Auth. Covers operator configuration, infrastructure services like NATS, Temporal, and Elasticsearch, and deployment on Kubernetes for versions v1.10 and v2.x.

Tokens
128.6K
Snippets
745
Records
1.2K
Agent score
49%

What's inside Formance

  1. Overview of Formance Flows

    Formance Flows (available in the Enterprise Edition of The Formance Platform) is a service designed to set up end-to-end money flows. It provides a compatibility model to move value between different ledgers, wallets, and payment processors by translating and interpreting transactions. It includes workflow capabilities for handling delays, external events, retries, and fallback options.

  2. Overview of Transfer Initiations

    Transfer initiations allow the movement of funds between accounts or bank accounts via a payment service provider. There are two supported types:

    • INTERNAL: Moves funds between internal accounts within the platform.
    • PAYOUT: Moves funds from an internal account to an external account.

    The lifecycle consists of three stages: Creation (pending state), Approval (transition to APPROVED or REJECTED), and Execution (contacting the payment service provider to move funds).

  3. Overview of Numscript for financial transaction modeling

    v1.10

    Numscript is a Domain-Specific Language (DSL) used to model complex financial transactions. It is built on three core design principles:

    1. Readability: Programs are designed to be understood by both developers and non-technical financial users to provide a shared, executable definition of money movements.
    2. Correctness: Prevents common currency rounding errors and accidental money creation/destruction. Execution is atomic, meaning all modeled transactions are committed or none are.
    3. Finiteness: Programs are designed to terminate predictably and consistently.

  4. Overview of Formance Ledger

    v1.10
    Formance Ledger is a real-time money tracking microservice designed to model and record complex financial transactions. It supports atomic, multi-posting transactions and utilizes Numscript, a dedicated Domain Specific Language (DSL), to model and templatize these transactions.

  5. Overview of Formance Wallets Module

    Wallets is a fully managed, white-label wallet service used to materialize and spend user funds. It provides an opinionated model implementation built on top of the Formance Ledger service, allowing developers to add wallet capabilities without managing the underlying transaction structure. Key features include multi-currency balances and temporary holds capabilities.

  6. Overview of Formance Platform Authentication

    v1.10

    The Formance Platform uses OpenID Connect (OIDC) and OAuth 2.0 protocols with JSON Web Tokens (JWTs) to authenticate users and applications. Authentication is managed via the auth service using OAuth clients.

    There are two types of clients:

    • Dynamic Client: Created via the auth service API (used in Cloud and self-hosted).
    • Static Client: Defined in the auth service configuration file (used in self-hosted deployments).

    Tokens are categorized as:

    • Platform Token: A JWT not scoped to any specific environment.
    • Environment Token: A JWT scoped to a specific environment.

  7. Introduction to Formance Ledger 'Hello World' Tutorial

    v1.10

    The 'Hello, world' tutorial provides a hands-on introduction to Formance Ledger. By completing this guide, developers will learn how to:

    • Create and manage a Formance Ledger sandbox.
    • Use the fctl CLI to interact with the ledger.
    • Model transactions and accounts.
    • Define transactions using Numscript.
    • Handle the introduction of money into the ledger from external sources.
    • Execute Numscript transactions via the command line.
    • Verify account balances and transaction history using the built-in dashboard.

  8. Overview of Formance Ledger

    Formance Ledger (v3.x) is a real-time money tracking microservice designed to model and record complex financial transactions. It supports atomic, multi-posting transactions and utilizes Numscript, a dedicated Domain Specific Language (DSL), to model and templatize these transactions.

  9. Overview of Formance Wallets module

    v2.x
    Wallets is a fully managed, white-label wallet service used to materialize and spend user funds. It provides an opinionated model implementation built on top of the Formance Ledger service, allowing developers to add wallet capabilities without managing the underlying transaction structure. Key features include built-in support for multi-currency balances and temporary holds.

  10. Overview of Formance Connectivity

    Formance Connectivity provides a unified API that abstracts multiple payment providers (such as Stripe and Wise). This allows developers to simplify the process of building complex money flows by stitching different payment providers together through a consistent interface.

  11. Overview of Formance Flows

    Formance Flows (available in the Enterprise Edition of The Formance Platform) is a service designed to orchestrate end-to-end money flows. It simplifies the movement of value between different ledgers, wallets, and payment processors by handling transaction translation and interpretation. It includes workflow capabilities for managing delays, external events, retries, and fallback options.

  12. Overview of Formance Flows v2.x

    v2.x
    Formance Flows is a service designed to set up end-to-end money flows by abstracting the complexity of piecing together various APIs. It provides a compatibility model to move value between different ledgers, wallets, and payment processors, handling the translation and interpretation of transactions automatically. The service includes workflow capabilities for managing delays, external events, retries, and fallback options.