Skip to main content
Denne side dokumenterer @whop/elements@1.10.0 og @whop/elements-react@1.10.0.
Siden v1.0.0. Monteres inde i Wallet. accountId og accessToken kommer derfra. Send props og callbacks via create-indstillingerne eller React-props. Behold det oprettede handle eller React-ref for at kalde refresh().
Du kan montere dette element inline (create) eller åbne det som et modal-overlay (createOverlay).

Eksempeldata. Åbn Playground.

Props

string
Et afgrænset token til at vise udbetalingsmetoder og oprette udbetalingen – kræver payout:withdraw_funds, payout:destination:read og payout:create_destination for at tilføje en bank. Hvis det udelades, bruger kaldene seerens egen session, som kun svarer på samme origin.
boolean
Om den bekræftede udbetaling blev oprettet. Standard er false.
boolean
Om udbetalingsmetoder og grænser er ved at blive indlæst. Standard er false.
WithdrawalMethod[]
Gemte udbetalingsmetoder med prisoverslag for det aktuelle beløb. Standard er [].
string
En fejl fra værtens side, der skal vises på den aktuelle skærm. Standard er "".
number
Afregnet saldo, der er tilgængelig for standardudbetalingsmetoder. Standard er 0.
number
Afventende saldo, der kan være tilgængelig for øjeblikkelige udbetalingsmetoder. Standard er 0.
string
Udbetalingskontoens land som ISO 3166-1 alpha-2. Standard er "US".
WithdrawalSupportedMethod[]
Udbetalingsmetoder, der kan tilføjes i det valgte land, inklusive påkrævede felter. Standard er [].
boolean
Om understøttede udbetalingsmetoder er ved at blive indlæst for det valgte land. Standard er false.
WithdrawalLimits
Aktuelle grænser for standard- og øjeblikkelige udbetalinger. Standard er {"standard":{"maxAmount":0},"instant":{"maxAmount":0}}.
boolean
Om prisen for det aktuelle beløb er ved at blive genberegnet. Standard er false.
boolean
Om denne udbetaling skal bruge et præcist prisoverslag fra udbyderen før bekræftelse. Standard er false.
WithdrawalPayoutQuote | null
Det præcise, kortlivede prisoverslag for udbetalingen til bekræftelse. Medtag serverTime, så overslaget tidsbestemmes efter sin resterende levetid i stedet for enhedens ur. Medtag recommendedMethod for at tilbyde en billigere metode via tilslutningsflowet uden at ændre den valgte metode. Standard er null.
boolean
Om et præcist prisoverslag for udbetalingen er ved at blive oprettet. Standard er false.
string
Fejlen fra den aktuelle anmodning om et præcist prisoverslag, hvis der er en. Standard er "".
boolean
Om den seneste anmodning om prisoverslag var uafklaret og skal forsøges igen med samme anmodnings-ID. Standard er false.
boolean
Om det seneste udbetalingsresultat var uafklaret og skal forsøges igen nøjagtigt. Standard er false.
WithdrawalRequest | null
Den præcise uafklarede udbetalingsanmodning, der skal forsøges igen, efter at elementet er monteret igen. Standard er null.
boolean
Om en ny udbetalingsmetode er ved at blive gemt. Standard er false.
boolean
Om den bekræftede udbetaling er ved at blive oprettet. Standard er false.
boolean
True, når den seneste udbetaling blev afvist, fordi banken ikke kunne bekræfte kontohaverens navn. Viser et valg mellem at rette eller bekræfte; en bekræftelse udsender withdrawalRequested igen med acknowledgeBankWarning sat. Sæt dette tilbage til false, når du håndterer hver withdrawalRequested – valget vises ved skiftet til true, så et flag, der forbliver true, skjuler alle senere afvisninger. Standard er false.
string
Den senest oprettede metode, som vælges, når den vises i methods. Standard er "".
boolean
Sættes, når betaleren afbrød Plaid Link, eller det ikke kunne åbnes. Låser op for manuel indtastning på en kanal, der ellers kræver tilknytning. Standard er false.
boolean
Om en banktilknytning er i gang – Plaid-sessionen er åben, eller den tilknyttede metode er ved at blive gemt. Standard er false.

Hændelser

Send callbacks i create-indstillingerne eller React-props.

onAmountChanged

Beløbet ændrede sig, og prisen bør beregnes igen.
object

onCountryChanged

Landet for tilføjelse af metode ændrede sig, og de understøttede metoder bør opdateres.
object

onSupportedMethodChanged

En understøttet udbetalingsmetode blev valgt, og dens præcise påkrævede felter bør indlæses.
object

onAddMethodRequested

Betaleren indsendte den dynamiske formular til tilføjelse af udbetalingsmetode.
WithdrawalCreateMethodInput

onPlaidLinkRequested

Betaleren valgte at tilknytte sin bank via Plaid i stedet for at indtaste oplysninger. Åbn Plaid Link, når du modtager dette.
object

onMethodVerificationCompleted

Den nyligt tilføjede udbetalingsmetode afsluttede sit verifikationstrin.

onRenameMethodRequested

Betaleren anmodede om at omdøbe en gemt udbetalingsmetode.
object

onRemoveMethodRequested

Betaleren anmodede om at fjerne en gemt udbetalingsmetode.
object

onPayoutQuoteRequested

Betaleren anmodede om et præcist, kortlivet prisoverslag, før en udbetaling bekræftes.
WithdrawalPayoutQuoteRequest

onWithdrawalRequested

Betaleren bekræftede udbetalingen. Når værten styrer flowet, skal du oprette udbetalingen, når du modtager dette. Når elementet har oprettet den, udløses dette efter succes, så værten kan opdatere saldi – opret ikke en ekstra udbetaling.
WithdrawalRequest

onDone

Betaleren er færdig med at gennemse en gennemført udbetaling.

onLoaderStart

Kører, efter at indlæsningsskelettet tegnes første gang, og før onReady.

onReady

Kører efter elementets første komplette optegning.

onError

Kører, når elementet ikke kan indlæses eller går ned. Fallback-visningen forbliver synlig. Brug code til programmatisk håndtering. sourceKey identificerer en host-state-kilde, der fejlede.
object

Metoder

Kald disse på det handle, som create returnerer, eller via en React-ref.

refresh

Hent gemte udbetalingsmetoder og grænser igen. Kald den, når noget på din side ændrer, hvad kontoen kan udbetale til. Returnerer Promise<void>

mount

Monterer elementet i target og begynder indlæsningen. React-komponenter monterer sig selv. Parametre
string | HTMLElement
påkrævet

destroy

Fjerner elementet og frigiver dets frame og abonnementer. Du kan kalde den mere end én gang. React fjerner elementet automatisk.

update

Fletter nye props ind i det monterede element. I React ændrer du i stedet komponentens props. Parametre
Partial<WithdrawElementProps>
påkrævet

Styling

Dette element eksponerer ingen klassenavne til styling. Brug appearance (tema, accentfarve, variabler) til at ændre dets udseende.