| name | abacatepay |
| description | Integrate AbacatePay in code or interact directly with the API (list customers, create checkouts, check balance, etc.) |
| metadata | {"tags":"abacatepay, payments, pix, subscriptions, webhooks, checkout"} |
When to use
Use this skill in two modes:
1. Integration Mode
When the user wants to write code to integrate AbacatePay into an application (TypeScript / Go). Use the rules, examples, and best practices below.
2. Agent Mode (Direct API)
When the user wants to perform actions directly — list customers, create checkouts, check balance, query MRR, etc. Execute the API via curl in the terminal. See rules/agent.md for all endpoints and templates.
How to use
For direct API usage (agent mode), see:
- rules/agent.md - Execute API calls directly via curl (list customers, create checkouts, check balance, etc.)
For code integration, read individual rule files:
Use development tools for enhanced integration experience:
File Index
Complete list of all files with objective summaries:
Rules > TS
- rules/ts/checkout.md - Guide for creating one-time checkouts via AbacatePay API, with Pix, card, validation and error handling.
- rules/ts/coupons.md - Managing discount coupons, creation, listing, toggle and validation.
- rules/ts/customers.md - Instructions for managing customers via CRUD, with required fields, metadata and secure integration.
- rules/ts/mrr.md - Accessing public MRR and revenue data, business metrics and visualization.
- rules/ts/payouts.md - Automating withdrawals and payouts, creation, query and transaction status.
- rules/ts/products.md - Instructions for managing catalog products via CRUD, with cache and integration in checkouts.
- rules/ts/security.md - Best practices for secure integrations, data protection and fraud prevention.
- rules/ts/subscriptions.md - Guide for recurring subscriptions, including creation, items, plans and cancellation.
- rules/ts/transparents.md - Transparent checkout integration, payment simulation and status verification.
- rules/ts/webhooks.md - Webhook setup and verification via dashboard, with HMAC examples and secure processing.
Rules > Go
- rules/go/checkout.md - Go guide for creating one-time checkouts via AbacatePay API, with Pix, card, validation and error handling.
- rules/go/coupons.md - Managing discount coupons in Go, creation, listing, toggle and validation.
- rules/go/customers.md - Go instructions for managing customers via CRUD, with required fields, metadata and secure integration.
- rules/go/mrr.md - Accessing public MRR and revenue data in Go, business metrics and visualization.
- rules/go/payouts.md - Automating withdrawals and payouts in Go, creation, query and transaction status.
- rules/go/products.md - Go instructions for managing catalog products via CRUD, with cache and integration in checkouts.
- rules/go/security.md - Best practices for secure integrations in Go, data protection and fraud prevention.
- rules/go/subscriptions.md - Go guide for recurring subscriptions, including creation, items, plans and cancellation.
- rules/go/transparents.md - Transparent checkout integration in Go, payment simulation and status verification.
- rules/go/webhooks.md - Webhook setup and verification via dashboard in Go, with HMAC examples and secure processing.
Examples > TS
- examples/ts/checkout-react.tsx - React component for checkout integration, with hooks and state.
- examples/ts/checkout.ts - TS implementation for creating checkouts, with Pix and card examples using SDK.
- examples/ts/coupons.ts - Coupon examples in TS, creation and application.
- examples/ts/customers.ts - TS examples for customer CRUD, with HTTP requests and data handling.
- examples/ts/mrr.ts - MRR access in TS, with requests for metrics.
- examples/ts/payouts.ts - TS implementation for payouts, creation and query.
- examples/ts/products.ts - Product CRUD in TS, with cache and SDK.
- examples/ts/remotion-mrr.tsx - MRR visualization with Remotion, animations and charts.
- examples/ts/store.ts - Examples for accessing store data via API.
- examples/ts/subscriptions.ts - TS code for managing subscriptions, including creation and listing.
- examples/ts/transparents.ts - Transparent checkout examples in TS.
- examples/ts/webhook.ts - Webhook verification in TS, with HMAC and event processing.
Examples > Go
Tests > TS
Tests > Go
Utils
Tools
Root
- README.md - Skill overview, installation and structure.
- SKILL.md - Metadata and usage guide (this file).
Visual Documentation
Checkout Flow Diagram
Use Mermaid or similar tools to visualize the checkout process:
graph TD
A[User Initiates Checkout] --> B[Create Checkout Request]
B --> C[Abacatepay API Processes]
C --> D[Return Checkout URL]
D --> E[User Completes Payment]
E --> F[Webhook Notification]
F --> G[Application Handles Event]
Webhook Flow Diagram
graph TD
A[Event Occurs in Abacatepay] --> B[Webhook Sent to Endpoint]
B --> C[Verify Signature]
C --> D{Valid?}
D -->|Yes| E[Process Event]
D -->|No| F[Reject Request]
E --> G[Respond with 200]
F --> H[Respond with 401]
Suggested tools: Mermaid (integrates with Markdown), Draw.io, or Lucidchart for creating diagrams.
