API Documentation



sandbox

As a demo of the ZimpleMoney system's capabilities, and to facilitate API development, we've setup a "sandbox" world at sandbox.zimplemoney.com. This system has all of the functionality of the ZimpleMoney system, but does not perform actual financial transactions, and some of the communications and external interfaces are limited.

Please click here for more information about ZimpleMoney worlds. To execute API requests in the sandbox, preface each endpoint with "sandbox" as in api.zimplemoney.com/sandbox/login.

To test the ZimpleMoney API, you may create one or more test members (users) simply by registering a new member in the system. This can be done via a POST to the /members endpoint (api.zimplemoney.com/sandbox/members), or via the online application's New member registration workflow. New members must confirm their email address before they can use the system.

If you use a Google gmail account for testing, note that any email addresses of the form: address+text@gmail.com are aliases for address@gmail.com. This allows you easily to specify many different addresses for testing.

Once a test member has been registered, you can make any API requests after authenticating with it, including creating contracts, making payments, adding ledger entries, etc. And you can use the online system at sandbox.zimplemoney.com to view and compare results to the API.

© 2025 Zimple Money