API reference

Midaz APIs deliver reliable, secure, and scalable access to the platform’s services, empowering seamless integration and adaptability to your evolving needs. Designed with RESTful principles, they provide a robust foundation for building innovative solutions.

Key highlights

  • RESTful architecture: Ensures predictable, consistent, and easy-to-use APIs.
  • JSON data exchange: Simplifies integrations with universal format compatibility.
  • Explicit versioning: Guarantees backward compatibility during updates.

Authentication


Midaz does not include a built-in authentication or authorization system. This gives you the flexibility to integrate with your existing identity provider or security stack.

If you need a ready-to-use solution, you can add Access Manager, a separate paid plugin developed by Lerian. It handles both authentication and fine-grained authorization, making it easier to control who can access what across your Midaz ecosystem. For more information, contact us.


Midaz APIs


Midaz is structured into three domains: Onboarding, Portfolio, and Transactions, each with APIs and endpoints tailored to specific functionalities. The tables below provide an overview of the available endpoints within each domain:

Onboarding domain



Portfolio domain





Transactions domain



Error list

Refer to the Midaz Error List page to check which errors Midaz endpoints might return. You’ll find all the details you need to handle them.


Access Manager APIs


The primary goal of the Access Manager plugin is to enable the client to effectively control user access and manage applications (Midaz and plugins).

Auth APIs


APIEndpoint
Authorization APIValidate User Permission


Identity APIs



Error list

Refer to the Access Manager Error List page to check which errors Access Manager endpoints might return. You’ll find all the details you need to handle them.


CRM APIs


The CRM (Customer Relationship Manager) plugin integrates data by storing essential registration information for the Midaz account user (Holder/Owner Account), termed as the “Entity.” While necessary for validation in integration processes, it is not part of the Ledger's transactional domain.


Error list

Refer to the CRM Error List page to check which errors CRM endpoints might return. You’ll find all the details you need to handle them.


Fee Engine APIs


The Fere Engine plugin manages fees across operations (financial, logistics, agriculture, pharmaceuticals, etc.) while storing transactions in customer ledgers. It aims for transparency, automation, and efficient control of fee charges.


APIEndpoint
Calculation APICalculate Fees for a Package

APIEndpoint
Simulation APISimulate Transaction Fees

Error list

Refer to the Fee Engine Error List page to check which errors Fee Engine endpoints might return. You’ll find all the details you need to handle them.


Smart Templates APIs


The Fere Engine plugin helps you generate dynamic, data-driven reports that can be rendered in CSV, XML, HTML, or TXT, always matching the structure defined in the template file.


Error list

Refer to the Smart Templates error list page to check which errors Smart Templates endpoints might return. You’ll find all the details you need to handle them.