Webhook

Webhooks são notificações automáticas que a API envia sempre que ocorre um evento relacionado a um saque. Assim, você não precisa ficar consultando a API: basta receber e processar o evento quando ele chegar.

Eventos de webhook

Cada webhook representa uma mudança no ciclo de vida do saque.

Tipos de evento

Evento	Descrição
WITHDRAWAL_CREATED	Saque criado
WITHDRAWAL_APPROVED	Saque aprovado
WITHDRAWAL_PROCESSED	Saque processado
WITHDRAWAL_APPROVED_AND_PROCESSED	Saque aprovado e processado
WITHDRAWAL_CANCELED	Saque cancelado
WITHDRAWAL_REFUNDED	Saque estornado
WITHDRAWAL_REJECTED	Saque rejeitado

Dados do webhook

Campo	Tipo	Obrigatório	Descrição
type	string (enum) - WITHDRAWAL_CREATED, WITHDRAWAL_APPROVED, WITHDRAWAL_PROCESSED, WITHDRAWAL_APPROVED_AND_PROCESSED, WITHDRAWAL_CANCELED, WITHDRAWAL_REFUNDED, WITHDRAWAL_REJECTED	Sim	Tipo do evento
data	object	Sim	Dados do saque (ver Sub-Objetos data)

Sub-Objetos

data

Campo	Tipo	Obrigatório	Descrição
id	string (UUID)	Sim	Identificador único do saque
externalCode	string	Sim	Seu código de referência (pode ser nulo)
amount	number	Sim	Valor do saque (inteiro em centavos)
method	string (enum) - PIX	Sim	Método do saque
status	string (enum) - PENDING, PROCESSING, PROCESSED, FAILED, CANCELED, REFUNDED, REJECTED	Sim	PENDING: Saque criado, aguardando processamento PROCESSING: Saque em processamento PROCESSED: Saque processado com sucesso FAILED: Erro no processamento CANCELED: Saque cancelado REFUNDED: Saque estornado REJECTED: Saque rejeitado pela gateway
pixKey	object	Sim	Chave PIX (ver Sub-Objetos PixKeyVo)
createdAt	string (ISO)	Sim	Data de criação
endToEnd	string	Sim	Identificador end-to-end do saque (pode ser nulo)
receiver	object	Não	Dados do recebedor (ver Sub-Objetos AccountHolder)
payer	object	Não	Dados do pagador (ver Sub-Objetos AccountHolder)
amountWithdrawn	number	Não	Valor efetivamente sacado
processedDate	string (ISO)	Não	Data de processamento

AccountHolder

Campo	Tipo	Obrigatório	Descrição
type	string (enum) - PF, PJ	Sim	Tipo do titular
name	string	Sim	Nome do titular
document	string	Sim	Documento do titular
bankAccount	object	Sim	Dados bancários (ver Sub-Objetos BankAccount)
pix	object	Sim	Chave PIX do titular (ver Sub-Objetos PixKeyVo)

BankAccount

Campo	Tipo	Obrigatório	Descrição
type	string	Sim	Tipo de conta
branch	string	Sim	Agência
number	string	Sim	Número da conta
digit	string	Sim	Dígito da conta
ispb	string	Sim	ISPB do banco

PixKeyVo

Campo	Tipo	Obrigatório	Descrição
key	string	Sim	Chave PIX
type	string (enum) - CPF, CNPJ, EMAIL, PHONE, EVP	Sim	Tipo da chave PIX

Exemplo de payload

{
  "type": "WITHDRAWAL_PROCESSED",
  "data": {
    "id": "553e8400-e29b-41d4-a716-436251480000",
    "externalCode": "SAQUE-123",
    "amount": 10000,
    "method": "PIX",
    "status": "PROCESSED",
    "pixKey": {
      "key": "12345678910",
      "type": "CPF"
    },
    "createdAt": "2026-03-06T12:49:04.681Z",
    "endToEnd": "0123456789",
    "receiver": {
      "type": "PJ",
      "name": "Empresa Exemplo LTDA",
      "document": "12345678000199",
      "bankAccount": {
        "type": "CHECKING",
        "branch": "0001",
        "number": "654321",
        "digit": "0",
        "ispb": "12345678"
      },
      "pix": {
        "key": "contato@exemplo.com",
        "type": "EMAIL"
      }
    },
    "payer": {
      "type": "PF",
      "name": "Fulano de Tal",
      "document": "12345678910",
      "bankAccount": {
        "type": "CHECKING",
        "branch": "0001",
        "number": "123456",
        "digit": "7",
        "ispb": "12345678"
      },
      "pix": {
        "key": "12345678910",
        "type": "CPF"
      }
    },
    "amountWithdrawn": 10000,
    "processedDate": "2026-03-06T12:49:04.681Z"
  }
}