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

# DepositElement

> Financiert een Whop-account. Toont een bedragveld en de live financieringskanalen van het account — crypto (een stortingsadres per netwerk met bijbehorende QR-code) en bankoverschrijving (de overschrijvingsgegevens voor elke afwikkelingsvaluta). De kanalen van een zakelijk account worden zonder credentials opgehaald, dus ze werken op elke pagina; een persoonlijk (`user_`) account toont zijn kanalen alleen aan zichzelf, dus geef er `accessToken` voor mee — zonder token dekt de eigen same-origin-sessie van de kijker het. Kaarten en platformsaldo zijn opt-in: geef `savedCards`, `allowNewCard` of `showPlatformBalance` mee en het element verzamelt het bedrag en de keuze, zendt daarna `cardDepositRequested` / `addCardRequested` / `platformBalanceSelected` uit en wacht tot je `showStep({ step: 'amount' })` aanroept wanneer je eigen scherm klaar is.

> [!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 `showStep()` en `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, DepositElement } from "@whop/elements-react";
import { loadWhop } from "@whop/elements";

function Example() {
  return (
    <WhopElements elements={loadWhop()}>
      <Wallet /* options */>
        <DepositElement onDepositInitiated={(e) => console.log(e)} onCardDepositRequested={(e) => console.log(e)} onAddCardRequested={(e) => console.log(e)} onBankSelected={(e) => console.log(e)} onIdentityVerificationRequested={(e) => console.log(e)} onPlatformBalanceSelected={(e) => console.log(e)} onDepositConfirmed={(e) => console.log(e)} onStepChanged={(e) => console.log(e)} onDismissed={(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('deposit', {
    onDepositInitiated: (e) => console.log(e),
    onCardDepositRequested: (e) => console.log(e),
    onAddCardRequested: (e) => console.log(e),
    onBankSelected: (e) => console.log(e),
    onIdentityVerificationRequested: (e) => console.log(e),
    onPlatformBalanceSelected: (e) => console.log(e),
    onDepositConfirmed: (e) => console.log(e),
    onStepChanged: (e) => console.log(e),
    onDismissed: (e) => console.log(e)
  }).mount('#wallet-deposit');
</script>
```

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

## Props

**accessToken** `string`

Een scoped token waarmee het ophalen van de kanalen een persoonlijk (`user_`) account kan lezen — vereist `payout:account:read`, plus `payout:account:update` om het bankkanaal in te richten. Maak het aan op je server met `POST /api/v1/access_tokens`. Wordt het weggelaten, dan gebruikt de aanroep de eigen sessie van de kijker, die alleen same-origin antwoordt; zakelijke accounts worden zonder credential opgehaald.

**amount** `string`

Vul het bedrag vooraf in en maak het alleen-lezen — voor flows die al weten wat er verschuldigd is. Een bedrag van nul of lager wordt genegeerd, net als een bedrag van meer dan 12 hele cijfers; de rest wordt afgerond op het aantal decimalen van de valuta. Standaard `""`.

**showCrypto** `boolean`

Bied het cryptokanaal aan wanneer het account een stortingsadres heeft. Standaard `true`.

**showBank** `boolean`

Bied het kanaal voor bankoverschrijving aan. Wordt ook getoond voordat het account bankgegevens heeft — als je het dan kiest, wordt de kijker gevraagd zijn identiteit te verifiëren wanneer het account dat nog moet doen, en wordt het kanaal als nog niet beschikbaar gemeld wanneer dat niet het geval is. Standaard `true`.

**savedCards** `DepositSavedCard[]`

Kaarten die je al voor deze betaler hebt, weergegeven als financieringsrijen. Als er een wordt gekozen, wordt `cardDepositRequested` met het bedrag uitgezonden — het element int nooit zelf een kaartbetaling. Standaard `[]`.

**eigenschappen**

**id** `string` *required*

ID van de betaalmethode dat wordt teruggegeven in `cardDepositRequested`.

**label** `string` *required*

Rijlabel, bijvoorbeeld `Visa •••• 4242`.

**cardBrand** `string | null`

Merksleutel waarmee het rijpictogram wordt gekozen — `visa`, `mastercard`, `amex`, `discover`, `jcb`.

**allowNewCard** `boolean`

Voeg een rij "Add card" toe die `addCardRequested` uitzendt, zodat je je eigen flow voor het verzamelen van kaarten kunt openen. Standaard `false`.

**showPlatformBalance** `boolean`

Bied een rij "Platform balance" aan die direct `platformBalanceSelected` uitzendt, zonder bedragstap. Standaard `false`.

**cardFee** `DepositCardFee | null`

Verwerkingskosten die als voorbeeld onder het bedrag worden getoond wanneer een kaartrij is geselecteerd. `percentageFee` is in procentpunten (`2.9` is 2,9%); `fixedFee` en `radarFee` zijn hoofdeenheden (`0.3` is \$0.30). Standaard `null`.

**eigenschappen**

**percentageFee** `number` *required*

Procentpunten, geen fractie: `2.9` betekent 2,9%.

**fixedFee** `number` *required*

Vaste vergoeding in hoofdeenheden: `0.3` betekent \$0.30.

**radarFee** `number` *required*

Vergoeding voor fraudecontrole in hoofdeenheden.

**depositRailFees** `Partial\<Record\<"crypto" | "bank", DepositRailFee\>\>`

Overschrijf de stortingskosten van het account onder de kanaalkiezer, per kanaal (`bank`, `crypto`). Weggelaten kanalen gebruiken de kosten die het account retourneert. `percentageFee` is in procentpunten (`1.5` is 1,5%); `fixedFeeUsd` is in USD-hoofdeenheden (`2` is \$2.00), ongeacht de stortingsvaluta. Toont het tarief voordat een bedrag is ingevoerd en daarna het in rekening gebrachte bedrag. Standaard `{}`.

**eigenschappen**

**crypto** `DepositRailFee`

**eigenschappen**

**percentageFee** `number` *required*

Procentpunten, geen fractie: `1.5` betekent 1,5%.

**fixedFeeUsd** `number` *required*

Vaste vergoeding in USD-hoofdeenheden: `2` betekent \$2.00, ongeacht de stortingsvaluta.

**bank** `DepositRailFee`

**eigenschappen**

**percentageFee** `number` *required*

Procentpunten, geen fractie: `1.5` betekent 1,5%.

**fixedFeeUsd** `number` *required*

Vaste vergoeding in USD-hoofdeenheden: `2` betekent \$2.00, ongeacht de stortingsvaluta.

**preferredMethodId** `string`

Selecteer vooraf een kanaal op id (`bank`, `crypto`, `platform_balance` of het id van een opgeslagen kaart). Continue blijft uitgeschakeld zolang dat kanaal nog niet wordt aangeboden, in plaats van via een ander kanaal te financieren. Standaard `""`.

**deferBankToHost** `boolean`

Zend `bankSelected` uit en blijf op het bedragscherm in plaats van de overschrijvingsgegevens te tonen — voor hosts die hun eigen stap uitvoeren nadat het account al een virtuele bankrekening heeft. Standaard `false`.

**confirmCryptoDeposit** `boolean`

Toon een knop "I have deposited my funds" op het cryptoscherm die `depositConfirmed` uitzendt, zodat je kunt beginnen met het volgen van de overboeking. Standaard `false`.

**initialStep** `"amount" | "crypto" | "bank"`

Open direct op een kanaal in plaats van op de kiezer. `crypto` en `bank` hebben geen bedrag nodig; hun terugknop zendt `dismissed` uit, omdat er geen kiezer achter zit. Standaard `"amount"`.

## Events

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

### `onDepositInitiated`

De betaler heeft een bedrag en een kanaal bevestigd. Wordt voor elk kanaal geactiveerd, voordat er instructies worden weergegeven — de hook voor analytics en funnels.

**payload** `object`

**eigenschappen**

**method** `"crypto" | "bank" | "card" | "platform_balance"` *required*

**amount** `number` *required*

**currency** `string` *required*

**paymentMethodId** `string`

### `onCardDepositRequested`

Er is een opgeslagen kaart gekozen. Int de betaling aan jouw kant en roep daarna `showStep({ step: "amount" })` aan om het element terug te zetten naar de kiezer.

**payload** `object`

**eigenschappen**

**amount** `number` *required*

**currency** `string` *required*

**paymentMethodId** `string` *required*

### `onAddCardRequested`

De rij "Add card" is gekozen — open je flow voor het verzamelen van kaarten.

### `onBankSelected`

Het bankkanaal is gekozen terwijl `deferBankToHost` is ingesteld — voer je stap uit en toon daarna zelf de velden of roep `showStep({ step: "bank" })` aan.

### `onIdentityVerificationRequested`

De kijker heeft bankoverschrijving gekozen voordat dit account een virtuele bankrekening heeft. Het element blijft op het bedragscherm en navigeert nooit — mount als reactie hierop je eigen verificatie, zoals de `verifications`-controller.

**payload** `object`

**eigenschappen**

**accountId** `string` *required*

### `onPlatformBalanceSelected`

De rij voor platformsaldo is gekozen. Deze bevat geen bedrag — je eigen scherm verzamelt dat.

### `onDepositConfirmed`

De betaler geeft aan de crypto te hebben verstuurd. `since` is een ondergrens in unix-seconden vanaf waar inkomende overboekingen worden gematcht (deze kijkt iets terug in de tijd, zodat een overboeking die vlak voor de klik is verstuurd nog steeds matcht).

**payload** `object`

**eigenschappen**

**network** `string` *required*

**token** `string` *required*

**networkLabel** `string` *required*

**since** `number` *required*

### `onStepChanged`

Het zichtbare scherm is gewijzigd.

**payload** `object`

**eigenschappen**

**step** `"amount" | "crypto" | "bank"` *required*

### `onDismissed`

De betaler heeft een kanaal verlaten waarop het element direct was geopend — sluit het oppervlak dat het element bevat.

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

### `showStep`

Zet het element op een scherm. Met `{ step: "amount" }` geef je de controle terug nadat je een kaart- of platformsaldostorting aan jouw kant hebt afgehandeld.

**Parameters**

**input** `object` *required*

**eigenschappen**

**step** `"amount" | "crypto" | "bank"` *required*

**Retourneert** `Promise<void>`

### `refresh`

Haal de financieringskanalen van het account opnieuw op. Roep dit aan nadat iets aan jouw kant verandert wat het account kan aanbieden — bijvoorbeeld het afronden van de bankonboarding — zodat het nieuwe kanaal verschijnt zonder te wachten tot de cache verloopt.

**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\<DepositElementProps\>` *required*

## Styling

Style deze onderdelen via `appearance.classes`. Gebruik camelCase of kebab-case voor eigenschapsnamen en vermeld eenheden. Stylesheets van de pagina kunnen het frame van het element niet bereiken. Het framework valideert elke declaratie voordat die wordt geïnjecteerd.

| Klasse | Doel |
| - | - |
| `.whop-DepositSurface` | De root van het deposit-element — één scherm tegelijk |

```ts theme={null}
const wallet = whop.wallet.create({
  appearance: {
    classes: {
      'whop-DepositSurface': { borderRadius: '8px', fontWeight: '600' }
    }
  }
});

wallet.update({
  appearance: {
    classes: { 'whop-DepositSurface': { fontWeight: '700' } }
  }
});
```

Geef in React `appearance` door aan `<Wallet>`. Stel het globaal in met `WhopElements({ appearance })`.


## Related topics

- [Wallet](https://docs.whop.com/nl/elements/latest/wallet/overview.md)
- [ActionsElement](https://docs.whop.com/nl/elements/latest/wallet/actions.md)
- [RequiredActionsElement](https://docs.whop.com/nl/elements/latest/dashboard/required-actions.md)
