Esta documentação descreve os diferentes tipos de eventos enviados via webhook pela plataforma. Sempre que umsaque tiver uma mudança de status, a plataforma envia uma notificação HTTP (webhook) para a URL configurada.Cada webhook possui um campo chamado eventType que define o tipo de evento.
Tipos de Evento (eventType)#
WITHDRAW#
Evento enviado quando o eventType é WITHDRAWAL, que representa uma retirada de valores da conta.
Possíveis Status de Saques#
| eventType | Status | Descrição |
|---|
| WITHDRAWAL_PENDING | PENDING | Solicitação de saque criada e aguardando análise. |
| WITHDRAWAL_APPROVED | APPROVED | Saque aprovado e aguardando envio ao banco. |
| WITHDRAWAL_REJECTED | REJECTED | Saque recusado por erro, saldo insuficiente ou análise. |
| WITHDRAWAL_PROCESSING | PROCESSING | Solicitação em processamento junto à instituição financeira. |
| WITHDRAWAL_PAID | PAID | Saque concluído com sucesso e valor enviado ao destinatário. |
| WITHDRAWAL_FAILED | FAILED | Erro ao processar o saque junto ao banco. |
| WITHDRAWAL_REFUNDED | REFUNDED | Valor do saque foi estornado para o saldo da conta. |
| WITHDRAWAL_CANCELED | CANCELED | Solicitação de saque foi cancelada antes da execução. |
| WITHDRAWAL_BLOCKED | BLOCKED | Saque bloqueado por motivos de segurança ou compliance. |
📦 Exemplo de Payload para WITHDRAWAL#
Saque Pendente
{
"eventType": "WITHDRAWAL_PENDING",
"id": "1af092f9-8fdb-48a9-a4cc-8e7de515a3cf",
"amount": 279000,
"method": "PIX",
"pixKey": "58523519000134",
"pixKeyType": "CNPJ",
"status": "PENDING",
"withdrawalType": "MANUAL",
"approvedAt": null,
"externalRef": null,
"processedAt": null,
"createdAt": "2025-07-09T09:27:39.811Z"
},
Saque Aprovado (MANUAL)
{
"eventType": "WITHDRAWAL_APPROVED",
"id": "1af092f9-8fdb-48a9-a4cc-8e7de515a3cf",
"amount": 279000,
"method": "PIX",
"pixKey": "58523519000134",
"pixKeyType": "CNPJ",
"status": "PENDING",
"withdrawalType": "MANUAL",
"approvedAt": null,
"externalRef": null,
"processedAt": null,
"createdAt": "2025-07-09T09:27:39.811Z"
},
Saque Rejeitado (MANUAL)
{
"eventType": "WITHDRAWAL_REJECTED",
"id": "1af092f9-8fdb-48a9-a4cc-8e7de515a3cf",
"amount": 279000,
"method": "PIX",
"pixKey": "58523519000134",
"pixKeyType": "CNPJ",
"status": "PENDING",
"withdrawalType": "MANUAL",
"approvedAt": null,
"externalRef": null,
"processedAt": null,
"createdAt": "2025-07-09T09:27:39.811Z"
},
Saque Pago
{
"eventType": "WITHDRAWAL_PAID",
"id": "1af092f9-8fdb-48a9-a4cc-8e7de515a3cf",
"amount": 279000,
"method": "PIX",
"pixKey": "58523519000134",
"pixKeyType": "CNPJ",
"status": "PENDING",
"withdrawalType": "MANUAL",
"approvedAt": null,
"externalRef": null,
"processedAt": null,
"createdAt": "2025-07-09T09:27:39.811Z"
},
Saque Falhou
{
"eventType": "WITHDRAWAL_FAILED",
"id": "1af092f9-8fdb-48a9-a4cc-8e7de515a3cf",
"amount": 279000,
"method": "PIX",
"pixKey": "58523519000134",
"pixKeyType": "CNPJ",
"status": "PENDING",
"withdrawalType": "MANUAL",
"approvedAt": null,
"externalRef": null,
"processedAt": null,
"createdAt": "2025-07-09T09:27:39.811Z"
},
Modificado em 2025-11-17 12:38:40