Follow these steps to create your Midaz structure using our API endpoints.
Starting with Midaz is straightforward. Follow these steps to build your foundation and explore the possibilities.
Step 1 - Set Up Your Environment
To set up your environment, you must first set up Midaz and then set up the Midaz Console.
Step 2 - Authenticate
Secure your access with our authentication documentation, and take the first step toward building in a safe and controlled environment.
Step 3 - Create Your Midaz Structure
Start by creating the data structure that powers your workflows.
Step 3.1 - Create an Organization
The first step is to create your Organization within Midaz.
- To create an Organization, use the Create an Organization endpoint.
Organizational Structure
If your organization has multiple branches, you can create various Organizations and designate a "Parent Organization."
For example, if Company XYZ has branches in New York and Brazil, you can create an Organization for Company XYZ and set it as the parent of XYZ New York and XYZ Brazil.
For a complete list of endpoints to manage your Organization, expand the section below:
Managing Organizations
- Retrieve all Organizations using the List Organizations endpoint.
- Retrieve a specific Organization with the Retrieve an Organization
- Update Organization details using the Update an Organization endpoint.
- Delete an Organization in Homologation using the Delete an Organization endpoint.
- For Organizations in Production, deletion requires contacting Lerian support for security purposes.
Step 3.2 - Create a Ledger
Each organization must have at least on Ledger. However, you can have multiple Ledgers within each Organization if needed.
- To create a Ledger, use the Create a Ledger endpoint.
For a complete list of endpoints to manage your Ledger, expand the section below:
Managing Ledgers
- Retrieve all Ledgers using the List Ledgers endpoint.
- Retrieve a specific Ledger with the Retrieve a Ledger endpoint.
- Update Ledger details using the Update a Ledger endpoint.
- Delete a Ledger in Homologation using the Delete a Ledger endpoint.
- For Ledgers in Production, deletion requires contacting Lerian support for security purposes.
Step 3.3 - Create the Assets
Your Organization can have multiple Assets. However, each Asset must be created individually, allowing for specific configurations like decimal places.
- To create an Asset, use the Create an Asset endpoint.
For a complete list of endpoints to manage your Assets, expand the section below:
Managing Assets
- Retrieve all Assets using the List Assets endpoint.
- Retrieve a specific Asset with the Retrieve an Asset endpoint.
- Update Asset details using the Update an Asset endpoint.
- Delete an Asset with the Delete an Asset endpoint.
Step 3.4 - Create a Segment (optional)
If you want, you can use the Segment ID as a custom grouping label that enables clustering accounts according to user-defined policies, supporting efficient account segmentation and management.
- To create a Product, use the Create a Segment endpoint.
For a complete list of endpoints to manage your Segment, expand the section below:
Managing Segment
- Retrieve all Segments using the List Segments endpoint.
- Retrieve a specific Segment with the Retrieve a Segment endpoint.
- Update Segment details using the Update a Segment endpoint.
- Delete a Segment using the Delete a Segment endpoint.
Step 3.5 - Create a Portfolio
Create a Portfolio to group your accounts of different Assets.
- To create a Portfolio, use the Create a Portfolio endpoint.
For a complete list of endpoints to manage your Portfolios, expand the section below:
Managing Portfolios
- Retrieve all Portfolios using the List Portfolios endpoint.
- Retrieve a specific Portfolio with the Retrieve a Portfolio endpoint.
- Update Portfolio details using the Update a Portfolio endpoint.
- Delete a Portfolio with the Delete a Portfolio endpoint.
Step 3.6 - Create the Accounts
You can now add the accounts related to the Assets you want to use with the Ledger. You will have to create one account for each Asset.
- To create an account, use the Create an Account endpoint.
For a complete list of endpoints to manage your Accounts, expand the section below:
Managing Accounts
- Retrieve all Accounts using the List Accounts endpoint.
- Retrieve a specific Account with the Retrieve an Account endpoint.
- Update Account details using the Update an Account endpoint.
- Delete an Account with the Delete an Account endpoint.
Create an Account from the Portfolio
Endpoint deprecation
These endpoints will be deprecated soon.
For now, you can also create an account from the Portfolio.
- To create an account from the Portfolio, use the Create a Portfolio Account endpoint.
For a complete list of endpoints to manage your Portfolio Accounts, expand the section below:
Managing Portfolio Accounts
- Retrieve all Portfolio Accounts using the List Portfolio Accounts endpoint.
- Retrieve a specific Portfolio Account with the Retrieve a Portfolio Account endpoint.
- Update Portfolio Account details using the Update a Portfolio Account endpoint.
- Delete a Portfolio Account with the Delete a Portfolio Account endpoint.
Step 4 - Explore Our APIs
Dive into the API reference to learn more about how Midaz can elevate your operations. From metadata handling to idempotency, every detail is crafted for simplicity and efficiency.
Need Help?
You're not alone. We’re here to support you every step of the way.
- Explore our Documentation Hub for in-depth guides and resources.
- Join the community on Lerian Forums.
- Contact our support team via email for personalized assistance.