AbacatePay Documentation

AbacatePay is a developer-friendly payment gateway designed to simplify payment processing. Built by developers for developers, it offers:

• Simple, intention-based API endpoints
• Idempotent operations for reliable transactions
• Consistent JSON request/response formats
• Native SDK support
• Easy dev mode integration
• PIX payment support
• Streamlined client and billing management

The documentation covers everything from getting started guides to detailed API references, helping you integrate payments into your application quickly and efficiently.

🚀 Quick Start

This documentation is built with Mintlify

1. Preview locally

# Install Mintlify CLI
npm i -g mintlify

# Start development server
mintlify dev

2. Visit http://localhost:3000 to see your documentation

📚 Documentation Structure

.
├── api-reference/  # Contains API documentation and endpoints reference
├── images/         # Store all documentation images and screenshots
├── logo/           # Brand logos for light and dark themes
├── pages/          # Main documentation content
├── docs.json          # Mintlify configuration file for documentation settings
├── favicon.ico        # Website favicon
├── openapi.yaml       # OpenAPI/Swagger specification file
└── README.md          # Project overview and setup instructions

🔧 Local Development

1. Install dependencies

mintlify install

2. Start development server

mintlify dev

OR

1. Run using docker

make start

Troubleshooting

• If Mintlify dev isn't running, try mintlify install to reinstall dependencies
• For 404 errors, ensure you're in a directory with mint.json

🚀 Deployment

Changes are automatically deployed when merged to the main branch, through the Mintlify GitHub integration.

See Mintlify GitHub App Documentation for more information.

💪 Support

• Join our Discord community
• Report issues on GitHub