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.checkout.create({ … }) çağrısına veya React’te <Checkout> üzerinde prop olarak iletin.
string
plan_ önekli mevcut plan kimliği. Bu planı ve quantity değerini içeren bir items dizisinin kısaltmasıdır. Fiyatı plan belirler; tutarlarla ilgili hiçbir şey istemci tarafında belirlenemez. plan, items veya bir checkoutConfiguration değerinden birini iletin. Yalnızca oluşturma sırasında ayarlanır: oturum bundan oluşturulur ve daha sonra değiştirilmesi reddedilir.
number
Satın alınacak birim sayısı. Birden fazla adete izin vermeyen planlar 1’in üzerindeki değerleri reddeder. Yalnızca oluşturma sırasında ayarlanır: oturum bununla oluşturulur ve daha sonra değiştirilmesi reddedilir. @default 1
CheckoutItemInput[]
Bu ödemedeki planlar ve her birinden kaç birim satın alınacağı. Her öğe aynı satıcıya ait olmalı ve uyumlu faturalama koşulları kullanmalıdır; API sepetin tamamını doğrular ve tek bir ücret olarak fiyatlandırır. Bunu plan, quantity veya checkoutConfiguration yerine iletin. Yalnızca oluşturma sırasında ayarlanır: oturum tam olarak bu sepetten oluşturulur ve daha sonra değiştirilmesi reddedilir.
string
ch_ önekli mevcut ödeme yapılandırması kimliği. Element ödeme oturumunu bundan oluşturur: yapılandırma satılan planı belirtir (veya setup modunda hiçbir plan belirtmez; ödeme bir ödeme yöntemini kaydeder ve hiçbir ücret almaz) ve kendi satış ortağı kodunu, meta verilerini, yönlendirmesini ve ödeme yöntemi ön ayarlarını belirler; burada onunla birlikte iletilen bir seçenek, alan bazında yapılandırmanın kopyasına göre önceliklidir. Yanında plan değerini yalnızca quantity ayarlamak için iletin; bu, yapılandırmanın kendi planı olmalıdır ve ön ayarlarının altından asla değiştirilemez. Yalnızca oluşturma sırasında ayarlanır.
string
Alıcı fiyatı görmeden önce uygulanacak bir promosyon kodu; indirim ilk fiyat teklifindedir ve alıcı yine de onu değiştirebilir veya kaldırabilir. Bir pazarlama bağlantısının taşıdığı kodu iletin: süresi dolmuş veya hiç geçerli olmamış bir kod, ödemeyi promosyon satırında nedeni gösterilerek tam fiyattan açar; asla açılmayan bir ödemeye yol açmaz. Yalnızca oluşturma sırasında ayarlanır.
string
Bu ödemenin ilişkilendirildiği satış ortağı. Yalnızca oluşturma sırasında ayarlanır.
CheckoutAttributionInput
Hesabın raporlaması için bu satışın nereden geldiği: alıcının geldiği bağlantının kampanya parametreleri (utmSource, utmMedium, utmCampaign, utmTerm, utmContent, utm altındaki diğer tüm utm_* parametreleri, bir Whop trackingLinkId, bir funnelId ve kendi source değeriniz). Buradaki her şey siparişe karşı kaydedilir ve alıcıya asla gösterilmez. Yalnızca oluşturma sırasında ayarlanır.
Record<string, string>
Siparişe karşı kaydedilecek ve ödemede geri okunacak kendi anahtar/değer çiftleriniz: sipariş kimlikleri, sepet kimlikleri veya mutabakat yaptığınız herhangi bir şey. En fazla 40 dize çifti. Yalnızca oluşturma sırasında ayarlanır.
string
Sonucu ne olursa olsun, site dışı bir ödeme adımından sonra alıcının ulaştığı adres. Sekme, sonuna payment (pay_ kimliği; kurulum modundaki bir ödeme için sint_ kimliğiyle setup) ve status (succeeded, failed veya canceled) eklenmiş ve diğer sorgu parametreleriniz korunmuş olarak gelir. Bir başarı sayfası göstermeden önce status değerine göre dallanın: reddedilen veya yarıda bırakılan bir site dışı adım da buraya ulaşır. Teslimatı bu ziyaretten değil, webhook’lardan yapın. Yalnızca https (localhost için http). Yalnızca oluşturma sırasında ayarlanır.
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 derlenmiş 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.

onComplete

Ödeme tamamlandığında ve sonucu kesinleştiğinde bağlama başına bir kez tetiklenir. result neyin kesinleştiğini belirtir: payment (alıcı ödeme yaptı, paymentId), waitlist_entry (alıcı bir bekleme listesine katıldı, entryId) veya setup (kurulum modundaki bir ödeme ödeme yöntemini kaydetti, setupIntentId); sessionId her durumda ödeme oturumudur. Herhangi bir returnUrl gezinmesinden önce tetiklenir, bu nedenle kendi analizlerinizin veya reklam piksellerinizin satın alma işlemini kaydettiği yer burasıdır. Teslimatı bu geri çağırmadan değil, webhook’lardan yapın: daha sonraki bir sayfa yüklemesinde geri yüklenen bir ödeme, aynı sonuç için onu tekrar tetikler.
CheckoutPaymentCompletion | CheckoutWaitlistCompletion | CheckoutSetupCompletion

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.checkout.create({ … }) veya useCheckout() üzerinden alınan Checkout tanıtıcısında çağırın.

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<CheckoutOptions>
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.

Kaynaklar

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

CheckoutSession

Kendi PayPal düğmesini çizen bir sayfa için düşük seviyeli, arayüzsüz (headless) ödeme oturumu. load(), ödeme oturumunu lineItems üzerinden oluşturur; show("paypal", { termsAccepted: true }) alıcıyı PayPal’a gönderir (masaüstünde bir açılır pencere, telefonlarda sekmenin tamamı) ve alıcı onayladığında ödemeyle birlikte çözümlenir. paymentMethodOptions.paypal.requestShipping ile PayPal alıcıdan bir teslimat adresi ister ve hesabın shipping_address.changed olayına abone olan webhook’u, alıcı PayPal’dayken her adresi sunucunuzda fiyatlandırır; ödeme yalnızca alıcı onayladıktan sonra, o fiyattan oluşturulur. Tam sayfa yönlendirmeden sonra promise hiçbir zaman sonuçlanmaz; bunun yerine sonucu redirectUrl adresinin payment ve status sorgu parametrelerinden okuyun.

Elementler

Bu grubun bağladığı elementler. Her birinin kendi sayfası vardır: Alternatifler. Aynı anda yalnızca birini bağlayın. Başka birini bağlamadan önce onu yok edin:

CheckoutElement

Eksiksiz ödeme yüzeyi: canlı fiyat teklifiyle sipariş özeti, promosyon kodu girişi, alıcının ödeme yaptığı para birimi, bu ödemenin alıcıdan toplaması gereken her şey, birleştirilmiş ödeme yöntemleri yüzeyi ve ödeme akışı. Topladığı şey, satıcının ayarladığı her neyse odur (e-posta, kendi soruları, bir telefon numarası, fiziksel ürünler için bir teslimat adresi, koşullarının açıkça kabul edilmesi) ve satıcının seçtiği sırayla tek bir ekranda birlikte gösterilir; bu nedenle yeni bir şey istemeye başlayan bir satıcının burada herhangi bir değişiklik yapması gerekmez. Satın alma işleminin tamamını gösterir; oturum ve kimlik bilgisi ödeme denetleyicisine aittir. Site dışı bir adım gerektiren bir ödemeden sonra alıcı geri döndüğünde, sunucunun bildirdiği sonucu da bu aynı yüzey gösterir.

ExpressCheckoutElement

Bir ödeme için tek dokunuşla Apple Pay, Google Pay ve PayPal düğmeleri: cüzdan, oturumun hâlâ ihtiyaç duyduğu her şeyi toplar (alıcının e-postası, fiziksel ürünler için bir teslimat adresi, Apple Pay ve Google Pay’de satıcının topladığı durumlarda bir telefon numarası ve Apple Pay’de satıcının giriş sunduğu durumlarda bir promosyon kodu) ve tek bir dokunuş satın alma işlemini tamamlar. Giriş alanını tam ödeme elementiyle paylaşır, bu nedenle bir tanıtıcı ikisinden tam olarak birini bağlar: satın alma işleminin bir sayfa (sheet) tarafından tamamlanabilecek kadar basit olduğu durumlarda yalnızca bu düğme, diğer her şey için tam ödeme yüzeyi. Yalnızca alıcının cihazının gerçekten ödeme yapabildiği ve ödemenin kendi ödeme yöntemi yapılandırmasının izin verdiği cüzdanları, sunulan düğme görselleriyle gösterir ve hiçbir cüzdan kullanılamadığında hiçbir şey göstermez. PayPal, satıcının kabul ettiği durumlarda görünür, kendi penceresinde açılır ve alıcının PayPal hesabını satın alma işlemiyle birlikte kaydeder; böylece bir yenileme, ücretsiz deneme ve satıcının daha sonra yaptığı ücretlendirmeler kayıtlı bir kart gibi çalışır. Üç cüzdanın tamamı sayfanın alan adında Apple Pay gerektirir: birinci taraf whop.com sayfaları önceden onaylıdır ve diğer tüm siteler, bu düğmelerden herhangi biri orada gösterilmeden önce Domains API aracılığıyla alan adlarına Apple Pay eklemelidir. Google Pay’i kendi sitenizde sunmak Google Pay API Hizmet Şartları’na tabidir. Sayfanın dürüstçe tamamlayamayacağı bir ödeme (bekleme listesine katılma, bir aktarım, yalnızca bir sayfanın sorabileceği bir form sorusu), başarısız olacak bir düğme göstermek yerine açıkça reddedilir.