Skip to main content

​
Visão Geral

Este guia vai te ajudar a:
  1. Obter sua chave de API
  2. Criar seu primeiro produto
  3. Gerar o link de pagamento
  4. Receber seu primeiro pagamento
Você pode completar todo este guia usando chaves de teste (sk_test_). Nenhuma cobrança real será processada.

​
Passo 1: Obtenha sua Chave de API

1

Acesse o Dashboard

Faça login no Dashboard da Garu
2

Navegue até Desenvolvedores

Vá para Configurações → Desenvolvedores
3

Crie uma chave de teste

Clique em Criar chave de API e selecione o ambiente Teste (sk_test_)
4

Salve sua chave

Copie e salve a chave em um local seguro. Ela só será exibida uma vez!

​
Passo 2: Crie seu Primeiro Produto

Use o comando abaixo para criar um produto. Substitua sk_test_sua_chave pela sua chave de API.
Veja todos os campos disponíveis na API de Criação de Produtos.
curl -X POST https://garu.com.br/api/products \
  -H "Authorization: Bearer sk_test_sua_chave" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Meu Primeiro Produto",
    "description": "Produto de teste criado via API",
    "value": 49.90,
    "pix": true,
    "creditCard": true,
    "boleto": true,
    "installments": 6
  }'
A resposta da API incluirá um campo uuid. Use-o para construir o link de pagamento. Veja mais detalhes em Link de Pagamento. 
{
  "id": 123,
  "name": "Meu Primeiro Produto",
  "value": 49.90,
  "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  ...
}
Seu link de pagamento: 
https://garu.com.br/pay/a1b2c3d4-e5f6-7890-abcd-ef1234567890
Pronto! Compartilhe este link com seus clientes para receber pagamentos.

​
Passo 4: Teste o Pagamento

  1. Abra o link de pagamento no navegador
  2. Preencha os dados de teste
  3. Escolha um método de pagamento (PIX é o mais rápido para testar)
  4. Complete o pagamento de teste
Em modo de teste, os pagamentos não são reais. Use para validar sua integração antes de ir para produção.

​
Passo 5: Configure Webhooks (Opcional)

Para receber notificações quando um pagamento for confirmado. Consulte a documentação de Webhooks para todos os eventos disponíveis.
  1. Acesse Configurações → Webhooks no Dashboard
  2. Adicione a URL do seu endpoint (ex: https://seusite.com/webhooks/garu)
  3. Selecione o evento transaction.paid
  4. Salve o segredo do webhook para validar as requisições
// Exemplo de handler de webhook
app.post('/webhooks/garu', (req, res) => {
  const { event, data } = req.body;

  if (event === 'transaction.paid') {
    console.log(`Pagamento confirmado: ${data.id}`);
    console.log(`Cliente: ${data.customer.email}`);
    // Liberar acesso ao produto, enviar email, etc.
  }

  res.status(200).json({ received: true });
});

​
Próximos Passos

Guia Completo de Produtos

Aprenda todas as opções disponíveis para criar produtos.

Autenticação

Entenda como funciona a autenticação da API.

Webhooks

Configure notificações em tempo real.

Ir para Produção

Checklist para lançar em produção.