> ## 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.

# Payments

> Ontvang een betaling op basis van een `plan_`-ID of een inline valuta en bedrag, of sla een betaalmethode op zonder af te schrijven met `mode: "setup"`. Mount PaymentElement, CardElement of CardFields en roep daarna `payments.createConfirmationToken` aan met factuurgegevens. Bij een walletselectie wordt de sheet automatisch geopend. Wanneer het account bankkoppeling op de pagina aanbiedt (`bank_debit.bank_connection` op het betaalmethodetype voor bankrekeningen), opent een selectie van een bankrekening Plaid Link ook op de pagina. Als een koper een van beide sluit, wordt de aanroep geweigerd met `payment_request_cancelled`, wat je betaalhandler als annulering moet behandelen. Bevestig het token server-side en geef daarna de `client_secret` van de betaling of setup intent door aan `handleNextAction` voor een eventuele openstaande stap.

> [!NOTE]
>
> Deze pagina documenteert `@whop/elements@1.10.0` en `@whop/elements-react@1.10.0`.

*Sinds `v1.0.0`.*

## Playground

Stel de elementen samen met voorbeeldgegevens. Bedien de besturingselementen, voeg elementen toe, rangschik ze en zie events live afgaan:

```tsx React theme={null}
import { WhopElements, Payments } from "@whop/elements-react";
import { loadWhop } from "@whop/elements";

function Example() {
  return (
    <WhopElements elements={loadWhop()}>
      <Payments /* options */>
        {/* mount elements here */}
      </Payments>
    </WhopElements>
  );
}
```

```html JavaScript theme={null}
<script src="https://cdn.whop.com/elements/amber/elements.js" data-whop-elements></script>
<script type="module">
  const payments = window.WhopElements().payments.create({ /* options */ });
</script>
```

## Opties

Geef deze mee aan `whop.payments.create({ … })`, of als props op `<Payments>` in React.

> [!NOTE]
>
> Geef precies één van deze combinaties mee:
>
> * `accountId` en `plan`
> * `accountId`, `currency` en `amount`
> * `accountId`, `mode: "setup"` en `currency`
> * geen van `plan`, `currency`, `amount` of `mode`

**accountId** `string`

Account-ID, met het voorvoegsel `biz_`. Laat het alleen weg bij het aanroepen van statische methoden zonder accountoppervlak.

**mode** `"payment" | "setup"`

Mountmodus, standaard `payment`. `setup` slaat een betaalmethode op en schrijft niets af, nu of later: alleen methoden die kunnen worden opgeslagen worden aangeboden en bedraggrenzen zijn niet van toepassing. Bevestig met `createConfirmationToken()` en maak daarna de setup intent server-side aan.

**plan** `string`

Plan-ID, met het voorvoegsel `plan_`. Wordt client-side omgezet naar valuta, bedrag en methodeconfiguratie. Geef een plan of een inline valuta en bedrag mee, nooit beide.

**offerAmounts** `object`

Totalen `feeInclusive` en `feeFree` in de kleinste munteenheid, gebruikt om methoden te filteren wanneer de checkout `amount` opnieuw prijst voor een methode zonder kosten, zoals BNPL. Elke methode wordt gecontroleerd tegen het bijbehorende totaal, zodat de geselecteerde methode zonder kosten niet verdwijnt. Als het wordt weggelaten, filtert `amount` elke methode.

**eigenschappen**

**feeInclusive** `number` *required*

**feeFree** `number` *required*

**returnUrl** `string`

Retour-URL voor externe bank- of 3DS-stappen. Standaard de pagina waarop wordt gemount. De koper komt daar terecht, wat de uitkomst ook is, met `payment` (of `setup`), `status` (`succeeded`, `failed`, `canceled` of een nog openstaande status zoals `processing`) en `client_secret` toegevoegd, dus vertak op `status` voordat je een succespagina toont.

**setupFutureUsage** `"off_session" | "on_session"`

Een setup slaat de betaalmethode op voor `off_session`-gebruik, het enige gebruik dat een setup accepteert.

**previewWalletAvailability** `WalletAvailability`

Overschrijving van de walletbeschikbaarheid voor deterministische previews. Live checkouts tasten de host af.

**eigenschappen**

**applePay** `boolean` *required*

**googlePay** `boolean` *required*

**payPal** `boolean`

**order** `("apple_pay" | "google_pay" | "paypal_express")[]`

De wallets gerangschikt op welke sheet native is in deze browser — Apple Pay eerst op WebKit, Google Pay eerst overal elders, PayPal als laatste — zodat expressknoppen met de beste bovenaan kunnen worden gestapeld. Ontbreekt bij door de consument opgegeven beschikbaarheid (previews) en bij berichten van vóór deze toevoeging. Een inline union, niet de WalletSheetType van payment-request: die module importeert deze al.

**wallets** `object`

De details van elke beschikbare wallet, met het wallettype als sleutel. Ontbreekt bij door de consument opgegeven beschikbaarheid (previews).

**eigenschappen**

**apple\_pay** `WalletDetails`

**eigenschappen**

**button** `WalletButtonArt`

De officiële knopafbeelding van de wallet. Ontbreekt wanneer er geen is gepubliceerd.

**eigenschappen**

**light** `object` *required*

Voor lichte pagina's.

**eigenschappen**

**color** `string` *required*

**image** `string` *required*

**dark** `object` *required*

Voor donkere pagina's.

**eigenschappen**

**color** `string` *required*

**image** `string` *required*

**google\_pay** `WalletDetails`

**eigenschappen**

**button** `WalletButtonArt`

De officiële knopafbeelding van de wallet. Ontbreekt wanneer er geen is gepubliceerd.

**eigenschappen**

**light** `object` *required*

Voor lichte pagina's.

**eigenschappen**

**color** `string` *required*

**image** `string` *required*

**dark** `object` *required*

Voor donkere pagina's.

**eigenschappen**

**color** `string` *required*

**image** `string` *required*

**paypal\_express** `WalletDetails`

**eigenschappen**

**button** `WalletButtonArt`

De officiële knopafbeelding van de wallet. Ontbreekt wanneer er geen is gepubliceerd.

**eigenschappen**

**light** `object` *required*

Voor lichte pagina's.

**eigenschappen**

**color** `string` *required*

**image** `string` *required*

**dark** `object` *required*

Voor donkere pagina's.

**eigenschappen**

**color** `string` *required*

**image** `string` *required*

**currency** `string`

Drieletterige ISO 4217-valutacode in kleine letters. Filtert de betaalmethodematrix.

**amount** `number`

Betalingsbedrag in de kleinste munteenheid. Methoden waarvan de grenzen het uitsluiten, worden niet aangeboden.

**paymentMethodConfiguration** `object`

Betaalmethodefilters van het account in het formaat `enabled`, `disabled` en `include_platform_defaults` van de API. `disabled` verwijdert typen, `enabled` herstelt aangeboden typen en `include_platform_defaults: false` laat alleen ingeschakelde typen over. Plannen leveren hun eigen configuratie.

**eigenschappen**

**enabled** `string[]`

**disabled** `string[]`

**include\_platform\_defaults** `boolean`

**appearance** `Appearance`

Visuele aanpassing voor de elementen van deze groep. Overschrijft de globale `WhopElements({ appearance })`. Wijzig het live met `update({ appearance })`.

**locale** `WhopElementsLocale`

Locale voor de UI-tekst van de elementen in deze groep. Stel het in op een van de ingebouwde locales van de app om de globale configuratie te overschrijven. Elke andere waarde valt terug op de standaardlocale.

## Events

Geef callbacks mee in de create-opties of als React-props.

### `onLoadingChange`

Wordt uitgevoerd wanneer de gegroepeerde laadstatus verandert. De waarde is `true` zolang een gemount element nog laadt.

**loading** `boolean`

## Methoden

Roep deze aan op de Payments-handle van `whop.payments.create({ … })` of `usePayments()`.

### `createConfirmationToken`

Maakt vanuit je betaalknop een bevestigingstoken aan voor de geselecteerde methode. Geef de factuurgegevens van de checkout mee. Die moeten `email` bevatten. Geef `phone` mee voor methoden die dat vereisen wanneer het verzamelen van factuurgegevens is uitgeschakeld. Kaarten hebben ook `name` nodig en een adres met `line1` en `country`. Bij een walletselectie wordt de sheet geopend tijdens de interactie met de betaalknop. Wanneer het account bankkoppeling op de pagina aanbiedt (`bank_debit.bank_connection` op het betaalmethodetype voor bankrekeningen), opent een selectie van een bankrekening daarbij ook Plaid Link, en wordt de aanroep afgerond zodra de koper een rekening heeft gekoppeld. Daarvoor is een whop.com-pagina nodig of een domein dat gereed is voor Apple Pay via de [Domains API](https://docs.whop.com/nl/api-reference/beta/domains/domain), en een Content Security Policy die de Plaid-hosts toestaat die `contentSecurityPolicy()` retourneert. Anders koppelt de koper de rekening in plaats daarvan na het verzenden. Als de koper de sheet of Link sluit, wordt de aanroep geweigerd met `payment_request_cancelled`: behandel dat als een annulering, niet als een betaalfout, en laat de koper opnieuw betalen. Bevestig het geretourneerde `confirmationToken` server-side en roep daarna `WhopElements.payments.handleNextAction(…)` aan. Wordt uitgevoerd op je pagina (host-side), niet in het controller-iframe.

**Parameters**

**input** `object` *required*

**eigenschappen**

**billingDetails** `object`

**eigenschappen**

**email** `string`

**name** `string`

**phone** `string`

**address** `object`

**eigenschappen**

**country** `string`

**line1** `string`

**line2** `string`

**city** `string`

**state** `string`

**postal\_code** `string`

**Retourneert** `Promise<object>`

**confirmationToken** `string` *required*

**type** `string` *required*

### `update`

Voegt nieuwe handle-opties samen in elk gemount element. Wijzig in React in plaats daarvan de namespace-props.

**Parameters**

**options** `Partial\<PaymentsOptions\>` *required*

### `destroy`

Verwijdert elk element en elke subcontroller die deze handle heeft aangemaakt, verwijdert het controllerframe en geeft de abonnementen vrij. Je kunt het meerdere keren aanroepen, maar een verwijderde handle weigert elke andere aanroep — maak een nieuwe handle aan om opnieuw te beginnen. React verwijdert de groep automatisch wanneer de provider wordt ontkoppeld.

## Statische methoden

Roep deze aan zonder te mounten: `whop.payments.<method>(…)` in vanilla of `useWhop().payments.<method>(…)` in React.

### `handleNextAction`

Voltooit de openstaande stap van een bevestigde betaling zonder een element te mounten. `clientSecret` identificeert de betaling. Je hebt geen betalings-ID nodig. Inline stappen openen in een dialoogvenster en worden afgerond met `redirected: false`. Als het dialoogvenster wordt gesloten, wordt de huidige status van de betaling geretourneerd, die openstaand kan blijven. Stappen op een volledige pagina leiden door met `redirected: true` naar `return_url`, of naar een gehost ontvangstbewijs als de betaling geen retour-URL heeft. Binnen een iframe navigeren ze het tabblad op het hoogste niveau. Als de insluitende pagina die navigatie weigert, worden ze geweigerd met code `TAB_NAVIGATION_BLOCKED` en blijft de betaling openstaan. Stel `returnUrl` in om de bestemming vóór de weergave bij te werken. Een mislukte update wordt geweigerd voordat er een stap wordt uitgevoerd. Inline stappen navigeren nooit naar die URL. Een betaling waarover de afschrijving nog wordt beslist, wordt gepolld totdat er een stap verschijnt of de betaling is afgehandeld; een betaling waarover al is beslist en zonder stap wordt direct afgerond.

**Parameters**

**input** `object` *required*

**eigenschappen**

**clientSecret** `string` *required*

**returnUrl** `string`

**pollIntervalMs** `number`

**Retourneert** `Promise<object>`

**status** `string` *required*

**redirected** `boolean` *required*

**lastPaymentError** `object | null` *required*

**eigenschappen**

**code** `string | null`

**decline\_code** `string | null`

**message** `string | null`

## Bronnen

Maak deze SDK-objecten aan zonder een element te mounten. Elk heeft een eigen pagina:

> [card] [PaymentRequest](https://docs.whop.com/nl/elements/latest/payments/paymentRequest.md)
>
> Low-level sheet voor Apple Pay, Google Pay of PayPal voor aangepaste knoppen, express checkout en verzendcallbacks. Wallettegels automatiseren deze flow via `payments.createConfirmationToken`. Wacht op `canMakePayment()` om de beschikbaarheid te controleren en de wallet voor te bereiden, en roep daarna `show(type)` synchroon aan in de handler van de gebruikersinteractie. De opgeleverde `ctok` is een bevestigingstoken met het voorvoegsel `ctok_`. Bevestig het server-side zoals een token dat door een element is aangemaakt. Een PayPal-token schrijft maximaal het totaal af dat PayPal aan de koper heeft getoond.

## Content Security Policy

Een deel van het werk van deze groep wordt uitgevoerd op je pagina, niet in een frame. Een pagina met een Content Security Policy heeft deze bronnen nodig. `contentSecurityPolicy()` uit `@whop/elements` retourneert elke bron in deze tabel. De sandboxbron geldt bij `environment: "sandbox"`.

| Vereiste | Directive | Productiebron | Sandboxbron |
| - | - | - | - |
| Script van Plaid Link | `script-src` | `https://cdn.plaid.com` | Hetzelfde |
| ↳ Frame van Plaid Link, dat het script van Plaid opent | `frame-src` | `https://cdn.plaid.com` | Hetzelfde |
| ↳ API van Plaid, die het script van Plaid aanroept | `connect-src` | `https://production.plaid.com` | `https://sandbox.plaid.com` |

## Elementen

De elementen die deze groep mount. Elk heeft een eigen pagina:

> [card] [AddressElement](https://docs.whop.com/nl/elements/latest/payments/address.md)
>
> Verzamelt een factuur- of verzendadres. Velden, volgorde en validatie volgen het geselecteerde land. Bevat autocomplete voor straten (schermvullend op telefoons) en methoden om het adres te lezen of te valideren.

> [card] [EmailElement](https://docs.whop.com/nl/elements/latest/payments/email.md)
>
> Verzamelt het e-mailadres van de koper en geeft het door aan `payments.createConfirmationToken()` zolang het gemount is. Een expliciete `billingDetails.email` heeft voorrang. Bij een overeenkomend Whop-account wordt een optionele inlog getoond met codeverificatie, of met de passkey van het account als dat er een heeft. Een geslaagde inlog ontgrendelt opgeslagen betaalmethoden in het betaalelement. Kopers kunnen doorgaan als gast.

> [card] [TaxIdElement](https://docs.whop.com/nl/elements/latest/payments/taxId.md)
>
> Verzamelt een zakelijke belastingregistratie die door de API wordt geaccepteerd. Labels gebruiken namen die voor kopers bedoeld zijn. De placeholder komt overeen met het geselecteerde formaat. `country` selecteert vooraf een type. `onChange` zendt vastgelegde paren uit. De host levert de validatiefouten van de API.

> [card] [BrandingElement](https://docs.whop.com/nl/elements/latest/payments/branding.md)
>
> **Vereist — de andere elementen behalve `AddressElement`, `EmailElement` en `TaxIdElement` wachten erop.** De merchant-of-record-melding van Whop: de instemming van de koper met de Buyer Terms of Service en het Privacy Policy van Whop, met het Whop-woordmerk. Vereist — de elementen voor betaling, kaart en kaartvelden blijven in hun laadstatus totdat het is gemount, en betalingen kunnen zonder dit element niet worden bevestigd.

**Alternatieven.** Mount er één tegelijk. Verwijder het voordat je een ander mount:

> [card] [PaymentElement](https://docs.whop.com/nl/elements/latest/payments/payment.md)
>
> Toont de beschikbare betaalmethoden en verzamelt de vereiste velden en vermeldingen van de geselecteerde methode. Gebruik `change` om je betaalknop in te schakelen. Roep in de activeringshandler ervan `payments.createConfirmationToken()` aan. Bevestig het token server-side en geef daarna een eventuele openstaande stap door aan `payments.handleNextAction(…)`. Gebruik `addressChange` voor updates die van het adres afhangen.

> [card] [CardElement](https://docs.whop.com/nl/elements/latest/payments/card.md)
>
> Vooraf gerangschikte velden voor kaartnummer, vervaldatum en beveiligingscode. Maak het aan met `payments.create("card")`, schakel je betaalknop in vanuit `onChange` en bevestig met `payments.createConfirmationToken()`. Kaartnummers blijven in PCI-geïsoleerde gehoste velden. `layout` ondersteunt `stacked` (standaard) en `compact`.

> [card] [CardFields](https://docs.whop.com/nl/elements/latest/payments/cardFields)
>
> Drie afzonderlijk te mounten, PCI-geïsoleerde kaartvelden voor aangepaste lay-outs: nummer, vervaldatum en beveiligingscode. Maak het aan met `payments.create("cardFields")`, plaats elk veld, schakel je betaalknop in vanuit `onChange` en bevestig met `payments.createConfirmationToken()`. Kaartnummers blijven in gehoste velden. *(subcontroller, 3 elementen)*
