Skip to main content
Permettez à vos sous-comptes d’effectuer eux-mêmes la vérification Know Your Customer (KYC), d’ajouter des méthodes de versement et de retirer leurs fonds. Vous pouvez monter les surfaces de portefeuille de Whop Elements directement dans votre application ou rediriger les utilisateurs vers un portail hébergé par Whop.

Portail de versement intégré

Implémentation côté serveur

Pour monter les éléments de portefeuille, générez un jeton d’accès pour le sous-compte sur votre serveur. Les éléments lisent le solde et les versements de ce compte avec ce jeton. Consultez Authentification et clés API pour savoir comment restreindre la portée de ce jeton et comment il se compare aux autres types d’identifiants de Whop.

API Create Access Token

Consultez la référence complète de l’API pour la génération de jetons d’accès et tous les paramètres disponibles

Configuration côté client

Implémentation côté client

Créez un handle Wallet pour le sous-compte et montez sous celui-ci les surfaces dont vous avez besoin. Le handle transmet son jeton d’accès à chaque élément placé sous lui : générez donc un seul jeton portant tous les scopes que ces éléments lisent.
Sur iOS, le SDK de portefeuille fournit BalanceElement, ListElement et ActivityElement. Consultez Premiers pas avec Elements et choisissez l’onglet Swift.

Vérification d’identité

Un sous-compte doit vérifier son identité avant de pouvoir effectuer un retrait. Montez l’élément KYC pour le parcours complet dans la page, qui collecte les informations, exécute la session du fournisseur hébergé et communique le résultat. Ou montez l’élément RequiredActions pour afficher toutes les actions en attente, vérification comprise, et permettre à l’utilisateur de lancer chacune d’elles.
React

Options de Wallet

Toutes les options, tous les événements et toutes les méthodes sont listés dans la référence Wallet.

Scopes

Les éléments lisent les données avec le jeton que vous générez : accordez donc sur ce seul jeton tous les scopes dont ils ont besoin :
  • Balances et Activity lisent company:balance:read.
  • Withdraw nécessite payout:withdraw_funds, payout:destination:read, ainsi que payout:create_destination pour ajouter une banque.
  • KYC nécessite identity:read et identity:write.
Un jeton créé sans scoped_actions hérite de toutes les permissions de votre clé API.

Actualiser le jeton

Les jetons d’accès expirent par défaut au bout d’une heure, et au maximum au bout de trois heures. Définissez-en un nouveau sur le handle avant son expiration :
En React, transmettez la nouvelle valeur dans la prop accessToken.
accessToken est une valeur que vous définissez, et non un callback appelé par le SDK. Verifications fait exception : il accepte un callback getToken et l’appelle avant le montage de l’élément.

Portail de versement hébergé

Au lieu d’intégrer le portail de versement dans votre application, vous pouvez rediriger les utilisateurs vers un portail de versement hébergé par Whop. C’est utile lorsque vous ne voulez pas créer d’interface personnalisée ou avez besoin d’une intégration rapide. Créez un lien de compte et redirigez l’utilisateur vers l’URL renvoyée :
Dans cet exemple :
  • account_id est la plateforme ou le sous-compte
  • use_case indique le type de portail
  • return_url est l’adresse vers laquelle Whop redirige l’utilisateur lorsqu’il souhaite revenir sur votre site
  • refresh_url est l’adresse vers laquelle Whop redirige l’utilisateur si la session expire

Cas d’usage disponibles

Après avoir créé le lien de compte, redirigez l’utilisateur vers l’url renvoyée dans la réponse. L’utilisateur termine le parcours de versement sur le portail hébergé par Whop, puis Whop le redirige vers votre return_url.

Éléments de portefeuille

Toutes les surfaces de portefeuille avec leurs options, événements et scopes

Payer les sous-comptes

Transférez des fonds vers des sous-comptes