Using our Sandbox

Lerian APIs, both Midaz and the plugins, come with a fully integrated sandbox environment so you can explore and test each endpoint safely, without affecting real data or production systems.

This sandbox is directly connected to our documentation. Every "Try it" box you see runs against the sandbox, giving you live responses with mock data and realistic behavior.

📘

Note

The sandbox is only accessible through the documentation interface. You can’t call it directly from external tools or scripts.


Base URLs


Here are the base URLs used behind the scenes when you interact with our documentation:

ServiceSandbox Base URL
Midaz APIshttps://onboarding.sandbox.midaz.io (Onboarding APIs) https://transaction.sandbox.midaz.io (Transactions APIs)
Access Managerhttps://auth.sandbox.midaz.io (Auth APIs) https://identity.sandbox.midaz.io (Indentity APIs)
CRMhttps://crm.sandbox.midaz.io
Fees Enginehttps://fees.sandbox.midaz.io
Smart Templateshttps://smart-templates.sandbox.midaz.io

These endpoints are already wired into every example and test box across our docs.


What you can do


The sandbox lets you:

  • Run real API calls from the docs
  • Preview how the request/response cycle works
  • Understand data formats, headers, and authentication flows
  • Learn and experiment—without risk
👍

Tip

You can test without setting up your own environment. Just click “Try it” on any endpoint and see how it behaves.


Limitations


The sandbox is designed for learning and exploration. It comes with a few intentional limitations:

  • It only works through the documentation
  • Data is mocked or non-persistent
  • Some features may return sample or static responses
  • Authentication may be simulated or skipped depending on the endpoint

For full integration tests, we recommend using your own deployed instance or reaching out for a dedicated dev environment.