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

> Collecte un montant de versement et un moyen de versement enregistré, regroupe les options de versement standard et instantané avec les frais en direct et les estimations d'arrivée, et collecte un nouveau moyen de versement si nécessaire. Lorsque l'hôte ne pilote pas le parcours, l'élément liste les moyens et crée lui-même le versement — transmettez `accessToken` (ou appuyez-vous sur la session same-origin du visiteur). Un hôte qui communique déjà avec l'API des versements peut toujours fournir les moyens, les limites et les indicateurs de chargement ; la confirmation émet alors `withdrawalRequested` pour que cet hôte crée le versement.

> [!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 `refresh()`.

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

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 pour lister les moyens de versement et créer le versement — nécessite `payout:withdraw_funds`, `payout:destination:read`, ainsi que `payout:create_destination` pour ajouter une banque. S'il est omis, les appels transportent la propre session du visiteur, qui ne répond qu'en same-origin.

**succeeded** `boolean`

Indique si le versement confirmé a été créé avec succès. Par défaut : `false`.

**loading** `boolean`

Indique si les moyens et les limites de versement sont en cours de chargement. Par défaut : `false`.

**methods** `WithdrawalMethod[]`

Les moyens de versement enregistrés, avec leurs devis pour le montant actuel. Par défaut : `[]`.

**propriétés**

**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`

**propriétés**

**percentage** `number` *required*

**fixedAmount** `number` *required*

**currency** `string` *required*

**standardEstimatedArrival** `string | null`

**instantEstimatedArrival** `string | null`

**quote** `WithdrawalQuote | null`

**propriétés**

**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`

**propriétés**

**estimatedArrival** `string | null`

**fee** `number` *required*

**totalReceived** `number` *required*

**currency** `string`

**destinationCurrency** `string`

**exchangeRate** `number`

**minLimit** `number`

**maxLimit** `number | null`

**instant** `WithdrawalQuoteSpeed | null`

**propriétés**

**estimatedArrival** `string | null`

**fee** `number` *required*

**totalReceived** `number` *required*

**currency** `string`

**destinationCurrency** `string`

**exchangeRate** `number`

**minLimit** `number`

**maxLimit** `number | null`

**error** `string`

Une erreur côté hôte à afficher dans l'écran actuel. Par défaut : `""`.

**availableBalance** `number`

Le solde réglé disponible pour les moyens de versement standard. Par défaut : `0`.

**pendingBalance** `number`

Le solde en attente pouvant être disponible pour les moyens de versement instantané. Par défaut : `0`.

**payoutCountry** `string`

Le pays ISO 3166-1 alpha-2 du compte de versement. Par défaut : `"US"`.

**supportedMethods** `WithdrawalSupportedMethod[]`

Les moyens de versement pouvant être ajoutés dans le pays sélectionné, avec leurs champs obligatoires. Par défaut : `[]`.

**propriétés**

**id** `string` *required*

**name** `string | null`

**iconUrl** `string | null`

**deliveryType** `string` *required*

**supportsStandard** `boolean` *required*

**supportsInstant** `boolean` *required*

**supportsPlaid** `boolean`

**feeStructure** `object | null`

**propriétés**

**percentage** `number` *required*

**fixedAmount** `number` *required*

**currency** `string` *required*

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

**propriétés**

**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`

**propriétés**

**estimatedArrival** `string | null`

**fee** `number` *required*

**totalReceived** `number` *required*

**currency** `string`

**destinationCurrency** `string`

**exchangeRate** `number`

**minLimit** `number`

**maxLimit** `number | null`

**instant** `WithdrawalQuoteSpeed | null`

**propriétés**

**estimatedArrival** `string | null`

**fee** `number` *required*

**totalReceived** `number` *required*

**currency** `string`

**destinationCurrency** `string`

**exchangeRate** `number`

**minLimit** `number`

**maxLimit** `number | null`

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

**propriétés**

**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`

Indique si les moyens de versement pris en charge sont en cours de chargement pour le pays sélectionné. Par défaut : `false`.

**limits** `WithdrawalLimits`

Les limites de versement standard et instantané en direct. Par défaut : `{"standard":{"maxAmount":0},"instant":{"maxAmount":0}}`.

**propriétés**

**standard** `object` *required*

**propriétés**

**maxAmount** `number` *required*

**errorCode** `string | null`

**errorMessage** `string | null`

**instant** `object` *required*

**propriétés**

**maxAmount** `number` *required*

**dailyAmountRemaining** `number | null`

**resetsAt** `string | null`

**errorCode** `string | null`

**errorMessage** `string | null`

**quoteLoading** `boolean`

Indique si le montant actuel est en cours de recalcul du prix. Par défaut : `false`.

**payoutQuoteRequired** `boolean`

Indique si ce versement doit utiliser un devis exact fourni par le prestataire avant la confirmation. Par défaut : `false`.

**payoutQuote** `WithdrawalPayoutQuote | null`

Le devis de versement exact et de courte durée pour la confirmation. Incluez serverTime afin que le devis soit chronométré selon sa durée de vie restante plutôt que selon l'horloge de l'appareil. Incluez recommendedMethod pour proposer un moyen moins coûteux via le parcours de connexion sans modifier le moyen sélectionné. Par défaut : `null`.

**propriétés**

**requestId** `string` *required*

**payoutMethodId** `string` *required*

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

**id** `string` *required*

**amount** `WithdrawalMoney` *required*

**propriétés**

**currency** `string` *required*

**amount** `string` *required*

**decimals** `number` *required*

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

**fee** `WithdrawalMoney` *required*

**propriétés**

**currency** `string` *required*

**amount** `string` *required*

**decimals** `number` *required*

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

**netAmount** `WithdrawalMoney` *required*

**propriétés**

**currency** `string` *required*

**amount** `string` *required*

**decimals** `number` *required*

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

**destinationAmount** `WithdrawalMoney` *required*

**propriétés**

**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`

**propriétés**

**supportedPayoutMethodId** `string` *required*

**name** `string` *required*

**country** `string` *required*

**destinationCurrency** `string` *required*

**estimatedSavings** `WithdrawalMoney` *required*

**propriétés**

**currency** `string` *required*

**amount** `string` *required*

**decimals** `number` *required*

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

**estimatedFee** `WithdrawalMoney` *required*

**propriétés**

**currency** `string` *required*

**amount** `string` *required*

**decimals** `number` *required*

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

**estimatedArrival** `string | null`

**payoutQuoteLoading** `boolean`

Indique si un devis de versement exact est en cours de création. Par défaut : `false`.

**payoutQuoteError** `string`

L'erreur de la demande de devis de versement exact en cours, le cas échéant. Par défaut : `""`.

**payoutQuoteRetryRequired** `boolean`

Indique si la dernière demande de devis n'a pas abouti et doit être relancée avec le même ID de requête. Par défaut : `false`.

**withdrawalRetryRequired** `boolean`

Indique si le résultat du dernier versement n'a pas abouti et doit être relancé à l'identique. Par défaut : `false`.

**unresolvedWithdrawalRequest** `WithdrawalRequest | null`

La demande de versement non résolue exacte à relancer après le remontage de l'élément. Par défaut : `null`.

**propriétés**

**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`

Indique si un nouveau moyen de versement est en cours d'enregistrement. Par défaut : `false`.

**submitting** `boolean`

Indique si le versement confirmé est en cours de création. Par défaut : `false`.

**bankWarning** `boolean`

Vaut true lorsque le dernier versement a été refusé parce que la banque n'a pas pu confirmer le nom du titulaire du compte. Affiche un choix entre corriger et confirmer ; la confirmation réémet withdrawalRequested avec acknowledgeBankWarning défini. Repassez cette valeur à false lors du traitement de chaque withdrawalRequested — le choix apparaît lors du passage à true, de sorte qu'un indicateur laissé à true masque tous les refus ultérieurs. Par défaut : `false`.

**createdMethodId** `string`

Le moyen créé le plus récemment, sélectionné lorsqu'il apparaît dans methods. Par défaut : `""`.

**plaidUnavailable** `boolean`

À définir lorsque le payeur a quitté Plaid Link ou que son ouverture a échoué. Déverrouille la saisie manuelle sur un canal qui nécessite sinon une liaison. Par défaut : `false`.

**linkingBank** `boolean`

Indique si une liaison bancaire est en cours — la session Plaid est ouverte, ou le moyen lié est en cours d'enregistrement. Par défaut : `false`.

## Événements

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

### `onAmountChanged`

Le montant a changé et son prix doit être recalculé.

**payload** `object`

**propriétés**

**amount** `number` *required*

### `onCountryChanged`

Le pays d'ajout de moyen a changé et les moyens pris en charge doivent être actualisés.

**payload** `object`

**propriétés**

**country** `string` *required*

### `onSupportedMethodChanged`

Un moyen de versement pris en charge a été sélectionné et ses champs obligatoires exacts doivent être chargés.

**payload** `object`

**propriétés**

**country** `string` *required*

**supportedPayoutMethodId** `string` *required*

**destinationCurrency** `string` *required*

### `onAddMethodRequested`

Le payeur a soumis le formulaire dynamique d'ajout de moyen de versement.

**payload** `WithdrawalCreateMethodInput`

**propriétés**

**country** `string` *required*

**supportedPayoutMethodId** `string` *required*

**destinationCurrency** `string` *required*

**nickname** `string` *required*

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

### `onPlaidLinkRequested`

Le payeur a choisi de lier sa banque via Plaid au lieu de saisir ses coordonnées. Ouvrez Plaid Link à la réception.

**payload** `object`

**propriétés**

**country** `string` *required*

**supportedPayoutMethodId** `string` *required*

**destinationCurrency** `string` *required*

### `onMethodVerificationCompleted`

Le moyen de versement nouvellement ajouté a terminé son étape de vérification.

### `onRenameMethodRequested`

Le payeur a demandé à renommer un moyen de versement enregistré.

**payload** `object`

**propriétés**

**methodId** `string` *required*

### `onRemoveMethodRequested`

Le payeur a demandé à supprimer un moyen de versement enregistré.

**payload** `object`

**propriétés**

**methodId** `string` *required*

### `onPayoutQuoteRequested`

Le payeur a demandé un devis exact de courte durée avant de confirmer un versement.

**payload** `WithdrawalPayoutQuoteRequest`

**propriétés**

**requestId** `string` *required*

**amount** `number` *required*

**currency** `string` *required*

**payoutMethodId** `string` *required*

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

### `onWithdrawalRequested`

Le payeur a confirmé le versement. Lorsque l'hôte pilote le parcours, créez le versement à la réception. Lorsque l'élément l'a créé, cet événement se déclenche après le succès afin que l'hôte puisse actualiser les soldes — ne créez pas de second versement.

**payload** `WithdrawalRequest`

**propriétés**

**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`

Le payeur a fini de consulter un versement réussi.

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

### `refresh`

Récupère à nouveau les moyens de versement enregistrés et les limites. Appelez-la après toute modification de votre côté des destinations vers lesquelles le compte peut verser.

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

## Style

Cet élément n'expose pas de noms de classes pour le style. Utilisez `appearance` (thème, couleur d'accent, variables) pour modifier son apparence.
