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

# BalanceElement

> El saldo de una cuenta y un gráfico de cómo ha cambiado. El total y su variación aparecen arriba, el gráfico debajo y los botones del intervalo de tiempo al final. El visitante puede leer puntos individuales del gráfico y cambiar el intervalo de tiempo por sí mismo.

> [!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 [`Balances`](https://docs.whop.com/es/elements/latest/wallet/balances), en [`Wallet`](https://docs.whop.com/es/elements/latest/wallet/overview). `accountId` y `currency` provienen de `Wallet`. Pasa las props y los callbacks a través de las opciones de creación o de las props de React.

Se monta en cualquier lugar de tu jerarquía de vistas. Recibe un `accountId` y carga sus propios datos; `range` elige el intervalo de tiempo con el que se abre. La raíz es un `VStack`, por lo que se ajusta a su contenido y ocupa el ancho que le des.

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

function Example() {
  return (
    <WhopElements elements={loadWhop()}>
      <Wallet /* options */>
        <Balances>
          <BalanceElement onRangeChanged={(e) => console.log(e)} onRangeBrushed={(e) => console.log(e)} />
        </Balances>
      </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 */ });
  const balances = wallet.create('balances', { /* options */ });
  balances.create('balance', {
    onRangeChanged: (e) => console.log(e),
    onRangeBrushed: (e) => console.log(e)
  }).mount('#wallet-balances-balance');
</script>
```

```swift Swift theme={null}
import SwiftUI
import WhopElements

// WhopSDK.configure(tokenProvider:) runs once at app launch. See Getting started.
struct WalletScreen: View {
    var body: some View {
        BalanceElement(
            accountId: "biz_xxxx",
            range: .oneMonth
        )
    }
}
```

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

[BalanceElement ejecutándose en un simulador de iPhone](https://app.revyl.ai/embed/bb0f1c0a-4242-486a-a5f5-03dd9711744c?controls=0)

## Props

**accessToken** `string`

Un token con alcance limitado para las lecturas. Una cuenta necesita `company:balance:read` para el total y `stats:read` para el gráfico; el saldo propio de un usuario necesita `user:balance:read`. Genéralo en tu servidor con `POST /api/v1/access_tokens` y establece uno nuevo antes de que caduque. Sin él, las lecturas usan la propia sesión del visitante, que solo funciona en el mismo origen. Por defecto es `""`.

**range** `"1D" | "1W" | "1M" | "1Y" | "ALL"`

El intervalo de tiempo con el que se abre. Los botones lo cambian a partir de ahí, o vuelve a establecer esta prop para controlarlo tú mismo. Por defecto es `"1M"`.

**openedAt** `string`

Cuándo se abrió la cuenta, como marca de tiempo ISO 8601. `ALL` empieza aquí en lugar de en su valor predeterminado de cinco años, para que una cuenta más antigua conserve todo su historial. Por defecto es `""`.

**accountName** `string`

Añade el nombre de la cuenta a la etiqueta: `Total balance · Acme` normalmente, y `Acme balance on Jul 9` mientras el visitante lee un punto. Sin él, la etiqueta es solo `Total balance`. Por defecto es `""`.

**brush** `object | null`

El intervalo seleccionado en el gráfico, como marcas de tiempo ISO 8601. Establécelo para controlar la selección tú mismo, o `null` para borrar la que hizo el visitante. Devuelve lo que informa `rangeBrushed`, y al borrar un filtro en otra parte de tu página también se borra la selección aquí. Por defecto es `null`.

**propiedades**

**from** `string` *required*

**to** `string` *required*

**markedAt** `string`

Un momento que marcar en el gráfico, como marca de tiempo ISO 8601: el punto al que apunta otra cosa de tu página, como la fila bajo el puntero en una lista de actividad. Se comporta como si el visitante pasara el puntero por ese punto, y se ignora cuando queda fuera de la ventana en pantalla o cuando el visitante está leyendo el gráfico. Por defecto es `""`.

**includeOwnedAccounts** `boolean`

Para un usuario, suma su propio dinero más el de cada cuenta de la que es propietario, en lugar de solo su propio dinero. Se ignora para una cuenta, que ya es una sola cuenta. Por defecto es `false`.

**hideTotal** `boolean`

Oculta el total y su variación, dejando el gráfico y los botones del intervalo. Por defecto es `false`.

**hideChart** `boolean`

Oculta el gráfico, dejando el total y los botones del intervalo. Por defecto es `false`.

**height** `number`

La altura a la que se dibuja el gráfico, en píxeles. Por defecto es `210`.

## Eventos

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

### `onRangeChanged`

El intervalo de tiempo visible cambió. Replícalo si otra cosa de tu página lee el mismo periodo.

**payload** `object`

**propiedades**

**range** `"1D" | "1W" | "1M" | "1Y" | "ALL"` *required*

### `onRangeBrushed`

El visitante arrastró sobre el gráfico para seleccionar un intervalo, o borró la selección (`null`). Proporciona marcas de tiempo ISO 8601 más el intervalo en el que se leyeron, para que puedas filtrar tus propias vistas, como una lista de actividad o una tabla, al mismo periodo.

**payload** `object | null`

**propiedades**

**from** `string` *required*

**to** `string` *required*

**range** `"1D" | "1W" | "1M" | "1Y" | "ALL"` *required*

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

### `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\<BalanceElementProps\>` *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-Balance` | El total, su línea y el selector de ventana |
| `.whop-BalanceBrushSummary` | El tramo medido |
| `.whop-BalanceChart` | La línea del saldo |
| `.whop-BalanceRanges` | El selector de ventana |
| `.whop-BalanceTotal` | El total y su variación |

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

// 5 classes use this shape
wallet.update({
  appearance: { classes: { 'whop-Balance': { fontWeight: '700' } } }
});
```

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

## Parámetros

**accountId** `String` *required*

La cuenta cuyo dinero lee la vista. Usa un ID de cuenta con el prefijo `biz_`. Un ID de usuario con el prefijo `user_` lee el saldo propio del visitante y necesita autenticación del visitante (`WhopSDK.configureWithOAuth`), no un token de cuenta.

**currency** `String`

La moneda en la que se muestran el total y el gráfico. Por defecto es `"usd"`.

**range** `WalletBalanceRange`

El intervalo de tiempo con el que se abre el gráfico: `.oneDay`, `.oneWeek`, `.oneMonth`, `.oneYear`, `.all`. Por defecto es `.oneMonth`, y el visitante puede cambiarlo con el selector.

## Estados

Muestra un gráfico de marcador de posición mientras se cargan los datos. Si el periodo de comparación falla, la variación se oculta en lugar de estimarse, de modo que cualquier cifra en pantalla es una que se midió realmente. Un ID de cuenta que no se puede resolver muestra `Couldn't load this account.` en lugar de quedarse cargando.

## Información útil

* Mantén pulsado y arrastra sobre el gráfico para recorrerlo. El titular sigue el punto bajo tu dedo y vuelve al total cuando lo sueltas.
* El historial del saldo solo está disponible para los ID de cuenta con el prefijo `biz_`, así que una cuenta personal con el prefijo `user_` renderiza el total sin gráfico.
* Se combina con [`ListElement`](https://docs.whop.com/es/elements/latest/wallet/balances-list#swift), que desglosa el mismo total en activos individuales.

> [!NOTE]
>
> Llama a `WhopSDK.configure(tokenProvider:)` una vez al iniciar. Las vistas esperan al token. Consulta [Primeros pasos](https://docs.whop.com/es/elements/latest/getting-started.md). Aplica un tema con `.whopTheme(_:)`.


## Related topics

- [ListElement](https://docs.whop.com/es/elements/latest/wallet/balances-list.md)
- [Primeros pasos con Elements](https://docs.whop.com/es/elements/latest/getting-started.md)
- [Habilitar pagos salientes de subcuentas](https://docs.whop.com/es/developer/platforms/render-payout-portal.md)
