Setupintent requires action

Headers

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

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

An object representing a setup intent, which is a flow for allowing a customer to add a payment method to their account without making a purchase.

Show child attributes

data.id

string

required

The setup intent ID

Example:

"sint_xxxxxxxxxxxxx"

data.status

enum<string>

required

The status of the setup intent

Available options:

processing,

succeeded,

canceled,

requires_action

data.created_at

string<date-time>

required

The datetime the payment was created

Example:

"2023-12-01T05:00:00.401Z"

data.error_message

string | null

required

The error message, if any.

data.company

object

required

The company of the setup intent

Show child attributes

data.company.id

string

required

The ID (tag) of the company.

Example:

"biz_xxxxxxxxxxxxxx"

data.checkout_configuration

object

required

The checkout configuration associated with the setup intent

Show child attributes

data.checkout_configuration.id

string

required

The ID of the checkout configuration

Example:

"ch_xxxxxxxxxxxxxxx"

data.member

object

required

The member connected to the setup intent

Show child attributes

data.member.id

string

required

The ID of the member

data.member.user

object

required

The user for this member, if any.

Show child attributes

data.member.user.id

string

required

The internal ID of the user account.

data.member.user.email

string | null

required

The digital mailing address of the user.

data.member.user.name

string | null

required

The user's full name.

data.member.user.username

string

required

The whop username.

data.payment_method

object

required

The payment method created during the setup, if available.

Show child attributes

data.payment_method.id

string

required

The ID of the payment method

Example:

"payt_xxxxxxxxxxxxx"

data.payment_method.created_at

string<date-time>

required

The date and time the payment method was created

Example:

"2023-12-01T05:00:00.401Z"

data.payment_method.payment_method_type

enum<string>

required

The payment method type of the payment method

Available options:

acss_debit,

affirm,

afterpay_clearpay,

alipay,

alma,

amazon_pay,

apple_pay,

au_becs_debit,

bacs_debit,

bancontact,

billie,

blik,

boleto,

card,

cashapp,

crypto,

eps,

fpx,

giropay,

google_pay,

grabpay,

ideal,

kakao_pay,

klarna,

konbini,

kr_card,

link,

mobilepay,

multibanco,

naver_pay,

nz_bank_account,

oxxo,

p24,

pay_by_bank,

payco,

paynow,

pix,

promptpay,

revolut_pay,

samsung_pay,

satispay,

sepa_debit,

sofort,

swish,

twint,

us_bank_account,

wechat_pay,

zip,

bizum,

capchase_pay,

kriya,

mondu,

ng_wallet,

paypay,

sequra,

scalapay,

vipps,

custom,

customer_balance,

gopay,

mb_way,

ng_bank,

ng_bank_transfer,

ng_card,

ng_market,

ng_ussd,

paypal,

payto,

qris,

rechnung,

south_korea_market,

kr_market,

shopeepay,

upi,

sunbit,

netbanking,

id_bank_transfer,

demo_pay,

shop_pay,

sezzle,

coinbase,

splitit,

platform_balance,

apple,

venmo,

unknown

data.payment_method.card

object

required

The card data associated with the payment method, if its a debit or credit card.

Show child attributes

data.payment_method.card.brand

enum<string> | null

required

Card brand (e.g., VISA, MASTERCARD).

Available options:

mastercard,

visa,

amex,

discover,

unionpay,

jcb,

diners,

link,

troy,

visadankort,

visabancontact,

china_union_pay,

rupay,

jcbrupay,

elo,

maestro,

unknown

data.payment_method.card.last4

string | null

required

Last four digits of the card.

data.payment_method.card.exp_month

integer | null

required

Card expiration month, like 03 for March.

Example:

42

data.payment_method.card.exp_year

integer | null

required

Card expiration year, like 27 for 2027.

Example:

42

data.metadata

object

required

The metadata associated with the setup intent

Response

200

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

Introduction

Payins

Payouts

Identity

CRM

Engagement

Courses

Developer

Setupintent requires action

Headers

Body

Response