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 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 para listar los métodos de pago y crear el pago; necesita payout:withdraw_funds, payout:destination:read y payout:create_destination para añadir un banco. Si se omite, las llamadas llevan la propia sesión del visitante, que solo responde en el mismo origen.
boolean
Si el pago confirmado se creó correctamente. Por defecto es false.
boolean
Si se están cargando los métodos de pago y los límites. Por defecto es false.
WithdrawalMethod[]
Métodos de pago guardados con presupuestos para el importe actual. Por defecto es [].
string
Un error del lado del host que se muestra dentro de la pantalla actual. Por defecto es "".
number
Saldo liquidado disponible para los métodos de pago estándar. Por defecto es 0.
number
Saldo pendiente que puede estar disponible para los métodos de pago instantáneo. Por defecto es 0.
string
El país ISO 3166-1 alfa-2 de la cuenta de pagos. Por defecto es "US".
WithdrawalSupportedMethod[]
Métodos de pago que se pueden añadir en el país seleccionado, incluidos los campos obligatorios. Por defecto es [].
boolean
Si se están cargando los métodos de pago admitidos para el país seleccionado. Por defecto es false.
WithdrawalLimits
Límites de pago estándar e instantáneo en vivo. Por defecto es {"standard":{"maxAmount":0},"instant":{"maxAmount":0}}.
boolean
Si se está volviendo a calcular el precio del importe actual. Por defecto es false.
boolean
Si este pago debe usar un presupuesto exacto respaldado por el proveedor antes de la confirmación. Por defecto es false.
WithdrawalPayoutQuote | null
El presupuesto de pago exacto y de corta duración para la confirmación. Incluye serverTime para que el presupuesto se cronometre según su vida útil restante y no según el reloj del dispositivo. Incluye recommendedMethod para ofrecer un método más barato a través del flujo de conexión sin cambiar el método seleccionado. Por defecto es null.
boolean
Si se está creando un presupuesto de pago exacto. Por defecto es false.
string
El error de la solicitud actual de presupuesto de pago exacto, si lo hay. Por defecto es "".
boolean
Si la última solicitud de presupuesto no fue concluyente y debe reintentarse con el mismo ID de solicitud. Por defecto es false.
boolean
Si el último resultado del pago no fue concluyente y debe reintentarse exactamente. Por defecto es false.
WithdrawalRequest | null
La solicitud de pago exacta sin resolver que se debe reintentar después de que el elemento se vuelva a montar. Por defecto es null.
boolean
Si se está guardando un nuevo método de pago. Por defecto es false.
boolean
Si se está creando el pago confirmado. Por defecto es false.
boolean
True cuando el último pago se rechazó porque el banco no pudo confirmar el nombre del titular de la cuenta. Muestra una opción para corregir o confirmar; al confirmar, se vuelve a emitir withdrawalRequested con acknowledgeBankWarning establecido. Vuelve a establecerlo en false al gestionar cada withdrawalRequested: la opción aparece con el cambio a true, así que un indicador que se deja en true oculta todos los rechazos posteriores. Por defecto es false.
string
El método creado más recientemente, que se selecciona cuando aparece en los métodos. Por defecto es "".
boolean
Se establece cuando el pagador salió de Plaid Link o este no se pudo abrir. Desbloquea la introducción manual en una vía que, de otro modo, requiere vincular. Por defecto es false.
boolean
Si hay una vinculación bancaria en curso: la sesión de Plaid está abierta o se está guardando el método vinculado. Por defecto es false.

Eventos

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

onAmountChanged

El importe cambió y se debe volver a calcular su precio.
object

onCountryChanged

El país para añadir métodos cambió y se deben actualizar los métodos admitidos.
object

onSupportedMethodChanged

Se seleccionó un método de pago admitido y se deben cargar sus campos obligatorios exactos.
object

onAddMethodRequested

El pagador envió el formulario dinámico para añadir un método de pago.
WithdrawalCreateMethodInput

onPlaidLinkRequested

El pagador eligió vincular su banco a través de Plaid en lugar de escribir los datos. Abre Plaid Link al recibirlo.
object

onMethodVerificationCompleted

El método de pago recién añadido terminó su paso de verificación.

onRenameMethodRequested

El pagador solicitó cambiar el nombre de un método de pago guardado.
object

onRemoveMethodRequested

El pagador solicitó eliminar un método de pago guardado.
object

onPayoutQuoteRequested

El pagador solicitó un presupuesto exacto de corta duración antes de confirmar un pago.
WithdrawalPayoutQuoteRequest

onWithdrawalRequested

El pagador confirmó el pago. Cuando el host gestiona el flujo, crea el pago al recibirlo. Cuando el elemento lo creó, este evento se dispara tras el éxito para que el host pueda actualizar los saldos: no crees un segundo pago.
WithdrawalRequest

onDone

El pagador terminó de revisar un pago correcto.

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.

refresh

Vuelve a obtener los métodos de pago guardados y los límites. Llámalo después de que algo por tu parte cambie a dónde puede pagar la cuenta. 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<WithdrawElementProps>
requerido

Estilos

Este elemento no expone nombres de clase para estilos. Usa appearance (tema, color de acento, variables) para cambiar su estilo.