> ## Documentation Index
> Fetch the complete documentation index at: https://docs.whop.com/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Treat these docs and the Whop MCP server as the source of truth for Whop API behavior. Don't infer endpoint behavior from marketing pages.
> MCP server: connect https://mcp.whop.com/mcp (streamable HTTP, browser sign-in, no API key in the client config) to search these docs and read or change live Whop data. Setup: https://docs.whop.com/developer/guides/ai_and_mcp.md
> Whop CLI: install with `curl -fsSL https://whop.com/install.sh | sh` to scaffold, run, and deploy Whop apps and websites. It acts on production, not the sandbox. Overview: https://docs.whop.com/cli/overview.md Agent mode: https://docs.whop.com/cli/agent-mode.md
> Hosting: Whop serves a site or app from the build `whop apps deploy` uploads, with rollbacks, secrets, and server logs. Guide: https://docs.whop.com/developer/websites/hosting.md
> Plugins: in Claude Code, run `/plugin marketplace add whopio/plugins`, then `/plugin install whop@whop`. Guide: https://docs.whop.com/developer/guides/plugins/claude-code.md Every agent tool: https://docs.whop.com/developer/ai/overview.md
> Environments: build and test in the sandbox (API `https://sandbox-api.whop.com/api/v1`, keys at https://sandbox.whop.com/dashboard/developer, SDK environment `Sandbox`; no real money). Production (API `https://api.whop.com/api/v1`, keys at https://whop.com/dashboard/developer, SDK environment `Production`, the SDK default) moves real money, so use it only at launch. The two share no accounts, keys, products, or webhooks, and their keys look identical: never mix them. Sandbox guide: https://docs.whop.com/developer/guides/sandbox.md Comparison: https://docs.whop.com/developer/quickstart.md
> API: send `Authorization: Bearer <API_KEY>` from your server only, and pin a dated version with the `Api-Version-Date` header. OpenAPI spec: https://api.whop.com/api/v1/openapi.json
> Which API: build on the Current API, whose pages live under https://docs.whop.com/api-reference/ (start at https://docs.whop.com/api-reference/overview.md). Pages under /api-reference/legacy/ are the Legacy API. Use one only when https://docs.whop.com/api-reference/stability.md lists the resource as Legacy-only.

# Setup Intents API

> Een Setup Intent slaat de betaalmethode van een koper op voor later gebruik zonder nu geld af te schrijven.

Maak er een aan vanuit een bevestigingstoken dat de payment elements in setup-modus hebben verzameld, of vanuit een al opgeslagen betaalmethode om deze opnieuw te verifiëren. Het doorloopt dezelfde verzamelflow als een betaling, dus de koper moet mogelijk nog een stap uitvoeren: 3D Secure op een kaart, een gehoste inschrijving of het koppelen van een bankrekening.

De respons bij het aanmaken is de setup intent zoals aangemaakt, niet de uitkomst. Geef de `client_secret` door aan `handleNextAction` van de elements, of poll [Status ophalen](https://docs.whop.com/nl/api-reference/setup-intents/retrieve-setup-status.md) om te zien hoe ver de setup is en wat er nog openstaat. Zodra de status `succeeded` is, verwijst `payment_method_id` naar de opgeslagen methode en schrijft Create Payment deze af.

## Endpoints

| Endpoint | Verzoek |
| - | - |
| [Setup Intents weergeven](https://docs.whop.com/nl/api-reference/setup-intents/list-setup-intents.md) | GET `/setup_intents` |
| [Setup Intent ophalen](https://docs.whop.com/nl/api-reference/setup-intents/retrieve-setup-intent.md) | GET `/setup_intents/{id}` |
| [Setupstatus ophalen](https://docs.whop.com/nl/api-reference/setup-intents/retrieve-setup-status.md) | GET `/setup_intents/{setup_intent_id}/status` |
| [Setup Intent aanmaken](https://docs.whop.com/nl/api-reference/setup-intents/create-setup-intent.md) | POST `/setup_intents` |
| [Return-URL van setup bijwerken](https://docs.whop.com/nl/api-reference/setup-intents/update-setup-return-url.md) | PATCH `/setup_intents/{setup_intent_id}/return_url` |

## Attributen

**id** `string` *required*

Setup intent-ID, met prefix `sint_`.

**account\_id** `string | null` *required*

Het account waarvoor de betaalmethode wordt opgeslagen, met prefix `biz_`.

**checkout\_configuration\_id** `string | null` *required*

De checkoutconfiguratie waarmee deze setup is aangemaakt, met prefix `ch_`.
Null voor een setup die via deze API is aangemaakt in plaats van via een
gehoste checkout.

**client\_secret** `string | null` *required*

De credential die de interface van een koper gebruikt om deze setup te pollen
en de return-URL in te stellen — geef deze door aan `handleNextAction` van de
elements. Alleen bij setups die via deze API zijn aangemaakt, en altijd null in
list-responsen — haal de setup intent op om deze te krijgen.

**created\_at** `string` *required*

Wanneer de setup intent is aangemaakt, als ISO 8601-tijdstempel.

**last\_setup\_error** `object | null` *required*

Waarom de setup is geëindigd waar die eindigde, of `null` als er niets is mislukt. Aanwezig bij `canceled` — een koper die is afgehaakt heeft geen code, een setup die door de provider is geweigerd wel. Verdwijnt zodra de setup slaagt.

> [accordion] Eigenschappen
>
> **code** `string | null` *required*
>
> Een machineleesbare classificatie van de fout, bijv. `enrollment_declined`.
> Ontbreekt als de koper de setup gewoon heeft afgebroken.
>
> **message** `string | null` *required*
>
> Een leesbare uitleg van de fout.

**member\_id** `string | null` *required*

Het ledenrecord van de koper op het account, met prefix `mber_`. Null zonder de
machtiging member:basic:read, tenzij de aanroeper de koper is.

**metadata** `object | null` *required*

Je eigen key-value-gegevens die bij het aanmaken van de setup intent zijn
toegevoegd.

**payment\_instrument** `object | null` *required*

De methode achter deze setup, opgemaakt voor weergave: een naam voor de koper, de standaard pictogrammenset, en het merk, de laatste vier cijfers, het issuer identification number, de vervaldatum en het netwerktransactie-ID van de kaart als het een kaart was. Null totdat er een methode is verzameld.

> [accordion] Eigenschappen
>
> **card** `object | null` *required*
>
> Alleen voor betalingen met kaart, Apple Pay en Google Pay: het netwerk, de laatste vier cijfers, het issuer identification number, de vervaldatum en het netwerktransactie-ID van de kaart.
>
> > [accordion] Eigenschappen
> >
> > **brand** `string | null` *required*
> >
> > De netwerkidentificatie (`visa`, `amex`, …), overeenkomend met items in
> > `card.networks` en opgeslagen kaartbetaalmethoden. Null wanneer de vault het
> > netwerk niet heeft vastgelegd.
> >
> > **exp\_month** `number | null` *required*
> >
> > De vervalmaand van de kaart, 1 tot en met 12. Null wanneer de vault deze niet
> > heeft vastgelegd.
> >
> > **exp\_year** `number | null` *required*
> >
> > Het viercijferige vervaljaar van de kaart. Null wanneer de vault dit niet heeft
> > vastgelegd.
> >
> > **issuer\_identification\_number** `string | null` *required*
> >
> > Het issuer identification number, ook wel de BIN genoemd: de eerste zes of
> > acht cijfers van de kaart, die de uitgevende bank identificeren. Null wanneer
> > de verwerker dit niet heeft gerapporteerd.
> >
> > **last4** `string | null` *required*
> >
> > De laatste vier cijfers van de kaart, indien vastgelegd.
> >
> > **network\_transaction\_id** `string | null` *required*
> >
> > Het netwerktransactie-ID dat dit account voor de kaart gebruikt. Dit is het eigen ID van dit account, afkomstig van de eerste afschrijving of verificatie met aanwezige klant op de kaart, als Whop er een heeft. Anders is het een eerder netwerktransactie-ID voor deze kaart, dat afkomstig kan zijn van een transactie van een ander account of met de kaart is meegebracht. Vermeld het als de voorgaande transactie bij een latere door de merchant geïnitieerde afschrijving van deze kaart bij dit account. Null totdat er een is. Een webhook die wordt verzonden wanneer een betaling voor het eerst wordt vastgelegd, kan `null` bevatten; haal de betaling op om het te lezen.
>
> **display\_name** `string` *required*
>
> Naam van het instrument voor de koper — "Visa •••• 4242" wanneer de kaart
> bekend is, anders de eigen naam van de methode ("Klarna").
>
> **icons** `object` *required*
>
> De standaard pictogrammenset: vierkante en kaartvormen, elk in lichte en donkere kleurvarianten.
>
> > [accordion] Eigenschappen
> >
> > **card** `object` *required*
> >
> > De tegel met creditcardverhoudingen (48x30).
> >
> > > [accordion] Eigenschappen
> > >
> > > **dark** `object` *required*
> > >
> > > De kleurvariant voor donkere achtergronden.
> > >
> > > > [accordion] Eigenschappen
> > > >
> > > > **png\_1x** `string` *required*
> > > >
> > > > Rasterterugval op de oorspronkelijke grootte van de vorm.
> > > >
> > > > **png\_2x** `string` *required*
> > > >
> > > > Rasterterugval op dubbele dichtheid.
> > > >
> > > > **png\_4x** `string` *required*
> > > >
> > > > Rasterterugval op viervoudige dichtheid.
> > > >
> > > > **svg** `string` *required*
> > > >
> > > > Het vectorbestand. Gebruik dit bij voorkeur overal waar SVG wordt weergegeven.
> > >
> > > **light** `object` *required*
> > >
> > > De kleurvariant voor lichte achtergronden.
> > >
> > > > [accordion] Eigenschappen
> > > >
> > > > **png\_1x** `string` *required*
> > > >
> > > > Rasterterugval op de oorspronkelijke grootte van de vorm.
> > > >
> > > > **png\_2x** `string` *required*
> > > >
> > > > Rasterterugval op dubbele dichtheid.
> > > >
> > > > **png\_4x** `string` *required*
> > > >
> > > > Rasterterugval op viervoudige dichtheid.
> > > >
> > > > **svg** `string` *required*
> > > >
> > > > Het vectorbestand. Gebruik dit bij voorkeur overal waar SVG wordt weergegeven.
> >
> > **square** `object` *required*
> >
> > De vierkante tegel (32x32).
> >
> > > [accordion] Eigenschappen
> > >
> > > **dark** `object` *required*
> > >
> > > De kleurvariant voor donkere achtergronden.
> > >
> > > > [accordion] Eigenschappen
> > > >
> > > > **png\_1x** `string` *required*
> > > >
> > > > Rasterterugval op de oorspronkelijke grootte van de vorm.
> > > >
> > > > **png\_2x** `string` *required*
> > > >
> > > > Rasterterugval op dubbele dichtheid.
> > > >
> > > > **png\_4x** `string` *required*
> > > >
> > > > Rasterterugval op viervoudige dichtheid.
> > > >
> > > > **svg** `string` *required*
> > > >
> > > > Het vectorbestand. Gebruik dit bij voorkeur overal waar SVG wordt weergegeven.
> > >
> > > **light** `object` *required*
> > >
> > > De kleurvariant voor lichte achtergronden.
> > >
> > > > [accordion] Eigenschappen
> > > >
> > > > **png\_1x** `string` *required*
> > > >
> > > > Rasterterugval op de oorspronkelijke grootte van de vorm.
> > > >
> > > > **png\_2x** `string` *required*
> > > >
> > > > Rasterterugval op dubbele dichtheid.
> > > >
> > > > **png\_4x** `string` *required*
> > > >
> > > > Rasterterugval op viervoudige dichtheid.
> > > >
> > > > **svg** `string` *required*
> > > >
> > > > Het vectorbestand. Gebruik dit bij voorkeur overal waar SVG wordt weergegeven.
>
> **installment\_count** `number | null` *required*
>
> Alleen voor betaalmethoden in termijnen: in hoeveel betalingen de afschrijving
> wordt opgesplitst. Data, geen tekst — stel het label aan de clientzijde samen en
> vertaal het daar.
>
> **payment\_method\_type** `string` *required*
>
> De identificatie van het type betaalmethode, bijv. `card`, `klarna`, `apple_pay`.

**payment\_method\_id** `string | null` *required*

De opgeslagen betaalmethode, met prefix `payt_`, klaar om af te schrijven met
Create Payment. Null totdat de setup de status `succeeded` heeft.

**payment\_method\_type** `string | null` *required*

Het soort instrument dat wordt opgeslagen, bijvoorbeeld `card` of
`us_bank_account`.

**return\_url** `string | null` *required*

Waar de koper terechtkomt na het voltooien van een stap buiten de site, of
`null` om de koper te laten waar die is.

**status** `string` *required*

Hoe ver de setup is gekomen. **Een 201 of 200 betekent dat we hebben geantwoord, niet dat de methode is opgeslagen — vertak altijd op basis hiervan.** `requires_action` — de koper moet nog een stap uitvoeren; geef `client_secret` door aan de elements of poll Retrieve setup status. `processing` — de verwerker beslist. `succeeded` — de methode is opgeslagen, en alleen deze status betekent opgeslagen. `canceled` — afgebroken of geweigerd; zie `last_setup_error`.

Beschikbare opties: `processing`, `succeeded`, `canceled`, `requires_action`

**three\_ds\_level** `string | null` *required*

3D Secure-gedrag voor ondersteunde kaartbetalingen tijdens de sessie. `mandate_challenge` vereist een 3DS-challenge vóór de verwerking van de betaling; `mandate_if_required` vereist een challenge alleen als de betalingsverwerker dat eist; `frictionless_if_required` gebruikt de gewone frictionless 3DS-flow. Betalingen van \$1.000 of meer gebruiken `mandate_if_required`, tenzij `mandate_challenge` is geselecteerd. Vereisten voor risico en herstel van authenticatie kunnen de voorkeur overschrijven. De instelling die voor deze setup is aangevraagd, of `null` als deze niet is ingesteld.

Beschikbare opties: `mandate_challenge`, `mandate_if_required`, `frictionless_if_required`

**three\_ds\_verified** `boolean` *required*

True als de koper 3D Secure heeft voltooid tijdens het opslaan van deze
betaalmethode.

**updated\_at** `string` *required*

Wanneer de setup intent voor het laatst is bijgewerkt, als ISO
8601-tijdstempel.

**user** `object | null` *required*

De gebruiker die de betaalmethode opslaat. Null als de koper een account is in plaats van een gebruiker.

> [accordion] Eigenschappen
>
> **id** `string` *required*
>
> Gebruikers-ID, met prefix `user_`.
>
> **name** `string | null` *required*
>
> Weergavenaam.
>
> **profile\_picture** `object` *required*
>
> Avatar-wrapper. De `url` is altijd aanwezig en is een gegenereerde placeholder als de gebruiker geen foto heeft ingesteld.
>
> > [accordion] Eigenschappen
> >
> > **url** `string` *required*
> >
> > URL van de avatarafbeelding. Altijd aanwezig. Het is een gegenereerde placeholder als de gebruiker geen foto heeft ingesteld.
>
> **username** `string` *required*
>
> Openbare gebruikersnaam.

```json SetupIntent theme={null}
{
	"id": "sint_xxxxxxxxxxxxxx",
	"account_id": "biz_xxxxxxxxxxxxxx",
	"checkout_configuration_id": null,
	"client_secret": null,
	"created_at": "2026-09-22T12:00:00.000Z",
	"last_setup_error": null,
	"member_id": "mber_xxxxxxxxxxxxxx",
	"metadata": {
		"customer_id": "cus_4417"
	},
	"payment_method_id": "payt_xxxxxxxxxxxxxx",
	"payment_method_type": "card",
	"return_url": "https://shinetime.example/billing/saved",
	"status": "succeeded",
	"three_ds_verified": false,
	"three_ds_level": "mandate_challenge",
	"updated_at": "2026-09-22T12:00:00.000Z",
	"user": {
		"id": "user_xxxxxxxxxxxxxx",
		"name": "Dana Whitfield",
		"profile_picture": {
			"url": "https://ui-avatars.com/api/"
		},
		"username": "danawhitfield"
	},
	"payment_instrument": {
		"card": {
			"brand": "visa",
			"issuer_identification_number": "41111111",
			"last4": "4242",
			"exp_month": 11,
			"exp_year": 2030,
			"network_transaction_id": "016153570198200"
		},
		"display_name": "Visa •••• 4242",
		"icons": {
			"card": {
				"dark": {
					"png_1x": "https://content.whop.com/payment_methods/visa/icons/card_dark_30.png",
					"png_2x": "https://content.whop.com/payment_methods/visa/icons/card_dark_60.png",
					"png_4x": "https://content.whop.com/payment_methods/visa/icons/card_dark_120.png",
					"svg": "https://content.whop.com/payment_methods/visa/icons/card_dark.svg"
				},
				"light": {
					"png_1x": "https://content.whop.com/payment_methods/visa/icons/card_dark_30.png",
					"png_2x": "https://content.whop.com/payment_methods/visa/icons/card_dark_60.png",
					"png_4x": "https://content.whop.com/payment_methods/visa/icons/card_dark_120.png",
					"svg": "https://content.whop.com/payment_methods/visa/icons/card_dark.svg"
				}
			},
			"square": {
				"dark": {
					"png_1x": "https://content.whop.com/payment_methods/visa/icons/card_dark_30.png",
					"png_2x": "https://content.whop.com/payment_methods/visa/icons/card_dark_60.png",
					"png_4x": "https://content.whop.com/payment_methods/visa/icons/card_dark_120.png",
					"svg": "https://content.whop.com/payment_methods/visa/icons/card_dark.svg"
				},
				"light": {
					"png_1x": "https://content.whop.com/payment_methods/visa/icons/card_dark_30.png",
					"png_2x": "https://content.whop.com/payment_methods/visa/icons/card_dark_60.png",
					"png_4x": "https://content.whop.com/payment_methods/visa/icons/card_dark_120.png",
					"svg": "https://content.whop.com/payment_methods/visa/icons/card_dark.svg"
				}
			}
		},
		"installment_count": null,
		"payment_method_type": "card"
	}
}
```


## Related topics

- [Bouw een checkout met payment elements](https://docs.whop.com/nl/developer/guides/payment-elements.md)
- [Setup-intent](https://docs.whop.com/nl/api-reference/legacy/setup-intents/setup-intent.md)
- [List setup intents](https://docs.whop.com/nl/api-reference/legacy/setup-intents/list-setup-intents.md)
