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

> Añade fondos a una cuenta de Whop. Renderiza un campo de importe y las vías de financiación activas de la cuenta: cripto (una dirección de depósito por red con su QR) y transferencia bancaria (los datos de transferencia para cada moneda de liquidación). Las vías de una cuenta de empresa se resuelven sin credenciales, así que funcionan en cualquier página; una cuenta personal (`user_`) solo se revela sus vías a sí misma, así que pasa `accessToken` para ella; si se omite, la propia sesión del visitante en el mismo origen la cubre. Las tarjetas y el saldo de la plataforma son opcionales: pasa `savedCards`, `allowNewCard` o `showPlatformBalance` y el elemento recoge el importe y la elección, después emite `cardDepositRequested` / `addCardRequested` / `platformBalanceSelected` y espera a que llames a `showStep({ step: 'amount' })` cuando tu propia pantalla haya terminado.

> [!NOTE]
>
> Esta página documenta `@whop/elements@1.10.0` y `@whop/elements-react@1.10.0`.

*Desde `v1.0.0`.*

Se monta dentro de [`Wallet`](https://docs.whop.com/es/elements/latest/wallet/overview). `accountId` y `accessToken` provienen de ahí. Pasa las props y los callbacks a través de las opciones de creación o de las props de React. Conserva el handle creado, o la `ref` de React, para llamar a `showStep()` y `refresh()`.

> [!NOTE]
>
> Puedes montar este elemento **en línea** (`create`) o abrirlo como un 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>
```

Datos de ejemplo. [Abre el Playground](https://docs.whop.com/es/elements/latest/wallet/overview#playground).

## Props

**accessToken** `string`

Un token con alcance limitado que permite a la resolución de vías leer una cuenta personal (`user_`); necesita `payout:account:read`, más `payout:account:update` para que se aprovisione la vía bancaria. Genéralo en tu servidor con `POST /api/v1/access_tokens`. Si se omite, la llamada lleva la propia sesión del visitante, que solo responde en el mismo origen; las cuentas de empresa se resuelven sin ninguna credencial.

**amount** `string`

Rellena previamente el importe y lo hace de solo lectura, para flujos que ya saben lo que se debe. Se ignora un importe igual o inferior a cero, así como uno de más de 12 dígitos enteros; el resto se redondea a los decimales de la moneda. Por defecto es `""`.

**showCrypto** `boolean`

Ofrece la vía cripto cuando la cuenta tiene una dirección de depósito. Por defecto es `true`.

**showBank** `boolean`

Ofrece la vía de transferencia bancaria. Se muestra incluso antes de que la cuenta tenga datos bancarios: al elegirla, se pide al visitante que verifique su identidad cuando eso es lo que la cuenta aún tiene pendiente, y se informa de que la vía todavía no está disponible cuando no lo es. Por defecto es `true`.

**savedCards** `DepositSavedCard[]`

Tarjetas que ya tienes de este pagador, renderizadas como filas de financiación. Elegir una emite `cardDepositRequested` con el importe: el elemento nunca cobra un pago con tarjeta. Por defecto es `[]`.

**propiedades**

**id** `string` *required*

ID del método de pago que se devuelve en `cardDepositRequested`.

**label** `string` *required*

Etiqueta de la fila, por ejemplo, `Visa •••• 4242`.

**cardBrand** `string | null`

Clave de marca que se usa para elegir el icono de la fila: `visa`, `mastercard`, `amex`, `discover`, `jcb`.

**allowNewCard** `boolean`

Añade una fila "Add card" que emite `addCardRequested` para que puedas abrir tu propio flujo de recogida de tarjetas. Por defecto es `false`.

**showPlatformBalance** `boolean`

Ofrece una fila "Platform balance" que emite `platformBalanceSelected` inmediatamente, sin paso de importe. Por defecto es `false`.

**cardFee** `DepositCardFee | null`

Comisiones de procesamiento que se previsualizan debajo del importe cuando se selecciona una fila de tarjeta. `percentageFee` está en PUNTOS porcentuales (`2.9` es 2.9%); `fixedFee` y `radarFee` están en unidades principales (`0.3` es \$0.30). Por defecto es `null`.

**propiedades**

**percentageFee** `number` *required*

PUNTOS porcentuales, no una fracción: `2.9` significa 2.9%.

**fixedFee** `number` *required*

Comisión fija en unidades principales: `0.3` significa \$0.30.

**radarFee** `number` *required*

Comisión de control de fraude en unidades principales.

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

Anula las comisiones de depósito de la cuenta que se muestran debajo del selector de vías, indexadas por vía (`bank`, `crypto`). Las vías omitidas usan las comisiones que devuelve la cuenta. `percentageFee` está en PUNTOS porcentuales (`1.5` es 1.5%); `fixedFeeUsd` está en unidades principales de USD (`2` es \$2.00) sea cual sea la moneda del depósito. Muestra la tarifa antes de que se escriba un importe y el importe cobrado después. Por defecto es `{}`.

**propiedades**

**crypto** `DepositRailFee`

**propiedades**

**percentageFee** `number` *required*

PUNTOS porcentuales, no una fracción: `1.5` significa 1.5%.

**fixedFeeUsd** `number` *required*

Comisión fija en unidades principales de USD: `2` significa \$2.00, sea cual sea la moneda del depósito.

**bank** `DepositRailFee`

**propiedades**

**percentageFee** `number` *required*

PUNTOS porcentuales, no una fracción: `1.5` significa 1.5%.

**fixedFeeUsd** `number` *required*

Comisión fija en unidades principales de USD: `2` significa \$2.00, sea cual sea la moneda del depósito.

**preferredMethodId** `string`

Preselecciona una vía por id (`bank`, `crypto`, `platform_balance` o el id de una tarjeta guardada). Continue permanece desactivado mientras esa vía aún no se ofrezca, en lugar de financiar a través de otra. Por defecto es `""`.

**deferBankToHost** `boolean`

Emite `bankSelected` y permanece en la pantalla de importe en lugar de mostrar los datos de transferencia, para hosts que ejecutan su propio paso después de que la cuenta ya tenga una cuenta bancaria virtual. Por defecto es `false`.

**confirmCryptoDeposit** `boolean`

Muestra un botón "I have deposited my funds" en la pantalla de cripto que emite `depositConfirmed`, para que puedas empezar a vigilar la transferencia. Por defecto es `false`.

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

Abre directamente una vía en lugar del selector. `crypto` y `bank` no necesitan importe; su botón de atrás emite `dismissed` porque no hay ningún selector detrás de ellos. Por defecto es `"amount"`.

## Eventos

Pasa los callbacks en las opciones de creación o como props de React.

### `onDepositInitiated`

El pagador confirmó un importe y una vía. Se dispara para todas las vías, antes de que se rendericen las instrucciones: es el hook de analítica/embudo.

**payload** `object`

**propiedades**

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

**amount** `number` *required*

**currency** `string` *required*

**paymentMethodId** `string`

### `onCardDepositRequested`

Se eligió una tarjeta guardada. Cobra el pago por tu parte y después llama a `showStep({ step: "amount" })` para devolver el elemento al selector.

**payload** `object`

**propiedades**

**amount** `number` *required*

**currency** `string` *required*

**paymentMethodId** `string` *required*

### `onAddCardRequested`

Se eligió la fila "Add card": abre tu flujo de recogida de tarjetas.

### `onBankSelected`

Se eligió la vía bancaria mientras `deferBankToHost` está establecido: ejecuta tu paso y después muestra los datos tú mismo o llama a `showStep({ step: "bank" })`.

### `onIdentityVerificationRequested`

El visitante eligió la transferencia bancaria antes de que esta cuenta tenga una cuenta bancaria virtual. El elemento permanece en la pantalla de importe y nunca navega: en respuesta a esto, monta tu propia verificación, como el controlador `verifications`.

**payload** `object`

**propiedades**

**accountId** `string` *required*

### `onPlatformBalanceSelected`

Se eligió la fila del saldo de la plataforma. No incluye ningún importe: tu propia pantalla lo recoge.

### `onDepositConfirmed`

El pagador indicó que envió las criptomonedas. `since` es un límite inferior en segundos unix a partir del cual empezar a buscar coincidencias con las transferencias entrantes (mira ligeramente hacia atrás en el tiempo, para que una transferencia enviada momentos antes del clic también coincida).

**payload** `object`

**propiedades**

**network** `string` *required*

**token** `string` *required*

**networkLabel** `string` *required*

**since** `number` *required*

### `onStepChanged`

La pantalla visible cambió.

**payload** `object`

**propiedades**

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

### `onDismissed`

El pagador salió de una vía en la que se abrió directamente el elemento: cierra la superficie que lo contiene.

### `onLoaderStart`

Se ejecuta después de que el esqueleto de carga se pinta por primera vez y antes de `onReady`.

### `onReady`

Se ejecuta después del primer pintado completo del elemento.

### `onError`

Se ejecuta cuando el elemento no se carga o falla. El contenido de respaldo permanece visible. Usa `code` para el manejo programático. `sourceKey` identifica una fuente de estado del host que falló.

**e** `object`

**propiedades**

**message** `string` *required*

**code** `string`

**sourceKey** `string`

## Métodos

Llámalos en el handle que devuelve `create`, o a través de una `ref` de React.

### `showStep`

Lleva el elemento a una pantalla. `{ step: "amount" }` es la forma de devolver el control después de liquidar por tu parte un depósito con tarjeta o con el saldo de la plataforma.

**Parámetros**

**input** `object` *required*

**propiedades**

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

**Devuelve** `Promise<void>`

### `refresh`

Vuelve a resolver las vías de financiación de la cuenta. Llámalo después de que algo por tu parte cambie lo que la cuenta puede ofrecer (por ejemplo, al terminar el alta bancaria) para que la nueva vía aparezca sin esperar a que caduque la caché.

**Devuelve** `Promise<void>`

### `mount`

Monta el elemento en `target` y comienza a cargarlo. Los componentes de React se montan solos.

**Parámetros**

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

### `destroy`

Elimina el elemento y libera su frame y sus suscripciones. Puedes llamarlo más de una vez. React elimina el elemento automáticamente.

### `update`

Combina nuevas props en el elemento montado. En React, cambia las props del componente en su lugar.

**Parámetros**

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

## Estilos

Aplica estilo a estas partes mediante `appearance.classes`. Usa camel case o kebab case para los nombres de las propiedades e incluye las unidades. Las hojas de estilo de la página no pueden llegar al frame del elemento. El framework valida cada declaración antes de inyectarla.

| Clase | Aplica a |
| - | - |
| `.whop-DepositSurface` | La raíz del elemento de depósito: una pantalla cada vez |

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

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

En React, pasa `appearance` a `<Wallet>`. Establécelo globalmente con `WhopElements({ appearance })`.


## Related topics

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