Skip to main content
Bu sayfa @whop/elements@1.10.0 ve @whop/elements-react@1.10.0 sürümlerini belgeler.
v1.0.0 sürümünden beri.
Payments içine bağlanır. Prop’ları ve geri çağırmaları oluşturma seçenekleri veya React prop’ları aracılığıyla iletin. select() çağırmak için oluşturulan tanıtıcıyı veya React ref değerini saklayın.
Dışlayıcı. PaymentElement, bu Payments tanıtıcısında CardElement veya CardFields için bir alternatiftir. Aynı anda yalnızca birini bağlayın. Başka birini bağlamadan önce onu yok edin.
BrandingElement öğesini bekler. Bu element, aynı Payments tanıtıcısında BrandingElement bağlanana kadar yükleme durumunda kalır.
Bir WhopPayments kapsamı içine bağlanır. Ücretin sunduğu yöntem kutucuklarını, ardından seçilen yöntemin topladığı her şeyi gösterir: kart alanları, yöntemin bildirdiği alanlar veya Apple Pay düğmesi.
Ücretin ve onay token’ının sahibi olan <Payments> içine bağlayın. <Payments> ise <WhopElements> içine bağlanır. Ücret için yöntem kutucuklarını gösterir ve seçilen yöntemin bildirdiği her şeyi toplar; böylece bir kart, bir cüzdan ödeme ekranı ve bir banka yönlendirmesi aynı tek satırdır.

Örnek veriler. Deneme alanını açın.

Prop’lar

string[]
Her iki düzende de görüntüleme sırasını kontrol eder. Listelenen türler sırayla önce görünür. Listelenmeyen türler göreli sıralarını korur. Kullanılabilirliği etkilemez. Varsayılan değer [].
object
Elementin hangi cüzdanları sunduğunu kontrol eder. Her anahtar varsayılan olarak 'auto' değerini alır; bu, cüzdanı hesabın, alıcının cihazının ve ücretin desteklediği her yerde sunar. 'never', o cüzdanı yöntem listesinden kaldırır. Sayfanız kendi Apple Pay, Google Pay veya PayPal düğmelerini paymentRequest ile çiziyorsa, alıcıların her cüzdanı yalnızca bir kez görmesi için bunu kullanın. payPal: 'never', PayPal yöntemini kaldırır. Kayıtlı ödeme yöntemleri etkilenmez. Varsayılan değer {}. v1.8.0 sürümünden beri.
object
Fatura bilgilerinin toplanmasını kontrol eder. billingDetails: 'minimal' (varsayılan) her yöntemin matrisini izler. Yöntemler varsayılan olarak adı ve ülkenin eksiksiz biçimini toplar. Bir geçersiz kılma yalnızca bildirilen minimumu topluyor ya da hiçbir şey toplamıyor olabilir. Kartlar için minimum, kart üzerindeki ad, ülke ve posta kodudur. 'full', her yeni yöntem için adı ve ülkenin eksiksiz biçimini zorunlu kılar. 'never' bloğu gizler. address: 'minimal' yalnızca her yöntemin bildirdiği minimumu ve bu minimumun ülke içermediği her yerde bir ülkeyi toplar (billingDetails: 'full' ödemenin vergilendirildiğini belirtiyorsa posta kodunu da); ancak hiç adres toplamayan cüzdanlar, kripto, banka borçlandırmaları, banka havaleleri, kartın fiziksel olarak sunulduğu ödemeler ve uygulama içi satın almalar ile sağlayıcısı eksiksiz fatura adresi gerektiren (requires_full_billing_address) ve kutucuğu işaretlenmemiş bir ödemeyle aynı kuralları izleyen yöntemler bunun dışındadır; aksi takdirde billingDetails: 'full' ayarına üstün gelir; satıcı eksiksiz bir fatura adresi toplamıyorsa bunu kullanın. phone: 'never', formunuz fatura telefonunu zaten topluyorsa yalnızca o girişi gizler; bunu gerektiren yöntemler için billingDetails.phone değerini createConfirmationToken metoduna iletin. Bunun yerine adresi createConfirmationToken metoduna iletin. Ülke seçici yalnızca yöntemin ve ödeme para biriminin desteklediği ülkeleri içerir. Bir taksit planı seçiliyken, planın hizmet verdiği ülkelere daralır; fatura ülkesi, ücretin altında işlendiği işlem ülkesidir. Yalnızca bir ülke mevcut olduğunda kilitlenir. Varsayılan değer {"billingDetails":"minimal"}.
object
Her yöntemin fatura bloğu ilk kez görüntülendiğinde fatura bilgilerini önceden doldurur. Alıcı önceden doldurulan her alanı düzenleyebilir. address.country bir ISO 3166-1 alpha-2 kodudur ve yalnızca seçilen yöntem bunu kabul ettiğinde uygulanır. phone, telefon toplayan yöntemler için fatura telefonu girişini +14155552671 gibi E.164 biçiminde doldurur; yöntemin desteklediği telefon ülkelerinin dışındaki bir numara yok sayılır. Yalnızca bloğun görüntülediği alanlar önceden doldurulur ve gönderilir. Diğer her şeyi billingDetails içinde createConfirmationToken metoduna iletin. v1.1.0 sürümünden beri.
"accordion" | "horizontal"
Seçici düzeni. accordion (varsayılan) yöntemleri üst üste dizer ve ayrıntıları satır içinde genişletir. horizontal, eşit genişlikte, kaydırılmayan kutucuklar ve altında seçili ayrıntıları gösterir. Dört yöntemden sonra bir Daha Fazla kutucuğu yerel bir seçici açar. Orada seçilen yöntem, bir sonraki seçime kadar son kutucuğu kaplar. Seçim ve onay aynı şekilde davranır. Varsayılan değer "accordion".
boolean
Yalnızca accordion. Yöntemler arasına boşluk ve ayrı kart stili ekler. layout değeri horizontal olduğunda yok sayılır. Varsayılan değer false.
boolean
Çözümlemeden sonra sunulan ilk yöntemin seçilip seçilmeyeceği. Varsayılan true değeri order ayarına uyar ve bir alıcı etkileşimi gibi selected ile change olaylarını yayar. Alıcı etkileşiminden önce bir kez çalışır ve hiçbir yöntem sunulmadığında hiçbir şey yapmaz. Seçimsiz bağlamak için false olarak ayarlayın. Bundan bağımsız olarak, bir güncelleme seçili yöntemi kaldırırsa seçim, sunulan ilk yönteme geri döner. Zaten seçimsiz olan bir element seçimsiz kalır. Varsayılan değer true.

Olaylar

Geri çağırmaları oluşturma seçeneklerinde veya React prop’larında iletin.

onChange

Seçim değiştiğinde tetiklenir. complete: true, alıcının bir yöntem seçtiği ve kart alanlarını veya gerekli girişlerini tamamladığı anlamına gelir. Onayı etkinleştirmek için bunu kullanın. paymentMethod, kayıtlı ya da yeni seçili ödeme yöntemidir veya hiçbir şey seçili değilken null olur: displayName ve icons seçimi elementin gösterdiği şekilde adlandırır (balance.imageUrl ile bir bakiye sahibinin görseli), card bir kartın ağını, son dört hanesini ve fon türünü taşır, requiresBillingPhone yöntemin fatura bilgilerinde telefon gerektirip gerektirmediğini belirtir ve countries yöntemin ücretin para biriminde hangi ülkelerden ödeme yapabileceğini listeler. Üst düzeydeki type, requiresBillingPhone ve method kullanımdan kaldırılmıştır: bunları paymentMethod içinden okuyun. Üst düzeydeki supportsBuyerFee de herhangi bir alternatifi olmadan kullanımdan kaldırılmıştır: Whop alıcı hizmet ücretini kendisi fiyatlandırır.
PaymentElementChangeEvent

onAddressChange

Dahili fatura adresi değiştikten yaklaşık 300 ms sonra tetiklenir. Vergi, kargo veya adrese bağlı diğer güncellemeler için bunu kullanın. country bir ISO 3166-1 alpha-2 kodudur. Yük, boş olan veya o ülke için kullanılmayan diğer adres anahtarlarını içermez. complete: true, fatura bloğunun geçerli ve eksiksiz olduğu anlamına gelir. Bu olay yalnızca adres toplama ödeme elementine ait olduğu sürece tetiklenir. fields.billingDetails: 'never' ile kendi adres kaynağınızı kullanın. Bağlı bir AddressElement ile onun change olayını kullanın.
object

onLoaderStart

Yükleme iskeleti ilk kez çizildikten sonra ve onReady öncesinde çalışır.

onReady

Elementin ilk eksiksiz çiziminden sonra çalışır.

onError

Element yüklenemediğinde veya çöktüğünde çalışır. Yedek görünüm görünür kalır. Programatik işleme için code kullanın. sourceKey, başarısız olan host-state kaynağını tanımlar.
object

Metotlar

Bunları create tarafından döndürülen tanıtıcı (handle) üzerinde veya bir React ref aracılığıyla çağırın.

select

Bir alıcı etkileşimiyle aynı yoldan bir yöntem seçer. Örneğin select('cashapp') kutucuğu genişletir ve selected ile change olaylarını yayar. Kartlar, alanları tamamlanana kadar complete: false olarak kalır. Bilinmeyen, kullanılamayan veya tutara bağlı olarak kısıtlanan yöntemler METHOD_NOT_OFFERED koduyla reddedilir. select(null) seçimi temizler ve complete: false ile change yayar. Tam harici kontrol için autoSelect={false} ile birlikte kullanın.Parametreler
string | null
gerekli
Döndürür Promise<void>

mount

Elementi target içine bağlar ve yüklemeyi başlatır. React bileşenleri kendilerini bağlar.Parametreler
string | HTMLElement
gerekli

destroy

Elementi kaldırır ve çerçevesini ile aboneliklerini serbest bırakır. Birden fazla kez çağırabilirsiniz. React elementi otomatik olarak kaldırır.

update

Yeni prop’ları bağlı elementle birleştirir. React’te bunun yerine bileşen prop’larını değiştirin.Parametreler
Partial<PaymentElementProps>
gerekli

Stil verme

Bu parçalara appearance.classes aracılığıyla stil verin. Özellik adları için camel case veya kebab case kullanın ve birimleri ekleyin. Sayfa stil sayfaları elementin çerçevesine ulaşamaz. Framework her bildirimi eklemeden önce doğrular.
React’te appearance değerini <Payments> bileşenine iletin. Genel olarak WhopElements({ appearance }) ile ayarlayın.

Parametreler

[WhopPaymentMethodType]
Bu bağlama için kutucuk sırası; denetleyicinin methodOrder değerini geçersiz kılar. Listelenen türler listedeki konumlarını alır; geri kalanlar gelen sıralarını koruyarak onların arkasında yer alır.
Binding<WhopPaymentSelection>?
Geçerli seçimi ve eksiksizliğini geri okur. Denetleyici her durumda ikisini de izler.

WhopPaymentSelection

Bir seçimin döndürdüğü değerler:
  • isComplete: Bool: seçili yöntem ihtiyaç duyduğu her şeye sahip
  • type: WhopPaymentMethodType?: seçili yöntem
  • displayName: String?: matrisin yazdığı şekliyle etiketi
  • category: String?: card, wallet, bank_debit, …

Durumlar

Yöntem matrisi yüklenirken iskelet kutucuklar, okuma başarısız olduğunda ise hata mesajı gösterir. Kategorisi bu derlemede çalıştırılamayan bir yöntem, bozuk bir kutucuk olarak gösterilmek yerine atlanır. Bir cüzdan seçmek, onay yüzeyini Apple Pay ile değiştirir.

Bilmekte fayda var

  • Apple Pay uygulamanızdan hiçbir şey gerektirmez: satıcı tanımlayıcısı yok, In-App Payments yeteneği yok. Satıcı, Whop hesabında kayıtlı olandır ve cihaz ödeme yapabildiği her durumda kutucuk görüntülenir.
  • Bir secure alanı bildiren yöntem, onu barındırılan bir giriş olarak gösterir. Bu değerler asla işleminize girmez.
  • Oturum açmış bir alıcının saklanan yöntemleri yeni olanların üstünde görünür. Kimlik bilgisini üreten oturum açmayı sunmak için WhopEmailElement bağlayın; saklanan bir satırı seçmek hiçbir şey toplamaz ve bir referans oluşturur.
  • Taksit kademeleri yayımlayan bir kart ücreti, kart panelinin içinde bir plan seçici gösterir. Alıcının kartının kullanamayacağı bir plan soluklaşmak yerine daraltılır ve bölgesi fatura ülkesiyle eşleşmeyen bir plan, herhangi bir tokenizer çalışmadan önce reddedilir.
  • Kimlik belgesi gerektiren bir pazar (bugün için bir ars ücreti), tür seçiciyi ve numara alanını panelin içinde gösterir. Bu numara karttan farklı olarak tokenizer’a giderken uygulamanızdan geçer, ancak yine de asla Whop’a ulaşmaz.
  • Kart ve güvenli alan değerleri oluşturmadan önce tokenleştirilir, bu nedenle uygulamanızdan geçen tek şey onay token’ıdır.
  • Bir yöntem fatura ülkesine ihtiyaç duyduğunda yanına WhopAddressElement bağlayın: kutucuk listesi o ülkenin izin verdiği yöntemlere daralır.

Kurulum

Onu, denetleyiciyi oluşturan ve içeriğine aktaran bir WhopPayments(accountID:charge:) kapsamı içine bağlayın. Bir e-posta ile oturum açma bir alıcıyı doğruladığında payments.buyer oturum açmış alıcıdır. Whop bu satışlarda kayıtlı satıcı (merchant of record) olduğundan WhopBrandingElement de ekranda olmalıdır; createConfirmationToken o olmadan reddeder. .whopElementsAppearance(_:) ile stil verin. Modül, cüzdan SDK’sının WhopElements modülü değil, Elements modülüdür. Bkz. Başlarken ve Görünüm.

Prop’lar

string[]
Stripe’ın paymentMethodOrder semantiğiyle yöntem görüntüleme sırası. Listelenmeyen türler gelen göreli sıralarını koruyarak listelenenlerin arkasında yer alır. <Payments> üzerinde de bir kez ayarlanabilir.
(payload: PaymentChangePayload) => void
Her seçim ve eksiksizlik değişikliğinde tetiklenir. Gönder düğmenizi complete değerine bağlayın.
StyleProp<ViewStyle>
Elementin dış View bileşenine uygulanır. Tema için, bu yüzeydeki her elementi kapsayan sağlayıcı üzerindeki appearance.parts seçeneğini tercih edin. React Native parça adlarının bugün web’in whop-* sınıf adlarından farklı, kendine ait bir küme olduğunu unutmayın; bu nedenle bir web appearance nesnesi değiştirilmeden aktarılamaz.
ReactNode
Element yüklenirken yerleşik iskelet yerine gösterilir.
() => void
Element etkileşimli hâle geldiğinde bir kez tetiklenir. <Payments> bunları gruplar, bu nedenle genellikle istediğiniz şey onun kendi onLoadingChange geri çağırmasıdır.
(error: { message: string; code?: string }) => void
Bu element için bir yükleme veya yapılandırma hatası. Element her iki durumda da kendi hata ekranını gösterir.

PaymentChangePayload

onChange geri çağırmasının döndürdüğü değerler:
  • complete: boolean: seçili yöntem ihtiyaç duyduğu her şeye sahip
  • type?: string: seçili yöntem türü, örn. card
  • method?: { type, category, template, display_name }: seçili yöntemin matris girdisi

Durumlar

Yöntem matrisi gelene kadar üç iskelet satır, ardından kutucuklar. Bir kutucuğu seçmek, altındaki ayrıntı bölgesini genişletir. Seçili yöntem ihtiyaç duyduğu her şeye sahip olduğunda onChange, complete bildirir; gönder düğmenizi kısıtlayan budur. Uygun yöntemi olmayan bir ücret, hiçbir şey göstermemek yerine açıklayıcı bir boş durum gösterir.

Bilmekte fayda var

  • Kart numaraları asla kodunuzdan geçmez. Alanlar PCI açısından yalıtılmış yerel girişlerdir ve SDK Whop’a bir token iletir; böylece uygulamanız PCI kapsamı dışında kalır.
  • Apple Pay ve Google Pay her ikisi de platformun kendi ödeme ekranını sunar. Hiçbiri sizden bir şey gerektirmez: Apple Pay, Whop hesabında kayıtlı satıcıyı kullanır, bu nedenle iletilecek bir satıcı tanımlayıcısı veya Xcode’da eklenecek bir yetenek yoktur; googlePayMerchantName ise yalnızca ödeme ekranında gösterilen adı ayarlar ve varsayılanı Whop’tur.
  • Yönlendirme yöntemleri ve 3D Secure, iOS’ta ASWebAuthenticationSession, Android’de Custom Tabs açar. Asla bir WebView değil, sistem tarayıcısı kullanılır; böylece kartı veren kuruluşun sayfası uygulamanızın güven sınırının dışında kalır.
  • <Payments> üzerindeki returnUrl değerini barındırdığınız bir https URL’sine ayarlayın. API, https veya loopback dışındaki her şeyi reddeder (PaymentsApi::ValidateReturnUrl), bu nedenle özel bir uygulama şeması burada kullanılamaz. Bir derin bağlantı kaydetmezsiniz: kartı veren kuruluş yönlendirdikten sonra handleNextAction, ödeme sonuçlanana kadar sorgular ve tarayıcıyı kendisi kapatır.
Uygulamanızı bir kez <WhopElements getToken={…}> ile sarın, ardından elementlerin etrafına <Payments> bağlayın. Bkz. Başlarken ve Görünüm.