Ontvang een betaling op basis van een plan_-ID of een inline valuta en bedrag, of sla een betaalmethode op zonder af te schrijven met mode: "setup". Mount PaymentElement, CardElement of CardFields en roep daarna payments.createConfirmationToken aan met factuurgegevens. Bij een walletselectie wordt de sheet automatisch geopend. Wanneer het account bankkoppeling op de pagina aanbiedt (bank_debit.bank_connection op het betaalmethodetype voor bankrekeningen), opent een selectie van een bankrekening Plaid Link ook op de pagina. Als een koper een van beide sluit, wordt de aanroep geweigerd met payment_request_cancelled, wat je betaalhandler als annulering moet behandelen. Bevestig het token server-side en geef daarna de client_secret van de betaling of setup intent door aan handleNextAction voor een eventuele openstaande stap.
Deze pagina documenteert @whop/elements@1.10.0 en @whop/elements-react@1.10.0.
Sinds v1.0.0.
Playground
Stel de elementen samen met voorbeeldgegevens. Bedien de besturingselementen, voeg elementen toe, rangschik ze en zie events live afgaan:
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> );}
Geef deze mee aan whop.payments.create({ … }), of als props op <Payments> in React.
Geef precies één van deze combinaties mee:
accountId en plan
accountId, currency en amount
accountId, mode: "setup" en currency
geen van plan, currency, amount of mode
string
Account-ID, met het voorvoegsel biz_. Laat het alleen weg bij het aanroepen van statische methoden zonder accountoppervlak.
"payment" | "setup"
Mountmodus, standaard payment. setup slaat een betaalmethode op en schrijft niets af, nu of later: alleen methoden die kunnen worden opgeslagen worden aangeboden en bedraggrenzen zijn niet van toepassing. Bevestig met createConfirmationToken() en maak daarna de setup intent server-side aan.
string
Plan-ID, met het voorvoegsel plan_. Wordt client-side omgezet naar valuta, bedrag en methodeconfiguratie. Geef een plan of een inline valuta en bedrag mee, nooit beide.
object
Totalen feeInclusive en feeFree in de kleinste munteenheid, gebruikt om methoden te filteren wanneer de checkout amount opnieuw prijst voor een methode zonder kosten, zoals BNPL. Elke methode wordt gecontroleerd tegen het bijbehorende totaal, zodat de geselecteerde methode zonder kosten niet verdwijnt. Als het wordt weggelaten, filtert amount elke methode.
Tonen eigenschappen
number
vereist
number
vereist
string
Retour-URL voor externe bank- of 3DS-stappen. Standaard de pagina waarop wordt gemount. De koper komt daar terecht, wat de uitkomst ook is, met payment (of setup), status (succeeded, failed, canceled of een nog openstaande status zoals processing) en client_secret toegevoegd, dus vertak op status voordat je een succespagina toont.
"off_session" | "on_session"
Een setup slaat de betaalmethode op voor off_session-gebruik, het enige gebruik dat een setup accepteert.
WalletAvailability
Overschrijving van de walletbeschikbaarheid voor deterministische previews. Live checkouts tasten de host af.
Tonen eigenschappen
boolean
vereist
boolean
vereist
boolean
("apple_pay" | "google_pay" | "paypal_express")[]
De wallets gerangschikt op welke sheet native is in deze browser — Apple Pay eerst op WebKit, Google Pay eerst overal elders, PayPal als laatste — zodat expressknoppen met de beste bovenaan kunnen worden gestapeld. Ontbreekt bij door de consument opgegeven beschikbaarheid (previews) en bij berichten van vóór deze toevoeging. Een inline union, niet de WalletSheetType van payment-request: die module importeert deze al.
object
De details van elke beschikbare wallet, met het wallettype als sleutel. Ontbreekt bij door de consument opgegeven beschikbaarheid (previews).
Tonen eigenschappen
WalletDetails
Tonen eigenschappen
WalletButtonArt
De officiële knopafbeelding van de wallet. Ontbreekt wanneer er geen is gepubliceerd.
Tonen eigenschappen
object
vereist
Voor lichte pagina’s.
Tonen eigenschappen
string
vereist
string
vereist
object
vereist
Voor donkere pagina’s.
Tonen eigenschappen
string
vereist
string
vereist
WalletDetails
Tonen eigenschappen
WalletButtonArt
De officiële knopafbeelding van de wallet. Ontbreekt wanneer er geen is gepubliceerd.
Tonen eigenschappen
object
vereist
Voor lichte pagina’s.
Tonen eigenschappen
string
vereist
string
vereist
object
vereist
Voor donkere pagina’s.
Tonen eigenschappen
string
vereist
string
vereist
WalletDetails
Tonen eigenschappen
WalletButtonArt
De officiële knopafbeelding van de wallet. Ontbreekt wanneer er geen is gepubliceerd.
Tonen eigenschappen
object
vereist
Voor lichte pagina’s.
Tonen eigenschappen
string
vereist
string
vereist
object
vereist
Voor donkere pagina’s.
Tonen eigenschappen
string
vereist
string
vereist
string
Drieletterige ISO 4217-valutacode in kleine letters. Filtert de betaalmethodematrix.
number
Betalingsbedrag in de kleinste munteenheid. Methoden waarvan de grenzen het uitsluiten, worden niet aangeboden.
object
Betaalmethodefilters van het account in het formaat enabled, disabled en include_platform_defaults van de API. disabled verwijdert typen, enabled herstelt aangeboden typen en include_platform_defaults: false laat alleen ingeschakelde typen over. Plannen leveren hun eigen configuratie.
Tonen eigenschappen
string[]
string[]
boolean
Appearance
Visuele aanpassing voor de elementen van deze groep. Overschrijft de globale WhopElements({ appearance }). Wijzig het live met update({ appearance }).
WhopElementsLocale
Locale voor de UI-tekst van de elementen in deze groep. Stel het in op een van de ingebouwde locales van de app om de globale configuratie te overschrijven. Elke andere waarde valt terug op de standaardlocale.
Events
Geef callbacks mee in de create-opties of als React-props.
onLoadingChange
Wordt uitgevoerd wanneer de gegroepeerde laadstatus verandert. De waarde is true zolang een gemount element nog laadt.
boolean
Methoden
Roep deze aan op de Payments-handle van whop.payments.create({ … }) of usePayments().
createConfirmationToken
Maakt vanuit je betaalknop een bevestigingstoken aan voor de geselecteerde methode. Geef de factuurgegevens van de checkout mee. Die moeten email bevatten. Geef phone mee voor methoden die dat vereisen wanneer het verzamelen van factuurgegevens is uitgeschakeld. Kaarten hebben ook name nodig en een adres met line1 en country. Bij een walletselectie wordt de sheet geopend tijdens de interactie met de betaalknop. Wanneer het account bankkoppeling op de pagina aanbiedt (bank_debit.bank_connection op het betaalmethodetype voor bankrekeningen), opent een selectie van een bankrekening daarbij ook Plaid Link, en wordt de aanroep afgerond zodra de koper een rekening heeft gekoppeld. Daarvoor is een whop.com-pagina nodig of een domein dat gereed is voor Apple Pay via de Domains API, en een Content Security Policy die de Plaid-hosts toestaat die contentSecurityPolicy() retourneert. Anders koppelt de koper de rekening in plaats daarvan na het verzenden. Als de koper de sheet of Link sluit, wordt de aanroep geweigerd met payment_request_cancelled: behandel dat als een annulering, niet als een betaalfout, en laat de koper opnieuw betalen. Bevestig het geretourneerde confirmationToken server-side en roep daarna WhopElements.payments.handleNextAction(…) aan. Wordt uitgevoerd op je pagina (host-side), niet in het controller-iframe.Parameters
object
vereist
Verbergen eigenschappen
object
Tonen eigenschappen
string
string
string
object
Tonen eigenschappen
string
string
string
string
string
string
RetourneertPromise<object>
string
vereist
string
vereist
update
Voegt nieuwe handle-opties samen in elk gemount element. Wijzig in React in plaats daarvan de namespace-props.Parameters
Partial<PaymentsOptions>
vereist
destroy
Verwijdert elk element en elke subcontroller die deze handle heeft aangemaakt, verwijdert het controllerframe en geeft de abonnementen vrij. Je kunt het meerdere keren aanroepen, maar een verwijderde handle weigert elke andere aanroep — maak een nieuwe handle aan om opnieuw te beginnen. React verwijdert de groep automatisch wanneer de provider wordt ontkoppeld.
Statische methoden
Roep deze aan zonder te mounten: whop.payments.<method>(…) in vanilla of useWhop().payments.<method>(…) in React.
handleNextAction
Voltooit de openstaande stap van een bevestigde betaling zonder een element te mounten. clientSecret identificeert de betaling. Je hebt geen betalings-ID nodig. Inline stappen openen in een dialoogvenster en worden afgerond met redirected: false. Als het dialoogvenster wordt gesloten, wordt de huidige status van de betaling geretourneerd, die openstaand kan blijven. Stappen op een volledige pagina leiden door met redirected: true naar return_url, of naar een gehost ontvangstbewijs als de betaling geen retour-URL heeft. Binnen een iframe navigeren ze het tabblad op het hoogste niveau. Als de insluitende pagina die navigatie weigert, worden ze geweigerd met code TAB_NAVIGATION_BLOCKED en blijft de betaling openstaan. Stel returnUrl in om de bestemming vóór de weergave bij te werken. Een mislukte update wordt geweigerd voordat er een stap wordt uitgevoerd. Inline stappen navigeren nooit naar die URL. Een betaling waarover de afschrijving nog wordt beslist, wordt gepolld totdat er een stap verschijnt of de betaling is afgehandeld; een betaling waarover al is beslist en zonder stap wordt direct afgerond.Parameters
object
vereist
Verbergen eigenschappen
string
vereist
string
number
RetourneertPromise<object>
string
vereist
boolean
vereist
object | null
vereist
Tonen eigenschappen
string | null
string | null
string | null
Bronnen
Maak deze SDK-objecten aan zonder een element te mounten. Elk heeft een eigen pagina:
PaymentRequest
Low-level sheet voor Apple Pay, Google Pay of PayPal voor aangepaste knoppen, express checkout en verzendcallbacks. Wallettegels automatiseren deze flow via payments.createConfirmationToken. Wacht op canMakePayment() om de beschikbaarheid te controleren en de wallet voor te bereiden, en roep daarna show(type) synchroon aan in de handler van de gebruikersinteractie. De opgeleverde ctok is een bevestigingstoken met het voorvoegsel ctok_. Bevestig het server-side zoals een token dat door een element is aangemaakt. Een PayPal-token schrijft maximaal het totaal af dat PayPal aan de koper heeft getoond.
Content Security Policy
Een deel van het werk van deze groep wordt uitgevoerd op je pagina, niet in een frame. Een pagina met een Content Security Policy heeft deze bronnen nodig. contentSecurityPolicy() uit @whop/elements retourneert elke bron in deze tabel. De sandboxbron geldt bij environment: "sandbox".
Vereiste
Directive
Productiebron
Sandboxbron
Script van Plaid Link
script-src
https://cdn.plaid.com
Hetzelfde
↳ Frame van Plaid Link, dat het script van Plaid opent
frame-src
https://cdn.plaid.com
Hetzelfde
↳ API van Plaid, die het script van Plaid aanroept
connect-src
https://production.plaid.com
https://sandbox.plaid.com
Elementen
De elementen die deze groep mount. Elk heeft een eigen pagina:
AddressElement
Verzamelt een factuur- of verzendadres. Velden, volgorde en validatie volgen het geselecteerde land. Bevat autocomplete voor straten (schermvullend op telefoons) en methoden om het adres te lezen of te valideren.
EmailElement
Verzamelt het e-mailadres van de koper en geeft het door aan payments.createConfirmationToken() zolang het gemount is. Een expliciete billingDetails.email heeft voorrang. Bij een overeenkomend Whop-account wordt een optionele inlog getoond met codeverificatie, of met de passkey van het account als dat er een heeft. Een geslaagde inlog ontgrendelt opgeslagen betaalmethoden in het betaalelement. Kopers kunnen doorgaan als gast.
TaxIdElement
Verzamelt een zakelijke belastingregistratie die door de API wordt geaccepteerd. Labels gebruiken namen die voor kopers bedoeld zijn. De placeholder komt overeen met het geselecteerde formaat. country selecteert vooraf een type. onChange zendt vastgelegde paren uit. De host levert de validatiefouten van de API.
BrandingElement
Vereist — de andere elementen behalve AddressElement, EmailElement en TaxIdElement wachten erop. De merchant-of-record-melding van Whop: de instemming van de koper met de Buyer Terms of Service en het Privacy Policy van Whop, met het Whop-woordmerk. Vereist — de elementen voor betaling, kaart en kaartvelden blijven in hun laadstatus totdat het is gemount, en betalingen kunnen zonder dit element niet worden bevestigd.
Alternatieven. Mount er één tegelijk. Verwijder het voordat je een ander mount:
PaymentElement
Toont de beschikbare betaalmethoden en verzamelt de vereiste velden en vermeldingen van de geselecteerde methode. Gebruik change om je betaalknop in te schakelen. Roep in de activeringshandler ervan payments.createConfirmationToken() aan. Bevestig het token server-side en geef daarna een eventuele openstaande stap door aan payments.handleNextAction(…). Gebruik addressChange voor updates die van het adres afhangen.
CardElement
Vooraf gerangschikte velden voor kaartnummer, vervaldatum en beveiligingscode. Maak het aan met payments.create("card"), schakel je betaalknop in vanuit onChange en bevestig met payments.createConfirmationToken(). Kaartnummers blijven in PCI-geïsoleerde gehoste velden. layout ondersteunt stacked (standaard) en compact.
CardFields
Drie afzonderlijk te mounten, PCI-geïsoleerde kaartvelden voor aangepaste lay-outs: nummer, vervaldatum en beveiligingscode. Maak het aan met payments.create("cardFields"), plaats elk veld, schakel je betaalknop in vanuit onChange en bevestig met payments.createConfirmationToken(). Kaartnummers blijven in gehoste velden. (subcontroller, 3 elementen)
Assistant
Responses are generated using AI and may contain mistakes.