Setupintent requires action

Sent when a setup intent is requires action

Required permissions:

• payment:setup_intent:read
• member:basic:read
• member:email:read
• webhook_receive:setup_intents

WEBHOOK setup_intent.requires_action

Example

{
  "id": "msg_xxxxxxxxxxxxxxxxxxxxxxxx",
  "api_version": "v1",
  "timestamp": "2025-01-01T00:00:00.000Z",
  "type": "setup_intent.requires_action",
  "data": {
    "id": "sint_xxxxxxxxxxxxx",
    "created_at": "2023-12-01T05:00:00.401Z",
    "error_message": "Your card was declined.",
    "company": {
      "id": "biz_xxxxxxxxxxxxxx"
    },
    "checkout_configuration": {
      "id": "ch_xxxxxxxxxxxxxxx"
    },
    "member": {
      "id": "<string>",
      "user": {
        "id": "<string>",
        "email": "<string>",
        "name": "<string>",
        "username": "<string>"
      }
    },
    "payment_method": {
      "id": "payt_xxxxxxxxxxxxx",
      "created_at": "2023-12-01T05:00:00.401Z",
      "card": {
        "last4": "4242",
        "exp_month": 42,
        "exp_year": 42
      },
      "mailing_address": {
        "name": "<string>",
        "line1": "<string>",
        "line2": "<string>",
        "city": "<string>",
        "state": "<string>",
        "postal_code": "<string>",
        "country": "<string>"
      }
    },
    "metadata": {}
  },
  "company_id": "biz_xxxxxxxxxxxxxx"
}

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

id · string · required

A unique ID for every single webhook request

Example:

"msg_xxxxxxxxxxxxxxxxxxxxxxxx"

api_version · string · required

The API version for this webhook

Allowed value: "v1"

Example:

"v1"

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: "setup_intent.requires_action"

Example:

"setup_intent.requires_action"

data · object · required

A setup intent allows a user to save a payment method for future use without making an immediate purchase.

Show child attributes

company_id · string | null

The company ID that this webhook event is associated with

Example:

"biz_xxxxxxxxxxxxxx"

Response

200

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