# AbacatePay

## Docs

- [MCP Server](https://docs.abacatepay.com/pages/ai/mcp.md): Integre a AbacatePay diretamente em agentes de IA como Claude Desktop e Cursor via Model Context Protocol.
- [Visão Geral](https://docs.abacatepay.com/pages/ai/overview.md): Ferramentas e contexto especializado para integrar a AbacatePay com IA.
- [Skills](https://docs.abacatepay.com/pages/ai/skills.md): Pacotes de contexto especializado para ensinar agentes de IA a integrar com a AbacatePay.
- [Chaves de API](https://docs.abacatepay.com/pages/authentication.md): Aprenda como funcionam as chaves de API e como utilizá-las para acessar a AbacatePay
- [Changelog da API](https://docs.abacatepay.com/pages/changelog/index.md): Mantenha-se atualizado com as mudanças e histórico de versões da API
- [Autenticação & Perfis](https://docs.abacatepay.com/pages/cli/auth.md): Comandos de login, logout, perfis múltiplos e gerenciamento de autenticação na AbacatePay CLI.
- [Casos de Uso](https://docs.abacatepay.com/pages/cli/cases.md): Cenários práticos de uso da AbacatePay CLI em desenvolvimento, testes e automação.
- [Configuração](https://docs.abacatepay.com/pages/cli/flags.md): Flags globais, formatos de output e configuração da AbacatePay CLI.
- [Visão Geral](https://docs.abacatepay.com/pages/cli/overview.md): Ferramenta oficial de linha de comando da AbacatePay para desenvolvimento, testes e automações.
- [Pagamentos](https://docs.abacatepay.com/pages/cli/payments.md): Comandos para criação, consulta e simulação de pagamentos PIX na AbacatePay CLI.
- [Utilitários](https://docs.abacatepay.com/pages/cli/utils.md): Comandos auxiliares para verificação de webhooks, atualização e documentação na AbacatePay CLI.
- [Webhooks & Eventos](https://docs.abacatepay.com/pages/cli/webhooks.md): Comandos para escutar, simular e depurar webhooks e eventos na AbacatePay CLI.
- [Criar um Cliente](https://docs.abacatepay.com/pages/client/create.md): Permite que você crie um cliente para a sua loja.
- [Deletar um Cliente](https://docs.abacatepay.com/pages/client/delete.md): Remove um cliente da sua loja.
- [Buscar um Cliente](https://docs.abacatepay.com/pages/client/get.md): Retorna os dados de um cliente específico baseado em filtros.
- [Listar Clientes](https://docs.abacatepay.com/pages/client/list.md): Retorna todos os clientes que você cadastrou com suporte a paginação.
- [Referência](https://docs.abacatepay.com/pages/client/reference.md): Clientes para pré-preencher checkout e reutilizar em várias cobranças
- [Criar um cupom](https://docs.abacatepay.com/pages/coupons/create.md): Permite que você crie um novo cupom que pode ser usado por seus clientes para aplicar descontos.
- [Deletar um Cupom](https://docs.abacatepay.com/pages/coupons/delete.md): Remove um cupom da sua loja.
- [Buscar um Cupom](https://docs.abacatepay.com/pages/coupons/get.md): Retorna os dados de um cupom específico baseado em filtros.
- [Listar cupons](https://docs.abacatepay.com/pages/coupons/list.md): Retorna todos os cupons que você criou com suporte a paginação.
- [Referência](https://docs.abacatepay.com/pages/coupons/reference.md): Crie cupons de desconto para seus clientes usarem uma ou várias vezes
- [Alternar Status de um Cupom](https://docs.abacatepay.com/pages/coupons/toggle.md): Alterna o status de um cupom entre ativo e inativo.
- [Dev mode, o que é?](https://docs.abacatepay.com/pages/devmode.md): Entenda o Dev mode e aprenda a usar este ambiente para testar sua integração com segurança.
- [Ecossistema](https://docs.abacatepay.com/pages/ecosystem/ecosystem.md): Bibliotecas, temas e extensões open source que compõem o ecossistema da AbacatePay.
- [ESLint Plugin](https://docs.abacatepay.com/pages/ecosystem/eslint.md): Plugin ESLint para evitar vazamento de chaves da AbacatePay e reforçar boas práticas de segurança.
- [REST](https://docs.abacatepay.com/pages/ecosystem/rest.md): REST client ergonômico, rápido e totalmente tipado para a API da AbacatePay.
- [Tema](https://docs.abacatepay.com/pages/ecosystem/theme.md): Tema oficial green-first da AbacatePay para VS Code, IntelliJ e Neovim.
- [TypeBox](https://docs.abacatepay.com/pages/ecosystem/typebox.md): Schemas oficiais da API da AbacatePay com TypeBox para validação runtime, contratos tipados e OpenAPI.
- [API Types](https://docs.abacatepay.com/pages/ecosystem/types.md): Tipagens oficiais e helpers modernos para integrar com a API da AbacatePay.
- [API Types (Golang)](https://docs.abacatepay.com/pages/ecosystem/types-go.md): Structs oficiais e helpers modernos para integrar com a API da AbacatePay em Golang.
- [Zod](https://docs.abacatepay.com/pages/ecosystem/zod.md): Schemas oficiais da API da AbacatePay com Zod para validação runtime, contratos tipados e OpenAPI.
- [Perguntas Frequentes](https://docs.abacatepay.com/pages/faq/index.md): Respostas para as dúvidas mais comuns durante a integração com a AbacatePay.
- [Glossário](https://docs.abacatepay.com/pages/glossario.md): Conceitos e termos técnicos da AbacatePay explicados de forma simples
- [Criar um link de pagamento](https://docs.abacatepay.com/pages/payment-links/create.md): Cria um link de pagamento (checkout com frequency MULTIPLE_PAYMENTS). Vários clientes podem pagar o mesmo link; não suporta customerId.
- [Listar links de pagamento](https://docs.abacatepay.com/pages/payment-links/list.md): Lista apenas links de pagamento (checkouts com frequency MULTIPLE_PAYMENTS).
- [Buscar um link de pagamento](https://docs.abacatepay.com/pages/payment-links/one.md): Retorna os dados de um link de pagamento específico (checkout com frequency MULTIPLE_PAYMENTS) usando o ID.
- [Referência](https://docs.abacatepay.com/pages/payment-links/reference.md): Links de pagamento — checkout com múltiplas parcelas
- [Criar um Checkout](https://docs.abacatepay.com/pages/payment/create.md): Cria um Checkout para o cliente realizar o pagamento.
- [Receber parcelado (Cartão)](https://docs.abacatepay.com/pages/payment/installments.md): Permita que seus clientes paguem em até 12x no cartão de crédito.
- [Listar Checkouts](https://docs.abacatepay.com/pages/payment/list.md): Retorna todos os Checkouts que você criou.
- [Buscar um Checkout](https://docs.abacatepay.com/pages/payment/one.md): Retorna os dados de um Checkout específico usando o ID.
- [Referência](https://docs.abacatepay.com/pages/payment/reference.md): Crie um checkout
- [Criar um Saque](https://docs.abacatepay.com/pages/payouts/create.md): Permite que você crie um novo payout para transferir valores da sua conta AbacatePay.
- [Buscar saque](https://docs.abacatepay.com/pages/payouts/get.md): Permite que você recupere os detalhes de um payout específico usando o externalId.
- [Listar Saques](https://docs.abacatepay.com/pages/payouts/list.md): Permite que você recupere uma lista de todos os payouts criados com suporte a paginação.
- [Referência](https://docs.abacatepay.com/pages/payouts/reference.md): Saques do seu saldo para sua própria chave PIX
- [Enviar PIX](https://docs.abacatepay.com/pages/pix/create.md): Permite que você envie dinheiro via PIX para qualquer chave PIX que não seja do titular da conta.
- [Buscar PIX](https://docs.abacatepay.com/pages/pix/get.md): Permite que você recupere os detalhes de uma transação PIX específica usando o ID ou externalId.
- [Listar PIX](https://docs.abacatepay.com/pages/pix/list.md): Permite que você recupere uma lista de transações PIX criadas.
- [Referência](https://docs.abacatepay.com/pages/pix/reference.md): Envie dinheiro via PIX para qualquer chave PIX
- [Indo para produção](https://docs.abacatepay.com/pages/production.md): Como sair do dev mode e começar a faturar
- [Criar um produto](https://docs.abacatepay.com/pages/products/create.md): Permite que você crie um novo produto que pode ser usado em cobranças. Produtos podem ser avulsos (pagamento único) ou de assinatura; use o campo opcional `cycle` para definir a recorrência (`WEEKLY`, `MONTHLY`, `SEMIANNUALLY`, `ANNUALLY`). Quando `cycle` é omitido ou `null`, o produto é avulso.
- [Deletar um Produto](https://docs.abacatepay.com/pages/products/delete.md): Remove um produto da sua loja (avulso ou de assinatura).
- [Buscar um produto](https://docs.abacatepay.com/pages/products/get.md): Retorna os dados de um produto específico baseado em filtros, incluindo o campo `cycle` (assinatura ou avulso).
- [Listar produtos](https://docs.abacatepay.com/pages/products/list.md): Retorna todos os produtos que você criou com suporte a paginação.
- [Referência](https://docs.abacatepay.com/pages/products/reference.md): Gerencie produtos para suas cobranças
- [Introdução](https://docs.abacatepay.com/pages/reference/introduction.md): Base URL, autenticação, formato de resposta, códigos de status e limites da API.
- [Go](https://docs.abacatepay.com/pages/sdks/go.md): Integre a AbacatePay em aplicações Go em minutos.
- [Java](https://docs.abacatepay.com/pages/sdks/java.md): Integre a AbacatePay em aplicações Java em minutos.
- [Kotlin](https://docs.abacatepay.com/pages/sdks/kotlin.md): Integre a AbacatePay em aplicações Android e Kotlin em minutos.
- [Node.js](https://docs.abacatepay.com/pages/sdks/nodejs.md): Integre a AbacatePay em aplicações Node.js e TypeScript em minutos.
- [PHP](https://docs.abacatepay.com/pages/sdks/php.md): Integre a AbacatePay em aplicações PHP em minutos.
- [Python](https://docs.abacatepay.com/pages/sdks/python.md): Integre a AbacatePay em aplicações Python em minutos.
- [Ruby](https://docs.abacatepay.com/pages/sdks/ruby.md): Integre a AbacatePay em aplicações Ruby em minutos.
- [Rust](https://docs.abacatepay.com/pages/sdks/rust.md): Integre a AbacatePay em aplicações Rust em minutos.
- [SDKs](https://docs.abacatepay.com/pages/sdks/sdks.md): Bibliotecas oficiais para integração com a API da AbacatePay
- [Swift](https://docs.abacatepay.com/pages/sdks/swift.md): Integre a AbacatePay em aplicações iOS e macOS em minutos.
- [Bem-vindo à Documentação da AbacatePay](https://docs.abacatepay.com/pages/start/welcome.md)
- [Obter detalhes da loja](https://docs.abacatepay.com/pages/store/get.md): Permite que você recupere os detalhes da sua conta/loja, incluindo informações de saldo.
- [Referência](https://docs.abacatepay.com/pages/store/reference.md): Dados da sua loja e saldos da conta
- [Cancelar uma assinatura](https://docs.abacatepay.com/pages/subscriptions/cancel.md): Cancela imediatamente uma assinatura ativa.
- [Criar Checkout de assinatura](https://docs.abacatepay.com/pages/subscriptions/create.md): Cria um Checkout de assinatura — uma página de pagamento igual ao Checkout comum, mas para cobrança recorrente.
- [Listar Checkouts de assinatura](https://docs.abacatepay.com/pages/subscriptions/list.md): Retorna todos os Checkouts de assinatura que você criou, com suporte a paginação baseada em cursor. Cada item possui o mesmo formato de um Checkout: `id`, `url`, `amount`, `items`, `status`, etc.
- [Referência](https://docs.abacatepay.com/pages/subscriptions/reference.md): Crie checkouts de assinatura e gerencie as existentes.
- [Criar cobrança Boleto](https://docs.abacatepay.com/pages/transparents/boleto.md): Cria um checkout transparente. Use `"method": "PIX"` para gerar um QR Code ou `"method": "BOLETO"` para emitir um boleto com PIX alternativo incluído.
- [Checar Status](https://docs.abacatepay.com/pages/transparents/check.md): Checar status do pagamento do QRCode Pix.
- [Criar cobrança PIX](https://docs.abacatepay.com/pages/transparents/create.md): Cria um checkout transparente. Use `"method": "PIX"` para gerar um QR Code ou `"method": "BOLETO"` para emitir um boleto com PIX alternativo incluído.
- [Listar Checkouts Transparentes](https://docs.abacatepay.com/pages/transparents/list.md): Retorna todos os Checkouts Transparentes (QRCodes PIX) que você criou.
- [Referência](https://docs.abacatepay.com/pages/transparents/reference.md): PIX QR Code e Boleto no seu checkout sem redirecionar o cliente
- [Simular Pagamento](https://docs.abacatepay.com/pages/transparents/simulate-payment.md): Simula o pagamento de um QRCode Pix criado no modo de desenvolvimento.
- [Obter Informações do Merchant](https://docs.abacatepay.com/pages/trustMRR/get.md): Retorna informações básicas da loja (ID, nome, website e data de criação).
- [Obter Receita por Período](https://docs.abacatepay.com/pages/trustMRR/list.md): Retorna a receita total, total de transações e transações por dia em um período específico. Os dados são cacheados por 1 hora (3600 segundos) para melhor performance. A data de fim deve ser posterior à data de início.
- [Obter MRR](https://docs.abacatepay.com/pages/trustMRR/mrr.md): Retorna o MRR (receita recorrente mensal) e o total de assinaturas ativas da loja.
- [Referência](https://docs.abacatepay.com/pages/trustMRR/reference.md): Métricas de receita públicas para integração ou exibição
- [Webhooks](https://docs.abacatepay.com/pages/webhooks.md): Receba notificações automáticas da AbacatePay sempre que algo importante acontecer — como um pagamento aprovado ou um saque concluído.
- [Criar um webhook](https://docs.abacatepay.com/pages/webhooks/create.md): Cria um novo webhook para receber notificações automáticas de eventos da sua loja.
- [Deletar um webhook](https://docs.abacatepay.com/pages/webhooks/delete.md): Remove um webhook da sua loja.
- [Checkout](https://docs.abacatepay.com/pages/webhooks/events/checkout.md): Eventos disparados para pagamentos via Checkout (PIX, Cartão e Boleto).
- [Saques](https://docs.abacatepay.com/pages/webhooks/events/payouts.md): Eventos disparados para saques (retirada de saldo da plataforma).
- [Assinaturas](https://docs.abacatepay.com/pages/webhooks/events/subscriptions.md): Eventos disparados para assinaturas (PIX e Cartão).
- [Transferências](https://docs.abacatepay.com/pages/webhooks/events/transfers.md): Eventos disparados para transferências de valores para contas externas.
- [Checkout Transparente](https://docs.abacatepay.com/pages/webhooks/events/transparent.md): Eventos disparados para pagamentos via Checkout Transparente (PIX, Cartão e Boleto).
- [Buscar um webhook](https://docs.abacatepay.com/pages/webhooks/get.md): Retorna os dados de um webhook específico pelo seu identificador.
- [Listar webhooks](https://docs.abacatepay.com/pages/webhooks/list.md): Retorna todos os webhooks da sua loja com suporte a paginação e busca.
- [Referência](https://docs.abacatepay.com/pages/webhooks/reference.md): Crie e gerencie webhooks para receber notificações automáticas de eventos na sua loja.
- [Verificação e Segurança](https://docs.abacatepay.com/pages/webhooks/security.md): Como validar a autenticidade dos webhooks e lidar com retentativas.

## OpenAPI Specs

- [openapi](https://docs.abacatepay.com/openapi.yaml)
- [openapi-v1](https://docs.abacatepay.com/openapi-v1.yaml)