Skip to main content
Payout’ları oluşturmak ve takip etmek, kayıtlı ödeme alma yöntemlerini yönetmek ve Whop’tan çıkan fonlar için beklenen varış ayrıntılarını göstermek üzere Payouts API’yi kullanın.

Uç noktalar

Özellikler

string
gerekli
wdrl_ önekli payout kimliği.
string
gerekli
Tam para birimi cinsinden payout tutarı, ondalık dize olarak.
boolean
gerekli
POST /payouts/\{id}/cancel isteğinin şu anda bu payout üzerinde işlem yapıp yapmayacağı: in_review durumundayken, ödeme sağlayıcısına henüz hiçbir şey gönderilmemiş şekilde processing durumundayken veya gönderilmiş bir payout’un sağlayıcıda hâlâ iptal edilmesi istenebildiği sürece true. Para ulaştığında veya payout zaten sona erdiğinde false.
object | null
gerekli
Payout gönderilmeden önce bakiyenin payout para birimine nasıl dönüştürüldüğü. Payout kendi para birimindeki bir bakiyeden gönderildiğinde null.

Özellikler

string
gerekli
Dönüştürmenin bakiyeden aldığı tutar, ondalık dize olarak.
string
gerekli
Dönüştürmenin tutarı aldığı bakiyenin para birimi.
number
gerekli
Her bir from_currency birimi için payout para birimi cinsinden dönüştürme oranı. Herhangi bir dönüştürme ücreti bu orana dahildir.
string
gerekli
Payout’un oluşturulma zamanı.
string
gerekli
Payout para birimi.
string | null
gerekli
Hedef para birimi cinsinden teslim edilen tutar, ondalık dize olarak. Payout işlendiğinde atanır, bu nedenle o zamandan önce ve kayıtlı dönüştürmesi olmayan payout’larda null.
string | null
gerekli
Fonların teslim edildiği para birimi; payout oluşturulduğunda payout yönteminden alınır. Bir dönüştürme talebiyle finanse edilen bir payout’ta, yanında oluşturulan kesinleşme payout’unu izler — bu payout’un kimliğini payout_request_id olarak taşıyan GET /payouts satırı — ve yalnızca kesinleşme payout’u olmadığında null olur.
string | null
gerekli
Fonların hedef hesapta kullanılabilir hale geleceği tahmini zaman.
number | null
gerekli
Payout para biriminden hedef para birimine döviz kuru. Payout işlendiğinde atanır, bu nedenle o zamandan önce ve kayıtlı kuru olmayan payout’larda null.
object | null
gerekli
Payout’un neden ödeme yapmadan sona erdiği veya kesinleşmeden sonra neden geri çevrildiği. Başarısız, iptal edilmiş, reddedilmiş ve geri çevrilmiş payout’larda bulunur; aksi halde null.

Özellikler

string | null
gerekli
Bakımı yapılan hata kataloğundan sınıflandırılmış hata kodu.
string | null
gerekli
Fonları bakiyeye geri koyan geri çevirmenin geçerlilik zamanı — fonlar hiç çıkmadıysa veya henüz geri dönmediyse null. Yalnızca dönüş defterde onaylandığında ayarlanır; defter kaydının kendisi bu zamandan birkaç dakika sonra gerçekleşebilir.
string | null
gerekli
Hatanın insan tarafından okunabilir açıklaması. payout:destination:read iznine sahip çağıranlar hedefe göre kişiselleştirilmiş metin alabilir; diğer çağıranlar genel katalog mesajını alır.
string
gerekli
Payout için alınan ücret, payout para birimi cinsinden, ondalık dize olarak.
string
gerekli
Payout ücretini kimin üstlendiği: hesabın kendisi veya üst platformu.Kullanılabilir seçenekler: self, platform
string
gerekli
Whop’un sağlayıcı ücreti üzerindeki marjı, payout para birimi cinsinden, ondalık dize olarak. Hiçbiri uygulanmadığında "0.0".
object
gerekli
Oluşturma sırasında eklenen ve her okumada geri döndürülen anahtar-değer verileri. En fazla 50 anahtar, en fazla 40 karakterlik anahtar adları, en fazla 500 karakterlik dize değerleri.
string
gerekli
Payout para birimi cinsinden hedef için planlanan net tutar: fee_paid_by self olduğunda amount eksi fee_amount eksi markup_fee; platform ücretleri karşıladığında amount değerine eşit. Reddedilmiş, iptal edilmiş veya başarısız olarak sona eren bir payout hiçbir şey teslim etmemiştir — çoğu planlanan rakamı korur ve failure fonların nerede olduğunu söyler, ancak bir dönüştürme talebiyle finanse edilen iptal edilmiş bir payout bunun yerine kesinleşmiş sonucu bildirebilir: amount bakiyede kalanı taşır, hiçbiri alınmadığı için ücretler sıfırdır ve hiçbir şey teslim edilmediği için net_amount 0’dır.
string | null
gerekli
Payout’u oluşturanın eklediği serbest biçimli notlar veya hiçbiri sağlanmadığında null. En fazla 255 karakter.
string
gerekli
string | null
gerekli
Payout’u işleyen kuruluşun adı.
object | null
gerekli
Kullanılan kayıtlı payout yöntemi. payout:destination:read gerektirir; bu izin olmadan null.

Özellikler

string | null
gerekli
Kayıtlı payout yöntemi takma adı.
object | null
gerekli
Desteklenen payout yöntemi görüntüleme ayrıntıları.

Özellikler

string
gerekli
Fonların alıcıya nasıl teslim edildiği.Kullanılabilir seçenekler: cash_pickup, bank_deposit, home_delivery, mobile_wallet, card, check, bill, cryptocurrency, unknown
string | null
gerekli
Desteklenen payout yöntemi simge URL’si.
string | null
gerekli
Desteklenen payout yöntemi görünen adı.
string
gerekli
Payout’un kullandığı payout yöntemi türü. external fonları Whop dışına gönderdi. whop_card fonları hesabın kendi Whop Card’ına aktardı.Kullanılabilir seçenekler: external, whop_card
string | null
gerekli
POST /payouts tarafından döndürülen cofr_ önekli payout talebi kimliği. GET /payouts içindeki kesinleşmiş payout ile eşleştirin. POST /payouts ile oluşturulmamış payout’lar için null döndürür.
string | null
gerekli
Payout’un nasıl oluşturulduğu. automatic planlanmış bir otomatik payout anlamına gelir. Payout’un kayıtlı bir kaynağı olmadığında null.Kullanılabilir seçenekler: api, dashboard, automatic
string
gerekli
Payout teslimat hızı.Kullanılabilir seçenekler: standard, instant
string | null
gerekli
Payout ile gönderilen ödeme açıklaması veya hiçbir tanımlayıcı ayarlanmadıysa null. Ayarlandığında 5-80 yazdırılabilir ASCII karakteri.
string
gerekli
Güncel payout durumu.Kullanılabilir seçenekler: requested, in_review, processing, completed, reversed, canceled, failed, denied
string
gerekli
status altındaki en ayrıntılı makine aşaması — örneğin processing altında awaiting_provider_acceptance ile in_transit karşılaştırması veya requested altındaki dönüştürme aşaması. Bilgilendirici sözcük dağarcığı: değerler sürüm artışı olmadan eklenebilir; sürümlü sözleşme status değeridir.
string | null
gerekli
Bu payout için ödeme ağı referansı, örneğin bir ACH izleme numarası, bir RTP veya FedNow uçtan uca kimliği, bir havale IMAD’ı veya bir SWIFT UETR. Referans kullanılabilir olana kadar ve referansı olmayan payout’larda null.
Payout