Skip to main content
Cette page documente @whop/elements@1.10.0 et @whop/elements-react@1.10.0.
Depuis v1.0.0.
Se monte à l’intérieur de Payments. Créez-le pour obtenir un handle, puis montez ses éléments sur ce handle. Appelez destroy() pour supprimer le sous-contrôleur et libérer son emplacement. Créez-le à nouveau pour obtenir un nouveau handle.
Exclusif. CardFields est une alternative à PaymentElement ou CardElement dans ce handle Payments. Montez-en un seul à la fois. Détruisez-le avant d’en monter un autre.

Aperçu

Une démo interactive en direct de la disposition par défaut de ce sous-contrôleur, avec des données d’exemple :
Se monte à l’intérieur d’un scope WhopPayments. Les trois mêmes saisies hébergées que WhopCardElement, placées une par une dans son builder de contenu pour que votre propre mise en page décide de l’emplacement de chacune.
Le provider des champs de carte placés individuellement. Enveloppez la partie de votre formulaire qui les contient, puis placez CardNumberElement, CardExpiryElement et CardCvcElement là où votre mise en page le souhaite.

Aperçu

Exécuté dans l’application d’exemple React Native :

Options

Transmettez-les à payments.create('cardFields', { … }), ou comme props sur <CardFields> avec React. Les props injectées par le parent n’apparaissent jamais ici.
CardNetworkArt[]
Les réseaux de carte acceptés par le vendeur, dans l’ordre d’affichage — les objets networks de l’entrée carte de la matrice, dont les icônes fournies par l’API déterminent le visuel de marque du champ de numéro. Omettez-le pour qu’il soit récupéré avec la clé.
"compact" | "stacked"
stacked (par défaut) agence les champs composés avec une ligne pour le numéro au-dessus de la date d’expiration et du code de sécurité. compact les agence sur une seule ligne. Les champs montés séparément ignorent cette disposition et s’affichent avec des bordures complètes et des coins arrondis. Par défaut : "stacked".
string
Clé publiable Basis Theory avancée. Omettez-la pour récupérer la clé automatiquement.

Événements

Transmettez les callbacks dans les options de création ou dans les props React.

onChange

Se déclenche lorsque l’état de complétude change. complete passe à true une fois que l’acheteur a rempli les trois champs. Utilisez-le pour activer la confirmation. brand est le réseau de carte détecté tel que le champ le signale ; network est la même détection dans le vocabulaire de réseaux de l’API (correspond aux networks de l’entrée carte de la matrice, null tant qu’il est inconnu). last4 correspond aux quatre derniers chiffres du numéro, null tant que la saisie du numéro n’est pas assez avancée. funding est le type de financement détecté (credit, debit ou prepaid), null tant que le numéro n’en identifie pas un. issuingCountry est le code à deux lettres en minuscules du pays d’émission de la carte, null tant que le numéro n’en identifie pas un.
object

Méthodes

Appelez-les sur le sous-handle obtenu avec payments.create('cardFields', { … }).

tokenize

Méthode avancée qui tokenise les trois champs sans créer de jeton de confirmation. Elle émet tokenized vers le contrôleur de paiements. Les erreurs de validation apparaissent sur le champ en échec, et la méthode lève une exception. Utilisez payments.createConfirmationToken() pour confirmer un paiement.Paramètres
object
requis
Renvoie Promise<object>
string
requis

collect

payments.createConfirmationToken() appelle cette action pour cardFields. Ne l’appelez pas directement. Elle tokenise les champs et renvoie les données utilisées pour créer le jeton de confirmation.Paramètres
object
requis
Renvoie Promise<object>
object
requis
object
requis

update

Fusionne de nouvelles props et de nouveaux callbacks dans le sous-contrôleur.Paramètres
Partial<CardFieldsSubOptions>
requis

destroy

Détruit le sous-contrôleur et ses éléments, puis libère son emplacement exclusif. Un create("cardFields") ultérieur repart de zéro.

Paramètres

String?
Une clé publiable avancée. Omettez-la et celle du compte est récupérée.
WhopCardElement.Layout
Lu uniquement lorsqu’une unité composée agence elle-même les champs. Les champs montés séparément l’ignorent.
Binding<WhopCardState>?
Relit l’état de complétude et la marque détectée.
() -> Content
requis
L’endroit où vont les trois vues de champ. Tout autre contenu placé ici s’affiche normalement.

WhopCardState

Ce que renvoie une sélection :
  • isComplete: Bool : les trois champs sont valides
  • brand: String? : le réseau détecté

États

Chaque champ s’affiche immédiatement et valide au fil de la saisie de l’acheteur. state.isComplete passe à true lorsque les trois sont valides, où que vous les placiez.

Bon à savoir

  • Les trois vues de champ ne fonctionnent qu’à l’intérieur d’un builder WhopCardFields : elles lisent l’unité qu’il crée. Montées ailleurs, elles n’affichent rien.
  • Montez les trois. Une unité à laquelle il en manque un n’est jamais complète, donc le bouton de confirmation ne s’active jamais.

Installation

Montez-le à l’intérieur d’un scope WhopPayments(accountID:charge:), qui crée le contrôleur et le transmet à son contenu. payments.buyer est l’acheteur connecté dès qu’une connexion par e-mail en a authentifié un. WhopBrandingElement doit aussi être à l’écran, car Whop est le marchand officiel (merchant of record) de ces ventes et createConfirmationToken refuse sans lui. Stylisez avec .whopElementsAppearance(_:). Le module est Elements, et non WhopElements du SDK wallet. Consultez Premiers pas et Apparence.

Props

ReactNode
requis
Votre mise en page, avec les trois éléments de champ placés quelque part à l’intérieur.
string
Une clé publiable de tokenizer avancée. Omettez-la et le SDK récupère lui-même la clé du compte.
'stacked' | 'compact'
Agence les champs composés ensemble. Les champs montés séparément l’ignorent et s’affichent avec des bordures complètes. Par défaut : stacked.
(payload: CardFieldsChangePayload) => void
Se déclenche à chaque modification avec l’état combiné des champs montés.

CardFieldsChangePayload

Ce que renvoie onChange :
  • complete: boolean : chaque champ monté est rempli et valide
  • errors: Record<string, string> : messages par champ, avec les clés cardNumber, cardExpiry, cardCvc

États

Ses enfants s’affichent une fois la clé publiable résolue. onChange signale l’état combiné de chaque champ monté, de sorte qu’un seul handler couvre toute la carte.

Bon à savoir

  • Les numéros de carte ne passent jamais par votre code. Les champs sont des saisies natives isolées PCI, et le SDK transmet un jeton à Whop : votre application reste donc hors du périmètre PCI.
  • Chaque champ doit se trouver dans le même CardFields. Ils partagent une seule tokenisation, donc un champ monté en dehors ne collecte rien.
  • CardFields enregistre la surface de collecte, de sorte que createConfirmationToken tokenise la carte sans branchement supplémentaire.
  • La récupération de la clé publiable est automatique. Ne transmettez publicKey que si vous en détenez déjà une.
Enveloppez votre application dans <WhopElements getToken={…}> une seule fois, puis montez <Payments> autour des éléments. Consultez Premiers pas et Apparence.

Éléments

Les éléments que monte ce sous-contrôleur. Chacun a sa propre page :

CardNumberElement

Champ hébergé du numéro de carte, isolé PCI. Les numéros de carte n’atteignent jamais la page hôte.

CardExpiryElement

Champ hébergé de la date d’expiration de la carte, isolé PCI.

CardCvcElement

Champ hébergé du code de sécurité de la carte, isolé PCI.