Welcome to the official documentation for Payman - the payment infrastructure for AI Agents. This repository contains our public documentation, API references, and integration guides.
/main- Core concepts and getting started guides/api-reference- Complete API documentation and endpoints/webhook- Webhook integration and event handling/capabilities- Detailed feature documentation
This documentation site is built using Mintlify. To run it locally:
# Install Mintlify CLI
npm i -g mintlify
# Start development server
mintlify devThe development server will start at http://localhost:3000.
We welcome contributions to improve our documentation! Here's how you can help:
- Fork this repository
- Create a new branch (
git checkout -b feature/improvement) - Make your changes
- Test locally using
mintlify dev - Commit your changes (
git commit -am 'Add new content') - Push to the branch (
git push origin feature/improvement) - Create a Pull Request
- Use clear, concise language
- Include code examples where relevant
- Follow the existing document structure
- Test all code samples
- Update the navigation in
mint.jsonif adding new pages
When adding code examples:
- Include both Node.js and Python examples where applicable
- Use real-world scenarios
- Include comments for complex operations
- Follow our code style guidelines
All pull requests automatically generate a preview deployment. Look for the "mintlify/deploy" check in your PR for the preview URL.
This documentation is licensed under the MIT License - see the LICENSE file for details.
- ACH bank transfers
- Agent-to-agent instant transfers
- Crypto payments (Coming Soon)
