Sign in

a84d4905fdbb

latestOpenAPI 3.1.02026-08-143874115.7 MB
Payouts

PayoutMethod Created

Sent when a payout method is created

Required permissions:

  • payout:destination:read
  • webhook_receive:payout_methods
postWebhookpayout_method.created

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

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

company_idstring nullable

The account ID that this webhook event is associated with

idstring required

A unique ID for every single webhook request

timestampstring date-time required

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

type'payout_method.created' required

The webhook event type

Example payload

{
  "api_version": "v1",
  "api_version_date": "2026-07-20",
  "company_id": "biz_xxxxxxxxxxxxxx",
  "data": {
    "account_reference": "••••6789",
    "bank_verification_state": "verified",
    "created_at": "2026-06-15T09:00:00.000Z",
    "destination_currency": "usd",
    "estimated_arrival": {
      "instant": "2026-07-30T12:30:00.000Z",
      "standard": "2026-08-03T00:00:00.000Z"
    },
    "fee_structure": {
      "currency": "usd",
      "fixed_amount": 0.25
    },
    "id": "pyot_xxxxxxxxxxxxx",
    "institution_name": "Frost Bank",
    "is_default": true,
    "nickname": "Business checking",
    "object": "payout_method",
    "payer_name": "ACH Bank Deposit",
    "quote": {
      "amount": 500,
      "currency": "usd",
      "exchange_rate": 1,
      "instant": {
        "fee": 5.25,
        "total_received": 494.75
      },
      "max_limit": 25000,
      "min_limit": 1,
      "standard": {
        "fee": 0.25,
        "total_received": 499.75
      }
    },
    "status": "active",
    "supported_payout_method": {
      "country_code": "USA",
      "delivery_type": "bank_deposit",
      "icon_url": "https://cdn.whop.com/payouts/ach.png",
      "name": "ACH Bank Deposit",
      "supports_plaid": true,
      "supports_standard_delivery": true
    }
  },
  "id": "msg_xxxxxxxxxxxxxxxxxxxxxxxx",
  "timestamp": "2025-01-01T00:00:00.000Z",
  "type": "payout_method.created"
}

Response

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