Skip to main content

Getting started

👋🏽 Welcome to the Chimoney API
This API allows you to make payouts seamlessly, whether you are a business owner or a developer just exploring the platform.

Create an account​

Before you can start making API calls, you need to create an account.

Businesses integrating with the API​

  1. Create an account at dash.chimoney.io.
  2. Email support@chimoney.io to request "Verification and API Access." Ensure you include links to your website and explain its use case briefly. Alternatively book-a-demo.

Developers testing the API​

  1. Create an account at the sandbox.
note

Your sandbox account is automatically funded with $1000 of test credits.

  1. Download the Chimoney app.
  2. Click the Organizations tab on the dashboard and create an organization or team.
  3. Open the Developers tab to create an app and use the API keys to access the sandbox endpoints.

▶️ Watch this video for step-by-step guidance.

The base URLs​

Chimoney provides two base URLs: one for production, one for sandbox testing:

EnvironmentURL
Productionhttps://api.chimoney.io
Sandboxhttps://api-v2-sandbox.chimoney.io

Authentication​

The Chimoney API uses an API Key for authentication.

  1. Copy your API key from the developer dashboard.
  2. Include it in the Authorization header of every request.

Required headers​

  • Authorization: <YOUR_API_KEY>
  • Content-type: application/json

A sample Postman request​

Below is a sample Postman request to generate invoice data with AI.

POST/https://api-v2-sandbox.chimoney.io/v0.2/ai/invoice/generate
Host: https://api-v2-sandbox.chimoney.io
Authorization: <YOUR_API_KEY>
Content-Type: application/json

{
  "instruction": "Create an invoice from Jane Doe to Chimoney Incorporate for Web Dev Service which I provided for 4 months at $5/month and for Project Management cost of $100 with tax rate of 5%."
}
tip

To test endpoints, you can do that in the documentation or import the postman collection by doing these:

  1. Go to get postman collection page.
  2. Click Run in Postman at the top right corner of the page.