Official documentation for the Monkei API - Payment platform with support for PIX, cryptocurrencies (BTC, USDT), and billing management.
This documentation is built with Mintlify and covers:
- Guides: Quick start guides, authentication, webhooks, rate limits
- API Reference: Complete reference for all API endpoints
- Billing: Creation and management of bills
- Coupons: Discount coupon system
- Transactions: Payments via PIX, BTC, and USDT
- Withdrawals: Withdrawals to bank accounts and crypto wallets
- Accounts: Account management, balance, and limits
- Health: Health check endpoints
To preview the documentation locally and test your changes:
Install the Mintlify CLI globally:
npm i -g mintRun the following command at the root of the documentation folder, where the docs.json file is located:
mint devThe documentation will be available at http://localhost:3000.
If the development environment is not working, update the CLI:
mint updatedocumentation/
├── docs.json # Main Mintlify configuration
├── index.mdx # Home page
├── quickstart.mdx # Quick start guide
├── testing.mdx # Testing guide
├── essentials/ # Essential concepts (auth, webhooks, etc.)
├── billing/ # Billing documentation
├── coupons/ # Coupons documentation
├── transactions/ # Transactions documentation
├── withdrawals/ # Withdrawals documentation
├── accounts/ # Accounts documentation
├── health/ # Health checks documentation
└── api-reference/ # Complete API reference
- Base URL:
https://api.monkei.co - Authentication: Use
X-API-Keyheader (notAuthorization: Bearer) - Example:
curl -X GET https://api.monkei.co/api/v1/balance \ -H "X-API-Key: sk_live_..."
All examples should include:
- cURL: For quick tests
- JavaScript: For web integrations
- Python: For scripts and automation
Some endpoints also include examples in TypeScript, Go, PHP, and Rust.
- Use the correct statuses as defined in the API
- Do not include private fields like
account_idorevent_idin example responses - Maintain consistency across different documentation files
Changes are automatically published after pushing to the default branch through the Mintlify GitHub App.
The GitHub App must be installed from the Mintlify dashboard.
Make sure you are running the mint dev command in the folder that contains the docs.json file.
Run mint update to ensure you have the latest version of the CLI.
Verify that internal links are using the correct path relative to docs.json and that pages exist in the navigation structure.
- Dashboard: app.monkei.co
- Status: stats.uptimerobot.com/nAsS6FyoB3
- GitHub: github.com/monkei-tech
- Support: support@monkei.co