Skip to main content

​
Get started with Kotani Pay API v3

Follow these steps to start integrating with Kotani Pay’s payment platform.

​
🚀 Try the API with Postman

Test our API endpoints instantly using our comprehensive Postman collection. Fork the collection to your workspace and start experimenting with real API calls without writing any code.

Run in Postman

Fork the complete Kotani Pay API collection with 57+ endpoints and pre-configured environments
  • Complete API Coverage: All 57 endpoints organized by functionality
  • Environment Variables: Pre-configured sandbox and production environments
  • Authentication Flow: Automated token management and API key setup
  • Sample Data: Example request bodies and expected responses
  • Workflow Examples: Common integration patterns and use cases
  1. Fork the collection: Click the “Run in Postman” button above
  2. Choose your workspace: Select or create a Postman workspace
  3. Import environments: Both sandbox and production environments will be imported
  4. Set up credentials: Add your API keys to the environment variables
  5. Start testing: Begin with the Health Check endpoint to verify setup
Make sure to use the sandbox environment for testing to avoid processing real transactions.
After forking, update these environment variables in Postman:Sandbox Environment:
  • base_url: https://sandbox-api.kotanipay.com
  • api_key: Your sandbox API key (get this from Step 1 below)
  • jwt_token: Will be auto-populated after login
Production Environment:
  • base_url: https://api.kotanipay.com
  • api_key: Your production API key
  • jwt_token: Will be auto-populated after login

​
Step 1: Create an integrator account

Create an integrator account to access the Kotani Pay API platform. Use the Create Integrator endpoint to register your business.
  1. Login to your account using the Authentication Login endpoint 2. Generate an API key using the Generate API Key endpoint 3. Store your credentials securely
Keep your API keys secure and never expose them in client-side code.

​
Step 2: Test the integration

Test your integration using our sandbox environment:Base URL: https://sandbox-api.kotanipay.comStart with the Health Check endpoint to verify connectivity.
Try initiating a deposit using the Initiate Deposit endpoint.
  1. Create a mobile money customer
  2. Initiate a deposit request
  3. Check the deposit status
  4. Handle webhook notifications
Start with small amounts for testing!

​
Step 3: Go live

  1. Switch to the production base URL: https://api.kotanipay.com 2. Update your API credentials for production 3. Configure your webhook endpoints 4. Start processing real transactions

​
Next steps

Explore our comprehensive API documentation:

API Reference

Complete API endpoint documentation

Deposits

Learn how to handle deposits

Payouts

Process payouts to customers

Webhooks

Set up real-time notifications