API Reference

Postman Collection

This collection includes all our available endpoints, designed to make it easier for you to test and integrate with our API seamlessly.

How to Use the Postman Collection

  1. Access the Collection:
    Click on the following link to open the Chimoney API Postman Collection: Chimoney API Postman Collection

  2. Run in Postman:

    • Once on the Postman documentation page, click the "Run in Postman" button.
    • Select the workspace you want to import the collection into

  3. Configure Environment Variables:

    • Ensure you have the necessary environment variables set up for authentication and other required parameters. To set the variables:
    • Click on the "Environments" icon in the top left corner.
    • If you have an existing environment, select it. If not, click "Add" to create a new one.
    • Name your environment (e.g., "Chimoney API").
    • Add or Verify Environment Variables.
    • Ensure the following key-value pairs are in your environment:
    `accept`: application/json
 `baseUrl`: <https://api-v2-sandbox.chimoney.io>
    `content-type`: application/json
    `apiKey`: YOUR_API_KEY

Ensure your API key variable is securely stored and never shared publicly.

  1. Start Testing:
    • Ensure you have the necessary environment variables set up for authentication and other required parameters. To set the variables:
    • In the imported collection, each request should have placeholders for your environment variables.
    • Select the environment you created from the dropdown in the top right corner.
    • Ensure each request uses {{baseUrl}} for the URL and includes the necessary headers (accept, content-type, and apiKey).
    • Now you can start testing each endpoint by sending requests and observing the responses.