Evento de criação de PIX para deposito

Quando um novo PIX é criado no sistema, você receberá um webhook com o evento pix.created 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.created`)
`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 (`DEPOSIT`)
`pixKeyType`	string	🔑 Tipo da chave PIX (`QRCODE`)
`qrCodeId`	string	📱 ID do QR Code gerado
`pixKey`	string	🎫 Chave PIX ou QR Code completo
`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 criou a transação
`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 pagamento

📥 Tipos de Transação

DEPOSIT - 💰 Depósito/recebimento de PIX

🔑 Tipos de Chave PIX

QRCODE - 📱 QR Code estático ou dinâmico

📝 Exemplo de Payload Completo

{
  "data": {
    "event": "pix.created",
    "data": {
      "pix": {
        "id": "p1x2i3d4-e5f6-7890-abcd-ef1234567890",
        "userId": "u1s2e3r4-i5d6-7f8g-9h0i-j1k2l3m4n5o6",
        "tenantId": "t1e2n3a4-n5t6-7i8d-9j0k-l1m2n3o4p5q6",
        "qrCodeId": "q1r2c3o4-d5e6-7890-f1g2-h3i4j5k6l7m8",
        "uuid": "u1u2i3d4-v5a6-7890-abcd-ef1234567890",
        "pixKey": "00020101021226770014BR.GOV.BCB.PIX2555api.itau/pix/qr/v2/12345678-9abc-def0-1234-567890abcdef5204000053039865802BR5919ETHER GLOBAL ASSETS6009SAO PAULO62070503***6304ABCD",
        "e2e": "",
        "pixKeyType": "QRCODE",
        "type": "DEPOSIT",
        "amount": 550,
        "description": null,
        "status": "PENDING",
        "providerReferenceId": "FOUR_ALL",
        "expireAt": "2025-08-13T18:02:13.430Z",
        "executedAt": null,
        "provider": null,
        "createdAt": "2025-08-13T17:52:13.656Z",
        "updatedAt": "2025-08-13T17:52:13.656Z",
        "senderInfo": null,
        "receiverInfo": null,
        "feeBatchId": null,
        "feeDistributionCompletedAt": null,
        "feeDistributionMetadata": null,
        "user": {
          "id": "u1s2e3r4-i5d6-7f8g-9h0i-j1k2l3m4n5o6",
          "email": "pedro.santos@empresa.com.br",
          "name": "Pedro Santos Oliveira",
          "role": "ADMIN",
          "cognitoId": "pedro.santos@empresa.com.br",
          "tenantId": "t1e2n3a4-n5t6-7i8d-9j0k-l1m2n3o4p5q6",
          "managerId": null,
          "baasId": null,
          "paymentId": "p1a2y3m4-e5n6-7t8i-9d0-1p2a3y4m5e6n7",
          "level": "premium",
          "status": "active",
          "complianceReviewDate": null,
          "complianceReason": null,
          "complianceAnalystId": null,
          "createdAt": "2025-03-17T17:55:47.927Z",
          "updatedAt": "2025-06-13T15:18:12.290Z",
          "assignedManagerId": null,
          "profile": null
        }
      },
      "timestamp": "2025-08-13T17:52:13.752Z"
    }
  },
  "id": "ev1nt2id3-4ev5-6nt7-8id9-0ev1nt2id3ev4",
  "apiKeyId": "ap1k2ey3-4ap5-6ke7-8y9-0ap1k2ey3ap4",
  "eventType": "pix.created",
  "timestamp": 1755107533825
}

🎯 Campos Principais

Campo	Descrição
`data.event`	🎪 Tipo do evento (`pix.created`)
`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 (`DEPOSIT`)
`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