SetupIntent Canceled

Payload

{
  "api_version": "v1",
  "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",
    "member": {
      "id": "string",
      "user": {
        "email": "string",
        "id": "string",
        "name": "string",
        "username": "string"
      }
    },
    "metadata": {},
    "payment_method": {
      "card": {
        "brand": "mastercard",
        "exp_month": 42,
        "exp_year": 42,
        "last4": "4242"
      },
      "created_at": "2023-12-01T05:00:00.401Z",
      "id": "payt_xxxxxxxxxxxxx",
      "mailing_address": {
        "city": "string",
        "country": "string",
        "line1": "string",
        "line2": "string",
        "name": "string",
        "postal_code": "string",
        "state": "string"
      },
      "payment_method_type": "acss_debit"
    },
    "status": "processing"
  },
  "id": "msg_xxxxxxxxxxxxxxxxxxxxxxxx",
  "timestamp": "2025-01-01T00:00:00.000Z",
  "type": "setup_intent.canceled"
}

Sent when a setup intent is canceled

Required permissions:

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

Payload

The payload of this webhook request is an object.

api_version"v1"Required

The API version for this webhook

dataobjectRequired

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

idstringRequired

A unique ID for every single webhook request

timestampdatetimeRequired

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

type"setup_intent.canceled"Required

The webhook event type

company_idstring or nullOptional

The company ID that this webhook event is associated with

Response

200

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

Headers

Payload

Response