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 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 voor het tonen van uitbetalingsmethoden en het aanmaken van de uitbetaling — vereist payout:withdraw_funds, payout:destination:read en payout:create_destination om een bank toe te voegen. Wordt het weggelaten, dan gebruiken de aanroepen de eigen sessie van de kijker, die alleen same-origin antwoordt.
boolean
Of de bevestigde uitbetaling met succes is aangemaakt. Standaard false.
boolean
Of uitbetalingsmethoden en limieten worden geladen. Standaard false.
WithdrawalMethod[]
Opgeslagen uitbetalingsmethoden met offertes voor het huidige bedrag. Standaard [].
string
Een fout aan de kant van de host die binnen het huidige scherm wordt getoond. Standaard "".
number
Afgewikkeld saldo dat beschikbaar is voor standaard uitbetalingsmethoden. Standaard 0.
number
Lopend saldo dat mogelijk beschikbaar is voor directe uitbetalingsmethoden. Standaard 0.
string
Het land van het uitbetalingsaccount als ISO 3166-1 alpha-2-code. Standaard "US".
WithdrawalSupportedMethod[]
Uitbetalingsmethoden die in het geselecteerde land kunnen worden toegevoegd, inclusief verplichte velden. Standaard [].
boolean
Of ondersteunde uitbetalingsmethoden worden geladen voor het geselecteerde land. Standaard false.
WithdrawalLimits
Live limieten voor standaard en directe uitbetalingen. Standaard {"standard":{"maxAmount":0},"instant":{"maxAmount":0}}.
boolean
Of de prijs voor het huidige bedrag opnieuw wordt berekend. Standaard false.
boolean
Of deze uitbetaling vóór bevestiging een exacte offerte van de provider moet gebruiken. Standaard false.
WithdrawalPayoutQuote | null
De exacte, kortlevende uitbetalingsofferte voor bevestiging. Neem serverTime op, zodat de offerte wordt getimed op basis van de resterende levensduur in plaats van de klok van het apparaat. Neem recommendedMethod op om via de koppelingsflow een goedkopere methode aan te bieden zonder de geselecteerde methode te wijzigen. Standaard null.
boolean
Of er een exacte uitbetalingsofferte wordt aangemaakt. Standaard false.
string
De eventuele fout van het huidige verzoek om een exacte uitbetalingsofferte. Standaard "".
boolean
Of het laatste offerteverzoek geen uitsluitsel gaf en opnieuw moet worden geprobeerd met hetzelfde verzoek-ID. Standaard false.
boolean
Of het laatste uitbetalingsresultaat geen uitsluitsel gaf en exact opnieuw moet worden geprobeerd. Standaard false.
WithdrawalRequest | null
Het exacte onopgeloste uitbetalingsverzoek dat opnieuw moet worden geprobeerd nadat het element opnieuw is gemount. Standaard null.
boolean
Of er een nieuwe uitbetalingsmethode wordt opgeslagen. Standaard false.
boolean
Of de bevestigde uitbetaling wordt aangemaakt. Standaard false.
boolean
True wanneer de laatste uitbetaling is geweigerd omdat de bank de naam van de rekeninghouder niet kon bevestigen. Toont een keuze tussen corrigeren of bevestigen; bevestigen zendt withdrawalRequested opnieuw uit met acknowledgeBankWarning ingesteld. Zet dit terug op false bij het afhandelen van elke withdrawalRequested — de keuze verschijnt bij de wijziging naar true, dus een vlag die op true blijft staan verbergt elke latere weigering. Standaard false.
string
De meest recent aangemaakte methode, die wordt geselecteerd wanneer deze in methods verschijnt. Standaard "".
boolean
Wordt ingesteld wanneer de betaler Plaid Link heeft verlaten of wanneer het niet kon worden geopend. Ontgrendelt handmatige invoer op een kanaal dat anders koppelen vereist. Standaard false.
boolean
Of er een bankkoppeling bezig is — de Plaid-sessie is geopend, of de gekoppelde methode wordt opgeslagen. Standaard false.

Events

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

onAmountChanged

Het bedrag is gewijzigd en de prijs moet opnieuw worden berekend.
object

onCountryChanged

Het land voor het toevoegen van een methode is gewijzigd en de ondersteunde methoden moeten worden ververst.
object

onSupportedMethodChanged

Er is een ondersteunde uitbetalingsmethode geselecteerd en de exacte verplichte velden ervan moeten worden geladen.
object

onAddMethodRequested

De betaler heeft het dynamische formulier voor het toevoegen van een uitbetalingsmethode verstuurd.
WithdrawalCreateMethodInput

onPlaidLinkRequested

De betaler heeft ervoor gekozen de bank via Plaid te koppelen in plaats van gegevens in te typen. Open Plaid Link bij ontvangst.
object

onMethodVerificationCompleted

De nieuw toegevoegde uitbetalingsmethode heeft de verificatiestap voltooid.

onRenameMethodRequested

De betaler heeft gevraagd een opgeslagen uitbetalingsmethode te hernoemen.
object

onRemoveMethodRequested

De betaler heeft gevraagd een opgeslagen uitbetalingsmethode te verwijderen.
object

onPayoutQuoteRequested

De betaler heeft om een exacte, kortlevende offerte gevraagd voordat een uitbetaling wordt bevestigd.
WithdrawalPayoutQuoteRequest

onWithdrawalRequested

De betaler heeft de uitbetaling bevestigd. Wanneer de host de flow aanstuurt, maak je de uitbetaling bij ontvangst aan. Wanneer het element de uitbetaling heeft aangemaakt, wordt dit na succes geactiveerd, zodat de host saldi kan verversen — maak geen tweede uitbetaling aan.
WithdrawalRequest

onDone

De betaler is klaar met het bekijken van een geslaagde uitbetaling.

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.

refresh

Haal opgeslagen uitbetalingsmethoden en limieten opnieuw op. Roep dit aan nadat iets aan jouw kant verandert waarnaar het account kan uitbetalen. 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<WithdrawElementProps>
vereist

Styling

Dit element stelt geen klassenamen beschikbaar voor styling. Gebruik appearance (thema, accentkleur, variabelen) om het opnieuw te stylen.