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 showStep() og 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, der lader opløsningen af kanaler læse en personlig (user_) konto – kræver payout:account:read plus payout:account:update, for at bankkanalen kan klargøres. Udsted det på din server med POST /api/v1/access_tokens. Hvis det udelades, bruger kaldet seerens egen session, som kun svarer på samme origin; virksomhedskonti opløses uden nogen legitimation.
string
Udfyld beløbet på forhånd, og gør det skrivebeskyttet – til flows, der allerede ved, hvad der skyldes. Et beløb på eller under nul ignoreres, ligesom et beløb med mere end 12 hele cifre; resten afrundes til valutaens antal decimaler. Standard er "".
boolean
Tilbyd kryptokanalen, når kontoen har en indbetalingsadresse. Standard er true.
boolean
Tilbyd kanalen til bankoverførsel. Vises, selv før kontoen har bankoplysninger – hvis den vælges, beder den seeren om at verificere sin identitet, når det er det, kontoen stadig mangler, og rapporterer kanalen som endnu ikke tilgængelig, når det ikke er tilfældet. Standard er true.
DepositSavedCard[]
Kort, du allerede har gemt for denne betaler, vist som indbetalingsrækker. Valg af et kort udsender cardDepositRequested med beløbet – elementet opkræver aldrig selv en kortbetaling. Standard er [].
boolean
Tilføj en “Add card”-række, der udsender addCardRequested, så du kan åbne dit eget flow til indsamling af kort. Standard er false.
boolean
Tilbyd en “Platform balance”-række, der udsender platformBalanceSelected med det samme uden et beløbstrin. Standard er false.
DepositCardFee | null
Behandlingsgebyrer, der vises som forhåndsvisning under beløbet, når en kortrække er valgt. percentageFee er i PROCENTPOINT (2.9 er 2,9 %); fixedFee og radarFee er i hele valutaenheder (0.3 er $0.30). Standard er null.
Partial<Record<"crypto" | "bank", DepositRailFee>>
Tilsidesæt kontoens indbetalingsgebyrer under kanalvælgeren, med kanalen som nøgle (bank, crypto). Udeladte kanaler bruger de gebyrer, kontoen returnerer. percentageFee er i PROCENTPOINT (1.5 er 1,5 %); fixedFeeUsd er i hele USD-enheder (2 er $2.00) uanset indbetalingsvalutaen. Viser satsen, før der indtastes et beløb, og det opkrævede beløb bagefter. Standard er {}.
string
Forvælg en kanal efter id (bank, crypto, platform_balance eller et gemt korts id). Continue forbliver deaktiveret, så længe den kanal endnu ikke tilbydes, i stedet for at indbetale via en anden. Standard er "".
boolean
Udsend bankSelected, og bliv på beløbsskærmen i stedet for at vise overførselsfelterne – til værter, der kører deres eget trin, efter at kontoen allerede har en virtuel bankkonto. Standard er false.
boolean
Vis en “I have deposited my funds”-knap på kryptoskærmen, der udsender depositConfirmed, så du kan begynde at holde øje med overførslen. Standard er false.
"amount" | "crypto" | "bank"
Åbn direkte på en kanal i stedet for vælgeren. crypto og bank kræver intet beløb; deres tilbage-knap udsender dismissed, fordi der ikke er nogen vælger bag dem. Standard er "amount".

Hændelser

Send callbacks i create-indstillingerne eller React-props.

onDepositInitiated

Betaleren bekræftede et beløb og en kanal. Udløses for alle kanaler, før nogen instruktioner vises – hooket til analyse/funnel.
object

onCardDepositRequested

Et gemt kort blev valgt. Opkræv betalingen på din side, og kald derefter showStep({ step: "amount" }) for at sende elementet tilbage til vælgeren.
object

onAddCardRequested

Rækken “Add card” blev valgt – åbn dit flow til indsamling af kort.

onBankSelected

Bankkanalen blev valgt, mens deferBankToHost er sat – kør dit trin, og vis derefter selv felterne, eller kald showStep({ step: "bank" }).

onIdentityVerificationRequested

Seeren valgte bankoverførsel, før denne konto har en virtuel bankkonto. Elementet bliver på beløbsskærmen og navigerer aldrig – montér din egen verifikation, f.eks. verifications-controlleren, som svar på dette.
object

onPlatformBalanceSelected

Rækken med platformssaldo blev valgt. Den indeholder intet beløb – din egen skærm indsamler det.

onDepositConfirmed

Betaleren oplyste at have sendt kryptoen. since er en nedre grænse i unix-sekunder, hvorfra indgående overførsler begynder at blive matchet (den kigger lidt tilbage i tiden, så en overførsel sendt øjeblikke før klikket stadig matcher).
object

onStepChanged

Den synlige skærm ændrede sig.
object

onDismissed

Betaleren gik tilbage fra en kanal, som elementet blev åbnet direkte på – luk den flade, der indeholder det.

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.

showStep

Flyt elementet til en skærm. { step: "amount" } er måden, du giver kontrollen tilbage på, efter at du har gennemført en indbetaling med kort eller platformssaldo på din side. Parametre
object
påkrævet
Returnerer Promise<void>

refresh

Opløs kontoens indbetalingskanaler igen. Kald den, når noget på din side ændrer, hvad kontoen kan tilbyde – f.eks. når bank-onboarding er fuldført – så den nye kanal vises uden at vente på, at cachen udløber. 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<DepositElementProps>
påkrævet

Styling

Style disse dele via appearance.classes. Brug camel case eller kebab case til egenskabsnavne, og medtag enheder. Sidens stylesheets kan ikke nå elementets frame. Frameworket validerer hver deklaration, før den indsættes.
I React sender du appearance til <Wallet>. Sæt det globalt med WhopElements({ appearance }).