This section is your gateway to every API in the Lerian ecosystem, organized by product. Whether you’re integrating directly with Midaz or automating reports with Reporter, you’ll find the full reference here—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), those plugin APIs are embedded within that product’s reference. This makes it easy to understand the full surface area of what you’re integrating with. For example, within the Midaz reference, you’ll find APIs for core entities (like Ledgers and Transactions), as well as for plugins such as Pix, CRM, and Fee Engine.

​
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.
Working on a plugin or custom integration?Visit the Partners Hub for development standards, documentation guidelines, and tooling.Recommended for partners, clients, and internal teams working on custom plugins.

​
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. And if something’s unclear, let us know—we’re always evolving the docs to match your needs.

​
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.