Exemplos de eventos de webhook

Referência de webhooks

O cliente pode cadastrar uma URL e configurar eventos em:
https://app.aurepay.com.br/integrations/webhooks/new

Gerenciar webhooks:
https://app.aurepay.com.br/integrations/webhooks

01. Fluxo de depósitos (cash-in)

DEPOSIT_PENDING

Disparado quando um depósito é criado e o QR Code está disponível; o pagamento ainda não foi realizado.

{
  "data": {
    "id": "01JKW8A1B2C3D4E5F6G7H8J9K0",
    "amount": 250,
    "feeAmount": 1.25,
    "netAmount": 248.75,
    "type": "deposit",
    "method": "pix",
    "currency": "brl",
    "customer": {
      "id": "01JKW7M6N5P4Q3R2S1T0V9W8X7",
      "name": "João da Silva Sauro",
      "email": "joao.silva@exemplo.com.br",
      "phone": "+5511998765432",
      "document": "12345678909"
    },
    "metadata": {
      "loja_id": "9988",
      "terminal": "PDV-01",
      "campanha": "verao_2026"
    },
    "reference": "ORD-DEP-99",
    "status": "pending",
    "qrCode": {
      "payload": "00020101021226790014br.gov.bcb.pix2557brcode.starkinfra.com/v2/9e71cb52eef14671961e7e9c6c07b65e5204000053039865802BR5912AURE BB LTDA6004Lins62070503***630469A6",
      "imageEncoded": "data:image/png;base64,iVBORw0K...[TRUNCATED_BASE64]"
    },
    "expiresAt": "2026-02-03T14:29:07.583Z",
    "createdAt": "2026-02-02T14:29:03.759Z",
    "updatedAt": "2026-02-02T14:29:07.687Z"
  },
  "event": "DEPOSIT_PENDING"
}

DEPOSIT_PAID

Disparado quando o Pix do depósito é confirmado e o valor já está creditado.

{
  "data": {
    "id": "01JKW8A1B2C3D4E5F6G7H8J9K0",
    "amount": 250,
    "feeAmount": 1.25,
    "netAmount": 248.75,
    "type": "deposit",
    "method": "pix",
    "currency": "brl",
    "customer": {
      "id": "01JKW7M6N5P4Q3R2S1T0V9W8X7",
      "name": "João da Silva Sauro",
      "email": "joao.silva@exemplo.com.br",
      "phone": "+5511998765432",
      "document": "12345678909"
    },
    "metadata": {
      "loja_id": "9988",
      "terminal": "PDV-01",
      "campanha": "verao_2026"
    },
    "reference": "ORD-DEP-99",
    "status": "paid",
    "paidAt": "2026-02-02T14:35:12.864Z",
    "createdAt": "2026-02-02T14:29:03.759Z",
    "updatedAt": "2026-02-02T14:35:15.639Z",
    "details": {
      "endToEndId": "E18236120202602021427s08f125770c",
      "payer": {
        "fullName": "JOAO DA SILVA SAURO",
        "document": "123.456.789-09",
        "bankData": {
          "id": "18236120",
          "name": "BANCO DO BRASIL S.A.",
          "agency": "0001",
          "account": "12345678"
        }
      },
      "receiver": {
        "fullName": "AURE B2B LTDA",
        "document": "62.389.603/0001-84",
        "bankData": {
          "id": "36741675",
          "name": "CORPX IP S.A.",
          "pixKey": "01a48d4d-f51c-42fe-9292-33956636c406",
          "agency": "0001",
          "account": "200001891"
        }
      },
      "requestedAt": "2026-02-02T14:35:10.792Z",
      "processedAt": "2026-02-02T14:35:12.864Z"
    }
  },
  "event": "DEPOSIT_PAID"
}

DEPOSIT_EXPIRED

Disparado quando o QR Code do depósito expira sem pagamento.

{
  "data": {
    "id": "01JKW8A1B2C3D4E5F6G7H8J9K0",
    "amount": 250,
    "feeAmount": 1.25,
    "netAmount": 248.75,
    "type": "deposit",
    "method": "pix",
    "currency": "brl",
    "customer": {
      "id": "01JKW7M6N5P4Q3R2S1T0V9W8X7",
      "name": "João da Silva Sauro",
      "document": "12345678909"
    },
    "metadata": {
      "loja_id": "9988",
      "terminal": "PDV-01",
      "campanha": "verao_2026"
    },
    "reference": "ORD-DEP-99",
    "status": "expired",
    "createdAt": "2026-02-02T14:29:03.759Z",
    "updatedAt": "2026-02-03T14:30:00.658Z"
  },
  "event": "DEPOSIT_EXPIRED"
}

02. Fluxo de saques (cash-out)

WITHDRAW_PENDING

Disparado quando um saque é solicitado e está aguardando processamento.

{
  "data": {
    "id": "01JKW9Z9Y8X7W6V5U4T3S2R1Q0",
    "amount": 1000,
    "feeAmount": 5,
    "totalAmount": 1005,
    "type": "withdraw",
    "method": "pix",
    "currency": "brl",
    "customer": {
      "id": "01JKW7M6N5P4Q3R2S1T0V9W8X7",
      "name": "João da Silva Sauro",
      "email": "joao.silva@exemplo.com.br",
      "phone": "+5511998765432",
      "document": "12345678909"
    },
    "pixKey": "12345678909",
    "metadata": {},
    "reference": "WIT-REF-2026",
    "status": "pending",
    "createdAt": "2026-02-02T15:30:29.149Z",
    "updatedAt": "2026-02-02T15:30:29.149Z"
  },
  "event": "WITHDRAW_PENDING"
}

WITHDRAW_PROCESSING

Disparado quando o saque está sendo processado pela instituição financeira.

{
  "data": {
    "id": "01JKW9Z9Y8X7W6V5U4T3S2R1Q0",
    "amount": 1000,
    "feeAmount": 5,
    "totalAmount": 1005,
    "type": "withdraw",
    "method": "pix",
    "currency": "brl",
    "customer": {
      "id": "01JKW7M6N5P4Q3R2S1T0V9W8X7",
      "name": "João da Silva Sauro",
      "document": "12345678909"
    },
    "pixKey": "12345678909",
    "metadata": {},
    "reference": "WIT-REF-2026",
    "status": "processing",
    "createdAt": "2026-02-02T15:30:29.149Z",
    "updatedAt": "2026-02-02T15:32:10.976Z"
  },
  "event": "WITHDRAW_PROCESSING"
}

WITHDRAW_PAID

Disparado quando o saque foi pago ao destinatário.

{
  "data": {
    "id": "01JKW9Z9Y8X7W6V5U4T3S2R1Q0",
    "amount": 1000,
    "feeAmount": 5,
    "totalAmount": 1005,
    "type": "withdraw",
    "method": "pix",
    "currency": "brl",
    "customer": {
      "id": "01JKW7M6N5P4Q3R2S1T0V9W8X7",
      "name": "João da Silva Sauro",
      "email": "joao.silva@exemplo.com.br",
      "phone": "+5511998765432",
      "document": "12345678909"
    },
    "pixKey": "12345678909",
    "metadata": {},
    "reference": "WIT-REF-2026",
    "status": "paid",
    "paidAt": "2026-02-02T15:40:00.009Z",
    "createdAt": "2026-02-02T15:30:29.149Z",
    "updatedAt": "2026-02-02T15:40:05.880Z",
    "details": {
      "endToEndId": "E3674167520260202095528038526013",
      "payer": {
        "fullName": "AURE BB LTDA",
        "document": "62.389.603/0001-84",
        "bankData": {
          "name": "CORPX IP S.A."
        }
      },
      "receiver": {
        "fullName": "JOAO DA SILVA SAURO",
        "document": "123.456.789-09",
        "bankData": {
          "name": "BANCO DO BRASIL",
          "pixKey": "12345678909",
          "agency": "0001",
          "account": "12345678"
        }
      },
      "requestedAt": "2026-02-02T15:40:00.009Z",
      "processedAt": "2026-02-02T15:40:00.009Z"
    }
  },
  "event": "WITHDRAW_PAID"
}

WITHDRAW_FAILED

Disparado quando o saque falha (ex.: chave Pix ou dados inválidos).

{
  "data": {
    "id": "01JKW9Z9Y8X7W6V5U4T3S2R1Q0",
    "status": "failed",
    "failedAt": "2026-02-02T15:45:39.980Z",
    "failedReason": "Chave Pix ou dados fornecidos inválidos.",
    "customer": {
      "id": "01JKW7M6N5P4Q3R2S1T0V9W8X7",
      "name": "João da Silva Sauro",
      "document": "12345678909"
    },
    "metadata": {},
    "reference": "WIT-REF-2026",
    "createdAt": "2026-02-02T15:30:29.149Z",
    "updatedAt": "2026-02-02T15:45:39.980Z"
  },
  "event": "WITHDRAW_FAILED"
}

WITHDRAW_CANCELED

Disparado quando o administrador recusa o saque pelo painel da AurePay (saque cancelado pelo adm).

{
  "data": {
    "id": "01JKW9Z9Y8X7W6V5U4T3S2R1Q0",
    "status": "canceled",
    "canceledAt": "2026-02-02T15:50:40.148Z",
    "canceledReason": "Saque cancelado pelo administrador.",
    "customer": {
      "id": "01JKW7M6N5P4Q3R2S1T0V9W8X7",
      "name": "João da Silva Sauro",
      "document": "12345678909"
    },
    "metadata": {},
    "reference": "WIT-REF-2026",
    "createdAt": "2026-02-02T15:30:29.149Z",
    "updatedAt": "2026-02-02T15:50:40.148Z"
  },
  "event": "WITHDRAW_CANCELED"
}

Exemplos de eventos de webhook

Referência de webhooks#

01. Fluxo de depósitos (cash-in)#

DEPOSIT_PENDING#

DEPOSIT_PAID#

DEPOSIT_EXPIRED#

02. Fluxo de saques (cash-out)#

WITHDRAW_PENDING#

WITHDRAW_PROCESSING#

WITHDRAW_PAID#

WITHDRAW_FAILED#

WITHDRAW_CANCELED#