Skip to content

Eventos

Referencia completa dos eventos de webhook disponiveis.

DEPOSIT_ASSET_SUCCESS

Disparado quando um deposito PIX e confirmado com sucesso.

Payload

json
{
  "event": "DEPOSIT_ASSET_SUCCESS",
  "data": {
    "success": true,
    "transactionId": "67a1b2c3d4e5f67890abcdef",
    "chargeId": "67a1b2c3d4e5f67890abcde0",
    "value": 5000,
    "creditedValue": 4950,
    "fee": 50,
    "providerId": "eulen-charge-id-123"
  }
}

Campos

CampoTipoDescricao
successBooleanSempre true para este evento
transactionIdStringID da transacao criada no sistema
chargeIdStringID da cobranca original
valueNumberValor original do deposito em centavos
creditedValueNumberValor creditado na conta (descontada a taxa) em centavos
feeNumberTaxa total cobrada em centavos
providerIdStringID do provedor de pagamento

Calculo da taxa

O valor creditado e calculado como:

creditedValue = value - fee

A taxa pode ser fixa ou percentual, conforme configuracao da conta.


PAYOUT_SUCCESSFUL

Disparado quando um pagamento ou saque e realizado com sucesso.

Payload

json
{
  "event": "PAYOUT_SUCCESSFUL",
  "data": {
    "success": true,
    "invoice": "lnbc500n1...",
    "valueInSatoshis": 50000,
    "pixKey": "email@exemplo.com",
    "valueInBrl": "50.00",
    "fee": 100,
    "quote": {
      "brlAmount": "50.00",
      "btcAmount": 0.00005,
      "satoshis": 50000,
      "btcToBrlRate": 350000
    }
  }
}

Campos

CampoTipoDescricao
successBooleanSempre true para este evento
invoiceStringHash ou identificador do pagamento
valueInSatoshisNumberValor em satoshis (se Lightning)
pixKeyStringChave PIX de destino
valueInBrlStringValor em reais
feeNumberTaxa cobrada em centavos
quote.brlAmountStringValor em BRL da cotacao
quote.btcAmountNumberValor em BTC
quote.satoshisNumberValor em satoshis
quote.btcToBrlRateNumberTaxa de conversao BTC/BRL no momento

PAYOUT_FAILED

Disparado quando um pagamento ou saque falha.

Payload

json
{
  "event": "PAYOUT_FAILED",
  "data": {
    "success": false,
    "error": "Insufficient funds",
    "transactionId": "67a1b2c3d4e5f67890abcdef"
  }
}

Campos

CampoTipoDescricao
successBooleanSempre false para este evento
errorStringMensagem descrevendo o motivo da falha
transactionIdStringID da transacao que falhou