> ## Documentation Index
> Fetch the complete documentation index at: https://developers.kotanipay.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Run in Postman

> Fork our complete API collection and start testing immediately

# 🚀 Run in Postman

Get started with the Kotani Pay API instantly using our comprehensive Postman collection. No setup required - just fork and start testing!

<Card icon="external-link" href="https://app.getpostman.com/run-collection/30841547-726e952e-e744-45ec-9204-1df4aba5e919?action=collection%2Ffork&source=rip_markdown" title="Fork Kotani Pay API Collection">
  Fork the complete API collection with 57+ endpoints and pre-configured environments
</Card>

## Quick Setup Guide

<Steps>
  <Step title="Fork the Collection">
    Click the "Fork Kotani Pay API Collection" button above to add the collection to your Postman workspace.
  </Step>

  <Step title="Import Environments">
    Both sandbox and production environments will be automatically imported with the collection.
  </Step>

  <Step title="Configure API Keys">
    Update the environment variables with your API credentials:

    * `api_key`: Your API key from the authentication flow
    * `base_url`: Already configured for each environment
  </Step>

  <Step title="Start Testing">
    Begin with the Health Check endpoint to verify your setup, then explore other endpoints organized by category.
  </Step>
</Steps>

## Testing Workflow

<Tabs>
  <Tab title="Authentication">
    1. **Create Account**: Register at [backoffice.kotanipay.com](https://backoffice.kotanipay.com/register?env=sandbox)
    2. **Login**: Get your JWT token for API access
    3. **Generate API Key**: Create a secure key for transactions
    4. **Verify Setup**: Test with any endpoint to confirm authentication
  </Tab>

  <Tab title="Deposits">
    1. **Create Customer**: Add a mobile money customer
    2. **Initiate Deposit**: Start a deposit transaction
    3. **Check Status**: Monitor transaction progress
    4. **Handle Webhooks**: Process real-time updates
  </Tab>

  <Tab title="Payouts">
    1. **Verify Balance**: Check wallet balance
    2. **Initiate Payout**: Send money to customers
    3. **Track Status**: Monitor payout progress
    4. **Confirm
       Completion**: Verify successful transfer
  </Tab>
</Tabs>

<Warning>
  Always use the **sandbox environment** for testing to avoid processing real transactions. Switch to production only when you're ready to go live.
</Warning>

## Need Help?

* **API Documentation**: Explore our [complete API reference](/v3/api-reference/introduction)
* **Quick Start Guide**: Follow our [step-by-step quickstart](/v3/quickstart)
* **Support**: Contact us at [sales@kotanipay.com](mailto:sales@kotanipay.com)

<Tip>
  The Postman collection includes automated authentication token management, so you don't need to manually handle JWT tokens for most requests.
</Tip>