Pular para o conteúdo principal

Webhook de Saque

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

Se você trabalha com transações, veja Webhook de Transação.

Eventos suportados​

EventoQuando é enviado
WITHDRAWAL_CREATEDQuando o saque é criado
WITHDRAWAL_APPROVEDQuando o saque é aprovado
WITHDRAWAL_PROCESSEDQuando o saque é processado
WITHDRAWAL_APPROVED_AND_PROCESSEDQuando o saque é aprovado e processado
WITHDRAWAL_CANCELEDQuando o saque é cancelado
WITHDRAWAL_REFUNDEDQuando o saque é estornado
WITHDRAWAL_REJECTEDQuando o saque é rejeitado
WITHDRAWAL_FAILEDQuando o saque falha

Formato do payload​

CampoTipoObrigatórioDescrição
typestring (enum) - WITHDRAWAL_CREATED, WITHDRAWAL_APPROVED, WITHDRAWAL_PROCESSED, WITHDRAWAL_APPROVED_AND_PROCESSED, WITHDRAWAL_CANCELED, WITHDRAWAL_REFUNDED, WITHDRAWAL_REJECTED, WITHDRAWAL_FAILEDSimTipo do evento enviado no webhook
dataobjectSimDados do saque

Payload base​

Esses campos estão presentes em todos os webhooks de saque.

CampoTipoObrigatórioDescrição
idstring (UUID)SimIdentificador único do saque
externalCodestringSimSeu código de referência
amountnumberSimValor do saque, em centavos
methodstring (enum) - PIXSimMétodo do saque
statusstring (enum) - PENDING, PROCESSING, PROCESSED, FAILED, CANCELED, REFUNDED, REJECTED, PENDING_COMPLIANCESim
  • 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
  • PENDING_COMPLIANCE: saque pendente de análise de compliance
createdAtstring (ISO)SimData de criação
endToEndstringSimIdentificador end-to-end do saque

Variações por evento​

WITHDRAWAL_CREATED, WITHDRAWAL_APPROVED e WITHDRAWAL_REJECTED​

Usam apenas o payload base.

WITHDRAWAL_PROCESSED e WITHDRAWAL_APPROVED_AND_PROCESSED​

Além do payload base, adicionam:

CampoTipoObrigatórioDescrição
pixKeyobjectSimChave PIX (ver Sub-Objeto PixKeyVo)
trackingKeystringNãoClave de rastreo do SPEI. Vem sempre null em saques PIX
receiverobjectNãoDados do recebedor (ver Sub-Objeto AccountHolder)
payerobjectNãoDados do pagador (ver Sub-Objeto AccountHolder)
amountWithdrawnnumberNãoValor efetivamente sacado
processedDatestring (ISO)NãoData de processamento
paymentReceiptstringNãoURL do comprovante

WITHDRAWAL_CANCELED e WITHDRAWAL_FAILED​

Além do payload base, adicionam:

CampoTipoObrigatórioDescrição
reasonstringNãoMotivo do cancelamento ou da falha, quando informado

WITHDRAWAL_REFUNDED​

Além do payload base, adiciona:

CampoTipoObrigatórioDescrição
refundAmountnumberSimValor do estorno
refundDatestring (ISO)NãoData do estorno
endToEndRefundstringNãoIdentificador end-to-end do estorno
refundReceiptstringNãoURL do comprovante de estorno

Sub-Objetos​

AccountHolder​

CampoTipoObrigatórioDescrição
typestring (enum) - PF, PJSimTipo do titular
namestringSimNome do titular
documentstringSimDocumento do titular
bankAccountobjectSimDados bancários (ver Sub-Objeto BankAccount)
pixobjectSimChave PIX do titular (ver Sub-Objeto PixKeyVo)

BankAccount​

CampoTipoObrigatórioDescrição
typestringSimTipo de conta
digitstringSimDígito da conta
ispbstringSimISPB do banco

PixKeyVo​

CampoTipoObrigatórioDescrição
keystringSimChave PIX
typestring (enum) - CPF, CNPJ, EMAIL, PHONE, EVPSimTipo da chave PIX

SpeiAccountVo​

CampoTipoObrigatórioDescrição
clabeobjectSimCLABE da conta de destino, no campo value
holderNamestringSimNome do titular da conta
institutionIdstringNãoIdentificador da instituição de destino

Exemplo de payload​

Dados mascarados

Valores sensíveis podem estar mascarados com ***.

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