Skip to main content
This section is for developers and technical integrators. For a business-level overview of what Lerian products do, start with Who we are. You can also explore individual product pages like About Midaz and What is Matcher?.
Lerian APIs cover everything the platform provides, from onboarding workflows and ledger management to plugins for authentication, CRM, and reporting. This section documents every API in the Lerian ecosystem, organized by product, including any related plugin APIs.

​
Product-structured, plugin-aware

Each product, like Midaz or Reporter, has its own API section. When a product supports plugins (e.g., Midaz), that product’s reference embeds those plugin APIs. For example, the Midaz reference has APIs for core entities like Ledgers and Transactions. It also covers the Fees Engine, part of the Midaz product family, and plugins such as Pix and CRM.

​
Key highlights

  • RESTful and predictable: All endpoints follow standard HTTP methods and status codes.
  • Consistent formats: Requests and responses use JSON, with clear typing and structures.
  • Explicit versioning: APIs are versioned to prevent breaking changes.
  • Plugin-first architecture: Features are modular. Each plugin has its own API set, documented alongside the product it extends.

​
What you’ll find here

  • Getting Started: Quick start guide, sandbox instructions, and how Lerian’s licensing model works.
  • Integration Essentials: Concepts like retries, pagination, metadata, and stability tools.
  • Stability & Quality: Error handling, testing best practices, QA process, and support coverage.
  • Product APIs:
    • Midaz: Ledgers, Transactions, Assets, Accounts, Portfolios, and plugin extensions
    • Reporter: Report creation, template upload, filters, and report exports
  • Error Lists: Each product and plugin includes dedicated error code references.
You’re viewing the documentation for the current version of Lerian’s APIs.If you’re working with an earlier release, use the version switcher (top-left) to access legacy docs and avoid compatibility issues.

​
Current vs Previous versions

We maintain documentation for both:
  • Current version: The most up-to-date features, actively supported.
  • Previous version: Deprecated but still available with partial support for a limited time.
Use the version switcher at the top-left of the screen to ensure you’re reading the right docs for your environment. If something’s unclear, let us know.

​
How to navigate

To access a product’s reference:
1
You’re already in the API Reference section of our documentation.
2
Open the dropdown menu in the left sidebar and select the product you’re working with, such as Midaz or Reporter.
3
You’ll land in a dedicated space with product-specific API details, including related plugins, full schema references, and real-world payload examples.