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 Payments. Angiv props og callbacks via create-indstillingerne eller som React-props. Behold det oprettede handle eller React-ref for at kalde select().
Eksklusiv. PaymentElement er et alternativ til CardElement eller CardFields i dette Payments-handle. Montér ét ad gangen. Ødelæg det, før du monterer et andet.
Venter på BrandingElement. Dette element forbliver i sin indlæsningstilstand, indtil BrandingElement er monteret i det samme Payments-handle.
Monteres inde i et WhopPayments-scope. Renderer de metodefliser, opkrævningen tilbyder, og derefter det, den valgte metode indsamler: kortfelterne, de felter, den erklærer, eller Apple Pay-knappen.
Montér inde i <Payments>, som ejer opkrævningen og bekræftelsestokenet. <Payments> monteres selv inde i <WhopElements>. Det renderer metodefliserne for opkrævningen og indsamler det, den valgte metode erklærer, så et kort, et wallet-ark og en bankomdirigering er den samme ene linje.

Eksempeldata. Åbn Playground.

Props

string[]
Styrer visningsrækkefølgen i begge layouts. Angivne typer vises først i rækkefølge. Ikke-angivne typer bevarer deres indbyrdes rækkefølge. Påvirker ikke tilgængeligheden. Standard er [].
object
Styrer, hvilke wallets elementet tilbyder. Hver nøgle har standardværdien 'auto', som tilbyder wallet’en overalt, hvor kontoen, køberens enhed og opkrævningen understøtter den. 'never' fjerner den pågældende wallet fra metodelisten. Brug det, når din side tegner sine egne Apple Pay-, Google Pay- eller PayPal-knapper med paymentRequest, så køberne kun ser hver wallet én gang. payPal: 'never' fjerner PayPal-metoden. Gemte betalingsmetoder påvirkes ikke. Standard er {}. Siden v1.8.0.
object
Styrer indsamlingen af faktureringsoplysninger. billingDetails: 'minimal' (standard) følger hver metodes matrix. Metoder indsamler som standard navn og landets fulde format. En tilsidesættelse kan indsamle kun det erklærede minimum eller ingenting. For kort er minimum navn på kortet, land og postnummer. 'full' kræver navn og landets fulde format for hver ny metode. 'never' skjuler blokken. address: 'minimal' indsamler kun hver metodes erklærede minimum plus et land, hvor dette minimum mangler et (og også postnummeret, når billingDetails: 'full' angiver, at checkouten er momspligtig), undtagen for wallets, krypto, bankdebiteringer, bankoverførsler, card-present og in-app-køb, som slet ikke indsamler nogen adresse, og undtagen for en metode, hvis udbyder kræver den fulde faktureringsadresse (requires_full_billing_address), hvis flise følger de samme regler som en checkout uden markering; ellers har den forrang over billingDetails: 'full'; brug den, når sælgeren ikke indsamler en fuld faktureringsadresse. phone: 'never' skjuler kun inputtet til faktureringstelefon, når din formular allerede indsamler det; angiv billingDetails.phone til createConfirmationToken for metoder, der kræver det. Angiv i stedet adressen til createConfirmationToken. Landevælgeren omfatter kun lande, der understøttes af metoden og betalingsvalutaen. Når en afbetalingsplan er valgt, indsnævres den til de lande, planen betjener — faktureringslandet er det transaktionsland, opkrævningen behandles under. Den låses, når kun ét er tilgængeligt. Standard er {"billingDetails":"minimal"}.
object
Forudfylder faktureringsoplysningerne, når hver metodes faktureringsblok renderes første gang. Køberen kan redigere hvert forudfyldt felt. address.country er en ISO 3166-1 alpha-2-kode og gælder kun, når den valgte metode accepterer den. phone udfylder inputtet til faktureringstelefon for metoder, der indsamler et, i E.164-format såsom +14155552671; et nummer uden for metodens understøttede telefonlande ignoreres. Kun felter, som blokken renderer, forudfyldes og sendes. Angiv alt andet til createConfirmationToken i billingDetails. Siden v1.1.0.
"accordion" | "horizontal"
Vælgerens layout. accordion (standard) stabler metoderne og udvider detaljerne inline. horizontal viser fliser med ens bredde uden rulning med detaljerne for den valgte nedenunder. Efter fire metoder åbner en More-flise en indbygget vælger. Den metode, der vælges dér, optager den sidste flise indtil næste valg. Valg og bekræftelse fungerer på samme måde. Standard er "accordion".
boolean
Kun accordion. Tilføjer afstand og separat kortstyling mellem metoderne. Ignoreres, når layout er horizontal. Standard er false.
boolean
Om den første tilbudte metode skal vælges efter opløsning. Standardværdien true respekterer order og udsender selected og change som ved en køberinteraktion. Den kører én gang før køberinteraktion og gør intet, når ingen metode tilbydes. Sæt false for at montere uden valg. Uafhængigt heraf falder valget tilbage til den første tilbudte metode, hvis en opdatering fjerner den valgte metode. Et element uden valg forbliver uden valg. Standard er true.

Events

Angiv callbacks i create-indstillingerne eller som React-props.

onChange

Udløses, når valget ændres. complete: true betyder, at køberen har valgt en metode og udfyldt dens kortfelter eller påkrævede input. Brug det til at aktivere bekræftelse. paymentMethod er den valgte betalingsmetode, gemt eller ny, eller null, mens intet er valgt: displayName og icons betegner valget, som elementet viser det (med balance.imageUrl, billedet af en saldos ejer), card indeholder et korts netværk, sidste fire cifre og finansieringstype, requiresBillingPhone angiver, om metoden kræver et telefonnummer i faktureringsoplysningerne, og countries angiver, hvorfra metoden kan betale i opkrævningens valuta. type, requiresBillingPhone og method på øverste niveau er forældede: læs dem fra paymentMethod. supportsBuyerFee på øverste niveau er også forældet, uden erstatning: Whop prissætter selv sit servicegebyr for købere.
PaymentElementChangeEvent

onAddressChange

Udløses ca. 300 ms efter, at den interne faktureringsadresse ændres. Brug det til moms, forsendelse eller andre adresseafhængige opdateringer. country er en ISO 3166-1 alpha-2-kode. Payloaden udelader andre adressenøgler, når de er tomme eller ikke bruges i det pågældende land. complete: true betyder, at faktureringsblokken er gyldig og komplet. Denne event udløses kun, mens betalingselementet ejer adresseindsamlingen. Med fields.billingDetails: 'never' skal du bruge din egen adressekilde. Med et monteret AddressElement skal du bruge dets change-event.
object

onLoaderStart

Kører, efter at indlæsningsskelettet først er tegnet, og før onReady.

onReady

Kører efter elementets første fuldstændige rendering.

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.

select

Vælg en metode via samme vej som en køberinteraktion. For eksempel udvider select('cashapp') flisen og udsender selected og change. Kort forbliver complete: false, indtil deres felter er udfyldt. Ukendte, utilgængelige eller beløbsbegrænsede metoder afvises med koden METHOD_NOT_OFFERED. select(null) rydder valget og udsender change med complete: false. Brug sammen med autoSelect={false} for fuld ekstern kontrol.Parametre
string | null
påkrævet
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<PaymentElementProps>
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 angiver du appearance til <Payments>. Sæt den globalt med WhopElements({ appearance }).

Parametre

[WhopPaymentMethodType]
Fliserækkefølge for denne montering, som tilsidesætter controllerens methodOrder. Angivne typer får deres placering i listen; resten bevarer deres indkommende rækkefølge bag dem.
Binding<WhopPaymentSelection>?
Aflæser det aktuelle valg og dets fuldstændighed. Controlleren sporer begge dele under alle omstændigheder.

WhopPaymentSelection

Det, et valg returnerer:
  • isComplete: Bool: den valgte metode har alt, hvad den skal bruge
  • type: WhopPaymentMethodType?: den valgte metode
  • displayName: String?: dens etiket, som matrixen staver den
  • category: String?: card, wallet, bank_debit, …

Tilstande

Viser skeletfliser, mens metodematrixen indlæses, og fejlmeddelelsen, når læsningen mislykkes. En metode, hvis kategori denne build ikke kan køre, springes over i stedet for at blive renderet som en defekt flise. Når en wallet vælges, udskiftes bekræftelsesfladen med Apple Pay.

Godt at vide

  • Apple Pay kræver intet fra din app: ingen merchant identifier, ingen In-App Payments-capability. Forhandleren er den, der er registreret på Whop-kontoen, og flisen renderes, når enheden kan betale.
  • En metode, der erklærer et secure-felt, renderer det som et hostet input. Disse værdier kommer aldrig ind i din proces.
  • En indlogget købers gemte metoder vises over de nye. Montér WhopEmailElement for at tilbyde det login, der giver legitimationen; valg af en gemt række indsamler intet og udsteder en reference.
  • En kortopkrævning, der udgiver afdragsniveauer, viser en planvælger inde i kortpanelet. En plan, som køberens kort ikke kan bruge, klappes sammen i stedet for at blive nedtonet, og en plan, hvis region ikke passer til faktureringslandet, afvises, før nogen tokenizer kører.
  • Et marked, der kræver et identitetsdokument (i dag en ars-opkrævning), renderer typevælgeren og nummerfeltet inde i panelet. Dette nummer passerer gennem din app på vej til tokenizeren, i modsætning til kortet, og når stadig aldrig frem til Whop.
  • Værdier fra kort og secure-felter tokeniseres før udstedelsen, så bekræftelsestokenet er det eneste, der passerer gennem din app.
  • Montér WhopAddressElement ved siden af, når en metode kræver et faktureringsland: flisenlisten indsnævres til de metoder, som landet tillader.

Installation

Montér det inde i et WhopPayments(accountID:charge:)-scope, som opretter controlleren og giver den videre til sit indhold. payments.buyer er den indloggede køber, når en e-mail-login har bekræftet en. WhopBrandingElement skal også være på skærmen, fordi Whop er merchant of record på disse salg, og createConfirmationToken afviser uden det. Style med .whopElementsAppearance(_:). Modulet er Elements, ikke wallet-SDK’ets WhopElements. Se Kom godt i gang og Appearance.

Props

string[]
Metodernes visningsrækkefølge med Stripes paymentMethodOrder-semantik. Ikke-angivne typer bevarer deres indkommende indbyrdes rækkefølge bag de angivne. Kan også angives én gang på <Payments>.
(payload: PaymentChangePayload) => void
Udløses ved hver ændring af valg og fuldstændighed. Gør din indsendelsesknap betinget af complete.
StyleProp<ViewStyle>
Anvendes på elementets ydre View. Til tematisering bør du foretrække appearance.parts på provideren, som dækker alle elementer på denne flade. Bemærk, at React Native-delenes navne i dag er deres eget sæt og ikke webbens whop-*-klassenavne, så et web-appearance-objekt kan ikke overføres uændret.
ReactNode
Renderes i stedet for det indbyggede skelet, mens elementet indlæses.
() => void
Udløses, når elementet er interaktivt. <Payments> grupperer disse, så dens egen onLoadingChange er normalt den, du har brug for.
(error: { message: string; code?: string }) => void
En indlæsnings- eller konfigurationsfejl for dette element. Elementet renderer under alle omstændigheder sin egen fejlvisning.

PaymentChangePayload

Det, onChange returnerer:
  • complete: boolean: den valgte metode har alt, hvad den skal bruge
  • type?: string: den valgte metodetype, f.eks. card
  • method?: { type, category, template, display_name }: den valgte metodes matrixpost

Tilstande

Tre skeletrækker, indtil metodematrixen er indlæst, og derefter fliserne. Når en flise vælges, udvides dens detaljeområde under den. onChange rapporterer complete, når den valgte metode har alt, hvad den skal bruge, hvilket er det, der styrer din indsendelsesknap. En opkrævning uden nogen kvalificeret metode renderer en forklarende tom tilstand i stedet for ingenting.

Godt at vide

  • Kortnumre passerer aldrig gennem din kode. Felterne er PCI-isolerede native inputs, og SDK’et giver Whop et token, så din app forbliver uden for PCI-scope.
  • Apple Pay og Google Pay viser begge platformens eget ark. Ingen af dem kræver noget fra dig: Apple Pay bruger den forhandler, der er registreret på Whop-kontoen, så der er ingen merchant identifier at angive og ingen capability at tilføje i Xcode, og googlePayMerchantName angiver kun det navn, der vises i arket, som standard Whop.
  • Omdirigeringsmetoder og 3D Secure åbner ASWebAuthenticationSession på iOS og Custom Tabs på Android. Systembrowseren, aldrig en WebView, så udstederens side forbliver uden for din apps tillidsgrænse.
  • Sæt returnUrl på <Payments> til en https-URL, du hoster. API’et afviser alt andet end https eller loopback (PaymentsApi::ValidateReturnUrl), så et brugerdefineret app-scheme er ikke tilgængeligt her. Du skal ikke registrere et deep link: efter at udstederen har omdirigeret, poller handleNextAction betalingen, indtil den er afsluttet, og lukker selv browseren.
Pak din app ind i <WhopElements getToken={…}> én gang, og montér derefter <Payments> omkring elementerne. Se Kom godt i gang og Appearance.