AurePay
  1. Saques (cash-out)
AurePay
API AurePay
  • API AurePay
  • API AureEX
  • Raiz
    • Documentação da API
    • Depósito (Pix In)
      • Introdução
      • Gerar QR Code
      • Consultar depósito
    • Saque (Pix Out)
      • Introdução
      • Solicitar saque
      • Consultar saque
    • Infrações e MED
      • Introdução
      • Listar MEDs
      • Consultar MED
      • Upload de provas
      • Enviar contestação para análise
      • Aceitar MED e estornar
    • Empresa
      • Introdução
      • Consultar dados
      • Consultar saldo
    • Webhook
      • Introdução
      • Exemplos de eventos de webhook
      • Depósitos (cash-in)
        • Eventos de depósito
      • Saques (cash-out)
        • Eventos de saque
      • MED (chargeback)
        • Eventos de MED
  1. Saques (cash-out)

Eventos de saque

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"
}




Página anterior
Eventos de depósito
Próxima página
Eventos de MED
Built with