Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.khaime.com/llms.txt

Use this file to discover all available pages before exploring further.

Partner API

The Khaime Partner API lets you create payments, manage subscriptions, and query transaction data from your server.

Base URL

https://api.khaime.com/api/v1/partner

Authentication

All requests require an API key in the X-API-Key header:
curl -H "X-API-Key: pk_sandbox_your_key_here" \
     https://api.khaime.com/api/v1/partner/products
API keys start with pk_sandbox_ (test) or pk_live_ (production). Generate keys in your Khaime Dashboard.

Rate Limits

LimitValue
Requests per hour1,000 per API key
Burst50 requests/second
When rate limited, the API returns 429 Too Many Requests. Rate limits reset hourly.

Response Format

All responses follow this structure:
Success
{
  "success": true,
  "data": { ... }
}
Error
{
  "success": false,
  "error": "Error message",
  "details": { ... }
}

HTTP Status Codes

CodeMeaning
200Success
201Created
400Bad request — check parameters
401Invalid or missing API key
404Resource not found
422Validation error
429Rate limit exceeded
500Server error

Pagination

List endpoints support pagination via query parameters:
ParameterDefaultMax
limit20100
offset0
sort_bycreated_atVaries
sort_orderDESCASC or DESC