Skip to main content

​
Webhook de saque

Sempre que ocorre uma mudança de status em uma transferência (saque), a Pluggou envia um webhook para todos os endpoints ativos cadastrados na sua conta. Para entender o funcionamento geral dos webhooks (headers, segurança, tempo limite, retentativas e idempotência), consulte o guia geral de Webhooks.

​
Exemplo de webhook recebido

curl -X POST https://seusite.com/webhook \
  -H "Content-Type: application/json" \
  -H "X-Webhook-Event-ID: b2c3d4e5-f6a1-7890-bcde-234567890abc" \
  -H "X-Webhook-Code: whk_a8Kd92mNx7Pq3rT5vW1yZ0bC4eF6gH8jL0mN2pR4tV6x" \
  -H "User-Agent: Pluggou-Webhook/1.0" \
  -d '{
    "id": "d4e5f6a1-b2c3-7890-defg-34567890abcd",
    "event_type": "withdrawal",
    "data": {
        "id": "e5f6a1b2-c3d4-7890-efgh-4567890abcde",
        "e2e_id": "E12345678202301011234abcdefghijkl",
        "amount": 50000,
        "liquid_amount": 50000,
        "pix_type": "cpf",
        "pix_key": "12345678909",
        "status": "paid",
        "paid_at": "2026-01-29 15:00:00",
        "created_at": "2026-01-29 14:58:00"
    }
  }'

​
Campos do payload

CampoTipoDescrição
idstring (UUID)Identificador único deste evento de webhook.
event_typestringSempre "withdrawal" para webhooks de saque.
data.idstring (UUID)Identificador único do saque.
data.e2e_idstring | nullIdentificador end-to-end do PIX de saída gerado pelo banco. Disponível apenas após a transferência ser processada.
data.amountintegerValor total do saque em centavos.
data.liquid_amountintegerValor líquido transferido em centavos (após taxas de saque, se houver).
data.pix_typestringTipo da chave PIX de destino. Valores possíveis: cpf, cnpj, email, phone, random.
data.pix_keystringValor da chave PIX de destino do saque.
data.statusstringStatus atual do saque (veja tabela abaixo).
data.paid_atstring | nullData/hora em que o saque foi efetivado no formato "YYYY-MM-DD HH:mm:ss". null se ainda não foi pago.
data.created_atstringData/hora de criação do saque no formato "YYYY-MM-DD HH:mm:ss".

​
Status possíveis

StatusSignificado
pendingSaque solicitado e aguardando processamento ou aprovação.
approvedSaque aprovado e em processamento pela adquirente.
paidSaque efetivado. O valor foi transferido para a chave PIX de destino.
failedSaque falhou durante o processamento (erro na adquirente, dados inválidos, etc.).
canceledSaque cancelado antes de ser processado.
refundedValor do saque estornado e devolvido à carteira do usuário.