Eventos de compra e venda de Criptomoedas
Este documento detalha o funcionamento dos webhooks disparados pelo sistema durante o ciclo de vida das operações de Compra (PURCHASE) e Venda (SELL). Você receberá um webhook com o evento pix.exchange.updated para cada alteração de status, contendo todas as informações da transação 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 de exchange |
|
|
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 de Exchange
|
Campo |
Tipo |
Descrição |
|---|---|---|
|
|
string |
🆔 ID único da transação |
|
|
string |
👤 ID do usuário |
|
|
string |
🎫 ID da transação PIX relacionada |
|
|
string |
� Endereço da carteira de criptomoedas |
|
|
string |
💎 Valor bruto (centavos na compra, unidade na venda) |
|
|
string |
💸 Valor da taxa aplicada |
|
|
string |
💰 Valor líquido após taxas |
|
|
string |
� Valor final estimado |
|
|
string |
� Valor final real |
|
|
string |
🪙 Símbolo da criptomoeda (BTC, ETH, USDT, USDC) |
|
|
string |
� Preço de cotação aplicado |
|
|
string |
🔗 Hash da transação na blockchain (quando concluída) |
|
|
string |
🌐 Rede blockchain utilizada |
|
|
string |
📈 Tipo da ordem ( |
|
|
string |
📊 Status atual da transação |
|
|
string |
❌ Mensagem de erro (se houver) |
|
|
string |
📅 Data/hora de criação |
|
|
string |
🔄 Data/hora de atualização |
|
|
array |
📝 Histórico de logs da transação |
📊 Ciclo de Vida e Status
O campo status varia conforme o tipo da operação (orderType).
📥 Fluxo de Compra (PURCHASE)
Na compra, o usuário paga BRL e recebe Criptomoedas.
|
Status |
Descrição |
|---|---|
|
|
⏳ Ordem criada, aguardando início do processamento. |
|
|
📋 Aguardando aprovação administrativa (se necessário). |
|
|
⚙️ Ordem em processamento pela administração. |
|
|
✅ Compra do ativo realizada com sucesso na exchange. |
|
|
📤 Finalizado. Ativo enviado para a carteira do usuário. |
|
|
❌ Operação falhou. |
📤 Fluxo de Venda (SELL)
Na venda, o usuário entrega Criptomoedas e recebe saldo em conta (BRL).
|
Status |
Descrição |
|---|---|
|
|
⏳ Ordem criada, aguardando liquidação. |
|
|
✅ Venda do ativo realizada com sucesso na exchange. |
|
|
🔄 Valor em BRL em transferência para a plataforma. |
|
|
✅ Finalizado. Saldo BRL conciliado e creditado. |
|
|
❌ Operação falhou (ex: erro de rede ou saldo insuficiente). |
|
|
🚫 Ordem cancelada. |
📝 Exemplo de Payload Completo
{
"data": {
"event": "pix.exchange.updated",
"data": {
"id": "e1x2c3h4-a5n6-7g8e-9u0p-1d2a3t4e5s6",
"userId": "u1s2e3r4-i5d6-7f8g-9h0i-j1k2l3m4n5o6",
"token": "USDT",
"network": "Polygon",
"orderType": "PURCHASE",
"status": "CRYPTO_SENT",
"baseAmount": "100.00",
"feeAmount": "1.50",
"netAmount": "98.50",
"tradePrice": "5.12",
"estimatedFinalAmount": "19.23",
"walletAddress": "0x742d35Cc6634C0532925a3b8D4C9db96C4b4d8b6",
"transactionHash": "0xa1b2c3d4e5f6789012345678901234567890abcdef1234567890abcdef123456",
"logs": [],
"createdAt": "2024-01-14T10:00:00.000Z",
"updatedAt": "2024-01-14T10:05:00.000Z"
}
},
"id": "ev1nt2id3-4ev5-6nt7-8id9-0ev1nt2id3ev4",
"apiKeyId": "ap1k2ey3-4ap5-6ke7-8y9-0ap1k2ey3ap4",
"eventType": "pix.exchange.updated",
"timestamp": 1736868300000
}
🎯 Campos Principais (Resumo)
|
Campo |
Descrição |
|---|---|
|
|
🎪 Tipo do evento ( |
|
|
🆔 ID único da transação |
|
|
🪙 Símbolo da criptomoeda |
|
|
📈 Tipo da ordem ( |
|
|
📊 Status atual da transação |
|
|
💎 Quantidade bruta |
|
|
💵 Valor final real |
|
|
🆔 ID único do evento webhook |
|
|
🕐 Timestamp do evento |