Indsaml en betaling ud fra et plan_-ID eller en inline valuta og et beløb, eller gem en betalingsmetode uden opkrævning med mode: "setup". Montér PaymentElement, CardElement eller CardFields, og kald derefter payments.createConfirmationToken med faktureringsoplysninger. Valg af wallet åbner automatisk wallettens ark. Når kontoen tilbyder banktilknytning på siden (bank_debit.bank_connection på dens betalingsmetodetype for bankkonto), åbner et valg af bankkonto også Plaid Link på siden. Hvis køberen lukker en af dem, afvises kaldet med payment_request_cancelled, som din betalingshandler bør behandle som en annullering. Bekræft tokenet på serveren, og send derefter betalingens eller setup intentens client_secret til handleNextAction for eventuelle udestående trin.
Denne side dokumenterer @whop/elements@1.10.0 og @whop/elements-react@1.10.0.
Siden v1.0.0.
Playground
Sæt elementerne sammen med eksempeldata. Betjen kontrollerne, tilføj og arrangér elementer, og se events blive udløst live:
import { WhopElements, Payments } from "@whop/elements-react";import { loadWhop } from "@whop/elements";function Example() { return ( <WhopElements elements={loadWhop()}> <Payments /* options */> {/* mount elements here */} </Payments> </WhopElements> );}
Angiv disse til whop.payments.create({ … }) eller som props på <Payments> i React.
Angiv præcis én af disse kombinationer:
accountId og plan
accountId, currency og amount
accountId, mode: "setup" og currency
ingen af plan, currency, amount eller mode
string
Konto-ID med præfikset biz_. Udelad kun, når du kalder statiske metoder uden en kontoflade.
"payment" | "setup"
Monteringstilstand, payment som standard. setup gemmer en betalingsmetode og opkræver intet, hverken nu eller senere: kun metoder, der kan gemmes, tilbydes, og beløbsgrænser gælder ikke. Bekræft med createConfirmationToken(), og opret derefter setup intenten på serveren.
string
Plan-ID med præfikset plan_. Det resolveres på klientsiden til valuta, beløb og metodekonfiguration. Angiv en plan eller en inline valuta og et beløb, aldrig begge.
object
Totaler for feeInclusive og feeFree i mindste enhed, der bruges til at afgrænse metoder, når checkout genprissætter amount for en gebyrfri metode såsom BNPL. Hver metode kontrolleres mod sin tilsvarende total, så den valgte gebyrfri metode ikke forsvinder. Når de udelades, afgrænser amount alle metoder.
Vis egenskaber
number
påkrævet
number
påkrævet
string
Retur-URL til bank- eller 3DS-trin uden for siden. Standard er den side, der monterer. Køberen lander der uanset udfaldet, med payment (eller setup), status (succeeded, failed, canceled eller en stadig afventende status såsom processing) og client_secret tilføjet, så forgren på status, før du viser en successide.
"off_session" | "on_session"
En setup gemmer betalingsmetoden til off_session-brug, den eneste anvendelse, en setup accepterer.
WalletAvailability
Tilsidesættelse af wallet-tilgængelighed til deterministiske forhåndsvisninger. Live checkouts undersøger værten.
Vis egenskaber
boolean
påkrævet
boolean
påkrævet
boolean
("apple_pay" | "google_pay" | "paypal_express")[]
Wallets rangeret efter, hvilket ark der er native i denne browser — Apple Pay først på WebKit, Google Pay først alle andre steder, PayPal sidst — så express-knapper kan stables med den bedste først. Fraværende ved tilgængelighed angivet af forbrugeren (forhåndsvisninger) og på wire-formater, der er ældre end feltet. En inline union, ikke payment-requests WalletSheetType: det modul importerer allerede dette.
object
Hver tilgængelig wallets detaljer med wallet-typen som nøgle. Fraværende ved tilgængelighed angivet af forbrugeren (forhåndsvisninger).
Vis egenskaber
WalletDetails
Vis egenskaber
WalletButtonArt
Wallettens officielle knapgrafik. Fraværende, når der ikke er publiceret nogen.
Vis egenskaber
object
påkrævet
Til lyse sider.
Vis egenskaber
string
påkrævet
string
påkrævet
object
påkrævet
Til mørke sider.
Vis egenskaber
string
påkrævet
string
påkrævet
WalletDetails
Vis egenskaber
WalletButtonArt
Wallettens officielle knapgrafik. Fraværende, når der ikke er publiceret nogen.
Vis egenskaber
object
påkrævet
Til lyse sider.
Vis egenskaber
string
påkrævet
string
påkrævet
object
påkrævet
Til mørke sider.
Vis egenskaber
string
påkrævet
string
påkrævet
WalletDetails
Vis egenskaber
WalletButtonArt
Wallettens officielle knapgrafik. Fraværende, når der ikke er publiceret nogen.
Vis egenskaber
object
påkrævet
Til lyse sider.
Vis egenskaber
string
påkrævet
string
påkrævet
object
påkrævet
Til mørke sider.
Vis egenskaber
string
påkrævet
string
påkrævet
string
Tre-bogstavs ISO 4217-valutakode med små bogstaver. Den filtrerer betalingsmetodematrixen.
number
Betalingsbeløb i mindste enhed. Metoder, hvis grænser udelukker det, tilbydes ikke.
object
Kontoens betalingsmetodefiltre i API’ets format med enabled, disabled og include_platform_defaults. disabled fjerner typer, enabled gendanner tilbudte typer, og include_platform_defaults: false efterlader kun aktiverede typer. Planer leverer deres egen konfiguration.
Vis egenskaber
string[]
string[]
boolean
Appearance
Visuel tilpasning af denne gruppes elementer. Tilsidesætter den globale WhopElements({ appearance }). Ændr den live med update({ appearance }).
WhopElementsLocale
Sprogindstilling for UI-teksten i denne gruppes elementer. Sæt den til en af appens indbyggede sprogindstillinger for at tilsidesætte den globale konfiguration. Enhver anden værdi falder tilbage til standardsproget.
Events
Angiv callbacks i create-indstillingerne eller som React-props.
onLoadingChange
Kører, når den grupperede indlæsningstilstand ændres. Værdien er true, så længe et monteret element stadig indlæses.
boolean
Metoder
Kald disse på Payments-handlet fra whop.payments.create({ … }) eller usePayments().
createConfirmationToken
Opretter et bekræftelsestoken for den valgte metode fra din betalingsknap. Angiv checkoutens faktureringsoplysninger. De skal indeholde email. Angiv phone for metoder, der kræver det, når indsamling af faktureringsoplysninger er slået fra. Kort kræver også name og en adresse, der indeholder line1 og country. Valg af wallet åbner wallettens ark under interaktionen med betalingsknappen. Når kontoen tilbyder banktilknytning på siden (bank_debit.bank_connection på dens betalingsmetodetype for bankkonto), åbner et valg af bankkonto også Plaid Link undervejs, og kaldet resolveres, når køberen har tilknyttet en konto. Det kræver en whop.com-side eller et domæne, der er klar til Apple Pay via Domains API, og en Content Security Policy, der tillader de Plaid-værter, som contentSecurityPolicy() returnerer. Ellers tilknytter køberen i stedet kontoen efter indsendelsen. Hvis køberen lukker arket eller Link, afvises kaldet med payment_request_cancelled: behandl det som en annullering, ikke en betalingsfejl, og lad køberen betale igen. Bekræft det returnerede confirmationToken på serveren, og kald derefter WhopElements.payments.handleNextAction(…). Kører på din side (på værtssiden), ikke i controllerens iframe.Parametre
object
påkrævet
Skjul egenskaber
object
Vis egenskaber
string
string
string
object
Vis egenskaber
string
string
string
string
string
string
ReturnererPromise<object>
string
påkrævet
string
påkrævet
update
Fletter nye handle-indstillinger ind i alle monterede elementer. I React ændrer du i stedet namespace-props.Parametre
Partial<PaymentsOptions>
påkrævet
destroy
Ødelægger alle elementer og sub-controllere, som dette handle har oprettet, fjerner controller-frame’en og frigiver dens abonnementer. Du kan kalde den mere end én gang, men et ødelagt handle afviser alle andre kald — opret et nyt handle for at starte forfra. React fjerner gruppen automatisk, når provideren afmonteres.
Statiske metoder
Kald disse uden at montere: whop.payments.<method>(…) i vanilla eller useWhop().payments.<method>(…) i React.
handleNextAction
Fuldfører en bekræftet betalings udestående trin uden at montere et element. clientSecret identificerer betalingen. Du behøver ikke et betalings-ID. Inline-trin åbner i en dialog og resolveres med redirected: false. Hvis dialogen lukkes, returneres betalingens aktuelle status, som kan forblive afventende. Helsidestrin omdirigerer med redirected: true til return_url eller til en hostet kvittering, når betalingen ikke har en retur-URL. Inde i en iframe navigerer de fanen på øverste niveau. Hvis den indlejrende side afviser den navigation, afvises de med koden TAB_NAVIGATION_BLOCKED, og betalingen forbliver afventende. Sæt returnUrl for at opdatere destinationen før visning. En mislykket opdatering afvises, før noget trin kører. Inline-trin navigerer aldrig til den URL. En betaling, hvis opkrævning stadig er ved at blive afgjort, polles, indtil et trin dukker op, eller den afsluttes; en afgjort betaling uden trin resolveres med det samme.Parametre
object
påkrævet
Skjul egenskaber
string
påkrævet
string
number
ReturnererPromise<object>
string
påkrævet
boolean
påkrævet
object | null
påkrævet
Vis egenskaber
string | null
string | null
string | null
Ressourcer
Opret disse SDK-objekter uden at montere et element. Hvert har sin egen side:
PaymentRequest
Lavniveau-ark til Apple Pay, Google Pay eller PayPal til brugerdefinerede knapper, express checkout og forsendelses-callbacks. Wallet-felter automatiserer dette flow via payments.createConfirmationToken. Afvent canMakePayment() for at kontrollere tilgængelighed og forberede wallet’en, og kald derefter show(type) synkront i handleren for brugerinteraktionen. Det resolverede ctok er et bekræftelsestoken med præfikset ctok_. Bekræft det på serveren som et token oprettet af et element. Et PayPal-token opkræver højst den total, PayPal viste køberen.
Content Security Policy
Noget af denne gruppes arbejde kører på din side, ikke i en frame. En side med en Content Security Policy har brug for disse kilder. contentSecurityPolicy() fra @whop/elements returnerer alle kilder i denne tabel. Sandbox-kilden gælder med environment: "sandbox".
Krav
Direktiv
Produktionskilde
Sandbox-kilde
Plaid Links script
script-src
https://cdn.plaid.com
Samme
↳ Plaid Links frame, som Plaids script åbner
frame-src
https://cdn.plaid.com
Samme
↳ Plaids API, som Plaids script kalder
connect-src
https://production.plaid.com
https://sandbox.plaid.com
Elementer
De elementer, som denne gruppe monterer. Hvert har sin egen side:
AddressElement
Indsamler en fakturerings- eller leveringsadresse. Felter, rækkefølge og validering følger det valgte land. Indeholder autocomplete for gadeadresse (fuld skærm på telefoner) og metoder til at læse eller validere adressen.
EmailElement
Indsamler køberens e-mail og sender den til payments.createConfirmationToken(), så længe elementet er monteret. En eksplicit billingDetails.email har forrang. En matchende Whop-konto viser valgfri indlogning med kodeverificering eller med kontoens passkey, hvis den har en. En vellykket indlogning låser op for gemte betalingsmetoder i betalingselementet. Købere kan fortsætte som gæster.
TaxIdElement
Indsamler en virksomheds skatteregistrering, som API’et accepterer. Etiketterne bruger navne rettet mod køberen. Pladsholderen matcher det valgte format. country forudvælger en type. onChange udsender bekræftede par. Værten leverer API’ets valideringsfejl.
BrandingElement
Påkrævet — de øvrige elementer undtagen AddressElement, EmailElement og TaxIdElement venter på det. Whops merchant-of-record-meddelelse: køberens accept af Whops servicevilkår for købere og privatlivspolitik, med Whop-ordmærket. Påkrævet — betalings-, kort- og kortfeltelementerne forbliver i deres indlæsningstilstand, indtil det er monteret, og betalinger kan ikke bekræftes uden det.
Alternativer. Montér ét ad gangen. Ødelæg det, før du monterer et andet:
PaymentElement
Viser tilgængelige betalingsmetoder og indsamler den valgte metodes påkrævede felter og oplysninger. Brug change til at aktivere din betalingsknap. Kald payments.createConfirmationToken() i dens aktiveringshandler. Bekræft tokenet på serveren, og send derefter eventuelle udestående trin til payments.handleNextAction(…). Brug addressChange til adresseafhængige opdateringer.
CardElement
Færdigarrangerede felter til kortnummer, udløbsdato og sikkerhedskode. Opret med payments.create("card"), aktivér din betalingsknap ud fra onChange, og bekræft med payments.createConfirmationToken(). Kortnumre forbliver i PCI-isolerede hostede felter. layout understøtter stacked (standard) og compact.
CardFields
Tre separat monterbare, PCI-isolerede kortfelter til brugerdefinerede layouts: nummer, udløbsdato og sikkerhedskode. Opret med payments.create("cardFields"), placér hvert felt, aktivér din betalingsknap ud fra onChange, og bekræft med payments.createConfirmationToken(). Kortnumre forbliver i hostede felter. (sub-controller, 3 elementer)
Assistant
Responses are generated using AI and may contain mistakes.