Início Rápido

Visão Geral

Este guia vai te ajudar a:

Obter sua chave de API
Criar seu primeiro produto
Gerar o link de pagamento
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

Acesse o Dashboard

Faça login no Dashboard da Garu

Navegue até Desenvolvedores

Vá para Configurações → Desenvolvedores

Crie uma chave de teste

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

Salve sua chave

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

Inclua sua chave de API no header Authorization de todas as requisições:

Authorization: Bearer sk_test_sua_chave_api

Nunca exponha sua chave de API em código frontend ou repositórios públicos.

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/v1/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
  }'

const response = await fetch('https://garu.com.br/api/v1/products', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer sk_test_sua_chave',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    name: 'Meu Primeiro Produto',
    description: 'Produto de teste criado via API',
    value: 49.90,
    pix: true,
    creditCard: true,
    boleto: true,
    installments: 6
  })
});

const produto = await response.json();
console.log(produto);

import requests

response = requests.post(
    'https://garu.com.br/api/v1/products',
    headers={
        'Authorization': 'Bearer sk_test_sua_chave',
        'Content-Type': 'application/json'
    },
    json={
        'name': 'Meu Primeiro Produto',
        'description': 'Produto de teste criado via API',
        'value': 49.90,
        'pix': True,
        'creditCard': True,
        'boleto': True,
        'installments': 6
    }
)

produto = response.json()
print(produto)

Passo 3: Obtenha o Link de Pagamento

A resposta da API incluirá um campo uuid. Use-o para construir o link de pagamento. Veja mais detalhes em Link de Pagamento.

{
  "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

Abra o link de pagamento no navegador
Preencha os dados de teste
Escolha um método de pagamento (PIX é o mais rápido para testar)
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.

Acesse Configurações → Webhooks no Dashboard
Adicione a URL do seu endpoint (ex: https://seusite.com/webhooks/garu)
Selecione o evento transaction.paid
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 });
});

E se eu quiser o pagamento na minha própria tela?

Os passos acima levam o cliente para uma página hospedada pela Garu — é o caminho mais rápido e cobre a maioria dos casos. Se você precisa que o pagamento aconteça dentro da sua interface, com a sua marca do começo ao fim, troque o Passo 3 por uma chamada de cobrança:

curl -X POST https://garu.com.br/api/v1/charges \
  -H "Authorization: Bearer sk_live_sua_chave_api" \
  -H "Content-Type: application/json" \
  -d '{
    "productId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "paymentMethod": "pix",
    "customer": {
      "name": "Maria Silva",
      "email": "maria@exemplo.com.br",
      "document": "12345678909",
      "phone": "11987654321"
    }
  }'

A resposta traz o código PIX copia-e-cola em pix.code, que você renderiza como QR Code no seu front. Nada de redirecionamento.

Checkout Transparente

O guia completo: PIX, boleto com PDF servido pela Garu, cartão e as implicações de PCI.

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.

Checkout Transparente

Receba PIX, boleto e cartão dentro da sua própria interface.

Boleto Parcelado (Carnê)

Venda um produto em até 12 boletos mensais. Leia antes de ativar: o risco de inadimplência é seu, não da Garu.

Primeiros Passos

Integrando Pagamentos

Ferramentas para Agentes

Integrações

Início Rápido

Visão Geral

Passo 1: Obtenha sua Chave de API

Passo 2: Crie seu Primeiro Produto

Passo 3: Obtenha o Link de Pagamento

Passo 4: Teste o Pagamento

Passo 5: Configure Webhooks (Opcional)

E se eu quiser o pagamento na minha própria tela?

Checkout Transparente

Próximos Passos

Guia Completo de Produtos

Autenticação

Webhooks

Ir para Produção

Checkout Transparente

Boleto Parcelado (Carnê)

​Visão Geral

​Passo 1: Obtenha sua Chave de API

​Passo 2: Crie seu Primeiro Produto

​Passo 3: Obtenha o Link de Pagamento

​Passo 4: Teste o Pagamento

​Passo 5: Configure Webhooks (Opcional)

​E se eu quiser o pagamento na minha própria tela?

Checkout Transparente

​Próximos Passos

Guia Completo de Produtos

Autenticação

Webhooks

Ir para Produção

Checkout Transparente

Boleto Parcelado (Carnê)

Visão Geral

Passo 1: Obtenha sua Chave de API

Passo 2: Crie seu Primeiro Produto

Passo 3: Obtenha o Link de Pagamento

Passo 4: Teste o Pagamento

Passo 5: Configure Webhooks (Opcional)

E se eu quiser o pagamento na minha própria tela?

Próximos Passos