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 Payments. Créalo para obtener un handle y luego monta sus elementos en ese handle. Llama a destroy() para eliminar el subcontrolador y liberar su espacio. Vuelve a crearlo para obtener un handle nuevo.
Exclusivo. CardFields es una alternativa a PaymentElement o CardElement en este handle de Payments. Monta uno a la vez. Destrúyelo antes de montar otro.

Vista previa

Una demostración interactiva en vivo de la disposición predeterminada de este subcontrolador con datos de ejemplo:
Se monta dentro de un ámbito WhopPayments. Los mismos tres campos alojados que WhopCardElement, colocados uno a uno dentro de su builder de contenido para que tu propio diseño decida dónde va cada uno.
El provider para campos de tarjeta colocados individualmente. Envuelve la parte de tu formulario que los contiene y luego coloca CardNumberElement, CardExpiryElement y CardCvcElement donde tu diseño los necesite.

Vista previa

Ejecutándose en la app de ejemplo de React Native:

Opciones

Pásalas a payments.create('cardFields', { … }), o como props en <CardFields> en React. Las props inyectadas por el padre nunca aparecen aquí.
CardNetworkArt[]
Las redes de tarjeta aceptadas por el vendedor en orden de visualización: los objetos networks de la entrada de tarjeta de la matriz, cuyos iconos servidos por la API determinan el logotipo de la marca del campo de número. Omítelo para obtenerlo junto con la clave.
"compact" | "stacked"
stacked (predeterminado) dispone los campos compuestos como una fila de número encima de la fecha de vencimiento y el código de seguridad. compact los dispone en una fila. Los campos montados por separado ignoran este diseño y se renderizan con bordes completos y esquinas redondeadas. El valor predeterminado es "stacked".
string
Clave publicable avanzada de Basis Theory. Omítela para obtener la clave automáticamente.

Eventos

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

onChange

Se dispara cuando cambia el estado de completitud. complete pasa a ser true después de que el comprador rellena los tres campos. Úsalo para habilitar la confirmación. brand es la red de la tarjeta detectada tal como la informa el campo; network es la misma detección en el vocabulario de redes de la API (coincide con los networks de la entrada de tarjeta de la matriz, null mientras se desconoce). last4 son los últimos cuatro dígitos del número, null hasta que el número está lo bastante avanzado. funding es el tipo de financiación detectado (credit, debit o prepaid), null hasta que el número identifica uno. issuingCountry es el código de dos letras en minúsculas del país en el que se emitió la tarjeta, null hasta que el número identifica uno.
object

Métodos

Llámalos en el subhandle de payments.create('cardFields', { … }).

tokenize

Método avanzado que tokeniza los tres campos sin crear un token de confirmación. Emite tokenized al controlador de pagos. Los errores de validación aparecen en el campo que falla y el método lanza una excepción. Usa payments.createConfirmationToken() para confirmar un pago.Parámetros
object
requerido
Devuelve Promise<object>
string
requerido

collect

payments.createConfirmationToken() llama a esta acción para cardFields. No la llames directamente. Tokeniza los campos y devuelve los datos usados para crear el token de confirmación.Parámetros
object
requerido
Devuelve Promise<object>
object
requerido
object
requerido

update

Combina nuevas props y callbacks en el subcontrolador.Parámetros
Partial<CardFieldsSubOptions>
requerido

destroy

Destruye el subcontrolador y sus elementos, y luego libera su espacio exclusivo. Un create("cardFields") posterior empieza de cero.

Parámetros

String?
Una clave publicable avanzada. Si la omites, se obtiene la propia de la cuenta.
WhopCardElement.Layout
Solo se lee cuando una unidad compuesta dispone los campos por sí misma. Los campos montados por separado lo ignoran.
Binding<WhopCardState>?
Devuelve si está completo y la marca detectada.
() -> Content
requerido
Donde van las tres vistas de campo. Cualquier otra cosa aquí dentro se renderiza con normalidad.

WhopCardState

Lo que devuelve una selección:
  • isComplete: Bool: los tres campos son válidos
  • brand: String?: la red detectada

Estados

Cada campo se renderiza inmediatamente y valida a medida que el comprador escribe. state.isComplete pasa a ser true cuando los tres son válidos, dondequiera que los coloques.

Información útil

  • Las tres vistas de campo solo funcionan dentro de un builder WhopCardFields: leen la unidad que este crea. Montadas en cualquier otro lugar, no renderizan nada.
  • Monta los tres. Una unidad a la que le falte uno nunca se completa, por lo que el botón de confirmar nunca se habilita.

Instalación

Móntalo dentro de un ámbito WhopPayments(accountID:charge:), que crea el controlador y se lo pasa a su contenido. payments.buyer es el comprador con sesión iniciada una vez que un inicio de sesión por correo electrónico lo ha verificado. WhopBrandingElement también tiene que estar en pantalla, porque Whop es el comerciante registrado en estas ventas y createConfirmationToken se rechaza sin él. Aplica estilo con .whopElementsAppearance(_:). El módulo es Elements, no WhopElements del SDK de wallet. Consulta Primeros pasos y Appearance.

Props

ReactNode
requerido
Tu diseño, con los tres elementos de campo en algún lugar de su interior.
string
Una clave publicable avanzada del tokenizador. Si la omites, el SDK obtiene por sí mismo la clave de la cuenta.
'stacked' | 'compact'
Da forma a los campos que se componen juntos. Los campos montados por separado lo ignoran y se renderizan con bordes completos. El valor predeterminado es stacked.
(payload: CardFieldsChangePayload) => void
Se dispara en cada edición con el estado combinado de los campos montados.

CardFieldsChangePayload

Lo que devuelve onChange:
  • complete: boolean: todos los campos montados están rellenos y son válidos
  • errors: Record<string, string>: mensajes por campo, con las claves cardNumber, cardExpiry, cardCvc

Estados

Sus hijos se renderizan una vez que se resuelve la clave publicable. onChange informa del estado combinado de todos los campos montados, por lo que un solo handler cubre toda la tarjeta.

Información útil

  • Los números de tarjeta nunca pasan por tu código. Los campos son inputs nativos aislados según PCI y el SDK entrega a Whop un token, por lo que tu app queda fuera del alcance de PCI.
  • Todos los campos deben estar dentro del mismo CardFields. Comparten una única tokenización, por lo que un campo montado fuera de él no recopila nada.
  • CardFields registra la superficie de recopilación, por lo que createConfirmationToken tokeniza la tarjeta sin conexiones adicionales.
  • La obtención de la clave publicable es automática. Pasa publicKey solo si ya tienes una.
Envuelve tu app en <WhopElements getToken={…}> una vez y luego monta <Payments> alrededor de los elementos. Consulta Primeros pasos y Appearance.

Elementos

Los elementos que monta este subcontrolador. Cada uno tiene su propia página:

CardNumberElement

Campo alojado del número de tarjeta, aislado según PCI. Los números de tarjeta nunca llegan a la página host.

CardExpiryElement

Campo alojado de la fecha de vencimiento de la tarjeta, aislado según PCI.

CardCvcElement

Campo alojado del código de seguridad de la tarjeta, aislado según PCI.