Evento de saque PIX iniciado

Quando um saque PIX é iniciado no sistema, você receberá um webhook com o evento pix.withdraw.initiated contendo todas as informações da transação de forma detalhada e organizada.

🏗️ Estrutura do Payload

🔑 Campos Principais

Campo	Tipo	Descrição
`data.event`	string	Tipo do evento (`pix.withdraw.initiated`)
`data.data`	object	Dados específicos da transação PIX
`id`	string	ID único do evento webhook
`apiKeyId`	string	ID da chave API que gerou o evento
`eventType`	string	Tipo do evento (igual a `data.event`)
`timestamp`	number	Timestamp Unix do evento

💰 Dados da Transação PIX

Campo	Tipo	Descrição
`pixId`	string	🆔 ID único da transação PIX
`uuid`	string	🔗 UUID da transação
`amount`	number	💵 Valor da transação em centavos
`status`	string	📊 Status atual da transação
`type`	string	📤 Tipo da transação (`WITHDRAW`)
`pixKeyType`	string	🔑 Tipo da chave PIX (`CNPJ`, `CPF`, `EMAIL`, `PHONE`, `RANDOM`)
`qrCodeId`	string	📱 ID do QR Code (null para saques)
`pixKey`	string	🎫 Chave PIX destino
`e2e`	string	🔗 ID end-to-end da transação PIX
`description`	string	📝 Descrição da transação
`providerReferenceId`	string	🏢 ID de referência do provedor
`expireAt`	string	⏰ Data/hora de expiração (ISO 8601)
`executedAt`	string	⏱️ Data/hora de execução (ISO 8601)
`provider`	string	🏦 Provedor de pagamento
`createdAt`	string	📅 Data/hora de criação (ISO 8601)
`updatedAt`	string	🔄 Data/hora de atualização (ISO 8601)
`senderInfo`	object	👤 Informações do remetente
`receiverInfo`	object	👥 Informações do destinatário
`feeBatchId`	string	💰 ID do lote de taxas
`feeDistributionCompletedAt`	string	✅ Data/hora de distribuição de taxas
`feeDistributionMetadata`	object	📊 Metadados da distribuição de taxas
`userId`	string	👤 ID do usuário que solicitou o saque
`tenantId`	string	🏢 ID do tenant/organização
`user`	object	👨‍💼 Dados do usuário
`timestamp`	string	🕐 Timestamp da criação (ISO 8601)

👤 Dados do Usuário

Campo	Tipo	Descrição
`user.id`	string	🆔 ID único do usuário
`user.email`	string	📧 Email do usuário
`user.name`	string	👨‍💼 Nome completo do usuário
`user.role`	string	👑 Função do usuário (`ADMIN`, `USER`)
`user.cognitoId`	string	🔐 ID do Cognito (autenticação)
`user.tenantId`	string	🏢 ID do tenant/organização
`user.managerId`	string	👨‍💼 ID do gerente responsável
`user.baasId`	string	🏦 ID do BaaS (Banking as a Service)
`user.paymentId`	string	💳 ID de pagamento do usuário
`user.level`	string	⭐ Nível do usuário (`premium`, `basic`)
`user.status`	string	📊 Status do usuário (`active`, `inactive`)
`user.complianceReviewDate`	string	📋 Data de revisão de compliance
`user.complianceReason`	string	📝 Motivo da revisão de compliance
`user.complianceAnalystId`	string	👨‍💻 ID do analista de compliance
`user.createdAt`	string	📅 Data de criação do usuário
`user.updatedAt`	string	🔄 Data de atualização do usuário
`user.assignedManagerId`	string	👨‍💼 ID do gerente designado
`user.profile`	object	👤 Perfil completo do usuário

📊 Status Possíveis

PENDING - ⏳ Transação aguardando processamento

📤 Tipos de Transação

WITHDRAW - 💸 Saque/envio de PIX

🔑 Tipos de Chave PIX

CPF - 👤 CPF da pessoa física
CNPJ - 🏢 CNPJ da pessoa jurídica
EMAIL - 📧 Email válido
PHONE - 📱 Telefone com DDD
RANDOM - 🔑 Chave aleatória

📝 Exemplo de Payload Completo

{
  "data": {
    "event": "pix.withdraw.initiated",
    "data": {
      "pix": {
        "id": "88eecafb-df8a-4dc9-acd7-438e120e889c",
        "userId": "d0d75271-d641-4c10-a765-69b96c15f4a9",
        "tenantId": "9a43ae9c-d7f2-43c6-a7d4-8706705e3d45",
        "qrCodeId": null,
        "uuid": "78147c97-abf3-4272-8256-84d94e5f6613",
        "pixKey": "12345678000199",
        "e2e": "",
        "pixKeyType": "CNPJ",
        "type": "WITHDRAW",
        "amount": 500,
        "description": "Saque PIX para empresa exemplo",
        "status": "PENDING",
        "providerReferenceId": "420026832",
        "expireAt": "2025-08-14T22:00:12.487Z",
        "executedAt": null,
        "provider": null,
        "createdAt": "2025-08-14T22:00:12.488Z",
        "updatedAt": "2025-08-14T22:00:15.836Z",
        "senderInfo": null,
        "receiverInfo": null,
        "feeBatchId": null,
        "feeDistributionCompletedAt": null,
        "feeDistributionMetadata": null,
        "user": {
          "id": "d0d75271-d641-4c10-a765-69b96c15f4a9",
          "email": "usuario@exemplo.com",
          "name": "João Silva Santos",
          "role": "USER",
          "cognitoId": "usuario@exemplo.com",
          "tenantId": "9a43ae9c-d7f2-43c6-a7d4-8706705e3d45",
          "managerId": null,
          "baasId": null,
          "paymentId": "1f052e22-45b4-6af5-a642-9a6d6e792081",
          "level": "premium",
          "status": "active",
          "complianceReviewDate": null,
          "complianceReason": null,
          "complianceAnalystId": null,
          "createdAt": "2025-05-13T15:49:20.894Z",
          "updatedAt": "2025-06-26T23:06:07.789Z",
          "assignedManagerId": null,
          "profile": null
        }
      },
      "timestamp": "2025-08-14T22:00:15.846Z"
    }
  },
  "id": "e27d27f9-ae26-4dc6-9d22-9294d7aac034",
  "apiKeyId": "0dd769bb-5e41-41c4-b8c2-6ec972914650",
  "eventType": "pix.withdraw.initiated",
  "timestamp": 1755208815854
}

🎯 Campos Principais

Campo	Descrição
`data.event`	🎪 Tipo do evento (`pix.withdraw.initiated`)
`data.data.pix.id`	🆔 ID único da transação PIX
`data.data.pix.amount`	💵 Valor da transação em centavos
`data.data.pix.status`	📊 Status atual da transação
`data.data.pix.type`	📤 Tipo da transação (`WITHDRAW`)
`data.data.pix.user.name`	👨‍💼 Nome do usuário
`data.data.pix.user.email`	📧 Email do usuário
`data.data.pix.user.role`	👑 Função do usuário
`data.data.pix.user.level`	⭐ Nível do usuário
`data.data.pix.expireAt`	⏰ Data/hora de expiração
`data.data.pix.providerReferenceId`	🏢 ID de referência do provedor
`id`	🆔 ID único do evento webhook
`timestamp`	🕐 Timestamp do evento