added
Documentation Update — End of Release Cycle
May 29th, 2025
We’ve wrapped up the release cycle with a fresh batch of documentation updates. Whether you’re building integrations, deploying infrastructure, or just getting started with Midaz, there’s something new for you.
What’s New
Here’s what’s been added to help you move faster and with more clarity:
Midaz new endpoints
Transactions API
- Create an Inflow Transaction – Use this endpoint to register incoming funds from external sources into the ledger.
- Create an Outflow Transaction – Use this endpoint to initiate an outflow transaction, abstracting the process of moving funds from internal ledger accounts to the external world.
Accounts API
- Retrieve an External Account – Use this endpoint to retrieve the details of a specific External Account by its asset code.
Platform & Deployment
- Installing Midaz monorepo – A step-by-step guide to get your local environment ready.
- Midaz Terraform Foundation – Deploy Midaz infrastructure with standardized, reusable Terraform modules.
- Midaz production best practices – Our recommendations for a secure, scalable, and resilient production setup.
SDKs & Libraries
- Midaz SDK for Go – Learn how to integrate Midaz into your Go applications with confidence.
- Midaz SDK for TypeScript – A complete guide to using our TypeScript SDK in both frontend and backend environments.
- lib-commons – Documentation for our shared Go library that powers consistent microservices.
- lib-commons – TypeScript utilities and models to keep your Midaz integrations modular and maintainable.
Plugins
CRM
Get to know how the CRM plugin helps you manage customer data securely and flexibly.
- Guides:
- CRM: An overview how the plugin works
- CRM data security: Learn more about how CRM handles data security
- Using CRM: Step-by-step example of how to use CRM
- API Reference:
- Holders API: Endpoints related to Holder management
- Alias Accounts API: Endpoints related to Alias Account management
- CRM Error List: List of errors that the CRM plugin can throw
Smart Templates
Learn how to generate dynamic, template-based reports with Smart Templates.
- Guides:
- Smart Templates: An overview of how the plugin works
- Template examples: Examples of how to create the templates
- Using Smart Templates: Step-by-step example of how to use Smart Templates
- API Reference:
- Templates API: Endpoints related to Template management
- Reports API: Endpoints related to Report management
- Smart Template error list: List of errors that the Smart Templates plugin can throw
Plugins under development
- Accounting overview – A clear explanation of how Midaz handles accounting logic, balances, and bookkeeping operations.
- Workflows – Understand how to orchestrate transaction flows with conditional steps and plugin integrations.
If you’re maintaining or building with Midaz, we recommend checking out these new pages to stay up-to-date and make the most of our platform.