abacatepay-skills
AbacatePay/skills
INSTALL
npx skills add AbacatePay/skillsRequires npx skills — the open source skill installer.
SKILL_DESCRIPTION
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:
- rules/ts/checkout.md / rules/go/checkout.md - Creating one-time payment checkouts (Pix/Card). Docs
- rules/ts/customers.md / rules/go/customers.md - Managing customers (Create, List, Get, Delete). Docs
- rules/ts/subscriptions.md / rules/go/subscriptions.md - Handling recurring billing, products, and plans.
- rules/ts/coupons.md / rules/go/coupons.md - Managing discounts and coupons. Docs
- rules/ts/webhooks.md / rules/go/webhooks.md - Securely handling events with HMAC verification. Docs
- rules/ts/payouts.md / rules/go/payouts.md - Automating withdrawals and payouts. Docs
- rules/ts/transparents.md / rules/go/transparents.md - Transparent Checkout integration. Docs
- rules/ts/mrr.md / rules/go/mrr.md - Accessing Public MRR and revenue data. Docs
- rules/ts/products.md / rules/go/products.md - Managing catalog products via CRUD operations. Docs
- rules/go/security.md - Best practices for secure integrations and fraud prevention.
Use development tools for enhanced integration experience:
- tools/auth.md - API key management and authentication guide. Docs
- tools/cli.md - Official CLI for terminal-based development, testing, and automation. Docs
- tools/devmode.md - Testing environment setup and usage. Docs
- tools/ecosystem.md - Open source ecosystem, including official and community projects. Docs
- tools/items.md - Managing subscription items and line items. Docs
- tools/nocode.md - No-code integration options and platforms. Docs
- tools/production.md - Best practices for production deployment. Docs
- tools/rest.md - Lightweight REST client for typed API requests. Docs
- tools/sdks/go.md - Go HTTP integration for payment API. Docs
- tools/sdks/nodejs.md - Node.js SDK for quick payment integration. Docs
- tools/start.md - Quickstart guide for first API requests. Docs
- tools/store.md - Retrieving and managing store information. Docs
- tools/theme.md - Official green-first theme for VS Code, IntelliJ, and Neovim. Docs
- tools/types.md - Official TypeScript typings and helpers for API integration. Docs
- tools/zod.md - Zod schemas for runtime validation and OpenAPI generation. Docs
- tools/sdks/nodejs.md - Node.js SDK for quick payment integration. Docs
- tools/sdks/go.md - Go HTTP integration for payment API. Docs
- tools/auth.md - API key management and authentication guide. Docs
- tools/devmode.md - Testing environment setup and usage. Docs
- tools/production.md - Best practices for production deployment. Docs
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
- examples/go/checkout.go - Go implementation for checkouts, with HTTP requests and structs.
- examples/go/coupons.go - Coupon examples in Go, creation and application.
- examples/go/customers.go - Go examples for customer CRUD, with HTTP requests and data handling.
- examples/go/mrr.go - MRR access in Go, with requests for metrics.
- examples/go/payouts.go - Go implementation for payouts, creation and query.
- examples/go/products.go - Product CRUD in Go, with cache and HTTP requests.
- examples/go/subscriptions.go - Go code for managing subscriptions, including creation and listing.
- examples/go/transparents.go - Transparent checkout examples in Go.
- examples/go/webhook.go - Webhook verification in Go, with HMAC and event processing.
Tests > TS
- tests/ts/checkout.test.ts - Jest tests for checkout functions, success and error cases.
- tests/ts/webhook.test.ts - Tests for webhook validation, HMAC and processing.
Tests > Go
- tests/go/checkout_test.go - Go tests for checkout, with success and error cases.
- tests/go/webhook_test.go - Tests for webhook validation in Go, HMAC and processing.
Utils
- utils/faq.md - Frequently asked questions about AbacatePay integration, troubleshooting and tips. Docs
- utils/glossary.md - Glossary of technical terms and concepts. Docs
Tools
- tools/auth.md - API key management and authentication guide. Docs
- tools/cli.md - Official CLI tool for development, testing, and local automations. Docs
- tools/devmode.md - Testing environment setup and usage. Docs
- tools/ecosystem.md - Overview of open source ecosystem with official and community projects. Docs
- tools/items.md - Managing subscription items and line items. Docs
- tools/nocode.md - No-code integration options and platforms. Docs
- tools/production.md - Best practices for production deployment. Docs
- tools/rest.md - Lightweight REST client for typed API requests with retries and timeouts. Docs
- tools/sdks/go.md - Go HTTP integration for payment API. Docs
- tools/sdks/nodejs.md - Node.js SDK for quick payment integration. Docs
- tools/start.md - Quickstart guide for first API requests. Docs
- tools/store.md - Retrieving and managing store information. Docs
- tools/theme.md - Official green-first theme for VS Code, IntelliJ, and Neovim editors. Docs
- tools/types.md - TypeScript typings and helpers for safe API integrations. Docs
- tools/zod.md - Zod schemas for runtime validation, contracts, and OpenAPI generation. Docs
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.
Last indexed: 6/16/2026
COMMENTS(0)
NO_COMMENTS_YET. BE_THE_FIRST.
SIGN_IN_TO_LEAVE_A_COMMENT
[SIGN_IN]