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 Wallet. accountId et accessToken proviennent de celui-ci. Transmettez les props et les callbacks via les options de création ou les props React. Conservez le handle créé, ou la ref React, pour appeler showStep() et refresh().
Vous pouvez monter cet élément inline (create) ou l’ouvrir en overlay modal (createOverlay).

Données d’exemple. Ouvrir le Playground.

Props

string
Un jeton à portée limitée qui permet à la résolution des canaux de lire un compte personnel (user_) — nécessite payout:account:read, ainsi que payout:account:update pour provisionner le canal bancaire. Générez-le sur votre serveur avec POST /api/v1/access_tokens. S’il est omis, l’appel transporte la propre session du visiteur, qui ne répond qu’en same-origin ; les comptes professionnels se résolvent sans aucun identifiant.
string
Préremplit le montant et le rend non modifiable — pour les parcours qui connaissent déjà la somme due. Un montant inférieur ou égal à zéro est ignoré, de même qu’un montant de plus de 12 chiffres entiers ; le reste est arrondi au nombre de décimales de la devise. Par défaut : "".
boolean
Propose le canal crypto lorsque le compte dispose d’une adresse de dépôt. Par défaut : true.
boolean
Propose le canal de virement bancaire. Affiché même avant que le compte ait des coordonnées bancaires — le choisir demande alors au visiteur de vérifier son identité lorsque c’est ce qu’il reste à faire pour le compte, et indique que le canal n’est pas encore disponible dans le cas contraire. Par défaut : true.
DepositSavedCard[]
Les cartes que vous détenez déjà pour ce payeur, affichées comme lignes d’approvisionnement. En choisir une émet cardDepositRequested avec le montant — l’élément ne collecte jamais de paiement par carte. Par défaut : [].
boolean
Ajoute une ligne “Add card” qui émet addCardRequested afin que vous puissiez ouvrir votre propre parcours de saisie de carte. Par défaut : false.
boolean
Propose une ligne “Platform balance” qui émet immédiatement platformBalanceSelected, sans étape de montant. Par défaut : false.
DepositCardFee | null
Les frais de traitement à prévisualiser sous le montant lorsqu’une ligne de carte est sélectionnée. percentageFee est exprimé en POINTS de pourcentage (2.9 correspond à 2,9 %) ; fixedFee et radarFee sont en unités principales (0.3 correspond à 0,30 $). Par défaut : null.
Partial<Record<"crypto" | "bank", DepositRailFee>>
Remplace les frais de dépôt du compte affichés sous le sélecteur de canal, indexés par canal (bank, crypto). Les canaux omis utilisent les frais renvoyés par le compte. percentageFee est exprimé en POINTS de pourcentage (1.5 correspond à 1,5 %) ; fixedFeeUsd est en unités principales USD (2 correspond à 2,00 $), quelle que soit la devise du dépôt. Affiche le taux avant la saisie d’un montant, puis le montant facturé ensuite. Par défaut : {}.
string
Présélectionne un canal par son id (bank, crypto, platform_balance ou l’id d’une carte enregistrée). Continue reste désactivé tant que ce canal n’est pas encore proposé, plutôt que d’approvisionner via un autre. Par défaut : "".
boolean
Émet bankSelected et reste sur l’écran du montant au lieu d’afficher les coordonnées de virement — pour les hôtes qui exécutent leur propre étape lorsque le compte dispose déjà d’un compte bancaire virtuel. Par défaut : false.
boolean
Affiche sur l’écran crypto un bouton “I have deposited my funds” qui émet depositConfirmed, afin que vous puissiez commencer à surveiller le transfert. Par défaut : false.
"amount" | "crypto" | "bank"
S’ouvre directement sur un canal au lieu du sélecteur. crypto et bank ne nécessitent pas de montant ; leur bouton retour émet dismissed, car il n’y a pas de sélecteur derrière eux. Par défaut : "amount".

Événements

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

onDepositInitiated

Le payeur a confirmé un montant et un canal. Se déclenche pour chaque canal, avant l’affichage de toute instruction — le point d’accroche pour l’analytique et le suivi du tunnel.
object

onCardDepositRequested

Une carte enregistrée a été choisie. Collectez le paiement de votre côté, puis appelez showStep({ step: "amount" }) pour ramener l’élément au sélecteur.
object

onAddCardRequested

La ligne “Add card” a été choisie — ouvrez votre parcours de saisie de carte.

onBankSelected

Le canal bancaire a été choisi alors que deferBankToHost est défini — exécutez votre étape, puis affichez vous-même les coordonnées ou appelez showStep({ step: "bank" }).

onIdentityVerificationRequested

Le visiteur a choisi le virement bancaire alors que ce compte n’a pas encore de compte bancaire virtuel. L’élément reste sur l’écran du montant et ne navigue jamais — montez en réponse votre propre vérification, comme le contrôleur verifications.
object

onPlatformBalanceSelected

La ligne du solde de la plateforme a été choisie. Elle ne transporte aucun montant — c’est votre propre écran qui le collecte.

onDepositConfirmed

Le payeur a indiqué avoir envoyé la crypto. since est un plancher en secondes unix à partir duquel commencer à rapprocher les transferts entrants (il remonte légèrement dans le temps, de sorte qu’un transfert envoyé quelques instants avant le clic est tout de même rapproché).
object

onStepChanged

L’écran visible a changé.
object

onDismissed

Le payeur a quitté un canal sur lequel l’élément avait été ouvert directement — fermez la surface qui le contient.

onLoaderStart

S’exécute après le premier affichage du squelette de chargement et avant onReady.

onReady

S’exécute après le premier affichage complet de l’élément.

onError

S’exécute lorsque l’élément ne parvient pas à se charger ou plante. L’affichage de repli reste visible. Utilisez code pour une gestion programmatique. sourceKey identifie une source d’état hôte en échec.
object

Méthodes

Appelez-les sur le handle renvoyé par create, ou via une ref React.

showStep

Amène l’élément sur un écran. { step: "amount" } vous permet de rendre la main après avoir réglé de votre côté un dépôt par carte ou par solde de la plateforme. Paramètres
object
requis
Renvoie Promise<void>

refresh

Résout à nouveau les canaux d’approvisionnement du compte. Appelez-la après toute modification de votre côté de ce que le compte peut proposer — la fin de l’onboarding bancaire, par exemple — afin que le nouveau canal apparaisse sans attendre l’expiration du cache. Renvoie Promise<void>

mount

Monte l’élément dans target et démarre le chargement. Les composants React se montent eux-mêmes. Paramètres
string | HTMLElement
requis

destroy

Supprime l’élément et libère son frame et ses abonnements. Vous pouvez l’appeler plusieurs fois. React supprime l’élément automatiquement.

update

Fusionne de nouvelles props dans l’élément monté. Avec React, modifiez plutôt les props du composant. Paramètres
Partial<DepositElementProps>
requis

Style

Stylisez ces parties via appearance.classes. Utilisez le camel case ou le kebab case pour les noms de propriétés et incluez les unités. Les feuilles de style de la page ne peuvent pas atteindre le frame de l’élément. Le framework valide chaque déclaration avant de l’injecter.
Avec React, transmettez appearance à <Wallet>. Définissez-la globalement avec WhopElements({ appearance }).