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

# WithdrawElement

> Verzamelt een uitbetalingsbedrag en een opgeslagen uitbetalingsmethode, groepeert standaard- en directe leveringsopties met live kosten en geschatte aankomsttijden, en verzamelt indien nodig een nieuwe uitbetalingsmethode. Wanneer de host de flow niet aanstuurt, toont het element de methoden en maakt het de uitbetaling zelf aan — geef `accessToken` mee (of vertrouw op de same-origin-sessie van de kijker). Een host die al met de payouts-API communiceert, kan nog steeds methoden, limieten en laadvlaggen aanleveren; bevestigen zendt dan `withdrawalRequested` uit, zodat die host de uitbetaling aanmaakt.

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

*Sinds `v1.0.0`.*

Wordt gemount binnen [`Wallet`](https://docs.whop.com/nl/elements/latest/wallet/overview). `accountId` en `accessToken` komen daarvandaan. Geef props en callbacks mee via de create-opties of als React-props. Bewaar de aangemaakte handle, of React-`ref`, om `refresh()` aan te roepen.

> [!NOTE]
>
> Je kunt dit element **inline** mounten (`create`) of openen als **modale** overlay (`createOverlay`).

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

function Example() {
  return (
    <WhopElements elements={loadWhop()}>
      <Wallet /* options */>
        <WithdrawElement onAmountChanged={(e) => console.log(e)} onCountryChanged={(e) => console.log(e)} onSupportedMethodChanged={(e) => console.log(e)} onAddMethodRequested={(e) => console.log(e)} onPlaidLinkRequested={(e) => console.log(e)} onMethodVerificationCompleted={(e) => console.log(e)} onRenameMethodRequested={(e) => console.log(e)} onRemoveMethodRequested={(e) => console.log(e)} onPayoutQuoteRequested={(e) => console.log(e)} onWithdrawalRequested={(e) => console.log(e)} onDone={(e) => console.log(e)} />
      </Wallet>
    </WhopElements>
  );
}
```

```html JavaScript theme={null}
<script src="https://cdn.whop.com/elements/amber/elements.js" data-whop-elements></script>
<script type="module">
  const wallet = window.WhopElements().wallet.create({ /* options */ });
  wallet.create('withdraw', {
    onAmountChanged: (e) => console.log(e),
    onCountryChanged: (e) => console.log(e),
    onSupportedMethodChanged: (e) => console.log(e),
    onAddMethodRequested: (e) => console.log(e),
    onPlaidLinkRequested: (e) => console.log(e),
    onMethodVerificationCompleted: (e) => console.log(e),
    onRenameMethodRequested: (e) => console.log(e),
    onRemoveMethodRequested: (e) => console.log(e),
    onPayoutQuoteRequested: (e) => console.log(e),
    onWithdrawalRequested: (e) => console.log(e),
    onDone: (e) => console.log(e)
  }).mount('#wallet-withdraw');
</script>
```

Voorbeeldgegevens. [Open de Playground](https://docs.whop.com/nl/elements/latest/wallet/overview#playground).

## Props

**accessToken** `string`

Een scoped token voor het tonen van uitbetalingsmethoden en het aanmaken van de uitbetaling — vereist `payout:withdraw_funds`, `payout:destination:read` en `payout:create_destination` om een bank toe te voegen. Wordt het weggelaten, dan gebruiken de aanroepen de eigen sessie van de kijker, die alleen same-origin antwoordt.

**succeeded** `boolean`

Of de bevestigde uitbetaling met succes is aangemaakt. Standaard `false`.

**loading** `boolean`

Of uitbetalingsmethoden en limieten worden geladen. Standaard `false`.

**methods** `WithdrawalMethod[]`

Opgeslagen uitbetalingsmethoden met offertes voor het huidige bedrag. Standaard `[]`.

**eigenschappen**

**id** `string` *required*

**createdAt** `string | null`

**nickname** `string | null`

**accountReference** `string | null`

**payerName** `string | null`

**destinationCurrency** `string` *required*

**isDefault** `boolean` *required*

**iconUrl** `string | null`

**name** `string | null`

**deliveryType** `string` *required*

**supportsStandard** `boolean` *required*

**supportsInstant** `boolean` *required*

**bankVerificationState** `string | null`

**unavailableReason** `string | null`

**feeStructure** `object | null`

**eigenschappen**

**percentage** `number` *required*

**fixedAmount** `number` *required*

**currency** `string` *required*

**standardEstimatedArrival** `string | null`

**instantEstimatedArrival** `string | null`

**quote** `WithdrawalQuote | null`

**eigenschappen**

**amount** `number` *required*

**currency** `string` *required*

**destinationCurrency** `string` *required*

**exchangeRate** `number` *required*

**minLimit** `number` *required*

**maxLimit** `number | null`

**instantUnavailableReason** `"minimum_crypto_sales_not_met" | null`

**standard** `WithdrawalQuoteSpeed | null`

**eigenschappen**

**estimatedArrival** `string | null`

**fee** `number` *required*

**totalReceived** `number` *required*

**currency** `string`

**destinationCurrency** `string`

**exchangeRate** `number`

**minLimit** `number`

**maxLimit** `number | null`

**instant** `WithdrawalQuoteSpeed | null`

**eigenschappen**

**estimatedArrival** `string | null`

**fee** `number` *required*

**totalReceived** `number` *required*

**currency** `string`

**destinationCurrency** `string`

**exchangeRate** `number`

**minLimit** `number`

**maxLimit** `number | null`

**error** `string`

Een fout aan de kant van de host die binnen het huidige scherm wordt getoond. Standaard `""`.

**availableBalance** `number`

Afgewikkeld saldo dat beschikbaar is voor standaard uitbetalingsmethoden. Standaard `0`.

**pendingBalance** `number`

Lopend saldo dat mogelijk beschikbaar is voor directe uitbetalingsmethoden. Standaard `0`.

**payoutCountry** `string`

Het land van het uitbetalingsaccount als ISO 3166-1 alpha-2-code. Standaard `"US"`.

**supportedMethods** `WithdrawalSupportedMethod[]`

Uitbetalingsmethoden die in het geselecteerde land kunnen worden toegevoegd, inclusief verplichte velden. Standaard `[]`.

**eigenschappen**

**id** `string` *required*

**name** `string | null`

**iconUrl** `string | null`

**deliveryType** `string` *required*

**supportsStandard** `boolean` *required*

**supportsInstant** `boolean` *required*

**supportsPlaid** `boolean`

**feeStructure** `object | null`

**eigenschappen**

**percentage** `number` *required*

**fixedAmount** `number` *required*

**currency** `string` *required*

**quotes** `WithdrawalQuote[]` *required*

**eigenschappen**

**amount** `number` *required*

**currency** `string` *required*

**destinationCurrency** `string` *required*

**exchangeRate** `number` *required*

**minLimit** `number` *required*

**maxLimit** `number | null`

**instantUnavailableReason** `"minimum_crypto_sales_not_met" | null`

**standard** `WithdrawalQuoteSpeed | null`

**eigenschappen**

**estimatedArrival** `string | null`

**fee** `number` *required*

**totalReceived** `number` *required*

**currency** `string`

**destinationCurrency** `string`

**exchangeRate** `number`

**minLimit** `number`

**maxLimit** `number | null`

**instant** `WithdrawalQuoteSpeed | null`

**eigenschappen**

**estimatedArrival** `string | null`

**fee** `number` *required*

**totalReceived** `number` *required*

**currency** `string`

**destinationCurrency** `string`

**exchangeRate** `number`

**minLimit** `number`

**maxLimit** `number | null`

**requiredFields** `WithdrawalRequiredField[]` *required*

**eigenschappen**

**id** `string` *required*

**label** `string` *required*

**inputType** `string` *required*

**required** `boolean` *required*

**sensitive** `boolean` *required*

**placeholder** `string | null`

**validation** `string | null`

**options** `string[] | null`

**supportedMethodsLoading** `boolean`

Of ondersteunde uitbetalingsmethoden worden geladen voor het geselecteerde land. Standaard `false`.

**limits** `WithdrawalLimits`

Live limieten voor standaard en directe uitbetalingen. Standaard `{"standard":{"maxAmount":0},"instant":{"maxAmount":0}}`.

**eigenschappen**

**standard** `object` *required*

**eigenschappen**

**maxAmount** `number` *required*

**errorCode** `string | null`

**errorMessage** `string | null`

**instant** `object` *required*

**eigenschappen**

**maxAmount** `number` *required*

**dailyAmountRemaining** `number | null`

**resetsAt** `string | null`

**errorCode** `string | null`

**errorMessage** `string | null`

**quoteLoading** `boolean`

Of de prijs voor het huidige bedrag opnieuw wordt berekend. Standaard `false`.

**payoutQuoteRequired** `boolean`

Of deze uitbetaling vóór bevestiging een exacte offerte van de provider moet gebruiken. Standaard `false`.

**payoutQuote** `WithdrawalPayoutQuote | null`

De exacte, kortlevende uitbetalingsofferte voor bevestiging. Neem serverTime op, zodat de offerte wordt getimed op basis van de resterende levensduur in plaats van de klok van het apparaat. Neem recommendedMethod op om via de koppelingsflow een goedkopere methode aan te bieden zonder de geselecteerde methode te wijzigen. Standaard `null`.

**eigenschappen**

**requestId** `string` *required*

**payoutMethodId** `string` *required*

**speed** `"standard" | "instant"` *required*

**id** `string` *required*

**amount** `WithdrawalMoney` *required*

**eigenschappen**

**currency** `string` *required*

**amount** `string` *required*

**decimals** `number` *required*

**display\_decimals** `number` *required*

**fee** `WithdrawalMoney` *required*

**eigenschappen**

**currency** `string` *required*

**amount** `string` *required*

**decimals** `number` *required*

**display\_decimals** `number` *required*

**netAmount** `WithdrawalMoney` *required*

**eigenschappen**

**currency** `string` *required*

**amount** `string` *required*

**decimals** `number` *required*

**display\_decimals** `number` *required*

**destinationAmount** `WithdrawalMoney` *required*

**eigenschappen**

**currency** `string` *required*

**amount** `string` *required*

**decimals** `number` *required*

**display\_decimals** `number` *required*

**exchangeRate** `number` *required*

**serverTime** `string`

**expiresAt** `string` *required*

**quoteToken** `string` *required*

**recommendedMethod** `object | null`

**eigenschappen**

**supportedPayoutMethodId** `string` *required*

**name** `string` *required*

**country** `string` *required*

**destinationCurrency** `string` *required*

**estimatedSavings** `WithdrawalMoney` *required*

**eigenschappen**

**currency** `string` *required*

**amount** `string` *required*

**decimals** `number` *required*

**display\_decimals** `number` *required*

**estimatedFee** `WithdrawalMoney` *required*

**eigenschappen**

**currency** `string` *required*

**amount** `string` *required*

**decimals** `number` *required*

**display\_decimals** `number` *required*

**estimatedArrival** `string | null`

**payoutQuoteLoading** `boolean`

Of er een exacte uitbetalingsofferte wordt aangemaakt. Standaard `false`.

**payoutQuoteError** `string`

De eventuele fout van het huidige verzoek om een exacte uitbetalingsofferte. Standaard `""`.

**payoutQuoteRetryRequired** `boolean`

Of het laatste offerteverzoek geen uitsluitsel gaf en opnieuw moet worden geprobeerd met hetzelfde verzoek-ID. Standaard `false`.

**withdrawalRetryRequired** `boolean`

Of het laatste uitbetalingsresultaat geen uitsluitsel gaf en exact opnieuw moet worden geprobeerd. Standaard `false`.

**unresolvedWithdrawalRequest** `WithdrawalRequest | null`

Het exacte onopgeloste uitbetalingsverzoek dat opnieuw moet worden geprobeerd nadat het element opnieuw is gemount. Standaard `null`.

**eigenschappen**

**amount** `number` *required*

**currency** `string` *required*

**payoutMethodId** `string` *required*

**presentedFee** `number` *required*

**quoteId** `string`

**quoteToken** `string`

**speed** `"standard" | "instant"` *required*

**notes** `string`

**acknowledgeBankWarning** `boolean`

**savingMethod** `boolean`

Of er een nieuwe uitbetalingsmethode wordt opgeslagen. Standaard `false`.

**submitting** `boolean`

Of de bevestigde uitbetaling wordt aangemaakt. Standaard `false`.

**bankWarning** `boolean`

True wanneer de laatste uitbetaling is geweigerd omdat de bank de naam van de rekeninghouder niet kon bevestigen. Toont een keuze tussen corrigeren of bevestigen; bevestigen zendt withdrawalRequested opnieuw uit met acknowledgeBankWarning ingesteld. Zet dit terug op false bij het afhandelen van elke withdrawalRequested — de keuze verschijnt bij de wijziging naar true, dus een vlag die op true blijft staan verbergt elke latere weigering. Standaard `false`.

**createdMethodId** `string`

De meest recent aangemaakte methode, die wordt geselecteerd wanneer deze in methods verschijnt. Standaard `""`.

**plaidUnavailable** `boolean`

Wordt ingesteld wanneer de betaler Plaid Link heeft verlaten of wanneer het niet kon worden geopend. Ontgrendelt handmatige invoer op een kanaal dat anders koppelen vereist. Standaard `false`.

**linkingBank** `boolean`

Of er een bankkoppeling bezig is — de Plaid-sessie is geopend, of de gekoppelde methode wordt opgeslagen. Standaard `false`.

## Events

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

### `onAmountChanged`

Het bedrag is gewijzigd en de prijs moet opnieuw worden berekend.

**payload** `object`

**eigenschappen**

**amount** `number` *required*

### `onCountryChanged`

Het land voor het toevoegen van een methode is gewijzigd en de ondersteunde methoden moeten worden ververst.

**payload** `object`

**eigenschappen**

**country** `string` *required*

### `onSupportedMethodChanged`

Er is een ondersteunde uitbetalingsmethode geselecteerd en de exacte verplichte velden ervan moeten worden geladen.

**payload** `object`

**eigenschappen**

**country** `string` *required*

**supportedPayoutMethodId** `string` *required*

**destinationCurrency** `string` *required*

### `onAddMethodRequested`

De betaler heeft het dynamische formulier voor het toevoegen van een uitbetalingsmethode verstuurd.

**payload** `WithdrawalCreateMethodInput`

**eigenschappen**

**country** `string` *required*

**supportedPayoutMethodId** `string` *required*

**destinationCurrency** `string` *required*

**nickname** `string` *required*

**fields** `Record\<string, string\>` *required*

### `onPlaidLinkRequested`

De betaler heeft ervoor gekozen de bank via Plaid te koppelen in plaats van gegevens in te typen. Open Plaid Link bij ontvangst.

**payload** `object`

**eigenschappen**

**country** `string` *required*

**supportedPayoutMethodId** `string` *required*

**destinationCurrency** `string` *required*

### `onMethodVerificationCompleted`

De nieuw toegevoegde uitbetalingsmethode heeft de verificatiestap voltooid.

### `onRenameMethodRequested`

De betaler heeft gevraagd een opgeslagen uitbetalingsmethode te hernoemen.

**payload** `object`

**eigenschappen**

**methodId** `string` *required*

### `onRemoveMethodRequested`

De betaler heeft gevraagd een opgeslagen uitbetalingsmethode te verwijderen.

**payload** `object`

**eigenschappen**

**methodId** `string` *required*

### `onPayoutQuoteRequested`

De betaler heeft om een exacte, kortlevende offerte gevraagd voordat een uitbetaling wordt bevestigd.

**payload** `WithdrawalPayoutQuoteRequest`

**eigenschappen**

**requestId** `string` *required*

**amount** `number` *required*

**currency** `string` *required*

**payoutMethodId** `string` *required*

**speed** `"standard" | "instant"` *required*

### `onWithdrawalRequested`

De betaler heeft de uitbetaling bevestigd. Wanneer de host de flow aanstuurt, maak je de uitbetaling bij ontvangst aan. Wanneer het element de uitbetaling heeft aangemaakt, wordt dit na succes geactiveerd, zodat de host saldi kan verversen — maak geen tweede uitbetaling aan.

**payload** `WithdrawalRequest`

**eigenschappen**

**amount** `number` *required*

**currency** `string` *required*

**payoutMethodId** `string` *required*

**presentedFee** `number` *required*

**quoteId** `string`

**quoteToken** `string`

**speed** `"standard" | "instant"` *required*

**notes** `string`

**acknowledgeBankWarning** `boolean`

### `onDone`

De betaler is klaar met het bekijken van een geslaagde uitbetaling.

### `onLoaderStart`

Wordt uitgevoerd nadat het laadskelet voor het eerst is weergegeven en vóór `onReady`.

### `onReady`

Wordt uitgevoerd na de eerste volledige weergave van het element.

### `onError`

Wordt uitgevoerd wanneer het element niet kan laden of crasht. De fallback blijft zichtbaar. Gebruik `code` voor programmatische afhandeling. `sourceKey` identificeert een mislukte host-state-bron.

**e** `object`

**eigenschappen**

**message** `string` *required*

**code** `string`

**sourceKey** `string`

## Methoden

Roep deze aan op de handle die `create` retourneert, of via een React-`ref`.

### `refresh`

Haal opgeslagen uitbetalingsmethoden en limieten opnieuw op. Roep dit aan nadat iets aan jouw kant verandert waarnaar het account kan uitbetalen.

**Retourneert** `Promise<void>`

### `mount`

Mount het element in `target` en begint met laden. React-componenten mounten zichzelf.

**Parameters**

**target** `string | HTMLElement` *required*

### `destroy`

Verwijdert het element en geeft het frame en de abonnementen vrij. Je kunt het meerdere keren aanroepen. React verwijdert het element automatisch.

### `update`

Voegt nieuwe props samen in het gemounte element. Wijzig in React in plaats daarvan de componentprops.

**Parameters**

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

## Styling

Dit element stelt geen klassenamen beschikbaar voor styling. Gebruik `appearance` (thema, accentkleur, variabelen) om het opnieuw te stylen.
