Saques

Usados para notificar o status de saques (retirada de saldo da plataforma).

payout.completed
payout.failed

Disparado quando um saque é concluído com sucesso. O campo endToEndIdentifier está presente apenas em saques concluídos.

{
  "event": "payout.completed",
  "apiVersion": 2,
  "devMode": false,
  "data": {
    "withdraw": {
      "id": "tran_xxx",
      "amount": 1000,
      "status": "COMPLETE",
      "method": "PIX",
      "platformFee": 80,
      "receiptUrl": "https://...",
      "externalId": null,
      "createdAt": "...",
      "updatedAt": "...",
      "endToEndIdentifier": "E123..."
    }
  }
}

Disparado quando um saque falha.

{
  "event": "payout.failed",
  "apiVersion": 2,
  "devMode": false,
  "data": {
    "withdraw": {
      "id": "tran_xxx",
      "amount": 1000,
      "status": "FAILED",
      "method": "PIX",
      "platformFee": 80,
      "receiptUrl": "https://...",
      "externalId": null,
      "createdAt": "...",
      "updatedAt": "..."
    }
  }
}

Visão geral

Segurança

Eventos