{
  "account_id": "biz_xxxxxxxxxxxxxx",
  "api_version": "v1",
  "api_version_date": "2026-09-15",
  "data": {
    "account_id": "biz_xxxxxxxxxxxxxx",
    "amount_after_fees": {
      "amount": "50.00",
      "currency": "usd",
      "decimals": 2,
      "display_decimals": 2
    },
    "auto_refunded": false,
    "billing_address": null,
    "billing_reason": "subscription_cycle",
    "checkout_configuration_id": null,
    "client_secret": null,
    "created_at": "2026-01-01T12:00:00.000Z",
    "currency": "usd",
    "customer_email": "marcus@shinetime.example",
    "customer_phone": null,
    "decline_code": null,
    "dispute_alerted_at": null,
    "failure_message": null,
    "financing_installments_count": null,
    "id": "pay_xxxxxxxxxxxxxx",
    "last_payment_attempt_at": null,
    "member_id": "mber_xxxxxxxxxxxxxx",
    "membership_id": null,
    "metadata": {},
    "needs_tracking": false,
    "next_payment_attempt_at": null,
    "paid_at": null,
    "payment_instrument": {
      "card": {
        "brand": "visa",
        "issuer_identification_number": null,
        "last4": "4242"
      },
      "display_name": "Visa •••• 4242",
      "icons": {
        "card": {
          "dark": {
            "png_1x": "https://content.whop.com/payment_methods/visa/icons/card_dark_30.png",
            "png_2x": "https://content.whop.com/payment_methods/visa/icons/card_dark_60.png",
            "png_4x": "https://content.whop.com/payment_methods/visa/icons/card_dark_120.png",
            "svg": "https://content.whop.com/payment_methods/visa/icons/card_dark.svg"
          },
          "light": {
            "png_1x": "https://content.whop.com/payment_methods/visa/icons/card_light_30.png",
            "png_2x": "https://content.whop.com/payment_methods/visa/icons/card_light_60.png",
            "png_4x": "https://content.whop.com/payment_methods/visa/icons/card_light_120.png",
            "svg": "https://content.whop.com/payment_methods/visa/icons/card_light.svg"
          }
        },
        "square": {
          "dark": {
            "png_1x": "https://content.whop.com/payment_methods/visa/icons/square_dark_32.png",
            "png_2x": "https://content.whop.com/payment_methods/visa/icons/square_dark_64.png",
            "png_4x": "https://content.whop.com/payment_methods/visa/icons/square_dark_128.png",
            "svg": "https://content.whop.com/payment_methods/visa/icons/square_dark.svg"
          },
          "light": {
            "png_1x": "https://content.whop.com/payment_methods/visa/icons/square_light_32.png",
            "png_2x": "https://content.whop.com/payment_methods/visa/icons/square_light_64.png",
            "png_4x": "https://content.whop.com/payment_methods/visa/icons/square_light_128.png",
            "svg": "https://content.whop.com/payment_methods/visa/icons/square_light.svg"
          }
        }
      },
      "installment_count": null,
      "payment_method_type": "card"
    },
    "payment_method_id": null,
    "payment_method_type": "card",
    "payment_rule_matches": [],
    "payments_failed": 0,
    "plan_id": "plan_xxxxxxxxxxxxxx",
    "presentment_total": {
      "amount": "50.00",
      "currency": "usd",
      "decimals": 2,
      "display_decimals": 2
    },
    "product_id": "prod_xxxxxxxxxxxxxx",
    "promo_code_id": null,
    "recovery_url": "https://whop.com/billing/manage/mber_xxxxxxxxxxxxxx/verify-payment/",
    "refundable": false,
    "refunded_amount": {
      "amount": "0.00",
      "currency": "usd",
      "decimals": 2,
      "display_decimals": 2
    },
    "refunded_at": null,
    "retryable": false,
    "risk_score": null,
    "risk_signals": null,
    "settlement_time_at": null,
    "shipment_id": null,
    "shipping_address": null,
    "status": "open",
    "substatus": "incomplete",
    "subtotal": {
      "amount": "50.00",
      "currency": "usd",
      "decimals": 2,
      "display_decimals": 2
    },
    "tax_amount": null,
    "tax_behavior": null,
    "tax_refunded_amount": {
      "amount": "0.00",
      "currency": "usd",
      "decimals": 2,
      "display_decimals": 2
    },
    "three_ds_verified": false,
    "total": {
      "amount": "50.00",
      "currency": "usd",
      "decimals": 2,
      "display_decimals": 2
    },
    "updated_at": "2026-01-01T12:00:00.000Z",
    "usd_total": {
      "amount": "50.00",
      "currency": "usd",
      "decimals": 2,
      "display_decimals": 2
    },
    "user": {
      "id": "user_xxxxxxxxxxxxxx",
      "name": "Marcus Webb",
      "profile_picture": {
        "url": "https://ui-avatars.com/api/"
      },
      "username": "marcuswebb"
    },
    "verification_checks": null,
    "voidable": false
  },
  "id": "msg_xxxxxxxxxxxxxxxxxxxxxxxx",
  "timestamp": "2025-01-01T00:00:00.000Z",
  "type": "payment.requires_action"
}

Payments

Payment Requires Action

Sent when the bank asks the buyer to verify an off-session charge, such as a subscription renewal or a saved-card payment your server made. data.recovery_url is the Whop link where the buyer signs in and completes 3D Secure; the event is only sent while that link exists, so it is null only when you lack member:basic:read. Then handle payment.succeeded or payment.failed for the outcome.

Required permissions:

payment:basic:read
plan:basic:read
access_pass:basic:read
member:email:read
member:basic:read
member:phone:read
promo_code:basic:read
shipment:basic:read
payment:dispute:read
payment:resolution_center_case:read
webhook_receive:payments

WEBHOOK

payment.requires_action

{
  "account_id": "biz_xxxxxxxxxxxxxx",
  "api_version": "v1",
  "api_version_date": "2026-09-15",
  "data": {
    "account_id": "biz_xxxxxxxxxxxxxx",
    "amount_after_fees": {
      "amount": "50.00",
      "currency": "usd",
      "decimals": 2,
      "display_decimals": 2
    },
    "auto_refunded": false,
    "billing_address": null,
    "billing_reason": "subscription_cycle",
    "checkout_configuration_id": null,
    "client_secret": null,
    "created_at": "2026-01-01T12:00:00.000Z",
    "currency": "usd",
    "customer_email": "marcus@shinetime.example",
    "customer_phone": null,
    "decline_code": null,
    "dispute_alerted_at": null,
    "failure_message": null,
    "financing_installments_count": null,
    "id": "pay_xxxxxxxxxxxxxx",
    "last_payment_attempt_at": null,
    "member_id": "mber_xxxxxxxxxxxxxx",
    "membership_id": null,
    "metadata": {},
    "needs_tracking": false,
    "next_payment_attempt_at": null,
    "paid_at": null,
    "payment_instrument": {
      "card": {
        "brand": "visa",
        "issuer_identification_number": null,
        "last4": "4242"
      },
      "display_name": "Visa •••• 4242",
      "icons": {
        "card": {
          "dark": {
            "png_1x": "https://content.whop.com/payment_methods/visa/icons/card_dark_30.png",
            "png_2x": "https://content.whop.com/payment_methods/visa/icons/card_dark_60.png",
            "png_4x": "https://content.whop.com/payment_methods/visa/icons/card_dark_120.png",
            "svg": "https://content.whop.com/payment_methods/visa/icons/card_dark.svg"
          },
          "light": {
            "png_1x": "https://content.whop.com/payment_methods/visa/icons/card_light_30.png",
            "png_2x": "https://content.whop.com/payment_methods/visa/icons/card_light_60.png",
            "png_4x": "https://content.whop.com/payment_methods/visa/icons/card_light_120.png",
            "svg": "https://content.whop.com/payment_methods/visa/icons/card_light.svg"
          }
        },
        "square": {
          "dark": {
            "png_1x": "https://content.whop.com/payment_methods/visa/icons/square_dark_32.png",
            "png_2x": "https://content.whop.com/payment_methods/visa/icons/square_dark_64.png",
            "png_4x": "https://content.whop.com/payment_methods/visa/icons/square_dark_128.png",
            "svg": "https://content.whop.com/payment_methods/visa/icons/square_dark.svg"
          },
          "light": {
            "png_1x": "https://content.whop.com/payment_methods/visa/icons/square_light_32.png",
            "png_2x": "https://content.whop.com/payment_methods/visa/icons/square_light_64.png",
            "png_4x": "https://content.whop.com/payment_methods/visa/icons/square_light_128.png",
            "svg": "https://content.whop.com/payment_methods/visa/icons/square_light.svg"
          }
        }
      },
      "installment_count": null,
      "payment_method_type": "card"
    },
    "payment_method_id": null,
    "payment_method_type": "card",
    "payment_rule_matches": [],
    "payments_failed": 0,
    "plan_id": "plan_xxxxxxxxxxxxxx",
    "presentment_total": {
      "amount": "50.00",
      "currency": "usd",
      "decimals": 2,
      "display_decimals": 2
    },
    "product_id": "prod_xxxxxxxxxxxxxx",
    "promo_code_id": null,
    "recovery_url": "https://whop.com/billing/manage/mber_xxxxxxxxxxxxxx/verify-payment/",
    "refundable": false,
    "refunded_amount": {
      "amount": "0.00",
      "currency": "usd",
      "decimals": 2,
      "display_decimals": 2
    },
    "refunded_at": null,
    "retryable": false,
    "risk_score": null,
    "risk_signals": null,
    "settlement_time_at": null,
    "shipment_id": null,
    "shipping_address": null,
    "status": "open",
    "substatus": "incomplete",
    "subtotal": {
      "amount": "50.00",
      "currency": "usd",
      "decimals": 2,
      "display_decimals": 2
    },
    "tax_amount": null,
    "tax_behavior": null,
    "tax_refunded_amount": {
      "amount": "0.00",
      "currency": "usd",
      "decimals": 2,
      "display_decimals": 2
    },
    "three_ds_verified": false,
    "total": {
      "amount": "50.00",
      "currency": "usd",
      "decimals": 2,
      "display_decimals": 2
    },
    "updated_at": "2026-01-01T12:00:00.000Z",
    "usd_total": {
      "amount": "50.00",
      "currency": "usd",
      "decimals": 2,
      "display_decimals": 2
    },
    "user": {
      "id": "user_xxxxxxxxxxxxxx",
      "name": "Marcus Webb",
      "profile_picture": {
        "url": "https://ui-avatars.com/api/"
      },
      "username": "marcuswebb"
    },
    "verification_checks": null,
    "voidable": false
  },
  "id": "msg_xxxxxxxxxxxxxxxxxxxxxxxx",
  "timestamp": "2025-01-01T00:00:00.000Z",
  "type": "payment.requires_action"
}

Headers

webhook-id

string

required

A unique identifier for this webhook request

Example:

"msg_xxxxxxxxxxxxxxxxxxxxxxxx"

webhook-signature

string

required

The signature of the webhook request with the webhook version prepended

Example:

"v1,BASE64ENCODEDSIGNATURE"

webhook-timestamp

string

required

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

Example:

"1727606400"

Body

application/json

api_version

string

required

The API version for this webhook

Allowed value: "v1"

Example:

"v1"

api_version_date

string | null

required

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

Example:

"2026-07-20"

data

object

required

Show child attributes

string

required

A unique ID for every single webhook request

Example:

"msg_xxxxxxxxxxxxxxxxxxxxxxxx"

timestamp

string<date-time>

required

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

Example:

"2025-01-01T00:00:00.000Z"

type

string

required

The webhook event type

Allowed value: "payment.requires_action"

Example:

"payment.requires_action"

account_id

string | null

The account ID that this webhook event is associated with

Example:

"biz_xxxxxxxxxxxxxx"

previous_attributes

object

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

Response

200

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

Introduction

Reference

Webhooks & Events

Core Resources

Notifications

Payments

Money

Commerce

Partners

Workforce

Tracking

Ads

Media

Identity

Developer

Payment Requires Action

Headers

Body

Response