Sign in
Payouts

Payout Updated

Sent when a payout's status changes (this event family replaces withdrawal.*)

Required permissions:

  • webhook_receive:withdrawals
postWebhookpayout.updated

Headers

webhook-idstring required

A unique identifier for this webhook request

Example:msg_xxxxxxxxxxxxxxxxxxxxxxxx
webhook-signaturestring required

The signature of the webhook request with the webhook version prepended

Example:v1,BASE64ENCODEDSIGNATURE
webhook-timestampstring required

The timestamp in seconds since the Unix epoch that the webhook was sent at on the server

Example:1727606400

Payload

account_idstring nullable

The account ID that this webhook event is associated with

api_version'v1' required

The API version for this webhook

api_version_datestring nullable required

The dated API version (Api-Version-Date) the payload is serialized to

idstring required

A unique ID for every single webhook request

previous_attributesobject

For some .updated events, the old values of the payload fields that changed, keyed by field name. Omitted when no capture is available for the event

timestampstring date-time required

The timestamp in ISO 8601 format that the webhook was sent at on the server

type'payout.updated' required

The webhook event type

Example payload

{
  "account_id": "biz_xxxxxxxxxxxxxx",
  "api_version": "v1",
  "api_version_date": "2026-07-20",
  "data": {
    "amount": "500.0",
    "created_at": "2026-07-29T18:22:00.000Z",
    "currency": "usd",
    "destination_amount": "461.7",
    "destination_currency": "eur",
    "estimated_arrival": "2026-08-03T00:00:00.000Z",
    "exchange_rate": 0.9234,
    "failure": {
      "code": "beneficiary_name_mismatch"
    },
    "fee_amount": "0.25",
    "fee_paid_by": "self",
    "id": "wdrl_xxxxxxxxxxxxx",
    "markup_fee": "0.0",
    "metadata": {
      "batch_id": "2026-08-18"
    },
    "net_amount": "49.75",
    "notes": "Detailing supplies restock",
    "object": "payout",
    "payer_name": "ACH Bank Deposit",
    "payout_method": {
      "nickname": "Business checking",
      "supported_payout_method": {
        "delivery_type": "bank_deposit",
        "icon_url": "https://cdn.whop.com/payouts/ach.png",
        "payer_name": "ACH Bank Deposit"
      }
    },
    "payout_request_id": "cofr_xxxxxxxxxxxxx",
    "source": "api",
    "speed": "standard",
    "status": "in_review",
    "status_detail": "awaiting_provider_acceptance",
    "trace_code": "021000021234567"
  },
  "id": "msg_xxxxxxxxxxxxxxxxxxxxxxxx",
  "timestamp": "2025-01-01T00:00:00.000Z",
  "type": "payout.updated"
}

Response

Return a 200 status to indicate that the data was received successfully

Changes

Webhooks have no change history: a webhook is keyed by its event name rather than a path and method, so no recorded change can name it.