Skip to main content

​
1. Crie sua conta

Acesse console.pagozz.com e entre com seu email. Você receberá um magic link para acessar o painel.

​
2. Gere uma API Key

Vá em Configurações → Chaves de API e crie uma nova chave.
Sua chave será exibida apenas uma vez. Guarde-a em um local seguro.
Você receberá uma chave no formato: 
pgz_test_XXXXXXXXXXXXXXXXXXXXXXXX   # Sandbox (pagamentos simulados)
pgz_live_XXXXXXXXXXXXXXXXXXXXXXXX   # Produção (pagamentos reais)
O prefixo determina o ambiente automaticamente. 
curl -X POST https://api.pagozz.com/v1/links \
  -H "Content-Type: application/json" \
  -H "Pagozz-Token: pgz_test_XXXXXXXXXXXXXXXXXXXXXXXX" \
  -d '{
    "name": "Consultoria 1h",
    "amount": 15000,
    "value_mode": "fixed",
    "payment_methods": ["pix"]
  }'
Resposta: 
{
  "data": {
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "name": "Consultoria 1h",
    "amount": 15000,
    "value_mode": "fixed",
    "payment_methods": ["pix"],
    "status": "active",
    "url": "https://checkout.pagozz.com/test_eyJhbGciOi...",
    "created_at": "2026-03-10T10:30:00Z"
  }
}
Envie a url retornada para seu cliente. Ao acessar, ele verá o formulário de checkout com QR Code PIX.

​
5. Receba notificações

Configure um webhook para ser notificado quando o pagamento for confirmado: 
curl -X POST https://api.pagozz.com/v1/webhooks \
  -H "Content-Type: application/json" \
  -H "Pagozz-Token: pgz_test_XXXXXXXXXXXXXXXXXXXXXXXX" \
  -d '{
    "url": "https://meusite.com/webhooks/pagozz",
    "events": ["payment.succeeded", "payment.failed"]
  }'

​
6. Teste o fluxo completo

Com a chave pgz_test_*, você pode simular pagamentos sem PIX real: 
# Criar pagamento no link
curl -X POST https://api.pagozz.com/v1/payments/pix \
  -H "Content-Type: application/json" \
  -H "Pagozz-Token: pgz_test_XXXXXXXXXXXXXXXXXXXXXXXX" \
  -d '{
    "link_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "payer": {
      "email": "cliente@email.com",
      "cpf": "12345678900"
    }
  }'

# Simular pagamento confirmado
curl -X POST https://api.pagozz.com/v1/payments/{transaction_id}/simulate/succeed \
  -H "Pagozz-Token: pgz_test_XXXXXXXXXXXXXXXXXXXXXXXX"
Pronto! Seu webhook receberá um evento payment.succeeded com os dados do pagamento.

​
Próximos passos

Ambientes

Entenda a diferença entre test e live.

Links de pagamento

Configure vencimentos, descontos e campos customizados.

Webhooks

Receba eventos e verifique assinaturas.

SDK TypeScript

Integre com nosso SDK oficial.