Evento de deposito PIX confirmado

Quando um PIX de depósito é confirmado e processado com sucesso no sistema, você receberá um webhook com o evento pix.deposit.confirmed contendo todas as informações da transação confirmada de forma detalhada e organizada.

🏗️ Estrutura do Payload

🔑 Campos Principais

Campo

Tipo

Descrição

data.event

string

Tipo do evento (pix.deposit.confirmed)

data.data

object

Dados específicos da transação PIX confirmada

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

pix.id

string

🆔 ID único da transação PIX

pix.uuid

string

🔗 UUID da transação

pix.amount

number

💵 Valor da transação em centavos

pix.status

string

📊 Status atual da transação

pix.type

string

📥 Tipo da transação (DEPOSIT)

pix.pixKeyType

string

🔑 Tipo da chave PIX (QRCODE)

pix.qrCodeId

string

📱 ID do QR Code gerado

pix.pixKey

string

🎫 Chave PIX ou QR Code

pix.e2e

string

🔗 ID end-to-end da transação PIX

pix.description

string

📝 Descrição da transação

pix.providerReferenceId

string

🏢 ID de referência do provedor

pix.expireAt

string

⏰ Data/hora de expiração (ISO 8601)

pix.executedAt

string

⏱️ Data/hora de execução (ISO 8601)

pix.provider

string

🏦 Provedor de pagamento

pix.createdAt

string

📅 Data/hora de criação (ISO 8601)

pix.updatedAt

string

🔄 Data/hora de atualização (ISO 8601)

pix.senderInfo

object

👤 Informações do remetente

pix.receiverInfo

object

👥 Informações do destinatário

pix.feeBatchId

string

💰 ID do lote de taxas

pix.feeDistributionCompletedAt

string

✅ Data/hora de distribuição de taxas

pix.feeDistributionMetadata

object

📊 Metadados da distribuição de taxas

pix.userId

string

👤 ID do usuário que criou a transação

pix.tenantId

string

🏢 ID do tenant/organização

pix.user

object

👨‍💼 Dados do usuário

timestamp

string

🕐 Timestamp da confirmação (ISO 8601)

👤 Dados do Usuário

Campo

Tipo

Descrição

pix.user.id

string

🆔 ID único do usuário

pix.user.email

string

📧 Email do usuário

pix.user.name

string

👨‍💼 Nome completo do usuário

pix.user.role

string

👑 Função do usuário (ADMIN, USER)

pix.user.cognitoId

string

🔐 ID do Cognito (autenticação)

pix.user.tenantId

string

🏢 ID do tenant/organização

pix.user.managerId

string

👨‍💼 ID do gerente responsável

pix.user.baasId

string

🏦 ID do BaaS (Banking as a Service)

pix.user.paymentId

string

💳 ID de pagamento do usuário

pix.user.level

string

⭐ Nível do usuário (premium, basic)

pix.user.status

string

📊 Status do usuário (active, inactive)

pix.user.complianceReviewDate

string

📋 Data de revisão de compliance

pix.user.complianceReason

string

📝 Motivo da revisão de compliance

pix.user.complianceAnalystId

string

👨‍💻 ID do analista de compliance

pix.user.createdAt

string

📅 Data de criação do usuário

pix.user.updatedAt

string

🔄 Data de atualização do usuário

pix.user.assignedManagerId

string

👨‍💼 ID do gerente designado

pix.user.profile

object

👤 Perfil completo do usuário

📊 Status Possíveis

  • CONFIRMED - ✅ Transação confirmada e processada

📥 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.deposit.confirmed",
    "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": "",
        "e2e": "E12345678920250813123456ABCDEF123456",
        "pixKeyType": "QRCODE",
        "type": "DEPOSIT",
        "amount": 500,
        "description": null,
        "status": "CONFIRMED",
        "providerReferenceId": "123456789",
        "expireAt": null,
        "executedAt": "2025-08-13T18:07:45.453Z",
        "provider": "FOUR_ALL",
        "createdAt": "2025-08-13T18:05:06.397Z",
        "updatedAt": "2025-08-13T18:07:45.634Z",
        "senderInfo": {
          "bank": {
            "code": "12345678",
            "ispb": "12345678",
            "name": "BANCO EXEMPLO"
          },
          "name": "MARIA SILVA SANTOS",
          "account": {
            "type": "CHECKING_ACCOUNT",
            "digit": "1",
            "agency": "0001",
            "number": "12345678"
          },
          "document": "12345678000199"
        },
        "receiverInfo": {
          "name": "PEDRO SANTOS OLIVEIRA",
          "userId": "u1s2e3r4-i5d6-7f8g-9h0i-j1k2l3m4n5o6",
          "document": "12.345.678/0001-99",
          "documentType": "CNPJ"
        },
        "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-05-13T15:49:20.894Z",
          "updatedAt": "2025-06-26T23:06:07.789Z",
          "assignedManagerId": null,
          "profile": null
        }
      },
      "timestamp": "2025-08-13T18:07:45.689Z"
    }
  },
  "id": "ev1nt2id3-4ev5-6nt7-8id9-0ev1nt2id3ev4",
  "apiKeyId": "ap1k2ey3-4ap5-6ke7-8y9-0ap1k2ey3ap4",
  "eventType": "pix.deposit.confirmed",
  "timestamp": 1755108465701
}

🎯 Campos Principais

Campo

Descrição

data.event

🎪 Tipo do evento (pix.deposit.confirmed)

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.e2e

🔗 ID end-to-end da transação

data.data.pix.executedAt

⏰ Data/hora de execução

data.data.pix.providerReferenceId

🏢 ID de referência do provedor

data.data.pix.provider

🏦 Provedor de pagamento

data.data.pix.senderInfo

👤 Informações do remetente

data.data.pix.receiverInfo

👥 Informações do destinatário

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

id

🆔 ID único do evento webhook

timestamp

🕐 Timestamp do evento