Skip to main content
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. 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().
Puedes montar este elemento en línea (create) o abrirlo como un overlay modal (createOverlay).

Datos de ejemplo. Abre el Playground.

Props

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.
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 "".
boolean
Ofrece la vía cripto cuando la cuenta tiene una dirección de depósito. Por defecto es true.
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.
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 [].
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.
boolean
Ofrece una fila “Platform balance” que emite platformBalanceSelected inmediatamente, sin paso de importe. Por defecto es false.
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.
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 {}.
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 "".
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.
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.
"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.
object

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

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

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).
object

onStepChanged

La pantalla visible cambió.
object

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ó.
object

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
object
requerido
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
string | HTMLElement
requerido

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
Partial<DepositElementProps>
requerido

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.
En React, pasa appearance a <Wallet>. Establécelo globalmente con WhopElements({ appearance }).