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 |
|---|---|---|
|
|
string |
Tipo do evento ( |
|
|
object |
Dados específicos da transação PIX confirmada |
|
|
string |
ID único do evento webhook |
|
|
string |
ID da chave API que gerou o evento |
|
|
string |
Tipo do evento (igual a |
|
|
number |
Timestamp Unix do evento |
💰 Dados da Transação PIX
|
Campo |
Tipo |
Descrição |
|---|---|---|
|
|
string |
🆔 ID único da transação PIX |
|
|
string |
🔗 UUID da transação |
|
|
number |
💵 Valor da transação em centavos |
|
|
string |
📊 Status atual da transação |
|
|
string |
📥 Tipo da transação ( |
|
|
string |
🔑 Tipo da chave PIX ( |
|
|
string |
📱 ID do QR Code gerado |
|
|
string |
🎫 Chave PIX ou QR Code |
|
|
string |
🔗 ID end-to-end da transação PIX |
|
|
string |
📝 Descrição da transação |
|
|
string |
🏢 ID de referência do provedor |
|
|
string |
⏰ Data/hora de expiração (ISO 8601) |
|
|
string |
⏱️ Data/hora de execução (ISO 8601) |
|
|
string |
🏦 Provedor de pagamento |
|
|
string |
📅 Data/hora de criação (ISO 8601) |
|
|
string |
🔄 Data/hora de atualização (ISO 8601) |
|
|
object |
👤 Informações do remetente |
|
|
object |
👥 Informações do destinatário |
|
|
string |
💰 ID do lote de taxas |
|
|
string |
✅ Data/hora de distribuição de taxas |
|
|
object |
📊 Metadados da distribuição de taxas |
|
|
string |
👤 ID do usuário que criou a transação |
|
|
string |
🏢 ID do tenant/organização |
|
|
object |
👨💼 Dados do usuário |
|
|
string |
🕐 Timestamp da confirmação (ISO 8601) |
👤 Dados do Usuário
|
Campo |
Tipo |
Descrição |
|---|---|---|
|
|
string |
🆔 ID único do usuário |
|
|
string |
📧 Email do usuário |
|
|
string |
👨💼 Nome completo do usuário |
|
|
string |
👑 Função do usuário ( |
|
|
string |
🔐 ID do Cognito (autenticação) |
|
|
string |
🏢 ID do tenant/organização |
|
|
string |
👨💼 ID do gerente responsável |
|
|
string |
🏦 ID do BaaS (Banking as a Service) |
|
|
string |
💳 ID de pagamento do usuário |
|
|
string |
⭐ Nível do usuário ( |
|
|
string |
📊 Status do usuário ( |
|
|
string |
📋 Data de revisão de compliance |
|
|
string |
📝 Motivo da revisão de compliance |
|
|
string |
👨💻 ID do analista de compliance |
|
|
string |
📅 Data de criação do usuário |
|
|
string |
🔄 Data de atualização do usuário |
|
|
string |
👨💼 ID do gerente designado |
|
|
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 |
|---|---|
|
|
🎪 Tipo do evento ( |
|
|
🆔 ID único da transação PIX |
|
|
💵 Valor da transação em centavos |
|
|
📊 Status atual da transação |
|
|
📥 Tipo da transação ( |
|
|
🔗 ID end-to-end da transação |
|
|
⏰ Data/hora de execução |
|
|
🏢 ID de referência do provedor |
|
|
🏦 Provedor de pagamento |
|
|
👤 Informações do remetente |
|
|
👥 Informações do destinatário |
|
|
👨💼 Nome do usuário |
|
|
📧 Email do usuário |
|
|
👑 Função do usuário |
|
|
⭐ Nível do usuário |
|
|
🆔 ID único do evento webhook |
|
|
🕐 Timestamp do evento |