Skip to main content
Webhooks são requisições POST que a plataforma envia para a URL do seu servidor quando eventos importantes acontecem — como um PIX recebido, uma transferência liquidada ou um MED aberto. Em vez de consultar a API repetidamente, você reage a eventos conforme eles ocorrem.

​
Eventos disponíveis

EventoQuando é disparado
PAYMENTCobrança criada ou com status alterado
TRANSFERTransferência criada ou com status alterado
REFUNDEstorno processado
MEDMED recebido ou com status alterado

​
Como funciona

  1. Você registra uma URL na plataforma via API
  2. A plataforma envia um POST para essa URL a cada evento
  3. Seu servidor valida a assinatura HMAC no header X-Webhook-Signature
  4. Seu servidor responde com HTTP 2xx para confirmar o recebimento
Sempre valide a assinatura HMAC antes de processar o payload. Implemente idempotência usando o uuid do objeto no evento — o mesmo webhook pode ser reenviado em caso de falha.

​
Referência da API

Criar Webhook

POST /api/v1/webhooks

Listar Webhooks

GET /api/v1/webhooks

Detalhar Webhook

GET /api/v1/webhooks/{uuid}

Excluir Webhook

DELETE /api/v1/webhooks/{uuid}

​
Eventos detalhados

Estrutura geral

Estrutura geral e headers

Validação de assinatura

Validação de assinatura HMAC

Evento PAYMENT

Payload do evento de cobrança

Evento TRANSFER

Payload do evento de transferência

Evento MED

Payload do evento de MED

Evento PIX_TRANSACTION

Payload do evento de transação PIX