Skip to main content
Prerequisites: - Valid Kotani Pay integrator account - API credentials (JWT token and API key) - Development environment setup
Follow these guidelines for effective development with Kotani Pay API v3.
1

Set up your environment

Start with the sandbox environment for development and testing:
BASE_URL=https://sandbox-api.kotanipay.com
2

Authenticate your requests

Include your JWT token in the Authorization header:
curl -X GET "https://sandbox-api.kotanipay.com/health" \
  -H "Authorization: Bearer <your-jwt-token>" \
  -H "Content-Type: application/json"
3

Handle responses properly

All Kotani Pay API responses follow this structure:
{
  "success": true,
  "message": "Operation completed successfully",
  "data": {
    // Response data here
  }
}

Error Handling

Kotani Pay API uses standard HTTP status codes and consistent error format:
{
  "success": false,
  "message": "Error description",
  "data": {}
}
Common status codes:
  • 200 - Success
  • 400 - Bad Request
  • 401 - Unauthorized
  • 404 - Not Found
  • 500 - Internal Server Error

Rate Limiting

Be mindful of API rate limits to ensure smooth integration:
  • Implement exponential backoff for retries
  • Cache responses when appropriate
  • Use webhooks instead of polling for status updates

Testing

Use our comprehensive test endpoints:

Health Check

Verify API connectivity and service status

Going to Production

When ready to deploy:
  1. Update base URL to production: https://api.kotanipay.com
  2. Replace sandbox credentials with production credentials
  3. Configure production webhook endpoints
  4. Enable monitoring and logging