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

> Approvisionne un compte Whop. Affiche un champ de montant et les canaux d'approvisionnement actifs du compte — crypto (une adresse de dépôt par réseau avec son QR code) et virement bancaire (les coordonnées de virement pour chaque devise de règlement). Les canaux d'un compte professionnel se résolvent sans identifiants, ils fonctionnent donc sur n'importe quelle page ; un compte personnel (`user_`) ne révèle ses canaux qu'à lui-même, transmettez donc `accessToken` pour celui-ci — s'il est omis, la propre session same-origin du visiteur suffit. Les cartes et le solde de la plateforme sont optionnels : transmettez `savedCards`, `allowNewCard` ou `showPlatformBalance` et l'élément collecte le montant et le choix, puis émet `cardDepositRequested` / `addCardRequested` / `platformBalanceSelected` et attend que vous appeliez `showStep({ step: 'amount' })` une fois votre propre écran terminé.

> [!NOTE]
>
> Cette page documente `@whop/elements@1.10.0` et `@whop/elements-react@1.10.0`.

*Depuis `v1.0.0`.*

Se monte à l'intérieur de [`Wallet`](https://docs.whop.com/fr/elements/latest/wallet/overview). `accountId` et `accessToken` proviennent de celui-ci. Transmettez les props et les callbacks via les options de création ou les props React. Conservez le handle créé, ou la `ref` React, pour appeler `showStep()` et `refresh()`.

> [!NOTE]
>
> Vous pouvez monter cet élément **inline** (`create`) ou l'ouvrir en overlay **modal** (`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>
```

Données d'exemple. [Ouvrir le Playground](https://docs.whop.com/fr/elements/latest/wallet/overview#playground).

## Props

**accessToken** `string`

Un jeton à portée limitée qui permet à la résolution des canaux de lire un compte personnel (`user_`) — nécessite `payout:account:read`, ainsi que `payout:account:update` pour provisionner le canal bancaire. Générez-le sur votre serveur avec `POST /api/v1/access_tokens`. S'il est omis, l'appel transporte la propre session du visiteur, qui ne répond qu'en same-origin ; les comptes professionnels se résolvent sans aucun identifiant.

**amount** `string`

Préremplit le montant et le rend non modifiable — pour les parcours qui connaissent déjà la somme due. Un montant inférieur ou égal à zéro est ignoré, de même qu'un montant de plus de 12 chiffres entiers ; le reste est arrondi au nombre de décimales de la devise. Par défaut : `""`.

**showCrypto** `boolean`

Propose le canal crypto lorsque le compte dispose d'une adresse de dépôt. Par défaut : `true`.

**showBank** `boolean`

Propose le canal de virement bancaire. Affiché même avant que le compte ait des coordonnées bancaires — le choisir demande alors au visiteur de vérifier son identité lorsque c'est ce qu'il reste à faire pour le compte, et indique que le canal n'est pas encore disponible dans le cas contraire. Par défaut : `true`.

**savedCards** `DepositSavedCard[]`

Les cartes que vous détenez déjà pour ce payeur, affichées comme lignes d'approvisionnement. En choisir une émet `cardDepositRequested` avec le montant — l'élément ne collecte jamais de paiement par carte. Par défaut : `[]`.

**propriétés**

**id** `string` *required*

ID du moyen de paiement renvoyé dans `cardDepositRequested`.

**label** `string` *required*

Libellé de la ligne, par exemple `Visa •••• 4242`.

**cardBrand** `string | null`

Clé de marque utilisée pour choisir l'icône de la ligne — `visa`, `mastercard`, `amex`, `discover`, `jcb`.

**allowNewCard** `boolean`

Ajoute une ligne "Add card" qui émet `addCardRequested` afin que vous puissiez ouvrir votre propre parcours de saisie de carte. Par défaut : `false`.

**showPlatformBalance** `boolean`

Propose une ligne "Platform balance" qui émet immédiatement `platformBalanceSelected`, sans étape de montant. Par défaut : `false`.

**cardFee** `DepositCardFee | null`

Les frais de traitement à prévisualiser sous le montant lorsqu'une ligne de carte est sélectionnée. `percentageFee` est exprimé en POINTS de pourcentage (`2.9` correspond à 2,9 %) ; `fixedFee` et `radarFee` sont en unités principales (`0.3` correspond à 0,30 \$). Par défaut : `null`.

**propriétés**

**percentageFee** `number` *required*

POINTS de pourcentage, et non une fraction : `2.9` signifie 2,9 %.

**fixedFee** `number` *required*

Frais fixes en unités principales : `0.3` signifie 0,30 \$.

**radarFee** `number` *required*

Frais de détection de fraude en unités principales.

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

Remplace les frais de dépôt du compte affichés sous le sélecteur de canal, indexés par canal (`bank`, `crypto`). Les canaux omis utilisent les frais renvoyés par le compte. `percentageFee` est exprimé en POINTS de pourcentage (`1.5` correspond à 1,5 %) ; `fixedFeeUsd` est en unités principales USD (`2` correspond à 2,00 \$), quelle que soit la devise du dépôt. Affiche le taux avant la saisie d'un montant, puis le montant facturé ensuite. Par défaut : `{}`.

**propriétés**

**crypto** `DepositRailFee`

**propriétés**

**percentageFee** `number` *required*

POINTS de pourcentage, et non une fraction : `1.5` signifie 1,5 %.

**fixedFeeUsd** `number` *required*

Frais fixes en unités principales USD : `2` signifie 2,00 \$, quelle que soit la devise du dépôt.

**bank** `DepositRailFee`

**propriétés**

**percentageFee** `number` *required*

POINTS de pourcentage, et non une fraction : `1.5` signifie 1,5 %.

**fixedFeeUsd** `number` *required*

Frais fixes en unités principales USD : `2` signifie 2,00 \$, quelle que soit la devise du dépôt.

**preferredMethodId** `string`

Présélectionne un canal par son id (`bank`, `crypto`, `platform_balance` ou l'id d'une carte enregistrée). Continue reste désactivé tant que ce canal n'est pas encore proposé, plutôt que d'approvisionner via un autre. Par défaut : `""`.

**deferBankToHost** `boolean`

Émet `bankSelected` et reste sur l'écran du montant au lieu d'afficher les coordonnées de virement — pour les hôtes qui exécutent leur propre étape lorsque le compte dispose déjà d'un compte bancaire virtuel. Par défaut : `false`.

**confirmCryptoDeposit** `boolean`

Affiche sur l'écran crypto un bouton "I have deposited my funds" qui émet `depositConfirmed`, afin que vous puissiez commencer à surveiller le transfert. Par défaut : `false`.

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

S'ouvre directement sur un canal au lieu du sélecteur. `crypto` et `bank` ne nécessitent pas de montant ; leur bouton retour émet `dismissed`, car il n'y a pas de sélecteur derrière eux. Par défaut : `"amount"`.

## Événements

Transmettez les callbacks dans les options de création ou dans les props React.

### `onDepositInitiated`

Le payeur a confirmé un montant et un canal. Se déclenche pour chaque canal, avant l'affichage de toute instruction — le point d'accroche pour l'analytique et le suivi du tunnel.

**payload** `object`

**propriétés**

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

**amount** `number` *required*

**currency** `string` *required*

**paymentMethodId** `string`

### `onCardDepositRequested`

Une carte enregistrée a été choisie. Collectez le paiement de votre côté, puis appelez `showStep({ step: "amount" })` pour ramener l'élément au sélecteur.

**payload** `object`

**propriétés**

**amount** `number` *required*

**currency** `string` *required*

**paymentMethodId** `string` *required*

### `onAddCardRequested`

La ligne "Add card" a été choisie — ouvrez votre parcours de saisie de carte.

### `onBankSelected`

Le canal bancaire a été choisi alors que `deferBankToHost` est défini — exécutez votre étape, puis affichez vous-même les coordonnées ou appelez `showStep({ step: "bank" })`.

### `onIdentityVerificationRequested`

Le visiteur a choisi le virement bancaire alors que ce compte n'a pas encore de compte bancaire virtuel. L'élément reste sur l'écran du montant et ne navigue jamais — montez en réponse votre propre vérification, comme le contrôleur `verifications`.

**payload** `object`

**propriétés**

**accountId** `string` *required*

### `onPlatformBalanceSelected`

La ligne du solde de la plateforme a été choisie. Elle ne transporte aucun montant — c'est votre propre écran qui le collecte.

### `onDepositConfirmed`

Le payeur a indiqué avoir envoyé la crypto. `since` est un plancher en secondes unix à partir duquel commencer à rapprocher les transferts entrants (il remonte légèrement dans le temps, de sorte qu'un transfert envoyé quelques instants avant le clic est tout de même rapproché).

**payload** `object`

**propriétés**

**network** `string` *required*

**token** `string` *required*

**networkLabel** `string` *required*

**since** `number` *required*

### `onStepChanged`

L'écran visible a changé.

**payload** `object`

**propriétés**

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

### `onDismissed`

Le payeur a quitté un canal sur lequel l'élément avait été ouvert directement — fermez la surface qui le contient.

### `onLoaderStart`

S'exécute après le premier affichage du squelette de chargement et avant `onReady`.

### `onReady`

S'exécute après le premier affichage complet de l'élément.

### `onError`

S'exécute lorsque l'élément ne parvient pas à se charger ou plante. L'affichage de repli reste visible. Utilisez `code` pour une gestion programmatique. `sourceKey` identifie une source d'état hôte en échec.

**e** `object`

**propriétés**

**message** `string` *required*

**code** `string`

**sourceKey** `string`

## Méthodes

Appelez-les sur le handle renvoyé par `create`, ou via une `ref` React.

### `showStep`

Amène l'élément sur un écran. `{ step: "amount" }` vous permet de rendre la main après avoir réglé de votre côté un dépôt par carte ou par solde de la plateforme.

**Paramètres**

**input** `object` *required*

**propriétés**

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

**Renvoie** `Promise<void>`

### `refresh`

Résout à nouveau les canaux d'approvisionnement du compte. Appelez-la après toute modification de votre côté de ce que le compte peut proposer — la fin de l'onboarding bancaire, par exemple — afin que le nouveau canal apparaisse sans attendre l'expiration du cache.

**Renvoie** `Promise<void>`

### `mount`

Monte l'élément dans `target` et démarre le chargement. Les composants React se montent eux-mêmes.

**Paramètres**

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

### `destroy`

Supprime l'élément et libère son frame et ses abonnements. Vous pouvez l'appeler plusieurs fois. React supprime l'élément automatiquement.

### `update`

Fusionne de nouvelles props dans l'élément monté. Avec React, modifiez plutôt les props du composant.

**Paramètres**

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

## Style

Stylisez ces parties via `appearance.classes`. Utilisez le camel case ou le kebab case pour les noms de propriétés et incluez les unités. Les feuilles de style de la page ne peuvent pas atteindre le frame de l'élément. Le framework valide chaque déclaration avant de l'injecter.

| Classe | Cible |
| - | - |
| `.whop-DepositSurface` | La racine de l'élément de dépôt — un écran à la fois |

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

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

Avec React, transmettez `appearance` à `<Wallet>`. Définissez-la globalement avec `WhopElements({ appearance })`.


## Related topics

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