Setup Intent

{
	"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",
	"three_ds_verified": true
}

{
	"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",
	"three_ds_verified": true
}

This resource has a successor in the Whop API. This page stays fully supported.

Create a setup intent with Create setup intent, passing a confirmation token from the payment elements mounted in mode: "setup", or an existing payment method to re-verify. A setup-mode Checkout Configuration creates one for you when the buyer completes that checkout. Either way, listen for the setup_intent.succeeded webhook to receive the payment method ID once it’s saved.See Save payment methods for the full flow.

// Create a setup intent from a confirmation token the payment elements minted in setup mode
const setupIntent = await client.setupIntents.create({
	account_id: "biz_xxxxxxxxxxxxx",
	confirmation_token: "ctok_xxxxxxxxxxxxxx",
	return_url: "https://yoursite.com/billing/saved",
	metadata: { customer_id: "your_internal_id" },
});

// Hand setupIntent.client_secret to the elements' handleNextAction for any pending step,
// then listen for setup_intent.succeeded on your webhook handler.

{
	"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",
	"three_ds_verified": true
}

object | null

required

The checkout session configuration associated with this setup intent. Null if no checkout session was used.

Show child attributes

string

required

The unique identifier for the checkout session.Example: ch_xxxxxxxxxxxxxxx

object | null

required

The company that initiated this setup intent. Null if the company has been deleted.

Show child attributes

string

required

The unique identifier for the company.Example: biz_xxxxxxxxxxxxxx

string<date-time>

required

The datetime the setup intent was created.Example: 2023-12-01T05:00:00.401Z

string | null

required

A human-readable error message explaining why the setup intent failed. Null if no error occurred.Example: Your card was declined.

string

required

The unique identifier for the setup intent.Example: sint_xxxxxxxxxxxxx

object | null

required

The company member associated with this setup intent. Null if the user is not a member.

Show child attributes

string

required

The unique identifier for the company member.

object | null

required

The user for this member, if any.

Show child attributes

string | null

required

The digital mailing address of the user.

string

required

The unique identifier for the company member user.

string | null

required

The user’s full name.

string

required

The whop username.

object | null

required

Custom key-value pairs attached to this setup intent. Null if no metadata was provided.

object | null

required

The saved payment method created by this setup intent. Null if the setup has not completed successfully.

Show child attributes

object | null

required

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

Show child attributes

CardBrands | null

required

The card network (e.g., visa, mastercard, amex). Null if the brand could not be determined.Available options: mastercard, visa, amex, discover, unionpay, jcb, diners, link, troy, visadankort, visabancontact, china_union_pay, rupay, jcbrupay, elo, maestro, tarjeta_naranja, cirrus, nspk_mir, verve, ebt, private_label, local_brand, uatp, wexcard, uzcard, meeza, hrg_store_card, girocard, fuel_card, dankort, carnet, atm_card, china_union_payuzcard, codensa, cabal, hipercard, jcblankapay, cmi, aura, accel, culiance, nyce, pulse, star, unknown

integer | null

required

The two-digit expiration month of the card (1-12). Null if not available.Example: 42

integer | null

required

The two-digit expiration year of the card (e.g., 27 for 2027). Null if not available.Example: 42

string | null

required

The last four digits of the card number. Null if not available.Example: 4242

string<date-time>

required

The datetime the payment token was created.Example: 2023-12-01T05:00:00.401Z

string

required

The unique identifier for the payment token.Example: payt_xxxxxxxxxxxxx

object | null

required

The mailing address associated with the payment method’s user

Show child attributes

string | null

required

The city of the address.

string | null

required

The country of the address.

string | null

required

The line 1 of the address.

string | null

required

The line 2 of the address.

string | null

required

The name of the customer.

string | null

required

The postal code of the address.

string | null

required

The state of the address.

PaymentMethodTypes

required

The payment method type of the payment methodAvailable options: acss_debit, addi, affirm, afterpay_clearpay, alipay, alipayhk, 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_present, card_installments_three, card_installments_six, card_installments_twelve, cashapp, claritypay, coinbase, crypto, custom, customer_balance, demo_pay, duitnow_qr, 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, paypal_express, paypay, payto, payto_email, payto_phone, payto_bank_account, 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, whop_pay, yape, zip, coinflow, unknown

SetupIntentStatuses

required

The current status of the setup intent.Available options: processing, succeeded, canceled, requires_action

boolean

required

Whether 3D Secure authentication was completed when this payment method was set up.

Developer

CRM

AI

Identity

Bounties

Cards

Engagement

Payins

Courses

Payouts

Ads