Skip to main content
Este guia leva você da conta WovePay até a primeira cobrança PIX confirmada por webhook. Tempo estimado: 15–20 minutos.

Pré-requisitos

  • Conta em app.wovepay.com
  • Backend ou ferramenta que faça HTTP (curl, Postman, seu servidor)
  • URL HTTPS pública para webhooks (em dev, use ngrok ou similar)

1. Criar a chave de API

Tutorial com screenshots: Criar chave de API.
  1. Acesse Integrações → API
  2. Clique em Nova chave
  3. Preencha:
    • Descrição: ex. Produção ERP
    • Escopo / permissões: comece com Escrita ou Leitura + payment-pix/create e webhooks/create
  4. Copie o wp_live_... — ele aparece uma única vez
Guarde em variável de ambiente:
Não existe sandbox separado. Todas as chaves são de produção; teste com valores baixos (ex. R$ 1,00).
Detalhes de permissões: Permissões da API key · Chaves de API.

2. Testar autenticação

Resposta esperada (envelope padrão):
Se receber 401, confira o header X-API-Key. Se 403, ajuste permissões ou IP allowlist no dashboard.

3. Criar uma cobrança PIX

Na resposta, use: Mostre o QR ou o copia e cola para o pagador. Guia completo: Receber PIX.

4. Cadastrar webhook

Anote o whsec_... retornado — só aparece na criação. Guia passo a passo: Webhooks na prática.
Endpoints criados por API key só recebem eventos de transações criadas pela mesma chave.

5. Confirmar o pagamento

Após o pagador concluir o PIX:
  1. Sua URL recebe POST com evento payment.paid
  2. Valide x-WovePay-signature com o whsec_...
  3. Use data.externalReference para marcar o pedido como pago no seu sistema
Alternativa sem webhook: GET /v1/payment-pix/get/{id} — mas prefira webhooks em produção.

Checklist de produção

  • Chave com permissões mínimas (não use full sem necessidade)
  • WovePay_API_KEY em secret manager, nunca no repositório
  • Webhook com HTTPS e validação HMAC
  • Idempotência pelo id da entrega webhook
  • externalReference em toda cobrança para reconciliação
  • Tratamento de 429 (100 req/min por chave)

Próximos passos

Receber PIX

Fluxo completo de cobrança e reconciliação.

Webhooks

Código de validação HMAC e idempotência.

Integração com IA

Use llms.txt no Cursor, Claude ou ChatGPT.

API Reference

Todas as rotas e playground interativo.