Welcome

This is the place to learn about Modulr's API, View API Documentation and learn about the Modulr Portal

API Guides and Help for developers

The Modulr API platform lets developers securely manage and automate the flow of money for their company by creating eMoney accounts and making payments.

The API is based on REST, and uses standard REST features such as resource-based endpoints, HTTP verbs, standard responses and authentication.

Some example use cases for the Modulr API:

• Automating payments
• Automating cards
• Creating discrete accounts to streamline incoming payments, receiving notifications of incoming funds via a webhook notification
• Managing funds on behalf of 3rd parties

If you want to, try out the API here, you can use search (found at the top of each page) to find information on a particular help topic.

Or, to use a more real-world sandbox environment (both the Modulr Portal UI and an API) you'll need to have a sandbox account and key to access.

If you don't yet have access to our Sandbox environment, then you are able to get an account and key here.

Modulr Portal Guides and Help

The Modulr Portal is a great tool to use during development (it's connected to your Sandbox API account) and can be used to give your end-users secure access to their Modulr eMoney accounts and to perform actions that your integration doesn't support (depending on your integration and partnership model). They can make and receive payments, manage approvals and view payment statuses in real time. They can also set up notifications and manage other users as well as take advantage of many other features.

When using the Portal in Sandbox mode, there are restrictions you can learn about here: Sandbox Account Restrictions

Go here → to find Information and guides on using the features of the Modulr Portal. Note: This will redirect you to our Portal Guides

If you don't yet have access to our Sandbox environment, then you are able to get an account and key here.

📘

Comments and suggestions

We’re regularly adding more guides as we build new features and make improvements. If there’s something you’d like to see covered here, please use the ‘Suggest edits’ link in the top right of each page to send us feedback.

See also

Get Sandbox Access

Getting Started with the API →
API reference →

Getting started with the Modulr Portal → Note: This will redirect you to our Customer Portal Knowledge Base