Sign in

v8

latestOpenAPI 3.1.02026-08-033623795.0 MB
Setup intents

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
postWebhooksetup_intent.requires_action

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'setup_intent.requires_action' required

The webhook event type

Example payload

{
  "api_version": "v1",
  "api_version_date": "2026-07-20",
  "company_id": "biz_xxxxxxxxxxxxxx",
  "data": {
    "checkout_configuration": {
      "id": "ch_xxxxxxxxxxxxxxx"
    },
    "company": {
      "id": "biz_xxxxxxxxxxxxxx"
    },
    "created_at": "2023-12-01T05:00:00.401Z",
    "error_message": "Your card was declined.",
    "id": "sint_xxxxxxxxxxxxx",
    "payment_method": {
      "card": {
        "exp_month": 42,
        "exp_year": 42,
        "last4": "4242"
      },
      "created_at": "2023-12-01T05:00:00.401Z",
      "id": "payt_xxxxxxxxxxxxx"
    }
  },
  "id": "msg_xxxxxxxxxxxxxxxxxxxxxxxx",
  "timestamp": "2025-01-01T00:00:00.000Z",
  "type": "setup_intent.requires_action"
}

Response

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