Skip to main content
Deze pagina documenteert @whop/elements@1.10.0 en @whop/elements-react@1.10.0.
Sinds v1.0.0. Wordt gemount binnen Wallet. accountId en accessToken komen daarvandaan. Geef props en callbacks mee via de create-opties of als React-props. Bewaar de aangemaakte handle, of React-ref, om showStep() en refresh() aan te roepen.
Je kunt dit element inline mounten (create) of openen als modale overlay (createOverlay).

Voorbeeldgegevens. Open de Playground.

Props

string
Een scoped token waarmee het ophalen van de kanalen een persoonlijk (user_) account kan lezen — vereist payout:account:read, plus payout:account:update om het bankkanaal in te richten. Maak het aan op je server met POST /api/v1/access_tokens. Wordt het weggelaten, dan gebruikt de aanroep de eigen sessie van de kijker, die alleen same-origin antwoordt; zakelijke accounts worden zonder credential opgehaald.
string
Vul het bedrag vooraf in en maak het alleen-lezen — voor flows die al weten wat er verschuldigd is. Een bedrag van nul of lager wordt genegeerd, net als een bedrag van meer dan 12 hele cijfers; de rest wordt afgerond op het aantal decimalen van de valuta. Standaard "".
boolean
Bied het cryptokanaal aan wanneer het account een stortingsadres heeft. Standaard true.
boolean
Bied het kanaal voor bankoverschrijving aan. Wordt ook getoond voordat het account bankgegevens heeft — als je het dan kiest, wordt de kijker gevraagd zijn identiteit te verifiëren wanneer het account dat nog moet doen, en wordt het kanaal als nog niet beschikbaar gemeld wanneer dat niet het geval is. Standaard true.
DepositSavedCard[]
Kaarten die je al voor deze betaler hebt, weergegeven als financieringsrijen. Als er een wordt gekozen, wordt cardDepositRequested met het bedrag uitgezonden — het element int nooit zelf een kaartbetaling. Standaard [].
boolean
Voeg een rij “Add card” toe die addCardRequested uitzendt, zodat je je eigen flow voor het verzamelen van kaarten kunt openen. Standaard false.
boolean
Bied een rij “Platform balance” aan die direct platformBalanceSelected uitzendt, zonder bedragstap. Standaard false.
DepositCardFee | null
Verwerkingskosten die als voorbeeld onder het bedrag worden getoond wanneer een kaartrij is geselecteerd. percentageFee is in procentpunten (2.9 is 2,9%); fixedFee en radarFee zijn hoofdeenheden (0.3 is $0.30). Standaard null.
Partial<Record<"crypto" | "bank", DepositRailFee>>
Overschrijf de stortingskosten van het account onder de kanaalkiezer, per kanaal (bank, crypto). Weggelaten kanalen gebruiken de kosten die het account retourneert. percentageFee is in procentpunten (1.5 is 1,5%); fixedFeeUsd is in USD-hoofdeenheden (2 is $2.00), ongeacht de stortingsvaluta. Toont het tarief voordat een bedrag is ingevoerd en daarna het in rekening gebrachte bedrag. Standaard {}.
string
Selecteer vooraf een kanaal op id (bank, crypto, platform_balance of het id van een opgeslagen kaart). Continue blijft uitgeschakeld zolang dat kanaal nog niet wordt aangeboden, in plaats van via een ander kanaal te financieren. Standaard "".
boolean
Zend bankSelected uit en blijf op het bedragscherm in plaats van de overschrijvingsgegevens te tonen — voor hosts die hun eigen stap uitvoeren nadat het account al een virtuele bankrekening heeft. Standaard false.
boolean
Toon een knop “I have deposited my funds” op het cryptoscherm die depositConfirmed uitzendt, zodat je kunt beginnen met het volgen van de overboeking. Standaard false.
"amount" | "crypto" | "bank"
Open direct op een kanaal in plaats van op de kiezer. crypto en bank hebben geen bedrag nodig; hun terugknop zendt dismissed uit, omdat er geen kiezer achter zit. Standaard "amount".

Events

Geef callbacks mee in de create-opties of als React-props.

onDepositInitiated

De betaler heeft een bedrag en een kanaal bevestigd. Wordt voor elk kanaal geactiveerd, voordat er instructies worden weergegeven — de hook voor analytics en funnels.
object

onCardDepositRequested

Er is een opgeslagen kaart gekozen. Int de betaling aan jouw kant en roep daarna showStep({ step: "amount" }) aan om het element terug te zetten naar de kiezer.
object

onAddCardRequested

De rij “Add card” is gekozen — open je flow voor het verzamelen van kaarten.

onBankSelected

Het bankkanaal is gekozen terwijl deferBankToHost is ingesteld — voer je stap uit en toon daarna zelf de velden of roep showStep({ step: "bank" }) aan.

onIdentityVerificationRequested

De kijker heeft bankoverschrijving gekozen voordat dit account een virtuele bankrekening heeft. Het element blijft op het bedragscherm en navigeert nooit — mount als reactie hierop je eigen verificatie, zoals de verifications-controller.
object

onPlatformBalanceSelected

De rij voor platformsaldo is gekozen. Deze bevat geen bedrag — je eigen scherm verzamelt dat.

onDepositConfirmed

De betaler geeft aan de crypto te hebben verstuurd. since is een ondergrens in unix-seconden vanaf waar inkomende overboekingen worden gematcht (deze kijkt iets terug in de tijd, zodat een overboeking die vlak voor de klik is verstuurd nog steeds matcht).
object

onStepChanged

Het zichtbare scherm is gewijzigd.
object

onDismissed

De betaler heeft een kanaal verlaten waarop het element direct was geopend — sluit het oppervlak dat het element bevat.

onLoaderStart

Wordt uitgevoerd nadat het laadskelet voor het eerst is weergegeven en vóór onReady.

onReady

Wordt uitgevoerd na de eerste volledige weergave van het element.

onError

Wordt uitgevoerd wanneer het element niet kan laden of crasht. De fallback blijft zichtbaar. Gebruik code voor programmatische afhandeling. sourceKey identificeert een mislukte host-state-bron.
object

Methoden

Roep deze aan op de handle die create retourneert, of via een React-ref.

showStep

Zet het element op een scherm. Met { step: "amount" } geef je de controle terug nadat je een kaart- of platformsaldostorting aan jouw kant hebt afgehandeld. Parameters
object
vereist
Retourneert Promise<void>

refresh

Haal de financieringskanalen van het account opnieuw op. Roep dit aan nadat iets aan jouw kant verandert wat het account kan aanbieden — bijvoorbeeld het afronden van de bankonboarding — zodat het nieuwe kanaal verschijnt zonder te wachten tot de cache verloopt. Retourneert Promise<void>

mount

Mount het element in target en begint met laden. React-componenten mounten zichzelf. Parameters
string | HTMLElement
vereist

destroy

Verwijdert het element en geeft het frame en de abonnementen vrij. Je kunt het meerdere keren aanroepen. React verwijdert het element automatisch.

update

Voegt nieuwe props samen in het gemounte element. Wijzig in React in plaats daarvan de componentprops. Parameters
Partial<DepositElementProps>
vereist

Styling

Style deze onderdelen via appearance.classes. Gebruik camelCase of kebab-case voor eigenschapsnamen en vermeld eenheden. Stylesheets van de pagina kunnen het frame van het element niet bereiken. Het framework valideert elke declaratie voordat die wordt geïnjecteerd.
Geef in React appearance door aan <Wallet>. Stel het globaal in met WhopElements({ appearance }).