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.

Playground

Elementleri örnek verilerle bir araya getirin. Kontrolleri kullanın, elementler ekleyip düzenleyin ve olayların canlı olarak tetiklenmesini izleyin:

Seçenekler

Bunları whop.payments.create({ … }) çağrısına veya React’te <Payments> üzerinde prop olarak iletin.
Bu kombinasyonlardan tam olarak birini iletin:
  • accountId ve plan
  • accountId, currency ve amount
  • accountId, mode: "setup" ve currency
  • plan, currency, amount veya mode değerlerinin hiçbiri
string
biz_ önekli hesap kimliği. Yalnızca bir hesap yüzeyi olmadan statik metotları çağırırken belirtmeyin.
"payment" | "setup"
Bağlama modu, varsayılan olarak payment. setup bir ödeme yöntemini kaydeder ve ne şimdi ne de daha sonra ücret alır: yalnızca kaydedilebilen yöntemler sunulur ve tutar sınırları uygulanmaz. createConfirmationToken() ile onaylayın, ardından setup intent’i sunucu tarafında oluşturun.
string
plan_ önekli plan kimliği. İstemci tarafında para birimi, tutar ve yöntem yapılandırmasına çözümlenir. Bir plan veya satır içi para birimi ve tutar iletin, asla ikisini birden iletmeyin.
object
Ödeme, BNPL gibi ücretsiz bir yöntem için amount değerini yeniden fiyatlandırdığında yöntemleri sınırlamak için kullanılan, küçük birim cinsinden feeInclusive ve feeFree toplamları. Her yöntem eşleşen toplamına göre kontrol edilir; bu, seçilen ücretsiz yöntemin kaybolmasını önler. Belirtilmezse her yöntemi amount sınırlar.
string
Site dışı banka veya 3DS adımları için dönüş URL’si. Varsayılan olarak bağlamanın yapıldığı sayfadır. Sonuç ne olursa olsun alıcı, payment (veya setup), status (succeeded, failed, canceled ya da processing gibi hâlâ beklemede olan bir durum) ve client_secret eklenmiş şekilde oraya ulaşır; bu nedenle bir başarı sayfası göstermeden önce status değerine göre dallanın.
"off_session" | "on_session"
Bir kurulum (setup), ödeme yöntemini bir kurulumun kabul ettiği tek kullanım olan off_session kullanımı için kaydeder.
WalletAvailability
Belirleyici önizlemeler için cüzdan kullanılabilirliği geçersiz kılması. Canlı ödemeler ana ortamı yoklar.
string
Küçük harfli, üç harfli ISO 4217 para birimi kodu. Ödeme yöntemi matrisini filtreler.
number
Küçük birim cinsinden ödeme tutarı. Sınırları bu tutarı kapsamayan yöntemler sunulmaz.
object
API’nin enabled, disabled ve include_platform_defaults biçimindeki hesap ödeme yöntemi filtreleri. disabled türleri kaldırır, enabled sunulan türleri geri getirir ve include_platform_defaults: false yalnızca etkinleştirilmiş türleri bırakır. Planlar kendi yapılandırmalarını sağlar.
Appearance
Bu grubun elementleri için görsel özelleştirme. Genel WhopElements({ appearance }) ayarını geçersiz kılar. update({ appearance }) ile canlı olarak değiştirin.
WhopElementsLocale
Bu grubun element arayüzü metinleri için yerel ayar. Genel yapılandırmayı geçersiz kılmak için uygulamanın yerleşik yerel ayarlarından birine ayarlayın. Diğer tüm değerler varsayılan yerel ayara geri döner.

Olaylar

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

onLoadingChange

Gruplanmış yükleme durumu değiştiğinde çalışır. Bağlı herhangi bir element hâlâ yüklenirken değer true olur.
boolean

Metotlar

Bunları whop.payments.create({ … }) veya usePayments() üzerinden alınan Payments tanıtıcısında çağırın.

createConfirmationToken

Ödeme düğmenizden seçilen yöntem için bir onay token’ı oluşturur. Ödemenin fatura bilgilerini iletin. Bunlar email içermelidir. Fatura bilgisi toplama devre dışıyken bunu gerektiren yöntemler için phone sağlayın. Kartlar ayrıca name ve line1 ile country içeren bir adres gerektirir. Cüzdan seçimleri, ödeme düğmesi etkileşimi sırasında sayfalarını açar. Hesap sayfa içi banka bağlantısı sunduğunda (banka hesabı ödeme yöntemi türünde bank_debit.bank_connection), bir banka hesabı seçimi de bu sırada Plaid Link’i açar ve çağrı, alıcı bir hesap bağladığında çözümlenir. Bunun için bir whop.com sayfası veya Domains API aracılığıyla Apple Pay için hazırlanmış bir alan adı ve contentSecurityPolicy() tarafından döndürülen Plaid ana makinelerine izin veren bir İçerik Güvenliği Politikası gerekir. Aksi takdirde alıcı hesabı bunun yerine gönderimden sonra bağlar. Alıcı sayfayı veya Link’i kapatırsa çağrı payment_request_cancelled ile reddedilir: bunu bir ödeme hatası olarak değil, bir iptal olarak ele alın ve alıcının yeniden ödeme yapmasına izin verin. Döndürülen confirmationToken değerini sunucu tarafında onaylayın, ardından WhopElements.payments.handleNextAction(…) çağırın. Denetleyici iframe’inde değil, sayfanızda (ana taraf) çalışır. Parametreler
object
gerekli
Döndürür Promise<object>
string
gerekli
string
gerekli

update

Yeni tanıtıcı seçeneklerini bağlı her elementle birleştirir. React’te bunun yerine ad alanı prop’larını değiştirin. Parametreler
Partial<PaymentsOptions>
gerekli

destroy

Bu tanıtıcının oluşturduğu her elementi ve alt denetleyiciyi yok eder, denetleyici çerçevesini kaldırır ve aboneliklerini serbest bırakır. Birden fazla kez çağırabilirsiniz, ancak yok edilmiş bir tanıtıcı diğer tüm çağrıları reddeder; baştan başlamak için yeni bir tanıtıcı oluşturun. React, sağlayıcı kaldırıldığında grubu otomatik olarak kaldırır.

Statik metotlar

Bunları bağlama yapmadan çağırın: vanilla JavaScript’te whop.payments.<method>(…) veya React’te useWhop().payments.<method>(…).

handleNextAction

Onaylanmış bir ödemenin bekleyen adımını bir element bağlamadan tamamlar. Ödemeyi clientSecret tanımlar. Bir ödeme kimliğine ihtiyacınız yoktur. Satır içi adımlar bir iletişim kutusunda açılır ve redirected: false ile çözümlenir. İletişim kutusunu kapatmak, ödemenin beklemede kalabilecek mevcut durumunu döndürür. Tam sayfa adımlar redirected: true ile return_url adresine veya ödemenin dönüş URL’si yoksa barındırılan bir makbuza yönlendirir. Bir iframe içinde en üst düzey sekmede gezinirler. Yerleştiren sayfa bu gezinmeyi reddederse TAB_NAVIGATION_BLOCKED koduyla reddedilirler ve ödeme beklemede kalır. Hedefi sunumdan önce güncellemek için returnUrl ayarlayın. Bir güncelleme hatası, herhangi bir adım çalışmadan önce reddedilir. Satır içi adımlar asla o URL’ye gitmez. Ücreti hâlâ belirlenmekte olan bir ödeme, bir adım görünene veya sonuçlanana kadar yoklanır; adımı olmayan, sonuçlanmış bir ödeme hemen çözümlenir. Parametreler
object
gerekli
Döndürür Promise<object>
string
gerekli
boolean
gerekli
object | null
gerekli

Kaynaklar

Bu SDK nesnelerini bir element bağlamadan oluşturun. Her birinin kendi sayfası vardır:

PaymentRequest

Özel düğmeler, hızlı ödeme ve teslimat geri çağırmaları için düşük seviyeli Apple Pay, Google Pay veya PayPal sayfası. Cüzdan kutucukları bu akışı payments.createConfirmationToken aracılığıyla otomatikleştirir. Kullanılabilirliği kontrol etmek ve cüzdanı hazırlamak için canMakePayment() sonucunu bekleyin, ardından kullanıcı etkileşimi işleyicisinde show(type) çağrısını eşzamanlı olarak yapın. Çözümlenen ctok, ctok_ önekli bir onay token’ıdır. Bunu, bir elementin ürettiği token gibi sunucu tarafında onaylayın. Bir PayPal token’ı en fazla PayPal’ın alıcıya gösterdiği toplam tutarı tahsil eder.

İçerik güvenliği politikası

Bu grubun işinin bir kısmı bir çerçevede değil, sayfanızda çalışır. İçerik Güvenliği Politikası olan bir sayfa bu kaynaklara ihtiyaç duyar. @whop/elements paketindeki contentSecurityPolicy(), bu tablodaki her kaynağı döndürür. Sandbox kaynağı environment: "sandbox" ile geçerlidir.

Elementler

Bu grubun bağladığı elementler. Her birinin kendi sayfası vardır:

AddressElement

Bir fatura veya teslimat adresi toplar. Alanlar, sıralama ve doğrulama seçilen ülkeye göre belirlenir. Sokak adresi otomatik tamamlamasını (telefonlarda tam ekran) ve adresi okumak ya da doğrulamak için metotları içerir.

EmailElement

Alıcının e-postasını toplar ve bağlı olduğu sürece payments.createConfirmationToken() çağrısına iletir. Açıkça belirtilen billingDetails.email önceliklidir. Eşleşen bir Whop hesabı, kod doğrulamasıyla veya hesabın bir geçiş anahtarı (passkey) varsa onunla isteğe bağlı oturum açma seçeneği gösterir. Başarılı oturum açma, ödeme elementindeki kayıtlı ödeme yöntemlerinin kilidini açar. Alıcılar misafir olarak devam edebilir.

TaxIdElement

API tarafından kabul edilen bir işletme vergi kaydını toplar. Etiketler alıcıya yönelik adlar kullanır. Yer tutucu, seçilen biçimle eşleşir. country bir türü önceden seçer. onChange kesinleşmiş çiftleri yayar. API doğrulama hatalarını ana uygulama sağlar.

BrandingElement

Zorunlu — AddressElement, EmailElement ve TaxIdElement dışındaki diğer elementler onu bekler. Whop’un kayıtlı satıcı (merchant of record) bildirimi: alıcının Whop’un Alıcı Hizmet Şartları’nı ve Gizlilik Politikası’nı kabul ettiği metin, Whop logo yazısıyla birlikte. Zorunludur; ödeme, kart ve kart alanları elementleri bu bağlanana kadar yükleme durumunda kalır ve onsuz ödemeler onaylanamaz.
Alternatifler. Aynı anda yalnızca birini bağlayın. Başka birini bağlamadan önce onu yok edin:

PaymentElement

Kullanılabilir ödeme yöntemlerini gösterir ve seçilen yöntemin gerekli alanlarını ve bildirimlerini toplar. Ödeme düğmenizi etkinleştirmek için change kullanın. Etkinleştirme işleyicisinde payments.createConfirmationToken() çağırın. Token’ı sunucu tarafında onaylayın, ardından bekleyen herhangi bir adımı payments.handleNextAction(…) çağrısına iletin. Adrese bağlı güncellemeler için addressChange kullanın.

CardElement

Kart numarası, son kullanma tarihi ve güvenlik kodu için önceden düzenlenmiş alanlar. payments.create("card") ile oluşturun, ödeme düğmenizi onChange üzerinden etkinleştirin ve payments.createConfirmationToken() ile onaylayın. Kart numaraları PCI’dan yalıtılmış barındırılan alanlarda kalır. layout, stacked (varsayılan) ve compact değerlerini destekler.

CardFields

Özel düzenler için ayrı ayrı bağlanabilen, PCI’dan yalıtılmış üç kart alanı: numara, son kullanma tarihi ve güvenlik kodu. payments.create("cardFields") ile oluşturun, her alanı yerleştirin, ödeme düğmenizi onChange üzerinden etkinleştirin ve payments.createConfirmationToken() ile onaylayın. Kart numaraları barındırılan alanlarda kalır. (alt denetleyici, 3 element)