# Garu

> Documentação oficial da API Garu - Gateway de pagamentos que simplifica a gestão e apoia empreendedores no seu crescimento. Integre PIX, Cartão de Crédito e Boleto em minutos.

## Docs

- [Bem-vindo à Garu](https://docs.garu.com.br/index.md): Gateway de pagamentos que simplifica a gestão e apoia empreendedores no seu crescimento
- [Início Rápido](https://docs.garu.com.br/quickstart.md): Crie seu primeiro produto e comece a receber pagamentos em 5 minutos
- [Criando Produtos](https://docs.garu.com.br/guias/criando-produtos.md): Guia completo para criar produtos e começar a vender via API
- [Cadastro de clientes](https://docs.garu.com.br/guias/clientes.md): Mantenha sua agenda de clientes no Garu, com dedup automática por CPF/CNPJ e e-mail de cobrança configurável por cliente.
- [Cobranças agendadas](https://docs.garu.com.br/guias/cobrancas-agendadas.md): Agende cobranças PIX e Boleto para datas futuras. A Garu envia o e-mail no vencimento, alerta seu time se atrasar e expõe ações para adiar, pausar, retomar ou marcar como paga.
- [Portal do cliente](https://docs.garu.com.br/guias/portal-do-cliente.md): Em garu.com.br/minha-area seu cliente vê e paga todas as cobranças agendadas em aberto, sem login, com um link mágico de 24h.
- [Checkout Sessions](https://docs.garu.com.br/guias/checkout-sessions.md): Guia completo para criar links de pagamento personalizados via API
- [Checkout Transparente](https://docs.garu.com.br/guias/checkout-transparente.md): Receba PIX, boleto e cartão dentro da sua própria interface, sem redirecionar o cliente
- [Assinaturas](https://docs.garu.com.br/guias/assinaturas.md): Guia completo para criar e gerenciar produtos com cobrança recorrente
- [Pix Automático](https://docs.garu.com.br/guias/pix-automatico.md): Cobrança recorrente no Pix: o cliente autoriza uma vez no app do banco e os próximos ciclos são debitados sozinhos, sem QR Code a cada mês.
- [Como integrar Pix Automático](https://docs.garu.com.br/guias/integrar-pix-automatico.md): Receita prática: ative o Pix Automático no produto, cobre via cobrança agendada ou checkout público, escute os webhooks e trate as falhas.
- [Reenviar webhook](https://docs.garu.com.br/guias/reenviar-webhook.md): Listou os eventos que falharam, escolheu o que precisa e mandou de novo — clonando o original ou retentando in place.
- [Ir para Produção](https://docs.garu.com.br/guias/producao.md): Checklist completo para lançar sua integração em produção
- [Boleto Parcelado (Carnê)](https://docs.garu.com.br/guias/carne.md): Venda um produto em até 12 boletos mensais — e entenda o risco que você assume
- [MCP Server](https://docs.garu.com.br/guias/mcp-server.md): Conecte agentes de IA à API Garu com o protocolo MCP
- [CLI](https://docs.garu.com.br/guias/cli.md): Gerencie cobranças, carnês e reembolsos direto no terminal com a CLI da Garu
- [Skills para Agentes](https://docs.garu.com.br/guias/skills.md): Ensine boas práticas de pagamento ao seu agente de IA com as skills da Garu
- [Node.js SDK](https://docs.garu.com.br/guias/node-sdk.md): Integre pagamentos Garu no seu projeto Node.js em minutos
- [Claude Code](https://docs.garu.com.br/guias/integracoes/claude-code.md): Aceite pagamentos com Claude Code e Garu
- [Cursor](https://docs.garu.com.br/guias/integracoes/cursor.md): Aceite pagamentos com Cursor e Garu
- [Codex](https://docs.garu.com.br/guias/integracoes/codex.md): Aceite pagamentos com OpenAI Codex e Garu
- [Windsurf](https://docs.garu.com.br/guias/integracoes/windsurf.md): Aceite pagamentos com Windsurf e Garu
- [Introdução](https://docs.garu.com.br/api-reference/introduction.md): Comece a integrar com a API da Garu para processar pagamentos
- [Autenticação](https://docs.garu.com.br/api-reference/autenticacao.md): Configure suas chaves de API para acessar os endpoints da Garu
- [Criar Produto](https://docs.garu.com.br/api-reference/produtos/criar.md): Aprenda a criar produtos para vendas avulsas ou assinaturas via API
- [Link de Pagamento](https://docs.garu.com.br/api-reference/produtos/link-pagamento.md): Obtenha e utilize o link de pagamento para receber de seus clientes
- [Listar Produtos](https://docs.garu.com.br/api-reference/produtos/listar.md): Consulte todos os seus produtos cadastrados
- [Atualizar Produto](https://docs.garu.com.br/api-reference/produtos/atualizar.md): Atualize os dados de um produto existente
- [Excluir Produto](https://docs.garu.com.br/api-reference/produtos/excluir.md): Desative um produto existente
- [Portal customizado por produto (B2B2C)](https://docs.garu.com.br/api-reference/produtos/portal-config.md): Customize a página de pagamento e o portal /minha-area por produto, não só por seller
- [Criar Checkout Session](https://docs.garu.com.br/api-reference/checkout/criar.md): Crie links de pagamento programaticamente com dados do cliente pré-preenchidos
- [Listar Checkout Sessions](https://docs.garu.com.br/api-reference/checkout/listar.md): Consulte suas checkout sessions com paginação e filtros
- [Detalhes da Checkout Session](https://docs.garu.com.br/api-reference/checkout/detalhes.md): Consulte os detalhes de uma checkout session específica
- [Expirar Checkout Session](https://docs.garu.com.br/api-reference/checkout/expirar.md): Expire manualmente uma checkout session aberta
- [Criar Cobrança](https://docs.garu.com.br/api-reference/cobrancas/criar.md): Crie uma cobrança PIX, boleto ou cartão e receba os dados para exibir o pagamento no seu próprio checkout
- [Consultar Cobrança](https://docs.garu.com.br/api-reference/cobrancas/detalhes.md): Recupere uma cobrança pelo uuid, incluindo status e dados de pagamento
- [Listar Cobranças](https://docs.garu.com.br/api-reference/cobrancas/listar.md): Liste as cobranças da sua conta com filtros de status, método, produto, período e cliente
- [Estornar Cobrança](https://docs.garu.com.br/api-reference/cobrancas/reembolsar.md): Estorne uma cobrança paga, total ou parcialmente
- [Cancelar Cobrança](https://docs.garu.com.br/api-reference/cobrancas/cancelar.md): Cancele uma cobrança que ainda não foi paga
- [Registrar Cliente](https://docs.garu.com.br/api-reference/clientes/criar.md): Cadastre um cliente para o seller autenticado, com dedup automática por CPF/CNPJ
- [Listar Clientes](https://docs.garu.com.br/api-reference/clientes/listar.md): Liste os clientes da sua conta, com busca e filtro por status de inadimplência
- [Consultar Cliente](https://docs.garu.com.br/api-reference/clientes/detalhes.md): Recupere um cliente pelo uuid
- [Atualizar Cliente](https://docs.garu.com.br/api-reference/clientes/atualizar.md): Atualize os dados de um cliente para o seu perfil, sem afetar outros sellers
- [Definir E-mail de Cobrança](https://docs.garu.com.br/api-reference/clientes/definir-email-cobranca.md): Fixe (ou limpe) o e-mail que recebe cobranças deste cliente, independente do e-mail de contato
- [Remover Cliente](https://docs.garu.com.br/api-reference/clientes/excluir.md): Desvincule um cliente da sua conta
- [Listar Transações](https://docs.garu.com.br/api-reference/transacoes/listar.md): Consulte todas as transações com filtros e paginação
- [Detalhes da Transação](https://docs.garu.com.br/api-reference/transacoes/detalhes.md): Consulte os detalhes completos de uma transação específica
- [Consultar Status](https://docs.garu.com.br/api-reference/transacoes/status.md): Endpoint público para verificar o status de uma transação
- [Reembolsar Transação](https://docs.garu.com.br/api-reference/transacoes/reembolsar.md): Emita reembolsos totais ou parciais para transações pagas
- [Cancelar Transação](https://docs.garu.com.br/api-reference/transacoes/cancelar.md): Cancele uma transação pendente antes de ser paga
- [Criar Preço de Assinatura](https://docs.garu.com.br/api-reference/assinaturas/precos/criar.md): Crie planos de preço para produtos de assinatura
- [Listar Preços de Assinatura](https://docs.garu.com.br/api-reference/assinaturas/precos/listar.md): Consulte todos os preços de assinatura cadastrados
- [Detalhes do Preço](https://docs.garu.com.br/api-reference/assinaturas/precos/detalhes.md): Consulte os detalhes de um preço de assinatura específico
- [Atualizar Preço de Assinatura](https://docs.garu.com.br/api-reference/assinaturas/precos/atualizar.md): Atualize um preço de assinatura existente
- [Excluir Preço de Assinatura](https://docs.garu.com.br/api-reference/assinaturas/precos/excluir.md): Exclua um preço de assinatura
- [Listar Assinaturas](https://docs.garu.com.br/api-reference/assinaturas/listar.md): Consulte todas as assinaturas com filtros e paginação
- [Detalhes da Assinatura](https://docs.garu.com.br/api-reference/assinaturas/detalhes.md): Consulte os detalhes completos de uma assinatura específica
- [Cancelar Assinatura](https://docs.garu.com.br/api-reference/assinaturas/cancelar.md): Cancele uma assinatura imediatamente ou ao fim do período
- [Pausar Assinatura](https://docs.garu.com.br/api-reference/assinaturas/pausar.md): Pause temporariamente as cobranças de uma assinatura
- [Retomar Assinatura](https://docs.garu.com.br/api-reference/assinaturas/retomar.md): Retome uma assinatura pausada e reative as cobranças
- [Eventos da Assinatura](https://docs.garu.com.br/api-reference/assinaturas/eventos.md): Consulte o histórico de eventos e billing history de uma assinatura
- [Portal do Cliente](https://docs.garu.com.br/api-reference/assinaturas/portal.md): Permitir que assinantes gerenciem suas assinaturas de forma autônoma
- [Criar Cobrança Agendada](https://docs.garu.com.br/api-reference/cobrancas-agendadas/criar.md): Agende uma cobrança PIX ou Boleto para um cliente cadastrado
- [Listar Cobranças Agendadas](https://docs.garu.com.br/api-reference/cobrancas-agendadas/listar.md): Liste e filtre cobranças agendadas com paginação e busca por cliente
- [Detalhes da Cobrança Agendada](https://docs.garu.com.br/api-reference/cobrancas-agendadas/detalhes.md): Busque uma cobrança junto com sua linha do tempo e transações geradas
- [Cobrar Agora](https://docs.garu.com.br/api-reference/cobrancas-agendadas/cobrar-agora.md): Dispare a cobrança e o e-mail ao cliente na hora, sem esperar o vencimento
- [Adiar Cobrança](https://docs.garu.com.br/api-reference/cobrancas-agendadas/adiar.md): Empurre uma cobrança para uma nova data de vencimento
- [Pausar Cobrança](https://docs.garu.com.br/api-reference/cobrancas-agendadas/pausar.md): Coloque uma cobrança em espera; nenhum lembrete é enviado enquanto pausada
- [Retomar Cobrança](https://docs.garu.com.br/api-reference/cobrancas-agendadas/retomar.md): Reative uma cobrança pausada
- [Marcar como Paga](https://docs.garu.com.br/api-reference/cobrancas-agendadas/marcar-como-paga.md): Registre um pagamento feito fora do Garu (transferência, dinheiro, etc.)
- [Listar tentativas de cobrança](https://docs.garu.com.br/api-reference/cobrancas-agendadas/tentativas.md): Log per-attempt para auditoria de billing recorrente
- [Criar Carnê](https://docs.garu.com.br/api-reference/carne/criar.md): Venda um produto em até 12 boletos mensais
- [Listar Carnês](https://docs.garu.com.br/api-reference/carne/listar.md): Lista os carnês da conta, com filtros e paginação
- [Detalhes do Carnê](https://docs.garu.com.br/api-reference/carne/detalhes.md): Um carnê com todas as suas parcelas
- [Segunda Via de Parcela](https://docs.garu.com.br/api-reference/carne/segunda-via.md): Emite um novo boleto para uma parcela vencida
- [Adiar Parcela](https://docs.garu.com.br/api-reference/carne/adiar.md): Move uma parcela para uma data posterior
- [Marcar Parcela como Paga](https://docs.garu.com.br/api-reference/carne/marcar-como-paga.md): Registra o pagamento de uma parcela quando o webhook não chegou
- [Cancelar Carnê](https://docs.garu.com.br/api-reference/carne/cancelar.md): Encerra o carnê e cancela os boletos em aberto
- [Solicitar Estorno de Carnê](https://docs.garu.com.br/api-reference/carne/solicitar-estorno.md): Abre um pedido de estorno — a Garu não move esse dinheiro
- [Listar Pedidos de Estorno](https://docs.garu.com.br/api-reference/estornos/listar.md): O que você ainda deve devolver a compradores
- [Detalhes do Pedido de Estorno](https://docs.garu.com.br/api-reference/estornos/detalhes.md): Um pedido de estorno
- [Confirmar Estorno](https://docs.garu.com.br/api-reference/estornos/confirmar.md): Registra que você já devolveu o dinheiro
- [Rejeitar Estorno](https://docs.garu.com.br/api-reference/estornos/rejeitar.md): Recusa o pedido; o carnê segue rodando
- [Solicitar Link Mágico](https://docs.garu.com.br/api-reference/portal-do-cliente/solicitar-link.md): Envia um link de acesso ao /minha-area para o e-mail registrado do cliente
- [Listar Cobranças do Cliente](https://docs.garu.com.br/api-reference/portal-do-cliente/listar-cobrancas.md): Cross-seller: cobranças do cliente em todos os vendedores
- [Atualizar E-mail de Cobrança](https://docs.garu.com.br/api-reference/portal-do-cliente/atualizar-email.md): Define ou limpa o e-mail de cobrança específico do cliente para um vendedor
- [Consultar Taxas Negociadas](https://docs.garu.com.br/api-reference/seller-config/taxas.md): Retorna as taxas efetivas do seu cadastro
- [Webhooks](https://docs.garu.com.br/api-reference/webhooks.md): Receba notificações em tempo real sobre eventos de pagamento
- [Códigos de falha](https://docs.garu.com.br/api-reference/webhooks/codigos-de-falha.md): Enum normalizado GaruFailureCode para rotear falhas de pagamento
- [Disparar webhook manualmente](https://docs.garu.com.br/api-reference/webhooks/disparar-manualmente.md): Substituto leve de sandbox: dispare um payload de exemplo de qualquer evento já assinado
- [Listar Eventos de Webhook](https://docs.garu.com.br/api-reference/webhooks/eventos/listar.md): Liste eventos de webhook com filtros de status, tipo e endpoint
- [Detalhes do Evento de Webhook](https://docs.garu.com.br/api-reference/webhooks/eventos/detalhes.md): Busque um evento de webhook pelo uuid com payload, tentativas e última resposta do endpoint
- [Reenviar (clonando) Evento de Webhook](https://docs.garu.com.br/api-reference/webhooks/eventos/resend.md): Clona um evento e dispara a entrega imediatamente, preservando o original intacto
- [Reenviar Evento de Webhook](https://docs.garu.com.br/api-reference/webhooks/eventos/reenviar.md): Reseta um evento para pending e dispara a entrega imediatamente
- [Exemplos de Código](https://docs.garu.com.br/api-reference/exemplos.md): Implementações completas em várias linguagens de programação
- [Solução de Problemas](https://docs.garu.com.br/api-reference/troubleshooting.md): Resolva erros comuns e problemas de integração

## OpenAPI Specs

- [openapi](https://docs.garu.com.br/api-reference/openapi.json)

## Optional

- [Dashboard](https://garu.com.br/inicio)
- [OpenAPI](https://garu.com.br/api/openapi.json)