AbacatePay Skills

1---
2name: abacatepay
3description: Integrate AbacatePay in code or interact directly with the API (list customers, create checkouts, check balance, etc.)
4metadata:
5  tags: abacatepay, payments, pix, subscriptions, webhooks, checkout
6---
7 
8## When to use
9 
10Use this skill in two modes:
11 
12### 1. Integration Mode
13When the user wants to **write code** to integrate AbacatePay into an application (TypeScript / Go). Use the rules, examples, and best practices below.
14 
15### 2. Agent Mode (Direct API)
16When 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](rules/agent.md) for all endpoints and templates.
17 
18## How to use
19 
20For **direct API usage** (agent mode), see:
21- [rules/agent.md](rules/agent.md) - Execute API calls directly via curl (list customers, create checkouts, check balance, etc.)
22 
23For **code integration**, read individual rule files:
24 
25- [rules/ts/checkout.md](rules/ts/checkout.md) / [rules/go/checkout.md](rules/go/checkout.md) - Creating one-time payment checkouts (Pix/Card). [Docs](https://docs.abacatepay.com/payment)
26- [rules/ts/customers.md](rules/ts/customers.md) / [rules/go/customers.md](rules/go/customers.md) - Managing customers (Create, List, Get, Delete). [Docs](https://docs.abacatepay.com/client)
27- [rules/ts/subscriptions.md](rules/ts/subscriptions.md) / [rules/go/subscriptions.md](rules/go/subscriptions.md) - Handling recurring billing, products, and plans.
28- [rules/ts/coupons.md](rules/ts/coupons.md) / [rules/go/coupons.md](rules/go/coupons.md) - Managing discounts and coupons. [Docs](https://docs.abacatepay.com/coupon)
29- [rules/ts/webhooks.md](rules/ts/webhooks.md) / [rules/go/webhooks.md](rules/go/webhooks.md) - Securely handling events with HMAC verification. [Docs](https://docs.abacatepay.com/webhooks)
30- [rules/ts/payouts.md](rules/ts/payouts.md) / [rules/go/payouts.md](rules/go/payouts.md) - Automating withdrawals and payouts. [Docs](https://docs.abacatepay.com/withdraw)
31- [rules/ts/transparents.md](rules/ts/transparents.md) / [rules/go/transparents.md](rules/go/transparents.md) - Transparent Checkout integration. [Docs](https://docs.abacatepay.com/pix-qrcode)
32- [rules/ts/mrr.md](rules/ts/mrr.md) / [rules/go/mrr.md](rules/go/mrr.md) - Accessing Public MRR and revenue data. [Docs](https://docs.abacatepay.com/trustMRR)
33- [rules/ts/products.md](rules/ts/products.md) / [rules/go/products.md](rules/go/products.md) - Managing catalog products via CRUD operations. [Docs](https://docs.abacatepay.com/products)
34- [rules/go/security.md](rules/go/security.md) - Best practices for secure integrations and fraud prevention.
35 
36Use development tools for enhanced integration experience:
37- [tools/auth.md](tools/auth.md) - API key management and authentication guide. [Docs](https://docs.abacatepay.com/authentication)
38- [tools/cli.md](tools/cli.md) - Official CLI for terminal-based development, testing, and automation. [Docs](https://docs.abacatepay.com/cli)
39- [tools/devmode.md](tools/devmode.md) - Testing environment setup and usage. [Docs](https://docs.abacatepay.com/devmode)
40- [tools/ecosystem.md](tools/ecosystem.md) - Open source ecosystem, including official and community projects. [Docs](https://docs.abacatepay.com/ecosystem)
41- [tools/items.md](tools/items.md) - Managing subscription items and line items. [Docs](https://docs.abacatepay.com/items)
42- [tools/nocode.md](tools/nocode.md) - No-code integration options and platforms. [Docs](https://docs.abacatepay.com/nocode)
43- [tools/production.md](tools/production.md) - Best practices for production deployment. [Docs](https://docs.abacatepay.com/production)
44- [tools/rest.md](tools/rest.md) - Lightweight REST client for typed API requests. [Docs](https://docs.abacatepay.com/ecosystem/rest)
45- [tools/sdks/go.md](tools/sdks/go.md) - Go HTTP integration for payment API. [Docs](https://docs.abacatepay.com)
46- [tools/sdks/nodejs.md](tools/sdks/nodejs.md) - Node.js SDK for quick payment integration. [Docs](https://docs.abacatepay.com/sdks/nodejs)
47- [tools/start.md](tools/start.md) - Quickstart guide for first API requests. [Docs](https://docs.abacatepay.com/start/quickstart)
48- [tools/store.md](tools/store.md) - Retrieving and managing store information. [Docs](https://docs.abacatepay.com/store)
49- [tools/theme.md](tools/theme.md) - Official green-first theme for VS Code, IntelliJ, and Neovim. [Docs](https://docs.abacatepay.com/ecosystem/theme)
50- [tools/types.md](tools/types.md) - Official TypeScript typings and helpers for API integration. [Docs](https://docs.abacatepay.com/ecosystem/types)
51- [tools/zod.md](tools/zod.md) - Zod schemas for runtime validation and OpenAPI generation. [Docs](https://docs.abacatepay.com/ecosystem/zod)
52- [tools/sdks/nodejs.md](tools/sdks/nodejs.md) - Node.js SDK for quick payment integration. [Docs](https://docs.abacatepay.com/sdks/nodejs)
53- [tools/sdks/go.md](tools/sdks/go.md) - Go HTTP integration for payment API. [Docs](https://docs.abacatepay.com)
54- [tools/auth.md](tools/auth.md) - API key management and authentication guide. [Docs](https://docs.abacatepay.com/authentication)
55- [tools/devmode.md](tools/devmode.md) - Testing environment setup and usage. [Docs](https://docs.abacatepay.com/devmode)
56- [tools/production.md](tools/production.md) - Best practices for production deployment. [Docs](https://docs.abacatepay.com/production)
57 
58## File Index
59 
60Complete list of all files with objective summaries:
61 
62**Rules > TS**
63- [rules/ts/checkout.md](rules/ts/checkout.md) - Guide for creating one-time checkouts via AbacatePay API, with Pix, card, validation and error handling.
64- [rules/ts/coupons.md](rules/ts/coupons.md) - Managing discount coupons, creation, listing, toggle and validation.
65- [rules/ts/customers.md](rules/ts/customers.md) - Instructions for managing customers via CRUD, with required fields, metadata and secure integration.
66- [rules/ts/mrr.md](rules/ts/mrr.md) - Accessing public MRR and revenue data, business metrics and visualization.
67- [rules/ts/payouts.md](rules/ts/payouts.md) - Automating withdrawals and payouts, creation, query and transaction status.
68- [rules/ts/products.md](rules/ts/products.md) - Instructions for managing catalog products via CRUD, with cache and integration in checkouts.
69- [rules/ts/security.md](rules/ts/security.md) - Best practices for secure integrations, data protection and fraud prevention.
70- [rules/ts/subscriptions.md](rules/ts/subscriptions.md) - Guide for recurring subscriptions, including creation, items, plans and cancellation.
71- [rules/ts/transparents.md](rules/ts/transparents.md) - Transparent checkout integration, payment simulation and status verification.
72- [rules/ts/webhooks.md](rules/ts/webhooks.md) - Webhook setup and verification via dashboard, with HMAC examples and secure processing.
73 
74**Rules > Go**
75- [rules/go/checkout.md](rules/go/checkout.md) - Go guide for creating one-time checkouts via AbacatePay API, with Pix, card, validation and error handling.
76- [rules/go/coupons.md](rules/go/coupons.md) - Managing discount coupons in Go, creation, listing, toggle and validation.
77- [rules/go/customers.md](rules/go/customers.md) - Go instructions for managing customers via CRUD, with required fields, metadata and secure integration.
78- [rules/go/mrr.md](rules/go/mrr.md) - Accessing public MRR and revenue data in Go, business metrics and visualization.
79- [rules/go/payouts.md](rules/go/payouts.md) - Automating withdrawals and payouts in Go, creation, query and transaction status.
80- [rules/go/products.md](rules/go/products.md) - Go instructions for managing catalog products via CRUD, with cache and integration in checkouts.
81- [rules/go/security.md](rules/go/security.md) - Best practices for secure integrations in Go, data protection and fraud prevention.
82- [rules/go/subscriptions.md](rules/go/subscriptions.md) - Go guide for recurring subscriptions, including creation, items, plans and cancellation.
83- [rules/go/transparents.md](rules/go/transparents.md) - Transparent checkout integration in Go, payment simulation and status verification.
84- [rules/go/webhooks.md](rules/go/webhooks.md) - Webhook setup and verification via dashboard in Go, with HMAC examples and secure processing.
85 
86**Examples > TS**
87- [examples/ts/checkout-react.tsx](examples/ts/checkout-react.tsx) - React component for checkout integration, with hooks and state.
88- [examples/ts/checkout.ts](examples/ts/checkout.ts) - TS implementation for creating checkouts, with Pix and card examples using SDK.
89- [examples/ts/coupons.ts](examples/ts/coupons.ts) - Coupon examples in TS, creation and application.
90- [examples/ts/customers.ts](examples/ts/customers.ts) - TS examples for customer CRUD, with HTTP requests and data handling.
91- [examples/ts/mrr.ts](examples/ts/mrr.ts) - MRR access in TS, with requests for metrics.
92- [examples/ts/payouts.ts](examples/ts/payouts.ts) - TS implementation for payouts, creation and query.
93- [examples/ts/products.ts](examples/ts/products.ts) - Product CRUD in TS, with cache and SDK.
94- [examples/ts/remotion-mrr.tsx](examples/ts/remotion-mrr.tsx) - MRR visualization with Remotion, animations and charts.
95- [examples/ts/store.ts](examples/ts/store.ts) - Examples for accessing store data via API.
96- [examples/ts/subscriptions.ts](examples/ts/subscriptions.ts) - TS code for managing subscriptions, including creation and listing.
97- [examples/ts/transparents.ts](examples/ts/transparents.ts) - Transparent checkout examples in TS.
98- [examples/ts/webhook.ts](examples/ts/webhook.ts) - Webhook verification in TS, with HMAC and event processing.
99 
100**Examples > Go**
101- [examples/go/checkout.go](examples/go/checkout.go) - Go implementation for checkouts, with HTTP requests and structs.
102- [examples/go/coupons.go](examples/go/coupons.go) - Coupon examples in Go, creation and application.
103- [examples/go/customers.go](examples/go/customers.go) - Go examples for customer CRUD, with HTTP requests and data handling.
104- [examples/go/mrr.go](examples/go/mrr.go) - MRR access in Go, with requests for metrics.
105- [examples/go/payouts.go](examples/go/payouts.go) - Go implementation for payouts, creation and query.
106- [examples/go/products.go](examples/go/products.go) - Product CRUD in Go, with cache and HTTP requests.
107- [examples/go/subscriptions.go](examples/go/subscriptions.go) - Go code for managing subscriptions, including creation and listing.
108- [examples/go/transparents.go](examples/go/transparents.go) - Transparent checkout examples in Go.
109- [examples/go/webhook.go](examples/go/webhook.go) - Webhook verification in Go, with HMAC and event processing.
110 
111**Tests > TS**
112- [tests/ts/checkout.test.ts](tests/ts/checkout.test.ts) - Jest tests for checkout functions, success and error cases.
113- [tests/ts/webhook.test.ts](tests/ts/webhook.test.ts) - Tests for webhook validation, HMAC and processing.
114 
115**Tests > Go**
116- [tests/go/checkout_test.go](tests/go/checkout_test.go) - Go tests for checkout, with success and error cases.
117- [tests/go/webhook_test.go](tests/go/webhook_test.go) - Tests for webhook validation in Go, HMAC and processing.
118 
119**Utils**
120- [utils/faq.md](utils/faq.md) - Frequently asked questions about AbacatePay integration, troubleshooting and tips. [Docs](https://docs.abacatepay.com/faq)
121- [utils/glossary.md](utils/glossary.md) - Glossary of technical terms and concepts. [Docs](https://docs.abacatepay.com/glossario)
122 
123**Tools**
124- [tools/auth.md](tools/auth.md) - API key management and authentication guide. [Docs](https://docs.abacatepay.com/authentication)
125- [tools/cli.md](tools/cli.md) - Official CLI tool for development, testing, and local automations. [Docs](https://docs.abacatepay.com/cli)
126- [tools/devmode.md](tools/devmode.md) - Testing environment setup and usage. [Docs](https://docs.abacatepay.com/devmode)
127- [tools/ecosystem.md](tools/ecosystem.md) - Overview of open source ecosystem with official and community projects. [Docs](https://docs.abacatepay.com/ecosystem)
128- [tools/items.md](tools/items.md) - Managing subscription items and line items. [Docs](https://docs.abacatepay.com/items)
129- [tools/nocode.md](tools/nocode.md) - No-code integration options and platforms. [Docs](https://docs.abacatepay.com/nocode)
130- [tools/production.md](tools/production.md) - Best practices for production deployment. [Docs](https://docs.abacatepay.com/production)
131- [tools/rest.md](tools/rest.md) - Lightweight REST client for typed API requests with retries and timeouts. [Docs](https://docs.abacatepay.com/ecosystem/rest)
132- [tools/sdks/go.md](tools/sdks/go.md) - Go HTTP integration for payment API. [Docs](https://docs.abacatepay.com)
133- [tools/sdks/nodejs.md](tools/sdks/nodejs.md) - Node.js SDK for quick payment integration. [Docs](https://docs.abacatepay.com/sdks/nodejs)
134- [tools/start.md](tools/start.md) - Quickstart guide for first API requests. [Docs](https://docs.abacatepay.com/start/quickstart)
135- [tools/store.md](tools/store.md) - Retrieving and managing store information. [Docs](https://docs.abacatepay.com/store)
136- [tools/theme.md](tools/theme.md) - Official green-first theme for VS Code, IntelliJ, and Neovim editors. [Docs](https://docs.abacatepay.com/ecosystem/theme)
137- [tools/types.md](tools/types.md) - TypeScript typings and helpers for safe API integrations. [Docs](https://docs.abacatepay.com/ecosystem/types)
138- [tools/zod.md](tools/zod.md) - Zod schemas for runtime validation, contracts, and OpenAPI generation. [Docs](https://docs.abacatepay.com/ecosystem/zod)
139 
140**Root**
141- [README.md](README.md) - Skill overview, installation and structure.
142- [SKILL.md](SKILL.md) - Metadata and usage guide (this file).
143 
144## Visual Documentation
145 
146### Checkout Flow Diagram
147Use Mermaid or similar tools to visualize the checkout process:
148 
149```
150graph TD
151    A[User Initiates Checkout] --> B[Create Checkout Request]
152    B --> C[Abacatepay API Processes]
153    C --> D[Return Checkout URL]
154    D --> E[User Completes Payment]
155    E --> F[Webhook Notification]
156    F --> G[Application Handles Event]
157```
158 
159### Webhook Flow Diagram
160```
161graph TD
162    A[Event Occurs in Abacatepay] --> B[Webhook Sent to Endpoint]
163    B --> C[Verify Signature]
164    C --> D{Valid?}
165    D -->|Yes| E[Process Event]
166    D -->|No| F[Reject Request]
167    E --> G[Respond with 200]
168    F --> H[Respond with 401]
169```
170 
171Suggested tools: Mermaid (integrates with Markdown), Draw.io, or Lucidchart for creating diagrams.
172