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 Payments. Geef props en callbacks mee via de create-opties of als React-props. Bewaar de aangemaakte handle, of de React-ref, om select() aan te roepen.
Exclusief. PaymentElement is een alternatief voor CardElement of CardFields in deze Payments-handle. Mount er één tegelijk. Verwijder het voordat je een ander mount.
Wacht op BrandingElement. Dit element blijft in de laadstatus totdat BrandingElement in dezelfde Payments-handle is gemount.
Wordt gemount binnen een WhopPayments-scope. Geeft de methodetegels weer die de afschrijving aanbiedt, en daarna wat de geselecteerde methode verzamelt: de kaartvelden, de velden die ze declareert of de Apple Pay-knop.
Mount binnen <Payments>, dat de afschrijving en het bevestigingstoken beheert. <Payments> zelf wordt gemount binnen <WhopElements>. Het geeft de methodetegels voor de afschrijving weer en verzamelt wat de geselecteerde methode declareert, zodat een kaart, een walletsheet en een bankdoorverwijzing allemaal dezelfde ene regel zijn.

Voorbeeldgegevens. Open de Playground.

Props

string[]
Bepaalt de weergavevolgorde in beide lay-outs. Vermelde typen verschijnen eerst, in volgorde. Niet-vermelde typen behouden hun relatieve volgorde. Heeft geen invloed op de beschikbaarheid. Standaard [].
object
Bepaalt welke wallets het element aanbiedt. Elke sleutel is standaard 'auto', wat de wallet aanbiedt overal waar het account, het apparaat van de koper en de afschrijving die ondersteunen. 'never' verwijdert die wallet uit de methodelijst. Gebruik het wanneer je pagina eigen knoppen voor Apple Pay, Google Pay of PayPal tekent met paymentRequest, zodat kopers elke wallet maar één keer zien. payPal: 'never' verwijdert de PayPal-methode. Opgeslagen betaalmethoden worden niet beïnvloed. Standaard {}. Sinds v1.8.0.
object
Bepaalt het verzamelen van factuurgegevens. billingDetails: 'minimal' (standaard) volgt de matrix van elke methode. Methoden verzamelen standaard de naam en het volledige landformaat. Een overschrijving kan alleen het gedeclareerde minimum of niets verzamelen. Voor kaarten is het minimum de naam op de kaart, het land en de postcode. 'full' vereist de naam en het volledige landformaat voor elke nieuwe methode. 'never' verbergt het blok. address: 'minimal' verzamelt alleen het gedeclareerde minimum van elke methode plus een land waar dat minimum er geen bevat (en ook de postcode wanneer billingDetails: 'full' aangeeft dat er belasting over de checkout wordt geheven), behalve voor wallets, crypto, bankincasso’s, bankoverschrijvingen, card-present en in-app-aankopen, die helemaal geen adres verzamelen, en behalve voor een methode waarvan de provider het volledige factuuradres vereist (requires_full_billing_address), waarvan de tegel dezelfde regels volgt als een checkout zonder deze markering; verder heeft het voorrang op billingDetails: 'full'; gebruik het wanneer de verkoper geen volledig factuuradres verzamelt. phone: 'never' verbergt alleen het telefoonveld voor facturering wanneer je formulier dat al verzamelt; geef billingDetails.phone mee aan createConfirmationToken voor methoden die het vereisen. Geef in plaats daarvan het adres mee aan createConfirmationToken. De landkiezer bevat alleen landen die door de methode en de betalingsvaluta worden ondersteund. Als er een termijnplan is geselecteerd, wordt deze beperkt tot de landen die het plan bedient — het factuurland is het transactieland waaronder de afschrijving wordt verwerkt. De kiezer wordt vergrendeld wanneer er maar één beschikbaar is. Standaard {"billingDetails":"minimal"}.
object
Vult de factuurgegevens vooraf in wanneer het factuurblok van elke methode voor het eerst wordt weergegeven. De koper kan elk vooraf ingevuld veld bewerken. address.country is een ISO 3166-1 alpha-2-code en geldt alleen wanneer de geselecteerde methode die accepteert. phone vult het telefoonveld voor facturering in voor methoden die er een verzamelen, in E.164-formaat zoals +14155552671; een nummer buiten de ondersteunde telefoonlanden van de methode wordt genegeerd. Alleen velden die het blok weergeeft, worden vooraf ingevuld en verzonden. Geef al het andere mee aan createConfirmationToken in billingDetails. Sinds v1.1.0.
"accordion" | "horizontal"
Lay-out van de kiezer. accordion (standaard) stapelt methoden en klapt details inline uit. horizontal toont niet-scrollende tegels van gelijke breedte met de geselecteerde details eronder. Na vier methoden opent een tegel More een native kiezer. De daar gekozen methode bezet de laatste tegel tot de volgende selectie. Selectie en bevestiging werken hetzelfde. Standaard "accordion".
boolean
Alleen accordion. Voegt ruimte en een aparte kaartstijl toe tussen methoden. Wordt genegeerd wanneer layout horizontal is. Standaard false.
boolean
Of de eerste aangeboden methode na het ophalen wordt geselecteerd. De standaardwaarde true respecteert order en zendt selected en change uit zoals bij een interactie van de koper. Het wordt eenmaal uitgevoerd vóór interactie van de koper en doet niets wanneer er geen methode wordt aangeboden. Stel in op false om zonder selectie te mounten. Los daarvan valt de selectie terug op de eerste aangeboden methode als een update de geselecteerde methode verwijdert. Een element zonder selectie blijft zonder selectie. Standaard true.

Events

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

onChange

Wordt geactiveerd wanneer de selectie verandert. complete: true betekent dat de koper een methode heeft geselecteerd en de kaartvelden of vereiste invoer ervan heeft ingevuld. Gebruik het om bevestiging in te schakelen. paymentMethod is de geselecteerde betaalmethode, opgeslagen of nieuw, of null zolang er niets is geselecteerd: displayName en icons benoemen de keuze zoals het element die toont (met balance.imageUrl, de afbeelding van de eigenaar van een saldo), card bevat het netwerk, de laatste vier cijfers en het financieringstype van een kaart, requiresBillingPhone geeft aan of de methode een telefoonnummer in de factuurgegevens nodig heeft, en countries vermeldt vanuit welke landen de methode kan betalen in de valuta van de afschrijving. type, requiresBillingPhone en method op het hoogste niveau zijn verouderd: lees ze uit paymentMethod. supportsBuyerFee op het hoogste niveau is ook verouderd, zonder vervanging: Whop bepaalt de prijs van zijn servicekosten voor kopers zelf.
PaymentElementChangeEvent

onAddressChange

Wordt ongeveer 300 ms nadat het interne factuuradres verandert geactiveerd. Gebruik het voor belasting, verzending of andere updates die van het adres afhangen. country is een ISO 3166-1 alpha-2-code. De payload laat andere adressleutels weg wanneer die leeg zijn of voor dat land niet worden gebruikt. complete: true betekent dat het factuurblok geldig en volledig is. Dit event wordt alleen geactiveerd zolang het betaalelement het verzamelen van het adres beheert. Gebruik bij fields.billingDetails: 'never' je eigen adresbron. Gebruik bij een gemount AddressElement het change-event daarvan.
object

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.

select

Selecteer een methode via hetzelfde pad als een interactie van de koper. select('cashapp') klapt bijvoorbeeld de tegel uit en zendt selected en change uit. Kaarten blijven complete: false totdat hun velden volledig zijn. Onbekende, niet-beschikbare of door het bedrag uitgesloten methoden worden geweigerd met code METHOD_NOT_OFFERED. select(null) wist de selectie en zendt change uit met complete: false. Gebruik het met autoSelect={false} voor volledige externe controle.Parameters
string | null
vereist
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<PaymentElementProps>
vereist

Styling

Style deze onderdelen via appearance.classes. Gebruik camelCase of kebab-case voor eigenschapsnamen en vermeld eenheden. Stylesheets van de pagina kunnen het frame van het element niet bereiken. Het framework valideert elke declaratie voordat die wordt geïnjecteerd.
Geef in React appearance mee aan <Payments>. Stel het globaal in met WhopElements({ appearance }).

Parameters

[WhopPaymentMethodType]
Tegelvolgorde voor deze mount, die methodOrder van de controller overschrijft. Vermelde typen nemen hun positie in de lijst in; de rest behoudt de oorspronkelijke volgorde erachter.
Binding<WhopPaymentSelection>?
Leest de huidige selectie en de volledigheid ervan terug. De controller houdt beide in elk geval bij.

WhopPaymentSelection

Wat een selectie teruggeeft:
  • isComplete: Bool: de geselecteerde methode heeft alles wat ze nodig heeft
  • type: WhopPaymentMethodType?: de geselecteerde methode
  • displayName: String?: het label ervan, zoals de matrix het schrijft
  • category: String?: card, wallet, bank_debit, …

Statussen

Toont skelettegels terwijl de methodematrix laadt, en de foutmelding wanneer het lezen mislukt. Een methode waarvan deze build de categorie niet kan uitvoeren, wordt overgeslagen in plaats van als kapotte tegel te worden weergegeven. Het selecteren van een wallet vervangt het bevestigingsoppervlak door Apple Pay.

Goed om te weten

  • Apple Pay heeft niets van je app nodig: geen merchant identifier, geen In-App Payments-capability. De merchant is degene die op het Whop-account is geregistreerd, en de tegel wordt weergegeven wanneer het apparaat kan betalen.
  • Een methode die een secure-veld declareert, geeft dat weer als gehost invoerveld. Die waarden komen nooit in je proces terecht.
  • De opgeslagen methoden van een ingelogde koper verschijnen boven de nieuwe. Mount WhopEmailElement om de inlog aan te bieden die de inloggegevens oplevert; het kiezen van een opgeslagen rij verzamelt niets en maakt een verwijzing aan.
  • Een kaartafschrijving die termijnniveaus publiceert, toont een plankiezer in het kaartpaneel. Een plan dat de kaart van de koper niet kan gebruiken, wordt ingeklapt in plaats van gedimd, en een plan waarvan de regio niet bij het factuurland past, wordt geweigerd voordat er een tokenizer wordt uitgevoerd.
  • Een markt die een identiteitsdocument vereist (momenteel een ars-afschrijving) geeft de typekiezer en het nummerveld in het paneel weer. Dat nummer gaat, anders dan de kaart, via je app naar de tokenizer en bereikt Whop nog steeds nooit.
  • Waarden van kaarten en beveiligde velden worden vóór het aanmaken van het token getokeniseerd, zodat het bevestigingstoken het enige is dat door je app gaat.
  • Mount WhopAddressElement ernaast wanneer een methode een factuurland nodig heeft: de tegellijst wordt beperkt tot de methoden die dat land toestaat.

Installatie

Mount het binnen een WhopPayments(accountID:charge:)-scope, die de controller aanmaakt en aan de inhoud doorgeeft. payments.buyer is de ingelogde koper zodra een inlog via e-mail er een heeft bevestigd. WhopBrandingElement moet ook op het scherm staan, omdat Whop merchant of record is bij deze verkopen en createConfirmationToken zonder dit element weigert. Style met .whopElementsAppearance(_:). De module is Elements, niet WhopElements van de wallet-SDK. Zie Aan de slag en Appearance.

Props

string[]
Weergavevolgorde van methoden, met de semantiek van paymentMethodOrder van Stripe. Niet-vermelde typen behouden hun oorspronkelijke relatieve volgorde achter de vermelde. Kan ook eenmalig op <Payments> worden ingesteld.
(payload: PaymentChangePayload) => void
Wordt geactiveerd bij elke wijziging van selectie en volledigheid. Laat je verzendknop afhangen van complete.
StyleProp<ViewStyle>
Toegepast op de buitenste View van het element. Gebruik voor thema’s bij voorkeur appearance.parts op de provider, dat elk element op dit oppervlak dekt. Let op: de namen van React Native-onderdelen vormen momenteel een eigen set, niet de whop-*-klassenamen van het web, dus een appearance-object voor het web is niet ongewijzigd over te zetten.
ReactNode
Wordt weergegeven in plaats van het ingebouwde skelet terwijl het element laadt.
() => void
Wordt eenmaal geactiveerd zodra het element interactief is. <Payments> groepeert deze, dus de eigen onLoadingChange daarvan is meestal wat je nodig hebt.
(error: { message: string; code?: string }) => void
Een laad- of configuratiefout voor dit element. Het element geeft in beide gevallen zijn eigen foutscherm weer.

PaymentChangePayload

Wat onChange teruggeeft:
  • complete: boolean: de geselecteerde methode heeft alles wat ze nodig heeft
  • type?: string: het geselecteerde methodetype, bijv. card
  • method?: { type, category, template, display_name }: de matrixvermelding van de geselecteerde methode

Statussen

Drie skeletrijen totdat de methodematrix binnen is, daarna de tegels. Het selecteren van een tegel klapt het detailgebied eronder uit. onChange meldt complete wanneer de geselecteerde methode alles heeft wat ze nodig heeft, en daar hangt je verzendknop van af. Een afschrijving zonder geschikte methode geeft een verklarende lege status weer in plaats van niets.

Goed om te weten

  • Kaartnummers gaan nooit door je code. De velden zijn PCI-geïsoleerde native invoervelden en de SDK geeft Whop een token, zodat je app buiten de PCI-scope blijft.
  • Apple Pay en Google Pay tonen allebei de eigen sheet van het platform. Geen van beide heeft iets van je nodig: Apple Pay gebruikt de merchant die op het Whop-account is geregistreerd, dus er is geen merchant identifier om mee te geven en geen capability om toe te voegen in Xcode, en googlePayMerchantName stelt alleen de naam in die in de sheet wordt getoond, standaard Whop.
  • Doorverwijsmethoden en 3D Secure openen ASWebAuthenticationSession op iOS en Custom Tabs op Android. Altijd de systeembrowser, nooit een WebView, zodat de pagina van de uitgever buiten de vertrouwensgrens van je app blijft.
  • Stel returnUrl op <Payments> in op een https-URL die je zelf host. De API weigert alles behalve https of loopback (PaymentsApi::ValidateReturnUrl), dus een aangepast app-schema is hier niet beschikbaar. Je registreert geen deep link: nadat de uitgever doorverwijst, pollt handleNextAction de betaling tot die is afgerond en sluit de browser zelf.
Wikkel je app eenmaal in <WhopElements getToken={…}> en mount daarna <Payments> rond de elementen. Zie Aan de slag en Appearance.