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

# API Reference

> Kotani Pay API endpoints for digital asset transactions using local payment channels

<Note>
  Welcome to the Kotani Pay API reference. Our API enables businesses to
  purchase digital assets using local payment channels such as mobile money and
  bank transfers.
</Note>

## Welcome

Kotani Pay provides a comprehensive API platform that supports various use cases including remittance, forex arbitrage, lending, insurance, savings, social protection, business financing, and gig work.

Our API documentation is built using OpenAPI specifications to provide you with:

* Interactive API playground
* Comprehensive endpoint documentation
* Code examples in multiple languages
* Real-time testing capabilities

<CardGroup cols={2}>
  <Card title="Kotani Pay API Endpoints" icon="api" href="/v3/api-reference/openapi.json">
    View the complete OpenAPI specification
  </Card>

  <Card title="Run in Postman" icon="external-link" href="https://app.getpostman.com/run-collection/30841547-726e952e-e744-45ec-9204-1df4aba5e919?action=collection%2Ffork&source=rip_markdown">
    Fork the complete API collection with environments
  </Card>
</CardGroup>

## Test with Postman

Our comprehensive Postman collection includes all 57 API endpoints organized by functionality, plus pre-configured environments for sandbox and production testing.

**What's included:**

* Complete API collection with all endpoints
* Sandbox and production environment configurations
* Pre-configured authentication workflows
* Sample request bodies and response examples
* Environment variables for easy testing

**To get started:**

1. Click the "Run in Postman" button above to fork the collection
2. Import both the collection and environment to your Postman workspace
3. Set up your API credentials in the environment variables
4. Start testing endpoints immediately

<Tip>
  The Postman collection automatically handles authentication token management
  and includes examples for common workflows like deposits, payouts, and wallet
  management.
</Tip>

## Base URLs

**Sandbox Environment:** `https://sandbox-api.kotanipay.com`\
**Production Environment:** `https://api.kotanipay.com`

## Authentication

All API endpoints require authentication using JWT Bearer tokens. You can obtain an access token by:

1. Creating an integrator account
2. Logging in to get a JWT token
3. Generating an API key for ongoing operations

```json theme={null}
"security": [
  {
    "JWT": []
  }
]
```

## Getting Started

1. **Create an Integrator Account** - Register your business to access the API
2. **Login** - Authenticate to receive your JWT token
3. **Generate API Key** - Create an API key for secure transaction processing
4. **Start Integrating** - Begin making API calls to process transactions

## Support

Need help getting started? Contact our support team at [sales@kotanipay.com](mailto:sales@kotanipay.com) or visit our website at [https://kotanipay.com](https://kotanipay.com)