---
title: "SetupIntent Canceled"
method: POST
path: "setup_intent.canceled"
tags: ["Setup Intents"]
---

# SetupIntent Canceled

`POST setup_intent.canceled` (webhook)

Sent when a setup intent is canceled

Required permissions:
 - `payment:setup_intent:read`
 - `member:basic:read`
 - `member:email:read`
 - `webhook_receive:setup_intents`

## Headers

- `webhook-id` string, required — A unique identifier for this webhook request
- `webhook-signature` string, required — The signature of the webhook request with the webhook version prepended
- `webhook-timestamp` string, required — The timestamp in seconds since the Unix epoch that the webhook was sent at on the server

## Payload

- object
  - `account_id` string, nullable — The account ID that this webhook event is associated with
  - `api_version` 'v1', required — The API version for this webhook
  - `api_version_date` string, nullable, required — The dated API version (Api-Version-Date) the payload is serialized to
  - `data` SetupIntent, required
    - `account_id` string, nullable, required — The account the payment method is saved for, prefixed `biz_`.
    - `checkout_configuration_id` string, nullable, required — The checkout configuration this setup was created through, prefixed `ch_`. Null for a setup created through this API rather than a hosted checkout.
    - `client_secret` string, nullable, required — The credential a buyer's surface presents to poll this setup and set its return URL — hand it to the elements' `handleNextAction`. Only on setups created through this API, and always null in list responses — retrieve the setup intent for it.
    - `created_at` string, required — When the setup intent was created, as an ISO 8601 timestamp.
    - `id` string, required — Setup intent ID, prefixed `sint_`.
    - `last_setup_error` SetupLastSetupError, required
      - `code` string, nullable, required — A machine-readable classification of the failure, e.g. `enrollment_declined`. Absent when the buyer simply abandoned the setup.
      - `message` string, nullable, required — A human-readable explanation of the failure.
    - `member_id` string, nullable, required — The buyer's member record on the account, prefixed `mber_`. Null without the member:basic:read permission, unless the caller is the buyer.
    - `metadata` object, nullable, required — Your own key-value data attached when the setup intent was created.
    - `payment_instrument` PaymentInstrument, required
      - `card` PaymentInstrumentCard, required
        - `brand` string, nullable, required — The network identifier (`visa`, `amex`, …), matching `card.networks` entries and saved card payment methods. Null when the vault did not record the network.
        - `exp_month` number, nullable, required — The card's expiry month, 1 to 12. Null when the vault did not record it.
        - `exp_year` number, nullable, required — The card's four-digit expiry year. Null when the vault did not record it.
        - `issuer_identification_number` string, nullable, required — The issuer identification number, also called the BIN: the card's leading six or eight digits, which identify the issuing bank. Null when the processor did not report it.
        - `last4` string, nullable, required — The card's last four digits, when captured.
      - `display_name` string, required — Buyer-facing instrument name — "Visa •••• 4242" when the card surfaced, else the method's own name ("Klarna").
      - `icons` PaymentMethodIcons, required
        - `card` PaymentMethodIconVariants, required
          - `dark` PaymentMethodIconFiles, required
            - `png_1x` string, required — Raster fallback at the shape's native size.
            - `png_2x` string, required — Raster fallback at double density.
            - `png_4x` string, required — Raster fallback at quadruple density.
            - `svg` string, required — The vector file. Prefer this everywhere SVG renders.
          - `light` PaymentMethodIconFiles, required
            - `png_1x` string, required — Raster fallback at the shape's native size.
            - `png_2x` string, required — Raster fallback at double density.
            - `png_4x` string, required — Raster fallback at quadruple density.
            - `svg` string, required — The vector file. Prefer this everywhere SVG renders.
        - `square` PaymentMethodIconVariants, required
          - `dark` PaymentMethodIconFiles, required
            - `png_1x` string, required — Raster fallback at the shape's native size.
            - `png_2x` string, required — Raster fallback at double density.
            - `png_4x` string, required — Raster fallback at quadruple density.
            - `svg` string, required — The vector file. Prefer this everywhere SVG renders.
          - `light` PaymentMethodIconFiles, required
            - `png_1x` string, required — Raster fallback at the shape's native size.
            - `png_2x` string, required — Raster fallback at double density.
            - `png_4x` string, required — Raster fallback at quadruple density.
            - `svg` string, required — The vector file. Prefer this everywhere SVG renders.
      - `installment_count` number, nullable, required — Installment methods only: how many payments the charge splits into. Data, not copy — compose and translate the label client-side.
      - `payment_method_type` string, required — The payment method type identifier, e.g. `card`, `klarna`, `apple_pay`.
    - `payment_method_id` string, nullable, required — The saved payment method, prefixed `payt_`, ready to charge with Create Payment. Null until the setup has `succeeded`.
    - `payment_method_type` 'acss_debit' | 'addi' | 'affirm' | 'afterpay_clearpay' | 'alipay' | 'alma' | 'amazon_pay' | 'apple' | 'apple_pay' | 'au_bank_transfer' | 'au_becs_debit' | 'bacs_debit' | 'bancolombia' | 'bancontact' | 'bank_wire' | 'billie' | 'blik' | 'boleto' | 'bre_b' | 'ca_bank_transfer' | 'capchase_pay' | 'card' | 'card_installments_three' | 'card_installments_six' | 'card_installments_twelve' | 'cashapp' | 'claritypay' | 'coinbase' | 'crypto' | 'custom' | 'customer_balance' | 'demo_pay' | 'efecty' | 'eps' | 'eu_bank_transfer' | 'fpx' | 'flex_pay' | 'gb_bank_transfer' | 'gcash' | 'giropay' | 'google_pay' | 'gopay' | 'grabpay' | 'id_bank_transfer' | 'ideal' | 'interac' | 'kakao_pay' | 'klarna' | 'klarna_pay_now' | 'konbini' | 'kr_card' | 'kr_market' | 'kriya' | 'kueski' | 'link' | 'mb_way' | 'm_pesa' | 'mercado_pago' | 'mercado_pago_ar' | 'mercado_pago_mx' | 'mobilepay' | 'modo' | 'mondu' | 'multibanco' | 'naver_pay' | 'nequi' | 'netbanking' | 'ng_bank' | 'ng_bank_transfer' | 'ng_card' | 'ng_market' | 'ng_ussd' | 'ng_wallet' | 'nupay' | 'nz_bank_account' | 'oney' | 'oney_3x' | 'oney_4x' | 'opay' | 'oxxo' | 'p24' | 'pago_efectivo' | 'pse' | 'pay_by_bank' | 'payco' | 'paynow' | 'paypal' | 'paypay' | 'payto' | 'pix' | 'platform_balance' | 'promptpay' | 'qris' | 'rapipago' | 'rechnung' | 'revolut_pay' | 'samsung_pay' | 'satispay' | 'scalapay' | 'sencillito' | 'sepa_debit' | 'sequra' | 'servipag' | 'sezzle' | 'shop_pay' | 'shopeepay' | 'sofort' | 'south_korea_market' | 'spei' | 'splitit' | 'sunbit' | 'swish' | 'tabby' | 'tamara' | 'touch_n_go' | 'twint' | 'upi' | 'us_bank_account' | 'us_bank_transfer' | 'venmo' | 'verve' | 'vipps' | 'webpay' | 'wechat_pay' | 'yape' | 'zip' | 'coinflow' | 'unknown', required — The different types of payment methods that can be used.
    - `return_url` string, nullable, required — Where the buyer lands after completing an off-site step, or `null` to leave them where they are.
    - `status` 'processing' | 'succeeded' | 'canceled' | 'requires_action', required — How far the setup has got. **A 201 or 200 means we answered, not that the method was saved — always branch on this.** `requires_action` — the buyer has a step outstanding; hand `client_secret` to the elements or poll Retrieve setup status. `processing` — the processor is deciding. `succeeded` — the method is saved, and only this one means saved. `canceled` — abandoned or refused; see `last_setup_error`.
    - `three_ds_verified` boolean, required — True when the buyer completed 3D Secure while saving this payment method.
    - `updated_at` string, required — When the setup intent was last updated, as an ISO 8601 timestamp.
    - `user` UserSummary, required
      - `id` string, required — User ID, prefixed `user_`.
      - `name` string, nullable, required — Display name.
      - `profile_picture` UserProfilePicture, required
        - `url` string, required — Avatar image URL. Always present — a generated placeholder when the user set no picture.
      - `username` string, required — Public username.
  - `id` string, required — A unique ID for every single webhook request
  - `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
  - `timestamp` string, date-time, required — The timestamp in ISO 8601 format that the webhook was sent at on the server
  - `type` 'setup_intent.canceled', required — The webhook event type

## Acknowledgement `200`

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

---

[API](https://skmtc.dev/whop/apis/whop-api.md) · [All operations](https://skmtc.dev/whop/apis/whop-api/llms.txt) · [OpenAPI document](https://skmtc.dev/whop/apis/whop-api/revisions/7fcefabddb0a?raw)