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 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 pour lister les moyens de versement et créer le versement — nécessite payout:withdraw_funds, payout:destination:read, ainsi que payout:create_destination pour ajouter une banque. S’il est omis, les appels transportent la propre session du visiteur, qui ne répond qu’en same-origin.
boolean
Indique si le versement confirmé a été créé avec succès. Par défaut : false.
boolean
Indique si les moyens et les limites de versement sont en cours de chargement. Par défaut : false.
WithdrawalMethod[]
Les moyens de versement enregistrés, avec leurs devis pour le montant actuel. Par défaut : [].
string
Une erreur côté hôte à afficher dans l’écran actuel. Par défaut : "".
number
Le solde réglé disponible pour les moyens de versement standard. Par défaut : 0.
number
Le solde en attente pouvant être disponible pour les moyens de versement instantané. Par défaut : 0.
string
Le pays ISO 3166-1 alpha-2 du compte de versement. Par défaut : "US".
WithdrawalSupportedMethod[]
Les moyens de versement pouvant être ajoutés dans le pays sélectionné, avec leurs champs obligatoires. Par défaut : [].
boolean
Indique si les moyens de versement pris en charge sont en cours de chargement pour le pays sélectionné. Par défaut : false.
WithdrawalLimits
Les limites de versement standard et instantané en direct. Par défaut : {"standard":{"maxAmount":0},"instant":{"maxAmount":0}}.
boolean
Indique si le montant actuel est en cours de recalcul du prix. Par défaut : false.
boolean
Indique si ce versement doit utiliser un devis exact fourni par le prestataire avant la confirmation. Par défaut : false.
WithdrawalPayoutQuote | null
Le devis de versement exact et de courte durée pour la confirmation. Incluez serverTime afin que le devis soit chronométré selon sa durée de vie restante plutôt que selon l’horloge de l’appareil. Incluez recommendedMethod pour proposer un moyen moins coûteux via le parcours de connexion sans modifier le moyen sélectionné. Par défaut : null.
boolean
Indique si un devis de versement exact est en cours de création. Par défaut : false.
string
L’erreur de la demande de devis de versement exact en cours, le cas échéant. Par défaut : "".
boolean
Indique si la dernière demande de devis n’a pas abouti et doit être relancée avec le même ID de requête. Par défaut : false.
boolean
Indique si le résultat du dernier versement n’a pas abouti et doit être relancé à l’identique. Par défaut : false.
WithdrawalRequest | null
La demande de versement non résolue exacte à relancer après le remontage de l’élément. Par défaut : null.
boolean
Indique si un nouveau moyen de versement est en cours d’enregistrement. Par défaut : false.
boolean
Indique si le versement confirmé est en cours de création. Par défaut : false.
boolean
Vaut true lorsque le dernier versement a été refusé parce que la banque n’a pas pu confirmer le nom du titulaire du compte. Affiche un choix entre corriger et confirmer ; la confirmation réémet withdrawalRequested avec acknowledgeBankWarning défini. Repassez cette valeur à false lors du traitement de chaque withdrawalRequested — le choix apparaît lors du passage à true, de sorte qu’un indicateur laissé à true masque tous les refus ultérieurs. Par défaut : false.
string
Le moyen créé le plus récemment, sélectionné lorsqu’il apparaît dans methods. Par défaut : "".
boolean
À définir lorsque le payeur a quitté Plaid Link ou que son ouverture a échoué. Déverrouille la saisie manuelle sur un canal qui nécessite sinon une liaison. Par défaut : false.
boolean
Indique si une liaison bancaire est en cours — la session Plaid est ouverte, ou le moyen lié est en cours d’enregistrement. Par défaut : false.

Événements

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

onAmountChanged

Le montant a changé et son prix doit être recalculé.
object

onCountryChanged

Le pays d’ajout de moyen a changé et les moyens pris en charge doivent être actualisés.
object

onSupportedMethodChanged

Un moyen de versement pris en charge a été sélectionné et ses champs obligatoires exacts doivent être chargés.
object

onAddMethodRequested

Le payeur a soumis le formulaire dynamique d’ajout de moyen de versement.
WithdrawalCreateMethodInput

onPlaidLinkRequested

Le payeur a choisi de lier sa banque via Plaid au lieu de saisir ses coordonnées. Ouvrez Plaid Link à la réception.
object

onMethodVerificationCompleted

Le moyen de versement nouvellement ajouté a terminé son étape de vérification.

onRenameMethodRequested

Le payeur a demandé à renommer un moyen de versement enregistré.
object

onRemoveMethodRequested

Le payeur a demandé à supprimer un moyen de versement enregistré.
object

onPayoutQuoteRequested

Le payeur a demandé un devis exact de courte durée avant de confirmer un versement.
WithdrawalPayoutQuoteRequest

onWithdrawalRequested

Le payeur a confirmé le versement. Lorsque l’hôte pilote le parcours, créez le versement à la réception. Lorsque l’élément l’a créé, cet événement se déclenche après le succès afin que l’hôte puisse actualiser les soldes — ne créez pas de second versement.
WithdrawalRequest

onDone

Le payeur a fini de consulter un versement réussi.

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.

refresh

Récupère à nouveau les moyens de versement enregistrés et les limites. Appelez-la après toute modification de votre côté des destinations vers lesquelles le compte peut verser. 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<WithdrawElementProps>
requis

Style

Cet élément n’expose pas de noms de classes pour le style. Utilisez appearance (thème, couleur d’accent, variables) pour modifier son apparence.