API referansı
Sunucu API'si hesapları, faturaları, güvenli ödemeyi, durumları ve webhook'ları destekler. OpenAPI, yolları, alanları ve hataları tanımlar. Bir ödeme başlatmak, yapılandırılmış bir ağ geçidi, onaylanmış bir satıcı ve desteklenen fatura koşulları gerektirir.
Bu sayfada
Temel URL ve biçim#
The base URL is https://kevmi.one. Request and response bodies use JSON. Money values are integer minor units. Account and support dates are Unix timestamps in milliseconds.
API yanıtları Cache-Control: no-store kullanır. Genel /openapi.json beş dakika önbelleğe alınabilir. Bir URL'ye çerez veya gizli anahtar yerleştirmeyin.
curl 'https://kevmi.one/api/config'
curl 'https://kevmi.one/openapi.json'İstek yetkilendirmesi#
Web hesabı bir HttpOnly oturum çerezi kullanır. GET /api/auth/me geçerli kullanıcıyı ve csrfToken değerini döndürür. Değişiklikler X-CSRF-Token ve aynı kaynaklı bir istek gerektirir.
Kapsamlı Kevmi satıcı anahtarları, /api/v1/payments, /api/v1/payment-links ve /api/v1/events yollarını yetkilendirir. Hesap ayarları veya yönetim yolları için oturum çerezini değiştirmezler.
const me = await fetch('/api/auth/me').then(r => r.json());
if (!me.authenticated) throw new Error('Sign in required');
const response = await fetch('/api/account/settings', {
method: 'PATCH',
headers: { 'Content-Type': 'application/json', 'X-CSRF-Token': me.csrfToken },
body: JSON.stringify({ vatPayer: 'merchant' })
});
if (!response.ok) throw new Error('Settings were not saved');
const updated = await response.json();Uç noktası grupları#
GET /api/config, sunucu yapılandırmasının varlığını bildirir. GET /api/checkout/{token}, seçilen yöntem için fatura kullanılabilirliğini döndürür; satıcı onayı ve kaydedilmiş koşullar dahildir. Bu kontroller sağlayıcı bağlantısı veya ödeme başarısı kurmaz: sonuç, doğrulanmış ağ geçidi işleminden gelir.
| Grup | Amaç |
|---|---|
| Yapılandırma ve sağlık | Genel hizmet ve depolama hazırlığı |
| Kimlik doğrulama | Telegram zorlukları ve oturumları |
| Hesap | Ayarlar ve özel satıcı uygulaması |
| /api/v1/payments | Kapsamlı sunucu fatura oluşturma ve okuma; bir ödeme başlatmaz |
| /api/v1/events | events:read ile sunucu olay günlüğü |
| Entegrasyonlar | Oturumla doğrulanmış anahtar ve webhook uç noktası yönetimi |
| Uygulamalar ve moderasyon | Sahip olunan gönderimler, durum takibi ve ayrı moderatör izinleri |
| Ödeme Sayfası | Genel fatura, şifrelenmiş kart isteği, somut işlem, banka kodu, durum ve mutabakat |
| Ağ geçidi girişi | İmzalı v3 bildirimleri ve doğrulanmış işlem doğrulaması |
| Destek ve bildirimler | Sorular, özel talepler, olaylar ve okuma durumu |
| Telegram | Doğrulanmış bot webhook'u |
| Desteklenmeyen para yolları | Eski doğrudan /api/payments ve /api/payouts yolları bir ödeme veya ödeme çıkışı oluşturmaz |
Genel bir bilgi isteği#
Yanıt mode, answer, sources, knowledgeVersion ve needsHuman içerir. Sağlanan bir Origin, uygulama kaynağıyla eşleşmelidir. Sunucu tarafı dokümantasyon aracısı Origin'i atlayabilir.
curl 'https://kevmi.one/api/support/ask' \
-H 'Content-Type: application/json' \
--data '{"question":"Who pays VAT?","locale":"en"}'Hatalar ve sınırlar#
Bir hata, makine tarafından okunabilir bir kod ve bir mesaj içerir. Bilinmeyen istek alanları reddedilir. Standart JSON gövdeleri 16.384 bayt kabul eder; /api/support/ask ve Telegram webhook'u 65.536 bayt kabul eder.
429 bir hız sınırını gösterir. 503, kullanılamayan bir entegrasyonu gösterebilir; reddedilen bir ödemeyi değil. error.code değerini okuyun ve bir finansal durumu yalnızca HTTP durumuna göre değiştirmeyin.
Birden fazla mağaza ve tek USD taban fiyat#
Toplu analiz ve işlemler için Tüm mağazaları seçin veya kendi kayıtları için bir mağaza seçin. Her mağazanın ayrı bir storeId'si, adı, varsayılan KDV'si, faturaları, API anahtarları, webhook uç noktaları, olay geçmişi ve web sitesi uygulaması vardır. Bildirimler ve destek talepleri hesaba aittir. Bir hesap en fazla 100 mağaza oluşturabilir. Mevcut kayıtlar ilk mağazasında kalır.
Yeni çalışma alanı faturaları pricingMode="universal" ve USD taban fiyat kullanır. Any, kart, alipay, sbp ve kriptoyu içerir; bir satıcı bir alt küme seçebilir. Kartlar ve Alipay USD tahsil eder. SBP, Rusya Merkez Bankası USD/RUB referans kurunu kullanarak RUB tahsil eder. Kripto, açık fatura kuralı 1 USD = 1 USDT kapsamında USDT tahsil eder. Bu bir fatura dönüştürme kuralıdır, piyasa USDT kotasyonu değildir. Ağ geçidi, transferden önce seçilen coin'in kurunu, tam transfer tutarını ve talimatlarını sağlar.
Referans kuru ve her iki tutar oluşturma sırasında dondurulur. RUB dönüştürmesi içeren faturalar 24 saat içinde sona erer. Referans kuru alınamazsa, oluşturma FX_UNAVAILABLE ile başarısız olur; uydurulmuş veya bayat yedek kur kullanılmaz. Sahip yanıt tutarı ve kotasyonlar USD muhasebe para birimini kullanır. quotes[method].settlement, yerel tahsil kotasyonunu içerir. Genel ödeme sayfası, seçilen tahsil para birimini currency içinde, orijinal fiyatı baseAmountMinor/baseCurrency içinde ve referans kurunu fx içinde gösterir. Bir ödeme gönderildikten sonra yöntemi değiştirilemez; bir faturanın tek ağ geçidi işlemi vardır.
Amaçlanan mağaza içinde bir API anahtarı oluşturun ve sunucunuzdan Authorization: Bearer <key> gönderin. Mağaza bağlaması değişmezdir; X-Kevmi-Store, anahtara başka bir mağazaya erişim izni veremez. Tarayıcı oturumları X-Kevmi-Store: <storeId> seçer; atlanırsa ilk mağaza seçilir. all değeri yalnızca GET /api/account/dashboard ve GET /api/payment-links tarafından kabul edilir. Değişiklikler seçili bir mağaza, Origin ve X-CSRF-Token gerektirir. Hesap kimlikleri ve mağaza kimlikleri farklı tanımlayıcılardır.
Uyumluluk için, pricingMode="universal" içermeyen API istekleri yerel fiyatlandırmayı ve orijinal para birimi kısıtlamalarını korur. Mevcut faturalar asla yeniden hesaplanmaz. Analizlerdeki onaylanmış tahsilatlar, doğrulanmış ödemelerden kaydedilmiş fatura giderlerinin düşülmesiyle elde edilir; bunlar çekilebilir bakiye değildir. Eski fatura para birimleri ayrı kalır ve ödemeler destek ile düzenlenir. Bir siparişi yalnızca sunucu API'si, olay geçmişi veya imzalı bir webhook üzerinden payment.fulfillmentReady=true ve payment.status="succeeded" durumunu kontrol ettikten sonra yerine getirin.
{
"pricingMode": "universal",
"title": "Order 1042",
"amountMinor": 1000,
"currency": "USD",
"methods": [
"card",
"alipay",
"sbp",
"crypto"
],
"vatCustomerPercent": 100,
"feeCustomerPercent": 0
}API uç noktaları #
Alanlarını, yetkilendirmesini ve yanıtlarını görmek için bir uç nokta açın. Bu şemalar, genel URL'de bulunan aynı OpenAPI belgesini kullanır.
Service
Genel hizmet durumu.
GET/api/config
Güncel entegrasyon hazırlığı
Kullanıcı oturumu gerekmez
Yanıtlar
200Sırlar olmadan yapılandırma.
telegramobjectzorunlusupportobjectzorunlugatewayobjectzorunlucapabilitiesobjectzorunlu503Bir entegrasyon veya depolama kullanılamıyor, bir olay işleniyor veya hizmet kullanılamıyor.
errorobjectzorunluGET/api/health
API ve D1 tablo durumu
not_configured, status=ok değerine sahip olabilir: genel sayfalar ve arama, DB olmadan çalışabilir. Kullanılamayan tablolara sahip yapılandırılmış bir DB, 503/degraded döndürür. Bu yanıt, Telegram veya model ağ bağlantısını test etmez.
Kullanıcı oturumu gerekmez
Yanıtlar
200Depolama hazır veya not_configured.
telegramobjectzorunlusupportobjectzorunlugatewayobjectzorunlucapabilitiesobjectzorunlustatusok | degradedzorunlustorageready | not_configured | unavailablezorunlu503D1 kullanılamıyor veya beklenmeyen bir hizmet hatası oluştu.
Varyant 1
telegramobjectzorunlusupportobjectzorunlugatewayobjectzorunlucapabilitiesobjectzorunlustatusok | degradedzorunlustorageready | not_configured | unavailablezorunluVaryant 2
errorobjectzorunluGET/openapi.json
Herkese açık makine tarafından okunabilir sözleşme
Yalnızca okuma. Sırlar, oturumlar, kullanıcı kayıtları veya operasyonel ödeme sağlayıcısı sözleşmesi içermez.
Kullanıcı oturumu gerekmez
Yanıtlar
200Bu OpenAPI 3.1 belgesi.
object
POST/api/jobs/dispatch
Vadesi gelen teslimat ve başvuru işlerini çalıştır
Sunucu zamanlayıcı giriş noktası. JOBS_SECRET gerektirir, bir tarayıcı oturumu veya satıcı anahtarı değil. İş kimliklerini veya rastgele giden URL'leri kabul etmez.
Yetkilendirme, uç nokta kurallarına uyar
Yanıtlar
200Arka plan bağlamı olmadan tamamlandı.
object
202Arka plan yürütme bağlamında kabul edildi.
acceptedtruezorunlu401Geçerli oturum yok; webhook için geçersiz bir sır.
errorobjectzorunlu503Bir entegrasyon veya depolama kullanılamıyor, bir olay işleniyor veya hizmet kullanılamıyor.
errorobjectzorunluAuth
Kayıt ve giriş, doğrulanmış Telegram akışını paylaşır.
GET/api/auth/me
Geçerli oturum ve CSRF
Yetkilendirme, uç nokta kurallarına uyar
Yanıtlar
200Geçerli bir oturum olmadığında authenticated=false.
Varyant 1
authenticatedfalsezorunluVaryant 2
authenticatedtruezorunluuserobjectzorunlucsrfTokenstringzorunluexpiresAtintegerzorunluUnix zaman damgası, milisaniye cinsinden, UTC.
503Bir entegrasyon veya depolama kullanılamıyor, bir olay işleniyor veya hizmet kullanılamıyor.
errorobjectzorunluPOST/api/auth/telegram/start
Giriş veya kayıt başlat
300 saniyelik bir meydan okuma ve bir HttpOnly tarayıcı kanıtı çerezi oluşturur; karmalanmış adres başına dakikada en fazla altı başlatma. Web sitesindeki ve özel bot sohbetindeki altı haneli kodu karşılaştırın.
Kullanıcı oturumu gerekmez
Başlıklar ve parametreler
OriginheaderzorunluAPP_ORIGIN ile birebir eşleşmelidir. Sec-Fetch-Site: cross-site reddedilir. Sunucu CORS erişimi sağlamaz.
JSON gövdesi
Yanıtlar
201Giriş talebi oluşturuldu; kanıt çerezi bunu orijinal tarayıcıya bağlar.
challengeIdstringzorunlucodestringzorunluexpiresAtintegerzorunluUnix zaman damgası, milisaniye cinsinden, UTC.
telegramUrlstringzorunlu400Geçersiz JSON, bilinmeyen alan veya geçersiz değer.
errorobjectzorunlu403Origin, CSRF veya tarayıcı bağlama doğrulaması başarısız oldu.
errorobjectzorunlu413Gövde 16.384 baytı aşıyor; /api/support/ask ve Telegram webhook'u için sınır 65.536 bayttır.
errorobjectzorunlu415Content-Type: application/json gereklidir.
errorobjectzorunlu429Hız sınırı aşıldı.
errorobjectzorunlu503Bir entegrasyon veya depolama kullanılamıyor, bir olay işleniyor veya hizmet kullanılamıyor.
errorobjectzorunluPOST/api/auth/telegram/complete
Doğrulanmış bir girişi tamamla
Başlangıçtaki kanıt çerezi ve aynı tarayıcıyı gerektirir. Beklemede 202 döndürür. Bot onayından sonra istek, 24 saatlik bir oturum düzenler. Meydan okuma başına dakikada en fazla 90 kontrol. İstemci tarafından sağlanan bir Telegram kimliği kabul edilmez.
Yetkilendirme, uç nokta kurallarına uyar
Başlıklar ve parametreler
OriginheaderzorunluAPP_ORIGIN ile birebir eşleşmelidir. Sec-Fetch-Site: cross-site reddedilir. Sunucu CORS erişimi sağlamaz.
JSON gövdesi
challengeIdstringzorunluYanıtlar
200Hesap oluşturuldu veya güncellendi ve oturum düzenlendi.
status"authenticated"zorunluuserobjectzorunlucsrfTokenstringzorunluexpiresAtintegerzorunluUnix zaman damgası, milisaniye cinsinden, UTC.
202Telegram'da onay bekleniyor.
status"pending"zorunlu400Geçersiz JSON, bilinmeyen alan veya geçersiz değer.
errorobjectzorunlu403Origin, CSRF veya tarayıcı bağlama doğrulaması başarısız oldu.
errorobjectzorunlu409Giriş talebi kullanıldı veya iptal edildi, kimlik doğrulanmadı veya bir destek talebi çakışıyor.
errorobjectzorunlu410Beş dakikalık giriş talebi süresi doldu.
errorobjectzorunlu413Gövde 16.384 baytı aşıyor; /api/support/ask ve Telegram webhook'u için sınır 65.536 bayttır.
errorobjectzorunlu415Content-Type: application/json gereklidir.
errorobjectzorunlu429Hız sınırı aşıldı.
errorobjectzorunlu503Bir entegrasyon veya depolama kullanılamıyor, bir olay işleniyor veya hizmet kullanılamıyor.
errorobjectzorunluPOST/api/auth/logout
Geçerli oturumu sonlandır
Gövde gerekmez veya okunmaz. Botun /logout komutu ayrıca tüm hesap oturumlarını sonlandırır.
Yetkilendirme, uç nokta kurallarına uyar
Başlıklar ve parametreler
OriginheaderzorunluAPP_ORIGIN ile birebir eşleşmelidir. Sec-Fetch-Site: cross-site reddedilir. Sunucu CORS erişimi sağlamaz.
X-CSRF-TokenheaderzorunluGET /api/auth/me veya başarılı giriş tamamlamadan gelen geçerli oturum belirteci.
Yanıtlar
200Oturum silindi ve çerez temizlendi.
loggedOuttruezorunlu401Geçerli oturum yok; webhook için geçersiz bir sır.
errorobjectzorunlu403Origin, CSRF veya tarayıcı bağlama doğrulaması başarısız oldu.
errorobjectzorunlu503Bir entegrasyon veya depolama kullanılamıyor, bir olay işleniyor veya hizmet kullanılamıyor.
errorobjectzorunluAccount
Yalnızca geçerli kullanıcı için ayarlar.
GET/api/account/settings
Geçerli kullanıcı ayarları
Yetkilendirme, uç nokta kurallarına uyar
Başlıklar ve parametreler
X-Kevmi-StoreheaderTarayıcı oturumu için sahip olunan bir mağaza seçin. İlk mağazayı kullanmak için atlayın. API anahtarları bu başlığı yok sayar ve her zaman değişmez mağaza bağlamasını kullanır. all değeri salt okunurdur ve yalnızca gösterge paneli ve fatura listesi uç noktaları tarafından desteklenir.
Yanıtlar
200Geçerli kullanıcı profillerinin genel alanları.
userobjectzorunlu401Geçerli oturum yok; webhook için geçersiz bir sır.
errorobjectzorunlu503Bir entegrasyon veya depolama kullanılamıyor, bir olay işleniyor veya hizmet kullanılamıyor.
errorobjectzorunluPATCH/api/account/settings
Mağaza adını, KDV mükellefini veya bildirimleri değiştir
Tüm alanlar isteğe bağlıdır: kısmi yama. vatPayer kaydetmek finansal bir işlem oluşturmaz. Ödemeler ve ödeme anahtarları, kapı kullanılabilirliğini değil tercihleri kontrol eder.
Yetkilendirme, uç nokta kurallarına uyar
Başlıklar ve parametreler
OriginheaderzorunluAPP_ORIGIN ile birebir eşleşmelidir. Sec-Fetch-Site: cross-site reddedilir. Sunucu CORS erişimi sağlamaz.
X-CSRF-TokenheaderzorunluGET /api/auth/me veya başarılı giriş tamamlamadan gelen geçerli oturum belirteci.
X-Kevmi-StoreheaderTarayıcı oturumu için sahip olunan bir mağaza seçin. İlk mağazayı kullanmak için atlayın. API anahtarları bu başlığı yok sayar ve her zaman değişmez mağaza bağlamasını kullanır. all değeri salt okunurdur ve yalnızca gösterge paneli ve fatura listesi uç noktaları tarafından desteklenir.
JSON gövdesi
storeNamestringÇevreleyen boşluklar kırpılır. Kırpma sonrası uzunluk: 1–80 karakter. Sekmeler ve satır sonları dışındaki kontrol karakterleri yasaktır.
vatPayercustomer | merchantnotificationsobjectYanıtlar
200Profil güncellendi.
userobjectzorunlu400Geçersiz JSON, bilinmeyen alan veya geçersiz değer.
errorobjectzorunlu401Geçerli oturum yok; webhook için geçersiz bir sır.
errorobjectzorunlu403Origin, CSRF veya tarayıcı bağlama doğrulaması başarısız oldu.
errorobjectzorunlu413Gövde 16.384 baytı aşıyor; /api/support/ask ve Telegram webhook'u için sınır 65.536 bayttır.
errorobjectzorunlu415Content-Type: application/json gereklidir.
errorobjectzorunlu503Bir entegrasyon veya depolama kullanılamıyor, bir olay işleniyor veya hizmet kullanılamıyor.
errorobjectzorunluGET/api/stores
Geçerli hesabın sahip olduğu tüm mağazaları listele
Yetkilendirme, uç nokta kurallarına uyar
Yanıtlar
200Mağaza kimlikleri hesap kimliklerinden farklıdır. Hiçbir sır ifşa edilmez.
storesarray<object>zorunludefaultStoreIdstringzorunlu401Geçerli oturum yok; webhook için geçersiz bir sır.
errorobjectzorunlu503Bir entegrasyon veya depolama kullanılamıyor, bir olay işleniyor veya hizmet kullanılamıyor.
errorobjectzorunluPOST/api/stores
Ayrı bir mağaza oluştur
Hesap başına en fazla 100 mağaza ve hesap başına saatte 10 oluşturma. Yeni bir mağaza, ödeme başlatmadan önce kendi web sitesi onayına ihtiyaç duyar.
Yetkilendirme, uç nokta kurallarına uyar
Başlıklar ve parametreler
OriginheaderzorunluAPP_ORIGIN ile birebir eşleşmelidir. Sec-Fetch-Site: cross-site reddedilir. Sunucu CORS erişimi sağlamaz.
X-CSRF-TokenheaderzorunluGET /api/auth/me veya başarılı giriş tamamlamadan gelen geçerli oturum belirteci.
JSON gövdesi
namestringzorunluYanıtlar
201Oluşturuldu.
storeobjectzorunlu400Geçersiz JSON, bilinmeyen alan veya geçersiz değer.
errorobjectzorunlu401Geçerli oturum yok; webhook için geçersiz bir sır.
errorobjectzorunlu403Origin, CSRF veya tarayıcı bağlama doğrulaması başarısız oldu.
errorobjectzorunlu409Giriş talebi kullanıldı veya iptal edildi, kimlik doğrulanmadı veya bir destek talebi çakışıyor.
errorobjectzorunlu429Hız sınırı aşıldı.
errorobjectzorunlu503Bir entegrasyon veya depolama kullanılamıyor, bir olay işleniyor veya hizmet kullanılamıyor.
errorobjectzorunluPATCH/api/stores/{id}
Sahip olunan bir mağazayı yeniden adlandırın veya varsayılan KDV'sini değiştirin
Yetkilendirme, uç nokta kurallarına uyar
Başlıklar ve parametreler
idpathzorunluOriginheaderzorunluAPP_ORIGIN ile birebir eşleşmelidir. Sec-Fetch-Site: cross-site reddedilir. Sunucu CORS erişimi sağlamaz.
X-CSRF-TokenheaderzorunluGET /api/auth/me veya başarılı giriş tamamlamadan gelen geçerli oturum belirteci.
JSON gövdesi
namestringvatPayercustomer | merchantYanıtlar
200Mevcut fatura kotasyonları değişmez.
storeobjectzorunlu400Geçersiz JSON, bilinmeyen alan veya geçersiz değer.
errorobjectzorunlu401Geçerli oturum yok; webhook için geçersiz bir sır.
errorobjectzorunlu403Origin, CSRF veya tarayıcı bağlama doğrulaması başarısız oldu.
errorobjectzorunlu404Kayıt eksik, genel belirteç geçersiz veya istenen kayıt başka bir kullanıcıya ait.
errorobjectzorunlu503Bir entegrasyon veya depolama kullanılamıyor, bir olay işleniyor veya hizmet kullanılamıyor.
errorobjectzorunluGET/api/account/dashboard
Bir mağaza veya sahip olunan tüm mağazalar için doğrulanmış tahsilatları oku
Net tahsilatlar çekilebilir bir bakiye değildir. Eski para birimleri ayrı kalır. Toplamlar tüm zamanları kapsar; günlük/yöntem dökümleri istenen UTC dönemini kullanır.
Yetkilendirme, uç nokta kurallarına uyar
Başlıklar ve parametreler
X-Kevmi-StoreheaderTarayıcı oturumu için sahip olunan bir mağaza seçin. İlk mağazayı kullanmak için atlayın. API anahtarları bu başlığı yok sayar ve her zaman değişmez mağaza bağlamasını kullanır. all değeri salt okunurdur ve yalnızca gösterge paneli ve fatura listesi uç noktaları tarafından desteklenir.
daysqueryYanıtlar
200Salt okunur muhasebe özeti.
storeIdstring | nullzorunlustoresarray<object>zorunlutotalsarray<object>zorunludailyarray<object>zorunlumethodsarray<object>zorunludays7 | 30zorunlufromintegerzorunluUnix zaman damgası, milisaniye cinsinden, UTC.
generatedAtintegerzorunluUnix zaman damgası, milisaniye cinsinden, UTC.
accountingBasis"verified_receipts"zorunluwithdrawableBalancenullzorunlupayoutCreationAvailablefalsezorunlu400Geçersiz JSON, bilinmeyen alan veya geçersiz değer.
errorobjectzorunlu401Geçerli oturum yok; webhook için geçersiz bir sır.
errorobjectzorunlu404Kayıt eksik, genel belirteç geçersiz veya istenen kayıt başka bir kullanıcıya ait.
errorobjectzorunlu503Bir entegrasyon veya depolama kullanılamıyor, bir olay işleniyor veya hizmet kullanılamıyor.
errorobjectzorunluPayment links
Geçerli mağaza için sunucu faturaları. Fiyat, para birimi, KDV mükellefi, satıcı adı ve hesaplama değiştirilemez.
GET/api/payment-links
Sahip olunan ödeme bağlantılarını listele
createdAt DESC, id DESC ile sıralanır. Genel bağlantılar cihazlar arasında çalışır; listeleme bir hesap gerektirir.
Yetkilendirme, uç nokta kurallarına uyar
Başlıklar ve parametreler
limitquerycursorqueryÖnceki yanıttan nextCursor. Hizmet base64 JSON [createdAt,id] kullanır; URLSearchParams üzerinden değiştirilmeden iletin.
X-Kevmi-StoreheaderTarayıcı oturumu için sahip olunan bir mağaza seçin. İlk mağazayı kullanmak için atlayın. API anahtarları bu başlığı yok sayar ve her zaman değişmez mağaza bağlamasını kullanır. all değeri salt okunurdur ve yalnızca gösterge paneli ve fatura listesi uç noktaları tarafından desteklenir.
Yanıtlar
200Sahip olunan ödeme bağlantılarından oluşan bir sayfa.
linksarray<object>zorunlunextCursorstring | nullzorunluOpak sonraki sayfa imleci. URL kodlu bir sorgu parametresi olarak iletin; null sonu işaretler.
400Geçersiz JSON, bilinmeyen alan veya geçersiz değer.
errorobjectzorunlu401Geçerli oturum yok; webhook için geçersiz bir sır.
errorobjectzorunlu503Bir entegrasyon veya depolama kullanılamıyor, bir olay işleniyor veya hizmet kullanılamıyor.
errorobjectzorunluPOST/api/payment-links
Değişmez koşullarla bir fatura oluştur
Değişmez bir fatura oluştur ve hemen checkoutUrl al; bu alıcıyı ücretlendirmez. USD: kart/Alipay; RUB: SBP; USDT: kripto. USD kripto uyumluluk için kabul edilir ancak bir USDT faturası olmadan ödenemez. Ücret ve KDV müşteri payları 0'dan 100'e bağımsız tam sayılardır; mevcut canlı kart/Alipay, KDV müşteri=100 ve ücret müşteri=0 destekler. Müşteri toplamı asla sessizce değiştirilmez. En son web sitesi uygulaması yeni bir canlı ücretlendirmeden önce onaylanmalıdır. Fatura oluşturma ve tüccar olayı atomik olarak işlenir.
Yetkilendirme, uç nokta kurallarına uyar
Başlıklar ve parametreler
OriginheaderzorunluAPP_ORIGIN ile birebir eşleşmelidir. Sec-Fetch-Site: cross-site reddedilir. Sunucu CORS erişimi sağlamaz.
X-CSRF-TokenheaderzorunluGET /api/auth/me veya başarılı giriş tamamlamadan gelen geçerli oturum belirteci.
Idempotency-KeyheaderzorunluMantıksal istek başına bir anahtar. Aynı kurallı girdiyle tekrar, orijinal kaydı döndürür; aynı anahtarla farklı girdi 409 döndürür.
X-Kevmi-StoreheaderTarayıcı oturumu için sahip olunan bir mağaza seçin. İlk mağazayı kullanmak için atlayın. API anahtarları bu başlığı yok sayar ve her zaman değişmez mağaza bağlamasını kullanır. all değeri salt okunurdur ve yalnızca gösterge paneli ve fatura listesi uç noktaları tarafından desteklenir.
JSON gövdesi
Para birimi USD
titlestringzorunluÇevreleyen boşluklar kırpılır. Kırpmadan sonra uzunluk: 1-120 karakter. Sekmeler ve satır sonları dışındaki kontrol karakterleri yasaktır.
descriptionstringİsteğe bağlı; boş dizeye izin verilir. Kırpmadan sonra en fazla 500 karakter.
amountMinorintegerzorunluTeknik tamsayı sınırı, ticari sağlayıcı sınırı değil. Negatif satıcı kredisi reddedilir.
vatPayercustomer | merchantAtlandığında, mevcut mağazanın kuralı kaydedilir.
expiresAtintegerGelecekte bir zaman, oluşturmadan en fazla 90 gün sonra. Varsayılan yedi gündür. Fatura anlık görüntüsünde kaydedilir.
currency"USD"zorunlumethodsarray<card | alipay | crypto>zorunluYeni USD ödeme, kart ve Alipay destekler. USD kripto faturaları yalnızca uyumluluk için kabul edilir ve canlı ödemede crypto_requires_usdt döndürür; kripto için USDT kullanın.
vatCustomerPercentintegerMüşteri payı, tam yüzde olarak. 0, satıcının her şeyi karşıladığı anlamına gelir; 100, müşterinin her şeyi karşıladığı anlamına gelir. Varsayılan: mağazanın eski KDV tercihi.
feeCustomerPercentintegerMüşteri payı, tam yüzde olarak. 0, satıcının her şeyi karşıladığı anlamına gelir; 100, müşterinin her şeyi karşıladığı anlamına gelir.
orderIdstringAlıcının gördüğü sipariş referansı.
metadataobjectÖzel satıcı meta verileri. JSON serileştirmesinden sonra en fazla 3000 UTF-8 bayt. Herkese açık ödeme sayfasında asla gösterilmez.
pricingMode"native"Eski para birimine özgü fiyatlandırma. Mevcut entegrasyonlarla uyumluluk için atlayın.
Para birimi RUB
titlestringzorunluÇevreleyen boşluklar kırpılır. Kırpmadan sonra uzunluk: 1-120 karakter. Sekmeler ve satır sonları dışındaki kontrol karakterleri yasaktır.
descriptionstringİsteğe bağlı; boş dizeye izin verilir. Kırpmadan sonra en fazla 500 karakter.
amountMinorintegerzorunluTeknik tamsayı sınırı, ticari sağlayıcı sınırı değil. Negatif satıcı kredisi reddedilir.
vatPayercustomer | merchantAtlandığında, mevcut mağazanın kuralı kaydedilir.
expiresAtintegerGelecekte bir zaman, oluşturmadan en fazla 90 gün sonra. Varsayılan yedi gündür. Fatura anlık görüntüsünde kaydedilir.
currency"RUB"zorunlumethodsarray<"sbp">zorunluvatCustomerPercentintegerMüşteri payı, tam yüzde olarak. 0, satıcının her şeyi karşıladığı anlamına gelir; 100, müşterinin her şeyi karşıladığı anlamına gelir. Varsayılan: mağazanın eski KDV tercihi.
feeCustomerPercentintegerMüşteri payı, tam yüzde olarak. 0, satıcının her şeyi karşıladığı anlamına gelir; 100, müşterinin her şeyi karşıladığı anlamına gelir.
orderIdstringAlıcının gördüğü sipariş referansı.
metadataobjectÖzel satıcı meta verileri. JSON serileştirmesinden sonra en fazla 3000 UTF-8 bayt. Herkese açık ödeme sayfasında asla gösterilmez.
pricingMode"native"Eski para birimine özgü fiyatlandırma. Mevcut entegrasyonlarla uyumluluk için atlayın.
Para birimi USDT
titlestringzorunluÇevreleyen boşluklar kırpılır. Kırpmadan sonra uzunluk: 1-120 karakter. Sekmeler ve satır sonları dışındaki kontrol karakterleri yasaktır.
descriptionstringİsteğe bağlı; boş dizeye izin verilir. Kırpmadan sonra en fazla 500 karakter.
amountMinorintegerzorunluTeknik tamsayı sınırı, ticari sağlayıcı sınırı değil. Negatif satıcı kredisi reddedilir.
vatPayercustomer | merchantAtlandığında, mevcut mağazanın kuralı kaydedilir.
expiresAtintegerGelecekte bir zaman, oluşturmadan en fazla 90 gün sonra. Varsayılan yedi gündür. Fatura anlık görüntüsünde kaydedilir.
currency"USDT"zorunlumethodsarray<"crypto">zorunluvatCustomerPercentintegerMüşteri payı, tam yüzde olarak. 0, satıcının her şeyi karşıladığı anlamına gelir; 100, müşterinin her şeyi karşıladığı anlamına gelir. Varsayılan: mağazanın eski KDV tercihi.
feeCustomerPercentintegerMüşteri payı, tam yüzde olarak. 0, satıcının her şeyi karşıladığı anlamına gelir; 100, müşterinin her şeyi karşıladığı anlamına gelir.
orderIdstringAlıcının gördüğü sipariş referansı.
metadataobjectÖzel satıcı meta verileri. JSON serileştirmesinden sonra en fazla 3000 UTF-8 bayt. Herkese açık ödeme sayfasında asla gösterilmez.
pricingMode"native"Eski para birimine özgü fiyatlandırma. Mevcut entegrasyonlarla uyumluluk için atlayın.
Varyant 4
titlestringzorunluÇevreleyen boşluklar kırpılır. Kırpmadan sonra uzunluk: 1-120 karakter. Sekmeler ve satır sonları dışındaki kontrol karakterleri yasaktır.
descriptionstringİsteğe bağlı; boş dizeye izin verilir. Kırpmadan sonra en fazla 500 karakter.
amountMinorintegerzorunluTeknik tamsayı sınırı, ticari sağlayıcı sınırı değil. Negatif satıcı kredisi reddedilir.
vatPayercustomer | merchantAtlandığında, mevcut mağazanın kuralı kaydedilir.
expiresAtintegerGelecekte bir zaman, oluşturmadan en fazla 90 gün sonra. Varsayılan yedi gündür. Fatura anlık görüntüsünde kaydedilir.
currencyUSD | RUB | USDTzorunluGirdi birimi. RUB, kaydedilmiş referans kuru üzerinden USD'ye çevrilir; USDT açık 1:1 fatura kuralını kullanır. Kaydedilmiş fatura taban para birimi USD'dir.
methodsarray<card | alipay | sbp | crypto>zorunluvatCustomerPercentintegerMüşteri payı, tam yüzde olarak. 0, satıcının her şeyi karşıladığı anlamına gelir; 100, müşterinin her şeyi karşıladığı anlamına gelir. Varsayılan: mağazanın eski KDV tercihi.
feeCustomerPercentintegerMüşteri payı, tam yüzde olarak. 0, satıcının her şeyi karşıladığı anlamına gelir; 100, müşterinin her şeyi karşıladığı anlamına gelir.
orderIdstringAlıcının gördüğü sipariş referansı.
metadataobjectÖzel satıcı meta verileri. JSON serileştirmesinden sonra en fazla 3000 UTF-8 bayt. Herkese açık ödeme sayfasında asla gösterilmez.
pricingMode"universal"zorunluYanıtlar
200Idempotent tekrar; replayed=true.
linkobjectzorunlureplayedbooleanzorunlucheckoutUrlstringzorunluÖdeme bağlantısı hemen kullanılabilir; yoklama gerekmez.
201Fatura oluşturuldu; replayed=false.
linkobjectzorunlureplayedbooleanzorunlucheckoutUrlstringzorunluÖdeme bağlantısı hemen kullanılabilir; yoklama gerekmez.
400Geçersiz JSON, bilinmeyen alan veya geçersiz değer.
errorobjectzorunlu401Geçerli oturum yok; webhook için geçersiz bir sır.
errorobjectzorunlu403Origin, CSRF veya tarayıcı bağlama doğrulaması başarısız oldu.
errorobjectzorunlu409Giriş talebi kullanıldı veya iptal edildi, kimlik doğrulanmadı veya bir destek talebi çakışıyor.
errorobjectzorunlu413Gövde 16.384 baytı aşıyor; /api/support/ask ve Telegram webhook'u için sınır 65.536 bayttır.
errorobjectzorunlu415Content-Type: application/json gereklidir.
errorobjectzorunlu429Hız sınırı aşıldı.
errorobjectzorunlu503Bir entegrasyon veya depolama kullanılamıyor, bir olay işleniyor veya hizmet kullanılamıyor.
errorobjectzorunluGET/api/payment-links/{id}
Sahip olunan bağlantı ve kaydedilmiş hesaplama
Yetkilendirme, uç nokta kurallarına uyar
Başlıklar ve parametreler
idpathzorunluSahip olunan bağlantı tanımlayıcısı, genel belirteç değil.
X-Kevmi-StoreheaderTarayıcı oturumu için sahip olunan bir mağaza seçin. İlk mağazayı kullanmak için atlayın. API anahtarları bu başlığı yok sayar ve her zaman değişmez mağaza bağlamasını kullanır. all değeri salt okunurdur ve yalnızca gösterge paneli ve fatura listesi uç noktaları tarafından desteklenir.
Yanıtlar
200Başka bir kullanıcının kimliği ve eksik bir kimlik ikisi de 404 döndürür.
linkobjectzorunlucheckoutUrlstringDurum güncelleme yanıtlarına dahil edilir; iç içe bağlantı her zaman checkoutUrl'sini içerir.
401Geçerli oturum yok; webhook için geçersiz bir sır.
errorobjectzorunlu404Kayıt eksik, genel belirteç geçersiz veya istenen kayıt başka bir kullanıcıya ait.
errorobjectzorunlu503Bir entegrasyon veya depolama kullanılamıyor, bir olay işleniyor veya hizmet kullanılamıyor.
errorobjectzorunluPATCH/api/payment-links/{id}
Bir bağlantıyı duraklat, sürdür veya iptal et
Yalnızca durumu değiştirir. Güncelleme ve değişmez fatura updated olayı atomik olarak işlenir. Eşzamanlı değişiklikler bir sürüm kontrolü kullanır; LINK_CHANGED üzerinde yenileyin ve yeniden deneyin. cancelled terminaldir, süre sonu asla uzatılmaz ve fiyat, yöntemler, maliyet payları ve açıklama donmuş kalır. Kaydedilmiş durumun tekrarlanması geçerli faturayı döndürür.
Yetkilendirme, uç nokta kurallarına uyar
Başlıklar ve parametreler
idpathzorunluSahip olunan bağlantı tanımlayıcısı, genel belirteç değil.
OriginheaderzorunluAPP_ORIGIN ile birebir eşleşmelidir. Sec-Fetch-Site: cross-site reddedilir. Sunucu CORS erişimi sağlamaz.
X-CSRF-TokenheaderzorunluGET /api/auth/me veya başarılı giriş tamamlamadan gelen geçerli oturum belirteci.
X-Kevmi-StoreheaderTarayıcı oturumu için sahip olunan bir mağaza seçin. İlk mağazayı kullanmak için atlayın. API anahtarları bu başlığı yok sayar ve her zaman değişmez mağaza bağlamasını kullanır. all değeri salt okunurdur ve yalnızca gösterge paneli ve fatura listesi uç noktaları tarafından desteklenir.
JSON gövdesi
statusactive | paused | cancelledzorunluYanıtlar
200Sahip olunan bağlantının geçerli durumu.
linkobjectzorunlucheckoutUrlstringDurum güncelleme yanıtlarına dahil edilir; iç içe bağlantı her zaman checkoutUrl'sini içerir.
400Geçersiz JSON, bilinmeyen alan veya geçersiz değer.
errorobjectzorunlu401Geçerli oturum yok; webhook için geçersiz bir sır.
errorobjectzorunlu403Origin, CSRF veya tarayıcı bağlama doğrulaması başarısız oldu.
errorobjectzorunlu404Kayıt eksik, genel belirteç geçersiz veya istenen kayıt başka bir kullanıcıya ait.
errorobjectzorunlu409Giriş talebi kullanıldı veya iptal edildi, kimlik doğrulanmadı veya bir destek talebi çakışıyor.
errorobjectzorunlu413Gövde 16.384 baytı aşıyor; /api/support/ask ve Telegram webhook'u için sınır 65.536 bayttır.
errorobjectzorunlu415Content-Type: application/json gereklidir.
errorobjectzorunlu503Bir entegrasyon veya depolama kullanılamıyor, bir olay işleniyor veya hizmet kullanılamıyor.
errorobjectzorunluCheckout
Hesap olmadan bir fatura okuyun. Ödeme kullanılabilirliği ayrıca kontrol edilir.
GET/api/checkout/{token}
Müşteri için genel fatura ayrıntıları
Değişmez genel fatura teklifini ve kalıcı ödeme anlık görüntüsünü oku. method faturanın kaydedilmiş yöntemlerine ait olmalıdır. Hesap gerekmez. Sahip kimliğini, özel meta verileri veya tüccar gelirlerini açığa çıkarmaz. Belirteç yalnızca bu ödeme sayfasına erişim sağlar. availability yapılandırmayı, tahsisi, teknik sınırları ve tüccar onayını yansıtır; ödeme onayı ayrıdır.
Kullanıcı oturumu gerekmez
Başlıklar ve parametreler
tokenpathzorunluÖdeme sayfası URL'sinden rastgele genel tanımlayıcı. Yalnızca bu faturaya okuma erişimi verir.
methodqueryFaturanın kaydedilmiş yöntemlerinde mevcut olmalıdır.
Yanıtlar
200Genel fatura ve gönderilmişse mevcut ödeme.
invoiceobjectzorunlupaymentoneOfzorunlu400Geçersiz JSON, bilinmeyen alan veya geçersiz değer.
errorobjectzorunlu404Kayıt eksik, genel belirteç geçersiz veya istenen kayıt başka bir kullanıcıya ait.
errorobjectzorunlu429Hız sınırı aşıldı.
errorobjectzorunlu503Bir entegrasyon veya depolama kullanılamıyor, bir olay işleniyor veya hizmet kullanılamıyor.
errorobjectzorunluPOST/api/checkout/{token}/pay
Fatura ödemesini başlat veya kurtar
Aynı kaynaktan alıcı işlemi; hesap veya CSRF belirteci gerekmez. Sunucu, ağ geçidi gönderiminden önce bir işlem ve istikrarlı bir kimliksizlik anahtarı ayırır. Tekrar, aynı işlemi kurtarır; kaybolan bir yanıt durum üzerinden çözülmelidir. Ödeme yöntemi gönderimden sonra kilitlenir. Kart verileri, yeni bir ödeme niyetiyle tarayıcıda şifrelenmelidir. SBP/kripto, kayıtlı müşteri toplamını gönderir; kart/Alipay desteklenen değişmez vergi yapılandırmasını kullanır. Yeni ücretlendirmeler onaylanmış bir satıcı başvurusu gerektirir. Mevcut gönderilmiş ödemeler, fatura süresi dolduktan, duraklatıldıktan veya onay değişikliklerinden sonra kurtarılabilir. /v2 veya barındırılan kart yolu kullanılmaz.
Kullanıcı oturumu gerekmez
Başlıklar ve parametreler
tokenpathzorunluÖdeme sayfası URL'sinden rastgele genel tanımlayıcı. Yalnızca bu faturaya okuma erişimi verir.
OriginheaderzorunluAPP_ORIGIN ile birebir eşleşmelidir. Sec-Fetch-Site: cross-site reddedilir. Sunucu CORS erişimi sağlamaz.
JSON gövdesi
Varyant 1
method"card"zorunlusealedobjectzorunluVaryant 2
method"alipay"zorunlunamestringzorunlucountry"CN"zorunluemailstringVaryant 3
method"sbp"zorunluVaryant 4
method"crypto"zorunlupayerCurrencystringzorunlunetworkstringzorunluYanıtlar
200Mevcut işlem kurtarıldı; ikinci bir ödeme yapılmadı.
paymentoneOfzorunlureplayedboolean202İşlem gönderildi; tamamlama eşzamansızdır.
paymentoneOfzorunlureplayedboolean400Geçersiz JSON, bilinmeyen alan veya geçersiz değer.
errorobjectzorunlu403Origin, CSRF veya tarayıcı bağlama doğrulaması başarısız oldu.
errorobjectzorunlu404Kayıt eksik, genel belirteç geçersiz veya istenen kayıt başka bir kullanıcıya ait.
errorobjectzorunlu409Giriş talebi kullanıldı veya iptal edildi, kimlik doğrulanmadı veya bir destek talebi çakışıyor.
errorobjectzorunlu410Ağ geçidi şifreleme niyeti veya banka meydan okuması süresi doldu. Aynı işlem için yeni bir niyet edinin; değiştirme ödemesi oluşturmayın.
errorobjectzorunlu413Gövde 16.384 baytı aşıyor; /api/support/ask ve Telegram webhook'u için sınır 65.536 bayttır.
errorobjectzorunlu415Content-Type: application/json gereklidir.
errorobjectzorunlu429Hız sınırı aşıldı.
errorobjectzorunlu502Ağ geçidi yanıtı kullanılamıyor, hatalı veya doğrulanamıyor. Herhangi bir yeniden denemeden önce mevcut ödeme durumunu okuyun.
errorobjectzorunlu503Bir entegrasyon veya depolama kullanılamıyor, bir olay işleniyor veya hizmet kullanılamıyor.
errorobjectzorunluGET/api/checkout/{token}/status
Aynı ödemeyi oku ve yenile
Hesap gerekmez. Kimliği doğrulanmış ağ geçidi taşıması üzerinden mevcut bir işlemi sunucu tarafı hız sınırlamasıyla yeniler. Yeni ödeme oluşturulmaz. Hiçbir şey gönderilmediyse null döndürür. Yalnızca fulfillmentReady true olduğunda bir siparişi onaylayın.
Kullanıcı oturumu gerekmez
Başlıklar ve parametreler
tokenpathzorunluÖdeme sayfası URL'sinden rastgele genel tanımlayıcı. Yalnızca bu faturaya okuma erişimi verir.
Yanıtlar
200Geçerli temizlenmiş ödeme durumu.
paymentoneOfzorunlureplayedboolean400Geçersiz JSON, bilinmeyen alan veya geçersiz değer.
errorobjectzorunlu404Kayıt eksik, genel belirteç geçersiz veya istenen kayıt başka bir kullanıcıya ait.
errorobjectzorunlu429Hız sınırı aşıldı.
errorobjectzorunlu502Ağ geçidi yanıtı kullanılamıyor, hatalı veya doğrulanamıyor. Herhangi bir yeniden denemeden önce mevcut ödeme durumunu okuyun.
errorobjectzorunlu503Bir entegrasyon veya depolama kullanılamıyor, bir olay işleniyor veya hizmet kullanılamıyor.
errorobjectzorunluPOST/api/checkout/{token}/reconcile
Yetkili bir durum mutabakatı iste
Mevcut işlemi okur ve ağ geçidinden sağlayıcı durumunu mutabakat etmesini ister. Ödeme oluşturmaz. Fatura başına dakikada en fazla 3 istek. Fatura artık etkin olmasa bile zaten gönderilmiş ödemeler için kullanılabilir.
Kullanıcı oturumu gerekmez
Başlıklar ve parametreler
tokenpathzorunluÖdeme sayfası URL'sinden rastgele genel tanımlayıcı. Yalnızca bu faturaya okuma erişimi verir.
OriginheaderzorunluAPP_ORIGIN ile birebir eşleşmelidir. Sec-Fetch-Site: cross-site reddedilir. Sunucu CORS erişimi sağlamaz.
JSON gövdesi
Yanıtlar
200Mutabakat edilmiş ödeme veya null.
paymentoneOfzorunlureplayedboolean400Geçersiz JSON, bilinmeyen alan veya geçersiz değer.
errorobjectzorunlu403Origin, CSRF veya tarayıcı bağlama doğrulaması başarısız oldu.
errorobjectzorunlu404Kayıt eksik, genel belirteç geçersiz veya istenen kayıt başka bir kullanıcıya ait.
errorobjectzorunlu409Giriş talebi kullanıldı veya iptal edildi, kimlik doğrulanmadı veya bir destek talebi çakışıyor.
errorobjectzorunlu410Ağ geçidi şifreleme niyeti veya banka meydan okuması süresi doldu. Aynı işlem için yeni bir niyet edinin; değiştirme ödemesi oluşturmayın.
errorobjectzorunlu413Gövde 16.384 baytı aşıyor; /api/support/ask ve Telegram webhook'u için sınır 65.536 bayttır.
errorobjectzorunlu415Content-Type: application/json gereklidir.
errorobjectzorunlu429Hız sınırı aşıldı.
errorobjectzorunlu502Ağ geçidi yanıtı kullanılamıyor, hatalı veya doğrulanamıyor. Herhangi bir yeniden denemeden önce mevcut ödeme durumunu okuyun.
errorobjectzorunlu503Bir entegrasyon veya depolama kullanılamıyor, bir olay işleniyor veya hizmet kullanılamıyor.
errorobjectzorunluPOST/api/checkout/{token}/card-intent
Ağ geçidi genel anahtarı ve bağlı bir şifreleme niyeti edin
Özel anahtar yalnızca ağ geçidine aittir. Bir niyet beş dakika içinde sona erer ve satıcı siparişini, para birimini, taban/toplam tutarları, işlem kimlik gücü anahtarını ve amacı bağlar. Ödeme niyetleri etkin bir fatura ve onaylanmış satıcı gerektirir; kod niyetleri mevcut, güncel bir banka sorunu gerektirir. Bu uç nokta PAN, CVV, banka kodu veya özel JWK alanlarını kabul etmez. Fatura başına en fazla 8 niyet ve istemci başına dakikada 12. Şifrelenmiş düz metin, ödeme için {intent,name,country,email?,card:{number,expiration,cvv,holder}} veya kod için {intent,code} biçimindedir. Düz metin yalnızca tarayıcı içinde JWE şifrelemesinden önce birleştirilir.
Kullanıcı oturumu gerekmez
Başlıklar ve parametreler
tokenpathzorunluÖdeme sayfası URL'sinden rastgele genel tanımlayıcı. Yalnızca bu faturaya okuma erişimi verir.
OriginheaderzorunluAPP_ORIGIN ile birebir eşleşmelidir. Sec-Fetch-Site: cross-site reddedilir. Sunucu CORS erişimi sağlamaz.
JSON gövdesi
purposepayment | codeYanıtlar
200Yalnızca kısa ömürlü niyet ve genel RSA anahtarı.
intentstringzorunluintentIdstringzorunluexpiresAtintegerzorunluUnix zaman damgası, milisaniye cinsinden, UTC.
keyobjectzorunlualgorithm"RSA-OAEP-256"zorunluencryption"A256GCM"zorunluprotocol"kevmi-card-v1"zorunlu400Geçersiz JSON, bilinmeyen alan veya geçersiz değer.
errorobjectzorunlu403Origin, CSRF veya tarayıcı bağlama doğrulaması başarısız oldu.
errorobjectzorunlu404Kayıt eksik, genel belirteç geçersiz veya istenen kayıt başka bir kullanıcıya ait.
errorobjectzorunlu409Giriş talebi kullanıldı veya iptal edildi, kimlik doğrulanmadı veya bir destek talebi çakışıyor.
errorobjectzorunlu410Ağ geçidi şifreleme niyeti veya banka meydan okuması süresi doldu. Aynı işlem için yeni bir niyet edinin; değiştirme ödemesi oluşturmayın.
errorobjectzorunlu413Gövde 16.384 baytı aşıyor; /api/support/ask ve Telegram webhook'u için sınır 65.536 bayttır.
errorobjectzorunlu415Content-Type: application/json gereklidir.
errorobjectzorunlu429Hız sınırı aşıldı.
errorobjectzorunlu502Ağ geçidi yanıtı kullanılamıyor, hatalı veya doğrulanamıyor. Herhangi bir yeniden denemeden önce mevcut ödeme durumunu okuyun.
errorobjectzorunlu503Bir entegrasyon veya depolama kullanılamıyor, bir olay işleniyor veya hizmet kullanılamıyor.
errorobjectzorunluPOST/api/checkout/{token}/code
Geçerli banka sorunu için şifrelenmiş bir kodu ilet
Amaç=code olan bir niyet edinin ve tarayıcıda {intent,code} şifreleyin. Ağ geçidi geçerli sorunu doğrular ve mühürlü niyeti bir kez tüketir. Kevmi düz metin kodu asla almaz. Fatura başına dakikada en fazla 5 gönderim; belirsiz bir yanıttan sonra durumu yenileyin.
Kullanıcı oturumu gerekmez
Başlıklar ve parametreler
tokenpathzorunluÖdeme sayfası URL'sinden rastgele genel tanımlayıcı. Yalnızca bu faturaya okuma erişimi verir.
OriginheaderzorunluAPP_ORIGIN ile birebir eşleşmelidir. Sec-Fetch-Site: cross-site reddedilir. Sunucu CORS erişimi sağlamaz.
JSON gövdesi
sealedobjectzorunluYanıtlar
202Kod gönderildi; geçerli ödeme durumu.
paymentoneOfzorunlureplayedboolean400Geçersiz JSON, bilinmeyen alan veya geçersiz değer.
errorobjectzorunlu403Origin, CSRF veya tarayıcı bağlama doğrulaması başarısız oldu.
errorobjectzorunlu404Kayıt eksik, genel belirteç geçersiz veya istenen kayıt başka bir kullanıcıya ait.
errorobjectzorunlu409Giriş talebi kullanıldı veya iptal edildi, kimlik doğrulanmadı veya bir destek talebi çakışıyor.
errorobjectzorunlu410Ağ geçidi şifreleme niyeti veya banka meydan okuması süresi doldu. Aynı işlem için yeni bir niyet edinin; değiştirme ödemesi oluşturmayın.
errorobjectzorunlu413Gövde 16.384 baytı aşıyor; /api/support/ask ve Telegram webhook'u için sınır 65.536 bayttır.
errorobjectzorunlu415Content-Type: application/json gereklidir.
errorobjectzorunlu429Hız sınırı aşıldı.
errorobjectzorunlu502Ağ geçidi yanıtı kullanılamıyor, hatalı veya doğrulanamıyor. Herhangi bir yeniden denemeden önce mevcut ödeme durumunu okuyun.
errorobjectzorunlu503Bir entegrasyon veya depolama kullanılamıyor, bir olay işleniyor veya hizmet kullanılamıyor.
errorobjectzorunluGET/api/checkout/{token}/crypto-services
Geçerli madeni para ve ağ kataloğunu oku
Yalnızca kripto paralara izin veren bir USDT faturası için. Fatura USDT cinsinden kalır; ağ geçidi seçilen ödeyici madeni parasını fiyatlar. USD'nin USDT'ye eşit olduğunu asla varsaymayın veya transfer tutarını kayan noktalı bir sayıya dönüştürmeyin. Fatura başına dakikada en fazla 10 katalog okuması.
Kullanıcı oturumu gerekmez
Başlıklar ve parametreler
tokenpathzorunluÖdeme sayfası URL'sinden rastgele genel tanımlayıcı. Yalnızca bu faturaya okuma erişimi verir.
Yanıtlar
200Ağ geçidi tarafından sağlanan katalog, güncel kullanılabilirlik ve transfer limitleriyle.
servicesarray<object>zorunlufetchedAtintegerzorunluUnix zaman damgası, milisaniye cinsinden, UTC.
400Geçersiz JSON, bilinmeyen alan veya geçersiz değer.
errorobjectzorunlu404Kayıt eksik, genel belirteç geçersiz veya istenen kayıt başka bir kullanıcıya ait.
errorobjectzorunlu429Hız sınırı aşıldı.
errorobjectzorunlu502Ağ geçidi yanıtı kullanılamıyor, hatalı veya doğrulanamıyor. Herhangi bir yeniden denemeden önce mevcut ödeme durumunu okuyun.
errorobjectzorunlu503Bir entegrasyon veya depolama kullanılamıyor, bir olay işleniyor veya hizmet kullanılamıyor.
errorobjectzorunluSupport
Genel bilgi tabanı ve geçerli kullanıcının destek talepleri.
POST/api/support/ask
Eksiksiz genel bilgi tabanından yanıt
Oturum veya CSRF olmadan herkese açık soru. Sağlanan Origin, APP_ORIGIN ile eşleşmelidir; aracılar bunu atlayabilir. AI modunda sunucu tüm yayınlanmış makaleleri, gerçekleri, sayfa kataloğunu ve özellik hazırlığını gönderir. İsteğe bağlı geçmiş ve pageContext güvenilmeyen soru bağlamıdır. Model hesaplara, paraya, özel isteklere veya araçlara erişemez. D1 ile, karmalanmış adres başına dakikada 12 soru sınırı vardır. AI, D1, geçerli sağlayıcı yapılandırması ve kota gerektirir: varsayılan olarak hizmet genelinde saatte 60 üretim. Yapılandırma hazırlığı harici API kullanılabilirliğini kanıtlamaz. Sağlayıcı hataları, kota tükenmesi veya geçersiz çıktı, aiUnavailable=true ve HTTP 200 ile normal arama döndürür. Üretim yapılandırması olmadan, normal arama döndürülür.
Kullanıcı oturumu gerekmez
Başlıklar ve parametreler
OriginheaderAPP_ORIGIN ile birebir eşleşmelidir. Sec-Fetch-Site: cross-site reddedilir. Sunucu CORS erişimi sağlamaz.
JSON gövdesi
questionstringzorunluÇevreleyen boşluklar kırpılır. Kırpma sonrası uzunluk: 2–2.000 karakter. Sekmeler ve satır sonları dışındaki kontrol karakterleri yasaktır.
localeru | en | es | de | fr | pt | tr | kkYanıt dili. Atlanırsa desteklenen Accept-Language tercihleri kullanılır; aksi takdirde İngilizce. Dokümantasyon desteklenen her arayüz dilinde mevcuttur.
historyarray<oneOf>En fazla son üç soru-cevap çifti. İsteğe bağlı. Güvenilmeyen bağlam, sağlayıcı sistem rolü mesajları değil.
pageContextstringKırpma sonrası kısa bölüm etiketi, 1–80 karakter. Harflere, rakamlara, boşluklara ve ·.,—–-(): izin verir. Satır sonları, URL'ler, sorgu parametreleri ve HTML yasaktır. Belirteçler veya sırlar eklemeyin.
Yanıtlar
200Doğrulanmış makale bağlantılarıyla bir yanıt veya eşleşen belgeler.
Varyant 1
mode"search"zorunluanswerstringzorunlusourcesarray<object>zorunluknowledgeVersionstring | nullzorunluneedsHumanbooleanzorunluaiUnavailabletrueVaryant 2
mode"ai"zorunluanswerstringzorunluYalnızca düz metin; URL'ler ve HTML reddedilir. Bağlantılar yalnızca kaynaklarda döndürülür.
sourcesarray<object>zorunluknowledgeVersionstringzorunluneedsHumanbooleanzorunlu400Geçersiz JSON, bilinmeyen alan veya geçersiz değer.
errorobjectzorunlu403Origin, CSRF veya tarayıcı bağlama doğrulaması başarısız oldu.
errorobjectzorunlu413Gövde 16.384 baytı aşıyor; /api/support/ask ve Telegram webhook'u için sınır 65.536 bayttır.
errorobjectzorunlu415Content-Type: application/json gereklidir.
errorobjectzorunlu429Hız sınırı aşıldı.
errorobjectzorunlu503Bir entegrasyon veya depolama kullanılamıyor, bir olay işleniyor veya hizmet kullanılamıyor.
errorobjectzorunluGET/api/support/tickets
Sahip olunan destek isteklerinin son 30'u
Yetkilendirme, uç nokta kurallarına uyar
Yanıtlar
200createdAt'e göre en yenisi önce; son 30 kaydı döndürür.
ticketsarray<object>zorunlu401Geçerli oturum yok; webhook için geçersiz bir sır.
errorobjectzorunlu503Bir entegrasyon veya depolama kullanılamıyor, bir olay işleniyor veya hizmet kullanılamıyor.
errorobjectzorunluPOST/api/support/tickets
Bir destek isteği kaydet
Kullanıcı başına saatte en fazla altı istek, web sitesi ve bot tarafından paylaşılır. Kaydetme bir hesap kaydı oluşturur. Durumu sormak için referansını saklayın.
Yetkilendirme, uç nokta kurallarına uyar
Başlıklar ve parametreler
OriginheaderzorunluAPP_ORIGIN ile birebir eşleşmelidir. Sec-Fetch-Site: cross-site reddedilir. Sunucu CORS erişimi sağlamaz.
X-CSRF-TokenheaderzorunluGET /api/auth/me veya başarılı giriş tamamlamadan gelen geçerli oturum belirteci.
JSON gövdesi
subjectstringzorunluÇevreleyen boşluklar kırpılır. Kırpmadan sonra uzunluk: 1-120 karakter. Sekmeler ve satır sonları dışındaki kontrol karakterleri yasaktır.
messagestringzorunluÇevreleyen boşluklar kırpılır. Kırpmadan sonra uzunluk: 5-4.000 karakter. Sekmeler ve satır sonları dışındaki kontrol karakterleri yasaktır.
Yanıtlar
201Destek isteği kaydedildi.
ticketobjectzorunlu400Geçersiz JSON, bilinmeyen alan veya geçersiz değer.
errorobjectzorunlu401Geçerli oturum yok; webhook için geçersiz bir sır.
errorobjectzorunlu403Origin, CSRF veya tarayıcı bağlama doğrulaması başarısız oldu.
errorobjectzorunlu409Giriş talebi kullanıldı veya iptal edildi, kimlik doğrulanmadı veya bir destek talebi çakışıyor.
errorobjectzorunlu413Gövde 16.384 baytı aşıyor; /api/support/ask ve Telegram webhook'u için sınır 65.536 bayttır.
errorobjectzorunlu415Content-Type: application/json gereklidir.
errorobjectzorunlu429Hız sınırı aşıldı.
errorobjectzorunlu503Bir entegrasyon veya depolama kullanılamıyor, bir olay işleniyor veya hizmet kullanılamıyor.
errorobjectzorunluGET/api/support/tickets/{id}
Sahip olunan bir destek isteğini oku
Yetkilendirme, uç nokta kurallarına uyar
Başlıklar ve parametreler
idpathzorunluSahip olunan bir destek isteğinin tanımlayıcısı.
Yanıtlar
200Başka bir kullanıcının isteği ve eksik bir istek ikisi de 404 döndürür.
ticketobjectzorunlu401Geçerli oturum yok; webhook için geçersiz bir sır.
errorobjectzorunlu404Kayıt eksik, genel belirteç geçersiz veya istenen kayıt başka bir kullanıcıya ait.
errorobjectzorunlu503Bir entegrasyon veya depolama kullanılamıyor, bir olay işleniyor veya hizmet kullanılamıyor.
errorobjectzorunluPATCH/api/support/tickets/{id}
Sahip olunan bir destek isteğini kapat
İzin verilen tek değişiklik status=closed'dır. Bu API istekleri yeniden açmaz, mesajları düzenlemez veya operatör yanıtları göndermez.
Yetkilendirme, uç nokta kurallarına uyar
Başlıklar ve parametreler
idpathzorunluSahip olunan bir destek isteğinin tanımlayıcısı.
OriginheaderzorunluAPP_ORIGIN ile birebir eşleşmelidir. Sec-Fetch-Site: cross-site reddedilir. Sunucu CORS erişimi sağlamaz.
X-CSRF-TokenheaderzorunluGET /api/auth/me veya başarılı giriş tamamlamadan gelen geçerli oturum belirteci.
JSON gövdesi
status"closed"zorunluYanıtlar
200Destek isteği kapatıldı.
closedtruezorunlu400Geçersiz JSON, bilinmeyen alan veya geçersiz değer.
errorobjectzorunlu401Geçerli oturum yok; webhook için geçersiz bir sır.
errorobjectzorunlu403Origin, CSRF veya tarayıcı bağlama doğrulaması başarısız oldu.
errorobjectzorunlu404Kayıt eksik, genel belirteç geçersiz veya istenen kayıt başka bir kullanıcıya ait.
errorobjectzorunlu413Gövde 16.384 baytı aşıyor; /api/support/ask ve Telegram webhook'u için sınır 65.536 bayttır.
errorobjectzorunlu415Content-Type: application/json gereklidir.
errorobjectzorunlu503Bir entegrasyon veya depolama kullanılamıyor, bir olay işleniyor veya hizmet kullanılamıyor.
errorobjectzorunluNotifications
Hesap olay merkezi, web sitesi okuma durumu ve bağımsız Telegram teslimat durumu.
GET/api/notifications
Sahip olunan bildirimlerden oluşan bir sayfa
En fazla 30 kayıt, createdAt DESC ardından id DESC ile sıralanır. Listeleme readAt'i değiştirmez veya teslimatı tetiklemez. unreadCount, geçerli kullanıcının sayfalar genelinde toplam okunmamış sayısıdır. Sahip alanları, Telegram kimliği ve sırlar hariç tutulur.
Yetkilendirme, uç nokta kurallarına uyar
Başlıklar ve parametreler
unreadquery1 yalnızca okunmamışları seçer; 0 veya atlanmış bir değer tüm olayları seçer.
cursorqueryÖnceki yanıttan nextCursor. URLSearchParams üzerinden değiştirilmeden iletin; biçim createdAt:id, createdAt milisaniye cinsinden güvenli bir tam sayı olarak.
Yanıtlar
200Bağımsız okuma ve teslimat durumlarına sahip olaylar.
notificationsarray<object>zorunluunreadCountintegerzorunlunextCursorstring | nullzorunluSonraki sayfa imleci; başka kayıt kalmadıysa null.
400Geçersiz JSON, bilinmeyen alan veya geçersiz değer.
errorobjectzorunlu401Geçerli oturum yok; webhook için geçersiz bir sır.
errorobjectzorunlu503Bir entegrasyon veya depolama kullanılamıyor, bir olay işleniyor veya hizmet kullanılamıyor.
errorobjectzorunluPATCH/api/notifications/read
Sahip olunan bildirimleri okunmuş olarak işaretle
Ya ids kabul eder ya da before ile birlikte all:true. before, son gözlemlenen olayın zamanıdır ve sunucu saatini aşamaz. Daha yeni olaylar okunmamış kalır. İstek idempotenttir: mevcut readAt değerleri değişmez. Diğer kullanıcıların ve eksik kimlikler ne değiştirilir ne de açıklanır. Telegram durumu ve sentAt değişmeden kalır.
Yetkilendirme, uç nokta kurallarına uyar
Başlıklar ve parametreler
OriginheaderzorunluAPP_ORIGIN ile birebir eşleşmelidir. Sec-Fetch-Site: cross-site reddedilir. Sunucu CORS erişimi sağlamaz.
X-CSRF-TokenheaderzorunluGET /api/auth/me veya başarılı giriş tamamlamadan gelen geçerli oturum belirteci.
JSON gövdesi
Varyant 1
idsarray<string>zorunluYinelenenlere izin verilir ve bir kez sayılır.
Varyant 2
alltruezorunlubeforeintegerzorunluGörüntülenen son olayın createdAt değeri. Sunucu ayrıca before <= Date.now() olmasını gerektirir.
Yanıtlar
200Yeni okunan olayların sayısı, işlem süresi ve geçerli okunmamış sayı.
updatedintegerzorunlureadAtintegerzorunluUnix zaman damgası, milisaniye cinsinden, UTC.
unreadCountintegerzorunlu400Geçersiz JSON, bilinmeyen alan veya geçersiz değer.
errorobjectzorunlu401Geçerli oturum yok; webhook için geçersiz bir sır.
errorobjectzorunlu403Origin, CSRF veya tarayıcı bağlama doğrulaması başarısız oldu.
errorobjectzorunlu413Gövde 16.384 baytı aşıyor; /api/support/ask ve Telegram webhook'u için sınır 65.536 bayttır.
errorobjectzorunlu415Content-Type: application/json gereklidir.
errorobjectzorunlu503Bir entegrasyon veya depolama kullanılamıyor, bir olay işleniyor veya hizmet kullanılamıyor.
errorobjectzorunluPOST/api/notifications/test
Hesabın Telegram'ına bir test bildirimi gönder
Bir mesajı sıraya alır ve teslimat dener. Kullanıcı başına saatte en fazla üç. Test bir ödeme bildirimi değildir ve bakiyeyi değiştirmez. HTTP 202 teslimatı onaylamaz; bildirim listesini kontrol edin.
Yetkilendirme, uç nokta kurallarına uyar
Başlıklar ve parametreler
OriginheaderzorunluAPP_ORIGIN ile birebir eşleşmelidir. Sec-Fetch-Site: cross-site reddedilir. Sunucu CORS erişimi sağlamaz.
X-CSRF-TokenheaderzorunluGET /api/auth/me veya başarılı giriş tamamlamadan gelen geçerli oturum belirteci.
JSON gövdesi
Yanıtlar
202Sıraya alma sonucu.
queuedbooleanzorunluidstring | null400Geçersiz JSON, bilinmeyen alan veya geçersiz değer.
errorobjectzorunlu401Geçerli oturum yok; webhook için geçersiz bir sır.
errorobjectzorunlu403Origin, CSRF veya tarayıcı bağlama doğrulaması başarısız oldu.
errorobjectzorunlu413Gövde 16.384 baytı aşıyor; /api/support/ask ve Telegram webhook'u için sınır 65.536 bayttır.
errorobjectzorunlu415Content-Type: application/json gereklidir.
errorobjectzorunlu429Hız sınırı aşıldı.
errorobjectzorunlu503Bir entegrasyon veya depolama kullanılamıyor, bir olay işleniyor veya hizmet kullanılamıyor.
errorobjectzorunluTelegram
Bot webhook'u; ödeme webhook'u değil.
POST/api/telegram/webhook
Bir Telegram Bot API olayı al
Yalnızca Telegram gizli üstbilgisini gerektirir, oturum, CSRF veya Origin olmadan. Ek Update alanlarına izin verilir. message ve callback_query'i işler; kişisel eylemler doğrulanmış gönderenin özel sohbetini gerektirir. Diğer güncellemeler atlanır. update_id yinelenenleri kaldırır; devam eden bir güncelleme yeniden deneme için 503 döndürür. Bu bir ödeme sağlayıcısı webhook'u değildir.
Yetkilendirme, uç nokta kurallarına uyar
JSON gövdesi
update_idintegerzorunlumessageobjectTelegram Mesajı: işleyici message_id, text, from ve chat kullanır.
callback_queryobjectTelegram CallbackQuery: işleyici id, from, data ve message.chat kullanır.
Yanıtlar
200İşlendi, atlandı veya zaten ele alındı.
oktruezorunlu400Geçersiz JSON, bilinmeyen alan veya geçersiz değer.
errorobjectzorunlu401Geçerli oturum yok; webhook için geçersiz bir sır.
errorobjectzorunlu413Gövde 16.384 baytı aşıyor; /api/support/ask ve Telegram webhook'u için sınır 65.536 bayttır.
errorobjectzorunlu415Content-Type: application/json gereklidir.
errorobjectzorunlu429Hız sınırı aşıldı.
errorobjectzorunlu502Telegram isteği başarısız oldu.
errorobjectzorunlu503Bir entegrasyon veya depolama kullanılamıyor, bir olay işleniyor veya hizmet kullanılamıyor.
errorobjectzorunluDesteklenmeyen para yolları
Desteklenmeyen eski para yolları ve ödeme yürütmesi. Genel ödeme akışının kendi belgelenmiş uç noktaları vardır.
POST/api/payments
Finansal işlem kullanılamıyor
503 GATEWAY_NOT_CONNECTED döndürür. Finansal işlemler kullanılamıyor. Gövde işlenmez ve ağ geçidi isteği yapılmaz.
Kullanıcı oturumu gerekmez
Yanıtlar
503Finansal işlemler kullanılamıyor.
errorobjectzorunluPOST/api/payouts
Finansal işlem kullanılamıyor
503 GATEWAY_NOT_CONNECTED döndürür. Finansal işlemler kullanılamıyor. Gövde işlenmez ve ağ geçidi isteği yapılmaz.
Kullanıcı oturumu gerekmez
Yanıtlar
503Finansal işlemler kullanılamıyor.
errorobjectzorunluMerchant API
Kapsamlı sunucudan sunucuya faturalar ve değiştirilemez olay geçmişi.
GET/api/v1/payments
Sahip olunan ödeme bağlantılarını listele
createdAt DESC, id DESC ile sıralanır. Genel bağlantılar cihazlar arasında çalışır; listeleme bir hesap gerektirir.
Yetkilendirme, uç nokta kurallarına uyar
Başlıklar ve parametreler
limitquerycursorqueryÖnceki yanıttan nextCursor. Hizmet base64 JSON [createdAt,id] kullanır; URLSearchParams üzerinden değiştirilmeden iletin.
Yanıtlar
200Sahip olunan ödeme bağlantılarından oluşan bir sayfa.
linksarray<object>zorunlunextCursorstring | nullzorunluOpak sonraki sayfa imleci. URL kodlu bir sorgu parametresi olarak iletin; null sonu işaretler.
400Geçersiz JSON, bilinmeyen alan veya geçersiz değer.
errorobjectzorunlu401Geçerli oturum yok; webhook için geçersiz bir sır.
errorobjectzorunlu503Bir entegrasyon veya depolama kullanılamıyor, bir olay işleniyor veya hizmet kullanılamıyor.
errorobjectzorunluPOST/api/v1/payments
Değişmez koşullarla bir fatura oluştur
Değişmez bir fatura oluştur ve hemen checkoutUrl al; bu alıcıyı ücretlendirmez. USD: kart/Alipay; RUB: SBP; USDT: kripto. USD kripto uyumluluk için kabul edilir ancak bir USDT faturası olmadan ödenemez. Ücret ve KDV müşteri payları 0'dan 100'e bağımsız tam sayılardır; mevcut canlı kart/Alipay, KDV müşteri=100 ve ücret müşteri=0 destekler. Müşteri toplamı asla sessizce değiştirilmez. En son web sitesi uygulaması yeni bir canlı ücretlendirmeden önce onaylanmalıdır. Fatura oluşturma ve tüccar olayı atomik olarak işlenir.
Yetkilendirme, uç nokta kurallarına uyar
Başlıklar ve parametreler
Idempotency-KeyheaderzorunluMantıksal istek başına bir anahtar. Aynı kurallı girdiyle tekrar, orijinal kaydı döndürür; aynı anahtarla farklı girdi 409 döndürür.
JSON gövdesi
Para birimi USD
titlestringzorunluÇevreleyen boşluklar kırpılır. Kırpmadan sonra uzunluk: 1-120 karakter. Sekmeler ve satır sonları dışındaki kontrol karakterleri yasaktır.
descriptionstringİsteğe bağlı; boş dizeye izin verilir. Kırpmadan sonra en fazla 500 karakter.
amountMinorintegerzorunluTeknik tamsayı sınırı, ticari sağlayıcı sınırı değil. Negatif satıcı kredisi reddedilir.
vatPayercustomer | merchantAtlandığında, mevcut mağazanın kuralı kaydedilir.
expiresAtintegerGelecekte bir zaman, oluşturmadan en fazla 90 gün sonra. Varsayılan yedi gündür. Fatura anlık görüntüsünde kaydedilir.
currency"USD"zorunlumethodsarray<card | alipay | crypto>zorunluYeni USD ödeme, kart ve Alipay destekler. USD kripto faturaları yalnızca uyumluluk için kabul edilir ve canlı ödemede crypto_requires_usdt döndürür; kripto için USDT kullanın.
vatCustomerPercentintegerMüşteri payı, tam yüzde olarak. 0, satıcının her şeyi karşıladığı anlamına gelir; 100, müşterinin her şeyi karşıladığı anlamına gelir. Varsayılan: mağazanın eski KDV tercihi.
feeCustomerPercentintegerMüşteri payı, tam yüzde olarak. 0, satıcının her şeyi karşıladığı anlamına gelir; 100, müşterinin her şeyi karşıladığı anlamına gelir.
orderIdstringAlıcının gördüğü sipariş referansı.
metadataobjectÖzel satıcı meta verileri. JSON serileştirmesinden sonra en fazla 3000 UTF-8 bayt. Herkese açık ödeme sayfasında asla gösterilmez.
pricingMode"native"Eski para birimine özgü fiyatlandırma. Mevcut entegrasyonlarla uyumluluk için atlayın.
Para birimi RUB
titlestringzorunluÇevreleyen boşluklar kırpılır. Kırpmadan sonra uzunluk: 1-120 karakter. Sekmeler ve satır sonları dışındaki kontrol karakterleri yasaktır.
descriptionstringİsteğe bağlı; boş dizeye izin verilir. Kırpmadan sonra en fazla 500 karakter.
amountMinorintegerzorunluTeknik tamsayı sınırı, ticari sağlayıcı sınırı değil. Negatif satıcı kredisi reddedilir.
vatPayercustomer | merchantAtlandığında, mevcut mağazanın kuralı kaydedilir.
expiresAtintegerGelecekte bir zaman, oluşturmadan en fazla 90 gün sonra. Varsayılan yedi gündür. Fatura anlık görüntüsünde kaydedilir.
currency"RUB"zorunlumethodsarray<"sbp">zorunluvatCustomerPercentintegerMüşteri payı, tam yüzde olarak. 0, satıcının her şeyi karşıladığı anlamına gelir; 100, müşterinin her şeyi karşıladığı anlamına gelir. Varsayılan: mağazanın eski KDV tercihi.
feeCustomerPercentintegerMüşteri payı, tam yüzde olarak. 0, satıcının her şeyi karşıladığı anlamına gelir; 100, müşterinin her şeyi karşıladığı anlamına gelir.
orderIdstringAlıcının gördüğü sipariş referansı.
metadataobjectÖzel satıcı meta verileri. JSON serileştirmesinden sonra en fazla 3000 UTF-8 bayt. Herkese açık ödeme sayfasında asla gösterilmez.
pricingMode"native"Eski para birimine özgü fiyatlandırma. Mevcut entegrasyonlarla uyumluluk için atlayın.
Para birimi USDT
titlestringzorunluÇevreleyen boşluklar kırpılır. Kırpmadan sonra uzunluk: 1-120 karakter. Sekmeler ve satır sonları dışındaki kontrol karakterleri yasaktır.
descriptionstringİsteğe bağlı; boş dizeye izin verilir. Kırpmadan sonra en fazla 500 karakter.
amountMinorintegerzorunluTeknik tamsayı sınırı, ticari sağlayıcı sınırı değil. Negatif satıcı kredisi reddedilir.
vatPayercustomer | merchantAtlandığında, mevcut mağazanın kuralı kaydedilir.
expiresAtintegerGelecekte bir zaman, oluşturmadan en fazla 90 gün sonra. Varsayılan yedi gündür. Fatura anlık görüntüsünde kaydedilir.
currency"USDT"zorunlumethodsarray<"crypto">zorunluvatCustomerPercentintegerMüşteri payı, tam yüzde olarak. 0, satıcının her şeyi karşıladığı anlamına gelir; 100, müşterinin her şeyi karşıladığı anlamına gelir. Varsayılan: mağazanın eski KDV tercihi.
feeCustomerPercentintegerMüşteri payı, tam yüzde olarak. 0, satıcının her şeyi karşıladığı anlamına gelir; 100, müşterinin her şeyi karşıladığı anlamına gelir.
orderIdstringAlıcının gördüğü sipariş referansı.
metadataobjectÖzel satıcı meta verileri. JSON serileştirmesinden sonra en fazla 3000 UTF-8 bayt. Herkese açık ödeme sayfasında asla gösterilmez.
pricingMode"native"Eski para birimine özgü fiyatlandırma. Mevcut entegrasyonlarla uyumluluk için atlayın.
Varyant 4
titlestringzorunluÇevreleyen boşluklar kırpılır. Kırpmadan sonra uzunluk: 1-120 karakter. Sekmeler ve satır sonları dışındaki kontrol karakterleri yasaktır.
descriptionstringİsteğe bağlı; boş dizeye izin verilir. Kırpmadan sonra en fazla 500 karakter.
amountMinorintegerzorunluTeknik tamsayı sınırı, ticari sağlayıcı sınırı değil. Negatif satıcı kredisi reddedilir.
vatPayercustomer | merchantAtlandığında, mevcut mağazanın kuralı kaydedilir.
expiresAtintegerGelecekte bir zaman, oluşturmadan en fazla 90 gün sonra. Varsayılan yedi gündür. Fatura anlık görüntüsünde kaydedilir.
currencyUSD | RUB | USDTzorunluGirdi birimi. RUB, kaydedilmiş referans kuru üzerinden USD'ye çevrilir; USDT açık 1:1 fatura kuralını kullanır. Kaydedilmiş fatura taban para birimi USD'dir.
methodsarray<card | alipay | sbp | crypto>zorunluvatCustomerPercentintegerMüşteri payı, tam yüzde olarak. 0, satıcının her şeyi karşıladığı anlamına gelir; 100, müşterinin her şeyi karşıladığı anlamına gelir. Varsayılan: mağazanın eski KDV tercihi.
feeCustomerPercentintegerMüşteri payı, tam yüzde olarak. 0, satıcının her şeyi karşıladığı anlamına gelir; 100, müşterinin her şeyi karşıladığı anlamına gelir.
orderIdstringAlıcının gördüğü sipariş referansı.
metadataobjectÖzel satıcı meta verileri. JSON serileştirmesinden sonra en fazla 3000 UTF-8 bayt. Herkese açık ödeme sayfasında asla gösterilmez.
pricingMode"universal"zorunluYanıtlar
200Idempotent tekrar; replayed=true.
linkobjectzorunlureplayedbooleanzorunlucheckoutUrlstringzorunluÖdeme bağlantısı hemen kullanılabilir; yoklama gerekmez.
201Fatura oluşturuldu; replayed=false.
linkobjectzorunlureplayedbooleanzorunlucheckoutUrlstringzorunluÖdeme bağlantısı hemen kullanılabilir; yoklama gerekmez.
400Geçersiz JSON, bilinmeyen alan veya geçersiz değer.
errorobjectzorunlu401Geçerli oturum yok; webhook için geçersiz bir sır.
errorobjectzorunlu403Origin, CSRF veya tarayıcı bağlama doğrulaması başarısız oldu.
errorobjectzorunlu409Giriş talebi kullanıldı veya iptal edildi, kimlik doğrulanmadı veya bir destek talebi çakışıyor.
errorobjectzorunlu413Gövde 16.384 baytı aşıyor; /api/support/ask ve Telegram webhook'u için sınır 65.536 bayttır.
errorobjectzorunlu415Content-Type: application/json gereklidir.
errorobjectzorunlu429Hız sınırı aşıldı.
errorobjectzorunlu503Bir entegrasyon veya depolama kullanılamıyor, bir olay işleniyor veya hizmet kullanılamıyor.
errorobjectzorunluGET/api/v1/payments/{id}
Sahip olunan bağlantı ve kaydedilmiş hesaplama
Yetkilendirme, uç nokta kurallarına uyar
Başlıklar ve parametreler
idpathzorunluSahip olunan bağlantı tanımlayıcısı, genel belirteç değil.
Yanıtlar
200Başka bir kullanıcının kimliği ve eksik bir kimlik ikisi de 404 döndürür.
linkobjectzorunlucheckoutUrlstringDurum güncelleme yanıtlarına dahil edilir; iç içe bağlantı her zaman checkoutUrl'sini içerir.
401Geçerli oturum yok; webhook için geçersiz bir sır.
errorobjectzorunlu404Kayıt eksik, genel belirteç geçersiz veya istenen kayıt başka bir kullanıcıya ait.
errorobjectzorunlu503Bir entegrasyon veya depolama kullanılamıyor, bir olay işleniyor veya hizmet kullanılamıyor.
errorobjectzorunluPATCH/api/v1/payments/{id}
Bir bağlantıyı duraklat, sürdür veya iptal et
Yalnızca durumu değiştirir. Güncelleme ve değişmez fatura updated olayı atomik olarak işlenir. Eşzamanlı değişiklikler bir sürüm kontrolü kullanır; LINK_CHANGED üzerinde yenileyin ve yeniden deneyin. cancelled terminaldir, süre sonu asla uzatılmaz ve fiyat, yöntemler, maliyet payları ve açıklama donmuş kalır. Kaydedilmiş durumun tekrarlanması geçerli faturayı döndürür.
Yetkilendirme, uç nokta kurallarına uyar
Başlıklar ve parametreler
idpathzorunluSahip olunan bağlantı tanımlayıcısı, genel belirteç değil.
JSON gövdesi
statusactive | paused | cancelledzorunluYanıtlar
200Sahip olunan bağlantının geçerli durumu.
linkobjectzorunlucheckoutUrlstringDurum güncelleme yanıtlarına dahil edilir; iç içe bağlantı her zaman checkoutUrl'sini içerir.
400Geçersiz JSON, bilinmeyen alan veya geçersiz değer.
errorobjectzorunlu401Geçerli oturum yok; webhook için geçersiz bir sır.
errorobjectzorunlu403Origin, CSRF veya tarayıcı bağlama doğrulaması başarısız oldu.
errorobjectzorunlu404Kayıt eksik, genel belirteç geçersiz veya istenen kayıt başka bir kullanıcıya ait.
errorobjectzorunlu409Giriş talebi kullanıldı veya iptal edildi, kimlik doğrulanmadı veya bir destek talebi çakışıyor.
errorobjectzorunlu413Gövde 16.384 baytı aşıyor; /api/support/ask ve Telegram webhook'u için sınır 65.536 bayttır.
errorobjectzorunlu415Content-Type: application/json gereklidir.
errorobjectzorunlu503Bir entegrasyon veya depolama kullanılamıyor, bir olay işleniyor veya hizmet kullanılamıyor.
errorobjectzorunluGET/api/v1/payment-links
Sahip olunan ödeme bağlantılarını listele
createdAt DESC, id DESC ile sıralanır. Genel bağlantılar cihazlar arasında çalışır; listeleme bir hesap gerektirir.
Yetkilendirme, uç nokta kurallarına uyar
Başlıklar ve parametreler
limitquerycursorqueryÖnceki yanıttan nextCursor. Hizmet base64 JSON [createdAt,id] kullanır; URLSearchParams üzerinden değiştirilmeden iletin.
Yanıtlar
200Sahip olunan ödeme bağlantılarından oluşan bir sayfa.
linksarray<object>zorunlunextCursorstring | nullzorunluOpak sonraki sayfa imleci. URL kodlu bir sorgu parametresi olarak iletin; null sonu işaretler.
400Geçersiz JSON, bilinmeyen alan veya geçersiz değer.
errorobjectzorunlu401Geçerli oturum yok; webhook için geçersiz bir sır.
errorobjectzorunlu503Bir entegrasyon veya depolama kullanılamıyor, bir olay işleniyor veya hizmet kullanılamıyor.
errorobjectzorunluPOST/api/v1/payment-links
Değişmez koşullarla bir fatura oluştur
Değişmez bir fatura oluştur ve hemen checkoutUrl al; bu alıcıyı ücretlendirmez. USD: kart/Alipay; RUB: SBP; USDT: kripto. USD kripto uyumluluk için kabul edilir ancak bir USDT faturası olmadan ödenemez. Ücret ve KDV müşteri payları 0'dan 100'e bağımsız tam sayılardır; mevcut canlı kart/Alipay, KDV müşteri=100 ve ücret müşteri=0 destekler. Müşteri toplamı asla sessizce değiştirilmez. En son web sitesi uygulaması yeni bir canlı ücretlendirmeden önce onaylanmalıdır. Fatura oluşturma ve tüccar olayı atomik olarak işlenir.
Yetkilendirme, uç nokta kurallarına uyar
Başlıklar ve parametreler
Idempotency-KeyheaderzorunluMantıksal istek başına bir anahtar. Aynı kurallı girdiyle tekrar, orijinal kaydı döndürür; aynı anahtarla farklı girdi 409 döndürür.
JSON gövdesi
Para birimi USD
titlestringzorunluÇevreleyen boşluklar kırpılır. Kırpmadan sonra uzunluk: 1-120 karakter. Sekmeler ve satır sonları dışındaki kontrol karakterleri yasaktır.
descriptionstringİsteğe bağlı; boş dizeye izin verilir. Kırpmadan sonra en fazla 500 karakter.
amountMinorintegerzorunluTeknik tamsayı sınırı, ticari sağlayıcı sınırı değil. Negatif satıcı kredisi reddedilir.
vatPayercustomer | merchantAtlandığında, mevcut mağazanın kuralı kaydedilir.
expiresAtintegerGelecekte bir zaman, oluşturmadan en fazla 90 gün sonra. Varsayılan yedi gündür. Fatura anlık görüntüsünde kaydedilir.
currency"USD"zorunlumethodsarray<card | alipay | crypto>zorunluYeni USD ödeme, kart ve Alipay destekler. USD kripto faturaları yalnızca uyumluluk için kabul edilir ve canlı ödemede crypto_requires_usdt döndürür; kripto için USDT kullanın.
vatCustomerPercentintegerMüşteri payı, tam yüzde olarak. 0, satıcının her şeyi karşıladığı anlamına gelir; 100, müşterinin her şeyi karşıladığı anlamına gelir. Varsayılan: mağazanın eski KDV tercihi.
feeCustomerPercentintegerMüşteri payı, tam yüzde olarak. 0, satıcının her şeyi karşıladığı anlamına gelir; 100, müşterinin her şeyi karşıladığı anlamına gelir.
orderIdstringAlıcının gördüğü sipariş referansı.
metadataobjectÖzel satıcı meta verileri. JSON serileştirmesinden sonra en fazla 3000 UTF-8 bayt. Herkese açık ödeme sayfasında asla gösterilmez.
pricingMode"native"Eski para birimine özgü fiyatlandırma. Mevcut entegrasyonlarla uyumluluk için atlayın.
Para birimi RUB
titlestringzorunluÇevreleyen boşluklar kırpılır. Kırpmadan sonra uzunluk: 1-120 karakter. Sekmeler ve satır sonları dışındaki kontrol karakterleri yasaktır.
descriptionstringİsteğe bağlı; boş dizeye izin verilir. Kırpmadan sonra en fazla 500 karakter.
amountMinorintegerzorunluTeknik tamsayı sınırı, ticari sağlayıcı sınırı değil. Negatif satıcı kredisi reddedilir.
vatPayercustomer | merchantAtlandığında, mevcut mağazanın kuralı kaydedilir.
expiresAtintegerGelecekte bir zaman, oluşturmadan en fazla 90 gün sonra. Varsayılan yedi gündür. Fatura anlık görüntüsünde kaydedilir.
currency"RUB"zorunlumethodsarray<"sbp">zorunluvatCustomerPercentintegerMüşteri payı, tam yüzde olarak. 0, satıcının her şeyi karşıladığı anlamına gelir; 100, müşterinin her şeyi karşıladığı anlamına gelir. Varsayılan: mağazanın eski KDV tercihi.
feeCustomerPercentintegerMüşteri payı, tam yüzde olarak. 0, satıcının her şeyi karşıladığı anlamına gelir; 100, müşterinin her şeyi karşıladığı anlamına gelir.
orderIdstringAlıcının gördüğü sipariş referansı.
metadataobjectÖzel satıcı meta verileri. JSON serileştirmesinden sonra en fazla 3000 UTF-8 bayt. Herkese açık ödeme sayfasında asla gösterilmez.
pricingMode"native"Eski para birimine özgü fiyatlandırma. Mevcut entegrasyonlarla uyumluluk için atlayın.
Para birimi USDT
titlestringzorunluÇevreleyen boşluklar kırpılır. Kırpmadan sonra uzunluk: 1-120 karakter. Sekmeler ve satır sonları dışındaki kontrol karakterleri yasaktır.
descriptionstringİsteğe bağlı; boş dizeye izin verilir. Kırpmadan sonra en fazla 500 karakter.
amountMinorintegerzorunluTeknik tamsayı sınırı, ticari sağlayıcı sınırı değil. Negatif satıcı kredisi reddedilir.
vatPayercustomer | merchantAtlandığında, mevcut mağazanın kuralı kaydedilir.
expiresAtintegerGelecekte bir zaman, oluşturmadan en fazla 90 gün sonra. Varsayılan yedi gündür. Fatura anlık görüntüsünde kaydedilir.
currency"USDT"zorunlumethodsarray<"crypto">zorunluvatCustomerPercentintegerMüşteri payı, tam yüzde olarak. 0, satıcının her şeyi karşıladığı anlamına gelir; 100, müşterinin her şeyi karşıladığı anlamına gelir. Varsayılan: mağazanın eski KDV tercihi.
feeCustomerPercentintegerMüşteri payı, tam yüzde olarak. 0, satıcının her şeyi karşıladığı anlamına gelir; 100, müşterinin her şeyi karşıladığı anlamına gelir.
orderIdstringAlıcının gördüğü sipariş referansı.
metadataobjectÖzel satıcı meta verileri. JSON serileştirmesinden sonra en fazla 3000 UTF-8 bayt. Herkese açık ödeme sayfasında asla gösterilmez.
pricingMode"native"Eski para birimine özgü fiyatlandırma. Mevcut entegrasyonlarla uyumluluk için atlayın.
Varyant 4
titlestringzorunluÇevreleyen boşluklar kırpılır. Kırpmadan sonra uzunluk: 1-120 karakter. Sekmeler ve satır sonları dışındaki kontrol karakterleri yasaktır.
descriptionstringİsteğe bağlı; boş dizeye izin verilir. Kırpmadan sonra en fazla 500 karakter.
amountMinorintegerzorunluTeknik tamsayı sınırı, ticari sağlayıcı sınırı değil. Negatif satıcı kredisi reddedilir.
vatPayercustomer | merchantAtlandığında, mevcut mağazanın kuralı kaydedilir.
expiresAtintegerGelecekte bir zaman, oluşturmadan en fazla 90 gün sonra. Varsayılan yedi gündür. Fatura anlık görüntüsünde kaydedilir.
currencyUSD | RUB | USDTzorunluGirdi birimi. RUB, kaydedilmiş referans kuru üzerinden USD'ye çevrilir; USDT açık 1:1 fatura kuralını kullanır. Kaydedilmiş fatura taban para birimi USD'dir.
methodsarray<card | alipay | sbp | crypto>zorunluvatCustomerPercentintegerMüşteri payı, tam yüzde olarak. 0, satıcının her şeyi karşıladığı anlamına gelir; 100, müşterinin her şeyi karşıladığı anlamına gelir. Varsayılan: mağazanın eski KDV tercihi.
feeCustomerPercentintegerMüşteri payı, tam yüzde olarak. 0, satıcının her şeyi karşıladığı anlamına gelir; 100, müşterinin her şeyi karşıladığı anlamına gelir.
orderIdstringAlıcının gördüğü sipariş referansı.
metadataobjectÖzel satıcı meta verileri. JSON serileştirmesinden sonra en fazla 3000 UTF-8 bayt. Herkese açık ödeme sayfasında asla gösterilmez.
pricingMode"universal"zorunluYanıtlar
200Idempotent tekrar; replayed=true.
linkobjectzorunlureplayedbooleanzorunlucheckoutUrlstringzorunluÖdeme bağlantısı hemen kullanılabilir; yoklama gerekmez.
201Fatura oluşturuldu; replayed=false.
linkobjectzorunlureplayedbooleanzorunlucheckoutUrlstringzorunluÖdeme bağlantısı hemen kullanılabilir; yoklama gerekmez.
400Geçersiz JSON, bilinmeyen alan veya geçersiz değer.
errorobjectzorunlu401Geçerli oturum yok; webhook için geçersiz bir sır.
errorobjectzorunlu403Origin, CSRF veya tarayıcı bağlama doğrulaması başarısız oldu.
errorobjectzorunlu409Giriş talebi kullanıldı veya iptal edildi, kimlik doğrulanmadı veya bir destek talebi çakışıyor.
errorobjectzorunlu413Gövde 16.384 baytı aşıyor; /api/support/ask ve Telegram webhook'u için sınır 65.536 bayttır.
errorobjectzorunlu415Content-Type: application/json gereklidir.
errorobjectzorunlu429Hız sınırı aşıldı.
errorobjectzorunlu503Bir entegrasyon veya depolama kullanılamıyor, bir olay işleniyor veya hizmet kullanılamıyor.
errorobjectzorunluGET/api/v1/payment-links/{id}
Sahip olunan bağlantı ve kaydedilmiş hesaplama
Yetkilendirme, uç nokta kurallarına uyar
Başlıklar ve parametreler
idpathzorunluSahip olunan bağlantı tanımlayıcısı, genel belirteç değil.
Yanıtlar
200Başka bir kullanıcının kimliği ve eksik bir kimlik ikisi de 404 döndürür.
linkobjectzorunlucheckoutUrlstringDurum güncelleme yanıtlarına dahil edilir; iç içe bağlantı her zaman checkoutUrl'sini içerir.
401Geçerli oturum yok; webhook için geçersiz bir sır.
errorobjectzorunlu404Kayıt eksik, genel belirteç geçersiz veya istenen kayıt başka bir kullanıcıya ait.
errorobjectzorunlu503Bir entegrasyon veya depolama kullanılamıyor, bir olay işleniyor veya hizmet kullanılamıyor.
errorobjectzorunluPATCH/api/v1/payment-links/{id}
Bir bağlantıyı duraklat, sürdür veya iptal et
Yalnızca durumu değiştirir. Güncelleme ve değişmez fatura updated olayı atomik olarak işlenir. Eşzamanlı değişiklikler bir sürüm kontrolü kullanır; LINK_CHANGED üzerinde yenileyin ve yeniden deneyin. cancelled terminaldir, süre sonu asla uzatılmaz ve fiyat, yöntemler, maliyet payları ve açıklama donmuş kalır. Kaydedilmiş durumun tekrarlanması geçerli faturayı döndürür.
Yetkilendirme, uç nokta kurallarına uyar
Başlıklar ve parametreler
idpathzorunluSahip olunan bağlantı tanımlayıcısı, genel belirteç değil.
JSON gövdesi
statusactive | paused | cancelledzorunluYanıtlar
200Sahip olunan bağlantının geçerli durumu.
linkobjectzorunlucheckoutUrlstringDurum güncelleme yanıtlarına dahil edilir; iç içe bağlantı her zaman checkoutUrl'sini içerir.
400Geçersiz JSON, bilinmeyen alan veya geçersiz değer.
errorobjectzorunlu401Geçerli oturum yok; webhook için geçersiz bir sır.
errorobjectzorunlu403Origin, CSRF veya tarayıcı bağlama doğrulaması başarısız oldu.
errorobjectzorunlu404Kayıt eksik, genel belirteç geçersiz veya istenen kayıt başka bir kullanıcıya ait.
errorobjectzorunlu409Giriş talebi kullanıldı veya iptal edildi, kimlik doğrulanmadı veya bir destek talebi çakışıyor.
errorobjectzorunlu413Gövde 16.384 baytı aşıyor; /api/support/ask ve Telegram webhook'u için sınır 65.536 bayttır.
errorobjectzorunlu415Content-Type: application/json gereklidir.
errorobjectzorunlu503Bir entegrasyon veya depolama kullanılamıyor, bir olay işleniyor veya hizmet kullanılamıyor.
errorobjectzorunluGET/api/api-keys
Kendi anahtar meta verilerini listele
Yetkilendirme, uç nokta kurallarına uyar
Başlıklar ve parametreler
X-Kevmi-StoreheaderTarayıcı oturumu için sahip olunan bir mağaza seçin. İlk mağazayı kullanmak için atlayın. API anahtarları bu başlığı yok sayar ve her zaman değişmez mağaza bağlamasını kullanır. all değeri salt okunurdur ve yalnızca gösterge paneli ve fatura listesi uç noktaları tarafından desteklenir.
Yanıtlar
200Sırlar ve sır karmaları atlanır.
keysarray<object>zorunlu401Geçerli oturum yok; webhook için geçersiz bir sır.
errorobjectzorunlu503Bir entegrasyon veya depolama kullanılamıyor, bir olay işleniyor veya hizmet kullanılamıyor.
errorobjectzorunluPOST/api/api-keys
Kapsamlı bir anahtar oluştur; sırrını bir kez göster
En fazla 10 etkin anahtar. Saatte kullanıcı başına en fazla 5 oluşturma. Anahtarların süresi dolar, iptal edilebilir ve anahtar başına dakikada 90 API isteğiyle sınırlandırılmıştır.
Yetkilendirme, uç nokta kurallarına uyar
Başlıklar ve parametreler
OriginheaderzorunluAPP_ORIGIN ile birebir eşleşmelidir. Sec-Fetch-Site: cross-site reddedilir. Sunucu CORS erişimi sağlamaz.
X-CSRF-TokenheaderzorunluGET /api/auth/me veya başarılı giriş tamamlamadan gelen geçerli oturum belirteci.
X-Kevmi-StoreheaderTarayıcı oturumu için sahip olunan bir mağaza seçin. İlk mağazayı kullanmak için atlayın. API anahtarları bu başlığı yok sayar ve her zaman değişmez mağaza bağlamasını kullanır. all değeri salt okunurdur ve yalnızca gösterge paneli ve fatura listesi uç noktaları tarafından desteklenir.
JSON gövdesi
namestringzorunluscopesarray<invoices:read | invoices:write | events:read>expiresInDaysintegerYanıtlar
201Sırrı sunucunda güvenli bir şekilde sakla.
keyobjectzorunlusecretstringzorunlu400Geçersiz JSON, bilinmeyen alan veya geçersiz değer.
errorobjectzorunlu401Geçerli oturum yok; webhook için geçersiz bir sır.
errorobjectzorunlu403Origin, CSRF veya tarayıcı bağlama doğrulaması başarısız oldu.
errorobjectzorunlu409Giriş talebi kullanıldı veya iptal edildi, kimlik doğrulanmadı veya bir destek talebi çakışıyor.
errorobjectzorunlu429Hız sınırı aşıldı.
errorobjectzorunlu503Bir entegrasyon veya depolama kullanılamıyor, bir olay işleniyor veya hizmet kullanılamıyor.
errorobjectzorunluDELETE/api/api-keys/{id}
Kendi anahtarını iptal et
Yetkilendirme, uç nokta kurallarına uyar
Başlıklar ve parametreler
idpathzorunluOriginheaderzorunluAPP_ORIGIN ile birebir eşleşmelidir. Sec-Fetch-Site: cross-site reddedilir. Sunucu CORS erişimi sağlamaz.
X-CSRF-TokenheaderzorunluGET /api/auth/me veya başarılı giriş tamamlamadan gelen geçerli oturum belirteci.
X-Kevmi-StoreheaderTarayıcı oturumu için sahip olunan bir mağaza seçin. İlk mağazayı kullanmak için atlayın. API anahtarları bu başlığı yok sayar ve her zaman değişmez mağaza bağlamasını kullanır. all değeri salt okunurdur ve yalnızca gösterge paneli ve fatura listesi uç noktaları tarafından desteklenir.
Yanıtlar
200Anahtarın gelecekteki kullanımları reddedilir.
revokedtruezorunlu401Geçerli oturum yok; webhook için geçersiz bir sır.
errorobjectzorunlu403Origin, CSRF veya tarayıcı bağlama doğrulaması başarısız oldu.
errorobjectzorunlu404Kayıt eksik, genel belirteç geçersiz veya istenen kayıt başka bir kullanıcıya ait.
errorobjectzorunlu503Bir entegrasyon veya depolama kullanılamıyor, bir olay işleniyor veya hizmet kullanılamıyor.
errorobjectzorunluGET/api/events
Kendi değişmez olay geçmişini oku
Yetkilendirme, uç nokta kurallarına uyar
Başlıklar ve parametreler
beforequeryEski özel zaman damgası sınırı. İmleçle birleştirilemez. Kayıpsız sayfalama için nextCursor kullanın.
cursorqueryÖnceki sayfa tarafından döndürülen opak nextCursor. [createdAt,id] kodlar ve tek zaman damgasını paylaşan olayları korur.
X-Kevmi-StoreheaderTarayıcı oturumu için sahip olunan bir mağaza seçin. İlk mağazayı kullanmak için atlayın. API anahtarları bu başlığı yok sayar ve her zaman değişmez mağaza bağlamasını kullanır. all değeri salt okunurdur ve yalnızca gösterge paneli ve fatura listesi uç noktaları tarafından desteklenir.
Yanıtlar
200En yeni önce; en fazla 50 olay. null olana kadar nextCursor'ı takip edin.
eventsarray<object>zorunlunextCursorstring | nullzorunlu400Geçersiz JSON, bilinmeyen alan veya geçersiz değer.
errorobjectzorunlu401Geçerli oturum yok; webhook için geçersiz bir sır.
errorobjectzorunlu503Bir entegrasyon veya depolama kullanılamıyor, bir olay işleniyor veya hizmet kullanılamıyor.
errorobjectzorunluGET/api/v1/events
Kendi değişmez olay geçmişini oku
Yetkilendirme, uç nokta kurallarına uyar
Başlıklar ve parametreler
beforequeryEski özel zaman damgası sınırı. İmleçle birleştirilemez. Kayıpsız sayfalama için nextCursor kullanın.
cursorqueryÖnceki sayfa tarafından döndürülen opak nextCursor. [createdAt,id] kodlar ve tek zaman damgasını paylaşan olayları korur.
Yanıtlar
200En yeni önce; en fazla 50 olay. null olana kadar nextCursor'ı takip edin.
eventsarray<object>zorunlunextCursorstring | nullzorunlu400Geçersiz JSON, bilinmeyen alan veya geçersiz değer.
errorobjectzorunlu401Geçerli oturum yok; webhook için geçersiz bir sır.
errorobjectzorunlu503Bir entegrasyon veya depolama kullanılamıyor, bir olay işleniyor veya hizmet kullanılamıyor.
errorobjectzorunluWebhooks
Doğrulanmış HTTPS uç noktaları, imzalı olaylar, teslimat denemeleri ve yeniden denemeler.
GET/api/webhooks
Uç noktalarını ve son 30 teslimatı listele
Yetkilendirme, uç nokta kurallarına uyar
Başlıklar ve parametreler
X-Kevmi-StoreheaderTarayıcı oturumu için sahip olunan bir mağaza seçin. İlk mağazayı kullanmak için atlayın. API anahtarları bu başlığı yok sayar ve her zaman değişmez mağaza bağlamasını kullanır. all değeri salt okunurdur ve yalnızca gösterge paneli ve fatura listesi uç noktaları tarafından desteklenir.
Yanıtlar
200İmzalama sırları döndürülmez.
endpointsarray<object>zorunludeliveriesarray<object>zorunluavailablebooleanzorunlueventTypesarray<invoice.created | invoice.updated | payment.succeeded | payment.failed | payment.refunded | payment.partially_refunded | payment.disputed | payment.review_required>zorunlu401Geçerli oturum yok; webhook için geçersiz bir sır.
errorobjectzorunlu404Kayıt eksik, genel belirteç geçersiz veya istenen kayıt başka bir kullanıcıya ait.
errorobjectzorunlu503Bir entegrasyon veya depolama kullanılamıyor, bir olay işleniyor veya hizmet kullanılamıyor.
errorobjectzorunluPOST/api/webhooks
Genel bir HTTPS hedefi kaydet
En fazla 5 uç noktası ve saatte kullanıcı başına 6 oluşturma. Yalnızca genel HTTPS alan adları; kimlik bilgisi, IP değişmezleri veya özel bağlantı noktaları yok. Yeni oluşturulan bir uç noktası, meydan okuması başarılı olana kadar canlı teslimat almaz.
Yetkilendirme, uç nokta kurallarına uyar
Başlıklar ve parametreler
OriginheaderzorunluAPP_ORIGIN ile birebir eşleşmelidir. Sec-Fetch-Site: cross-site reddedilir. Sunucu CORS erişimi sağlamaz.
X-CSRF-TokenheaderzorunluGET /api/auth/me veya başarılı giriş tamamlamadan gelen geçerli oturum belirteci.
X-Kevmi-StoreheaderTarayıcı oturumu için sahip olunan bir mağaza seçin. İlk mağazayı kullanmak için atlayın. API anahtarları bu başlığı yok sayar ve her zaman değişmez mağaza bağlamasını kullanır. all değeri salt okunurdur ve yalnızca gösterge paneli ve fatura listesi uç noktaları tarafından desteklenir.
JSON gövdesi
urlstringzorunludescriptionstringeventsarray<invoice.created | invoice.updated | payment.succeeded | payment.failed | payment.refunded | payment.partially_refunded | payment.disputed | payment.review_required>Yanıtlar
201Tek seferlik imzalama sırrını kaydet.
endpointobjectzorunlusecretstringzorunluYalnızca oluşturma/döndürmede gösterilir. Sunucu tarafında şifrelenmiş olarak saklanır.
400Geçersiz JSON, bilinmeyen alan veya geçersiz değer.
errorobjectzorunlu401Geçerli oturum yok; webhook için geçersiz bir sır.
errorobjectzorunlu403Origin, CSRF veya tarayıcı bağlama doğrulaması başarısız oldu.
errorobjectzorunlu409Giriş talebi kullanıldı veya iptal edildi, kimlik doğrulanmadı veya bir destek talebi çakışıyor.
errorobjectzorunlu429Hız sınırı aşıldı.
errorobjectzorunlu503Bir entegrasyon veya depolama kullanılamıyor, bir olay işleniyor veya hizmet kullanılamıyor.
errorobjectzorunluGET/api/webhooks/{id}
Uç noktalarını ve son 30 teslimatı listele
Yetkilendirme, uç nokta kurallarına uyar
Başlıklar ve parametreler
idpathzorunluX-Kevmi-StoreheaderTarayıcı oturumu için sahip olunan bir mağaza seçin. İlk mağazayı kullanmak için atlayın. API anahtarları bu başlığı yok sayar ve her zaman değişmez mağaza bağlamasını kullanır. all değeri salt okunurdur ve yalnızca gösterge paneli ve fatura listesi uç noktaları tarafından desteklenir.
Yanıtlar
200İmzalama sırları döndürülmez.
endpointsarray<object>zorunludeliveriesarray<object>zorunluavailablebooleanzorunlueventTypesarray<invoice.created | invoice.updated | payment.succeeded | payment.failed | payment.refunded | payment.partially_refunded | payment.disputed | payment.review_required>zorunlu401Geçerli oturum yok; webhook için geçersiz bir sır.
errorobjectzorunlu404Kayıt eksik, genel belirteç geçersiz veya istenen kayıt başka bir kullanıcıya ait.
errorobjectzorunlu503Bir entegrasyon veya depolama kullanılamıyor, bir olay işleniyor veya hizmet kullanılamıyor.
errorobjectzorunluPATCH/api/webhooks/{id}
Doğrulanmış bir uç noktasını duraklat veya sürdür
Duraklatılmış doğrulanmış uç noktaları uygun olayları kuyrukta tutar; sürdürme, vadesi gelen teslimatları işler.
Yetkilendirme, uç nokta kurallarına uyar
Başlıklar ve parametreler
idpathzorunluOriginheaderzorunluAPP_ORIGIN ile birebir eşleşmelidir. Sec-Fetch-Site: cross-site reddedilir. Sunucu CORS erişimi sağlamaz.
X-CSRF-TokenheaderzorunluGET /api/auth/me veya başarılı giriş tamamlamadan gelen geçerli oturum belirteci.
X-Kevmi-StoreheaderTarayıcı oturumu için sahip olunan bir mağaza seçin. İlk mağazayı kullanmak için atlayın. API anahtarları bu başlığı yok sayar ve her zaman değişmez mağaza bağlamasını kullanır. all değeri salt okunurdur ve yalnızca gösterge paneli ve fatura listesi uç noktaları tarafından desteklenir.
JSON gövdesi
statusactive | pausedzorunluYanıtlar
200Durum kaydedildi.
updatedtruezorunlu400Geçersiz JSON, bilinmeyen alan veya geçersiz değer.
errorobjectzorunlu401Geçerli oturum yok; webhook için geçersiz bir sır.
errorobjectzorunlu403Origin, CSRF veya tarayıcı bağlama doğrulaması başarısız oldu.
errorobjectzorunlu404Kayıt eksik, genel belirteç geçersiz veya istenen kayıt başka bir kullanıcıya ait.
errorobjectzorunlu409Giriş talebi kullanıldı veya iptal edildi, kimlik doğrulanmadı veya bir destek talebi çakışıyor.
errorobjectzorunlu503Bir entegrasyon veya depolama kullanılamıyor, bir olay işleniyor veya hizmet kullanılamıyor.
errorobjectzorunluDELETE/api/webhooks/{id}
Uç noktasını kaldır ve teslim edilmemiş işleri iptal et
Bekleyen, başarısız ve kiralanmış işleri iptal eder. Ağ üzerinden zaten gönderilmiş bir istek geri çağrılamaz.
Yetkilendirme, uç nokta kurallarına uyar
Başlıklar ve parametreler
idpathzorunluOriginheaderzorunluAPP_ORIGIN ile birebir eşleşmelidir. Sec-Fetch-Site: cross-site reddedilir. Sunucu CORS erişimi sağlamaz.
X-CSRF-TokenheaderzorunluGET /api/auth/me veya başarılı giriş tamamlamadan gelen geçerli oturum belirteci.
X-Kevmi-StoreheaderTarayıcı oturumu için sahip olunan bir mağaza seçin. İlk mağazayı kullanmak için atlayın. API anahtarları bu başlığı yok sayar ve her zaman değişmez mağaza bağlamasını kullanır. all değeri salt okunurdur ve yalnızca gösterge paneli ve fatura listesi uç noktaları tarafından desteklenir.
Yanıtlar
200Uç noktası kaldırıldı.
deletedtruezorunlu401Geçerli oturum yok; webhook için geçersiz bir sır.
errorobjectzorunlu403Origin, CSRF veya tarayıcı bağlama doğrulaması başarısız oldu.
errorobjectzorunlu404Kayıt eksik, genel belirteç geçersiz veya istenen kayıt başka bir kullanıcıya ait.
errorobjectzorunlu503Bir entegrasyon veya depolama kullanılamıyor, bir olay işleniyor veya hizmet kullanılamıyor.
errorobjectzorunluPOST/api/webhooks/{id}/verify
İmzalı bir uç noktası doğrulama meydan okuması gönder
Saatte kullanıcı başına en fazla 5 doğrulama denemesi. Sunucun, Kevmi-Signature değerini doğrulamalı ve 2xx JSON {"challenge":"<data.challenge>"} döndürmelidir. İstek zaman aşımı: 8 saniye; yanıt sınırı: 8192 bayt. Yönlendirmeler izlenmez. Doğrulama, uç noktasını etkinleştirir.
Yetkilendirme, uç nokta kurallarına uyar
Başlıklar ve parametreler
idpathzorunluOriginheaderzorunluAPP_ORIGIN ile birebir eşleşmelidir. Sec-Fetch-Site: cross-site reddedilir. Sunucu CORS erişimi sağlamaz.
X-CSRF-TokenheaderzorunluGET /api/auth/me veya başarılı giriş tamamlamadan gelen geçerli oturum belirteci.
X-Kevmi-StoreheaderTarayıcı oturumu için sahip olunan bir mağaza seçin. İlk mağazayı kullanmak için atlayın. API anahtarları bu başlığı yok sayar ve her zaman değişmez mağaza bağlamasını kullanır. all değeri salt okunurdur ve yalnızca gösterge paneli ve fatura listesi uç noktaları tarafından desteklenir.
JSON gövdesi
Yanıtlar
200Doğrulanmış ve etkin.
verifiedtruezorunluendpointobjectzorunlu400Geçersiz JSON, bilinmeyen alan veya geçersiz değer.
errorobjectzorunlu401Geçerli oturum yok; webhook için geçersiz bir sır.
errorobjectzorunlu403Origin, CSRF veya tarayıcı bağlama doğrulaması başarısız oldu.
errorobjectzorunlu404Kayıt eksik, genel belirteç geçersiz veya istenen kayıt başka bir kullanıcıya ait.
errorobjectzorunlu409Giriş talebi kullanıldı veya iptal edildi, kimlik doğrulanmadı veya bir destek talebi çakışıyor.
errorobjectzorunlu422Hedef doğrulanamadı.
errorobjectzorunlu429Hız sınırı aşıldı.
errorobjectzorunlu503Bir entegrasyon veya depolama kullanılamıyor, bir olay işleniyor veya hizmet kullanılamıyor.
errorobjectzorunluPOST/api/webhooks/{id}/rotate
İmzalama sırrını değiştir ve tekrar doğrulama iste
Saatte kullanıcı başına en fazla 3 döndürme. Sunucunu güncelle ve uç noktasını tekrar doğrula. Zaten uçuşta olan bir istek hâlâ önceki imzayı taşıyabilir.
Yetkilendirme, uç nokta kurallarına uyar
Başlıklar ve parametreler
idpathzorunluOriginheaderzorunluAPP_ORIGIN ile birebir eşleşmelidir. Sec-Fetch-Site: cross-site reddedilir. Sunucu CORS erişimi sağlamaz.
X-CSRF-TokenheaderzorunluGET /api/auth/me veya başarılı giriş tamamlamadan gelen geçerli oturum belirteci.
X-Kevmi-StoreheaderTarayıcı oturumu için sahip olunan bir mağaza seçin. İlk mağazayı kullanmak için atlayın. API anahtarları bu başlığı yok sayar ve her zaman değişmez mağaza bağlamasını kullanır. all değeri salt okunurdur ve yalnızca gösterge paneli ve fatura listesi uç noktaları tarafından desteklenir.
JSON gövdesi
Yanıtlar
200Yeni sır bir kez gösterilir.
secretstringzorunluYalnızca oluşturma/döndürmede gösterilir. Sunucu tarafında şifrelenmiş olarak saklanır.
requiresVerificationtruezorunlu400Geçersiz JSON, bilinmeyen alan veya geçersiz değer.
errorobjectzorunlu401Geçerli oturum yok; webhook için geçersiz bir sır.
errorobjectzorunlu403Origin, CSRF veya tarayıcı bağlama doğrulaması başarısız oldu.
errorobjectzorunlu404Kayıt eksik, genel belirteç geçersiz veya istenen kayıt başka bir kullanıcıya ait.
errorobjectzorunlu409Giriş talebi kullanıldı veya iptal edildi, kimlik doğrulanmadı veya bir destek talebi çakışıyor.
errorobjectzorunlu429Hız sınırı aşıldı.
errorobjectzorunlu503Bir entegrasyon veya depolama kullanılamıyor, bir olay işleniyor veya hizmet kullanılamıyor.
errorobjectzorunluPOST/api/webhooks/{id}/deliveries/{deliveryId}/retry
Etkin bir uç noktasına başarısız bir teslimatı yeniden dene
Olay kimliğini ve yükünü korur; yeni bir zaman damgası ve imza üretir. Her otomatik teslimat döngüsü, süresi dolmuş kiralamalar dahil en fazla 6 deneme yapar; 1d, 5d, 30d, 2s ve 12s gecikmelerle. Teslimat en az bir kezdir; olay kimliklerini sunucunda tekilleştir.
Yetkilendirme, uç nokta kurallarına uyar
Başlıklar ve parametreler
idpathzorunludeliveryIdpathzorunluOriginheaderzorunluAPP_ORIGIN ile birebir eşleşmelidir. Sec-Fetch-Site: cross-site reddedilir. Sunucu CORS erişimi sağlamaz.
X-CSRF-TokenheaderzorunluGET /api/auth/me veya başarılı giriş tamamlamadan gelen geçerli oturum belirteci.
X-Kevmi-StoreheaderTarayıcı oturumu için sahip olunan bir mağaza seçin. İlk mağazayı kullanmak için atlayın. API anahtarları bu başlığı yok sayar ve her zaman değişmez mağaza bağlamasını kullanır. all değeri salt okunurdur ve yalnızca gösterge paneli ve fatura listesi uç noktaları tarafından desteklenir.
JSON gövdesi
Yanıtlar
202Yeniden deneme zamanlandı.
queuedtruezorunlu400Geçersiz JSON, bilinmeyen alan veya geçersiz değer.
errorobjectzorunlu401Geçerli oturum yok; webhook için geçersiz bir sır.
errorobjectzorunlu403Origin, CSRF veya tarayıcı bağlama doğrulaması başarısız oldu.
errorobjectzorunlu404Kayıt eksik, genel belirteç geçersiz veya istenen kayıt başka bir kullanıcıya ait.
errorobjectzorunlu409Giriş talebi kullanıldı veya iptal edildi, kimlik doğrulanmadı veya bir destek talebi çakışıyor.
errorobjectzorunlu429Hız sınırı aşıldı.
errorobjectzorunlu503Bir entegrasyon veya depolama kullanılamıyor, bir olay işleniyor veya hizmet kullanılamıyor.
errorobjectzorunluApplications
Kimlik doğrulamalı web sitesi uygulamaları ve bireysel izleme.
GET/api/applications
En fazla 30 kendi uygulamanı listele
Yetkilendirme, uç nokta kurallarına uyar
Başlıklar ve parametreler
X-Kevmi-Localeheaderİzleme URL'si ve sistem mesajı dili. Desteklenen bir değer olmadan, aynı kaynaktan yönlendiren ve tarayıcı dili dikkate alınır; geri dönüş İngilizcedir.
X-Kevmi-StoreheaderTarayıcı oturumu için sahip olunan bir mağaza seçin. İlk mağazayı kullanmak için atlayın. API anahtarları bu başlığı yok sayar ve her zaman değişmez mağaza bağlamasını kullanır. all değeri salt okunurdur ve yalnızca gösterge paneli ve fatura listesi uç noktaları tarafından desteklenir.
Yanıtlar
200En yeni önce.
applicationsarray<object>zorunlu401Geçerli oturum yok; webhook için geçersiz bir sır.
errorobjectzorunlu503Bir entegrasyon veya depolama kullanılamıyor, bir olay işleniyor veya hizmet kullanılamıyor.
errorobjectzorunluPOST/api/applications
Web sitesi bilgilerini gönder ve bir izleme URL'si al
Onaylanmış Telegram girişi gerektirir. Günde kullanıcı başına en fazla 5 yeni gönderim. Kimliksiz tekrar oynatma 200 döndürür. Sunucu gerçek kalıcı aşamaları ilerletir; kullanılamayan veya riskli otomatik sonuçlar insan incelemesi gerektirir. Onay, ödeme ağ geçidini yapılandırmaz. Sahiplik ve durum, başvuru sahibi tarafından sağlanamaz.
Yetkilendirme, uç nokta kurallarına uyar
Başlıklar ve parametreler
OriginheaderzorunluAPP_ORIGIN ile birebir eşleşmelidir. Sec-Fetch-Site: cross-site reddedilir. Sunucu CORS erişimi sağlamaz.
X-CSRF-TokenheaderzorunluGET /api/auth/me veya başarılı giriş tamamlamadan gelen geçerli oturum belirteci.
Idempotency-KeyheaderzorunluMantıksal istek başına bir anahtar. Aynı kurallı girdiyle tekrar, orijinal kaydı döndürür; aynı anahtarla farklı girdi 409 döndürür.
X-Kevmi-Localeheaderİzleme URL'si ve sistem mesajı dili. Desteklenen bir değer olmadan, aynı kaynaktan yönlendiren ve tarayıcı dili dikkate alınır; geri dönüş İngilizcedir.
X-Kevmi-StoreheaderTarayıcı oturumu için sahip olunan bir mağaza seçin. İlk mağazayı kullanmak için atlayın. API anahtarları bu başlığı yok sayar ve her zaman değişmez mağaza bağlamasını kullanır. all değeri salt okunurdur ve yalnızca gösterge paneli ve fatura listesi uç noktaları tarafından desteklenir.
JSON gövdesi
websiteUrlstringzorunluKimlik bilgisi, sorgu parametresi, IP değişmezi veya özel bağlantı noktası olmayan genel HTTPS alan adı. Bir parça, normalleştirme sırasında kaldırılır.
businessNamestringzorunlubusinessTypedigital_goods | software | services | physical_goods | education | otherzorunludescriptionstringzorunlucontactTelegramstringzorunluBir harfle başlayan, ardından harfler/rakamlar/alt çizgiler gelen 5–32 karakterli Telegram kullanıcı adı. İsteğe bağlı @ veya https://t.me/ öneki; çevresindeki boşluklar kırpılır. @username olarak saklanır.
consenttruezorunluYanıtlar
200Mevcut gönderim.
applicationobjectzorunluurlstringzorunlureplayedbooleanzorunlu202Kabul edildi; işleme sunucuda devam ediyor.
applicationobjectzorunluurlstringzorunlureplayedbooleanzorunlu400Geçersiz JSON, bilinmeyen alan veya geçersiz değer.
errorobjectzorunlu401Geçerli oturum yok; webhook için geçersiz bir sır.
errorobjectzorunlu403Origin, CSRF veya tarayıcı bağlama doğrulaması başarısız oldu.
errorobjectzorunlu409Giriş talebi kullanıldı veya iptal edildi, kimlik doğrulanmadı veya bir destek talebi çakışıyor.
errorobjectzorunlu429Hız sınırı aşıldı.
errorobjectzorunlu503Bir entegrasyon veya depolama kullanılamıyor, bir olay işleniyor veya hizmet kullanılamıyor.
errorobjectzorunluGET/api/applications/{id}
Kendi inceleme aşamalarını ve olay geçmişini oku
Yetkilendirme, uç nokta kurallarına uyar
Başlıklar ve parametreler
idpathzorunluX-Kevmi-Localeheaderİzleme URL'si ve sistem mesajı dili. Desteklenen bir değer olmadan, aynı kaynaktan yönlendiren ve tarayıcı dili dikkate alınır; geri dönüş İngilizcedir.
X-Kevmi-StoreheaderTarayıcı oturumu için sahip olunan bir mağaza seçin. İlk mağazayı kullanmak için atlayın. API anahtarları bu başlığı yok sayar ve her zaman değişmez mağaza bağlamasını kullanır. all değeri salt okunurdur ve yalnızca gösterge paneli ve fatura listesi uç noktaları tarafından desteklenir.
Yanıtlar
200Özel başvuru sahibi projeksiyonu. Kanıt ve model çıktısı açığa çıkarılmaz.
applicationobjectzorunlueventsarray<object>zorunlu401Geçerli oturum yok; webhook için geçersiz bir sır.
errorobjectzorunlu404Kayıt eksik, genel belirteç geçersiz veya istenen kayıt başka bir kullanıcıya ait.
errorobjectzorunlu503Bir entegrasyon veya depolama kullanılamıyor, bir olay işleniyor veya hizmet kullanılamıyor.
errorobjectzorunluPOST/api/applications/{id}/resume
Uygun bir arka plan aşamasını sürdür
İncelemeyi atlayamaz veya bir aşamayı onaylayamaz. Bir sunucu kiralaması yinelenen işi önler. İnceleme gerektiren ve son başvurular değişmeden kalır. Dakikada kullanıcı başına en fazla 30 işleme-devam isteği.
Yetkilendirme, uç nokta kurallarına uyar
Başlıklar ve parametreler
idpathzorunluOriginheaderzorunluAPP_ORIGIN ile birebir eşleşmelidir. Sec-Fetch-Site: cross-site reddedilir. Sunucu CORS erişimi sağlamaz.
X-CSRF-TokenheaderzorunluGET /api/auth/me veya başarılı giriş tamamlamadan gelen geçerli oturum belirteci.
X-Kevmi-Localeheaderİzleme URL'si ve sistem mesajı dili. Desteklenen bir değer olmadan, aynı kaynaktan yönlendiren ve tarayıcı dili dikkate alınır; geri dönüş İngilizcedir.
X-Kevmi-StoreheaderTarayıcı oturumu için sahip olunan bir mağaza seçin. İlk mağazayı kullanmak için atlayın. API anahtarları bu başlığı yok sayar ve her zaman değişmez mağaza bağlamasını kullanır. all değeri salt okunurdur ve yalnızca gösterge paneli ve fatura listesi uç noktaları tarafından desteklenir.
JSON gövdesi
Yanıtlar
200İşleme gerekmez.
applicationobjectzorunlu202İşleme zamanlandı.
applicationobjectzorunluscheduledtruezorunlu400Geçersiz JSON, bilinmeyen alan veya geçersiz değer.
errorobjectzorunlu401Geçerli oturum yok; webhook için geçersiz bir sır.
errorobjectzorunlu403Origin, CSRF veya tarayıcı bağlama doğrulaması başarısız oldu.
errorobjectzorunlu404Kayıt eksik, genel belirteç geçersiz veya istenen kayıt başka bir kullanıcıya ait.
errorobjectzorunlu429Hız sınırı aşıldı.
errorobjectzorunlu503Bir entegrasyon veya depolama kullanılamıyor, bir olay işleniyor veya hizmet kullanılamıyor.
errorobjectzorunluModeration
İzin listesindeki Telegram moderatörleri; her karar sürüm kontrolünden geçer.
GET/api/moderation/applications
Denetim için en fazla 100 başvuruyu listele
Doğrulanmış Telegram kimliğinin MODERATOR_TELEGRAM_IDS içinde olmasını gerektirir. Tüm durumları içerir; önce needs_review, sonra processing, ardından son durumlar sıralanır; bir grup içinde en yeni güncellemeler önce.
Yetkilendirme, uç nokta kurallarına uyar
Yanıtlar
200Moderatör kuyruğu.
applicationsarray<object>zorunlu401Geçerli oturum yok; webhook için geçersiz bir sır.
errorobjectzorunlu403Origin, CSRF veya tarayıcı bağlama doğrulaması başarısız oldu.
errorobjectzorunlu503Bir entegrasyon veya depolama kullanılamıyor, bir olay işleniyor veya hizmet kullanılamıyor.
errorobjectzorunluGET/api/moderation/applications/{id}
İnceleme kanıtını ve aşama geçmişini oku
Yetkilendirme, uç nokta kurallarına uyar
Başlıklar ve parametreler
idpathzorunluYanıtlar
200Özel moderatör kanıtı.
applicationobjectzorunlueventsarray<object>zorunluevidenceobjectzorunlu401Geçerli oturum yok; webhook için geçersiz bir sır.
errorobjectzorunlu403Origin, CSRF veya tarayıcı bağlama doğrulaması başarısız oldu.
errorobjectzorunlu404Kayıt eksik, genel belirteç geçersiz veya istenen kayıt başka bir kullanıcıya ait.
errorobjectzorunlu503Bir entegrasyon veya depolama kullanılamıyor, bir olay işleniyor veya hizmet kullanılamıyor.
errorobjectzorunluPOST/api/moderation/applications/{id}/decision
Mevcut inceleme aşamasını onayla veya genel bir gerekçeyle reddet
Yapılandırılmış bir moderatör gerektirir; kullanıcı başına en fazla 30 karar/dakika. expectedVersion atomik olarak karşılaştırılır. Yalnızca mevcut needs_review aşaması onaylanabilir; nihai başvurular sessizce yeniden açılamaz. Reddetme, düzenlenebilir bir genel gerekçe gerektirir. Karar, aşama geçmişi ve etkinleştirilmiş başvuru bildirimi birlikte kaydedilir.
Yetkilendirme, uç nokta kurallarına uyar
Başlıklar ve parametreler
idpathzorunluOriginheaderzorunluAPP_ORIGIN ile birebir eşleşmelidir. Sec-Fetch-Site: cross-site reddedilir. Sunucu CORS erişimi sağlamaz.
X-CSRF-TokenheaderzorunluGET /api/auth/me veya başarılı giriş tamamlamadan gelen geçerli oturum belirteci.
JSON gövdesi
Varyant 1
expectedVersionintegerzorunluaction"approve_step"zorunlureasonstringVaryant 2
expectedVersionintegerzorunluaction"reject"zorunlureasonstringzorunluYanıtlar
200Karar kaydedildi.
applicationobjectzorunlu400Geçersiz JSON, bilinmeyen alan veya geçersiz değer.
errorobjectzorunlu401Geçerli oturum yok; webhook için geçersiz bir sır.
errorobjectzorunlu403Origin, CSRF veya tarayıcı bağlama doğrulaması başarısız oldu.
errorobjectzorunlu404Kayıt eksik, genel belirteç geçersiz veya istenen kayıt başka bir kullanıcıya ait.
errorobjectzorunlu409Giriş talebi kullanıldı veya iptal edildi, kimlik doğrulanmadı veya bir destek talebi çakışıyor.
errorobjectzorunlu429Hız sınırı aşıldı.
errorobjectzorunlu503Bir entegrasyon veya depolama kullanılamıyor, bir olay işleniyor veya hizmet kullanılamıyor.
errorobjectzorunluGateway events
Kaynak yerel kapı olayları doğrulanır, ardından yetkili ödeme, kimlik doğrulamalı sunucu aktarımı üzerinden okunur. Satıcıya yönelik webhook'lar ayrı bir imza ve teslimat kuyruğu kullanır.
POST/api/gateway/webhook
İmzalı kaynak-yerel ağ geçidi olaylarını al
Yerel v3: X-Gateway-Timestamp (Unix saniye), X-Gateway-Signature ve eşleşen X-Gateway-Event-Id sağlayın. Maksimum zaman farkı 300 saniyedir. İmza doğrulamasından sonra Kevmi, kimliği doğrulanmış ağ geçidi API'si üzerinden ödemeyi getirir, kayıtlı siparişi, tam para birimini/tutarını, yöntemi ve sağlayıcı tarafından onaylanmış durumu kontrol eder, ardından makbuzu ve satıcı outbox olayını atomik olarak depolar. Webhook metni ve tarayıcı gözlemleri tek başına bir ödemeyi asla doğrulamaz. Tekrarlanan kimlikler yinelenir; mevcut bir kimlik için değiştirilmiş bir gövde reddedilir. Gecikmeli olaylar güncel yetkili durumu kullanır. Kısmi iadeler, tam iadeler, anlaşmazlıklar ve inceleme durumları desteklenir. Bağlanmamış siparişler kabul edilir ve yok sayılır. Kevmi-Signature kullanan eski normalleştirilmiş olaylar ayrıca desteklenmeye devam eder; yalnızca başarılı/başarısız/tam-iade-edilmiş geçişleri uygulanır.
Yetkilendirme, uç nokta kurallarına uyar
Başlıklar ve parametreler
X-Gateway-TimestampheaderYerel v3 olayları için gereklidir.
X-Gateway-Event-IdheaderYerel v3 için gereklidir; body.id ile eşleşmelidir.
JSON gövdesi
Varyant 1
idstringzorunluapi_version"3"zorunlumode"live"zorunlutypestringzorunludataobjectzorunluVaryant 2
eventIdstringzorunlupaymentIdstringzorunluinvoiceIdstringzorunlustatussucceeded | failed | refundedzorunluamountMinorintegerzorunluKüçük para birimi birimlerinde tamsayı tutar.
currencyUSD | RUB | USDTzorunluFatura birimleri: USD cent, RUB kopek veya USDT'nin yüzde biri. Otomatik para birimi dönüşümü yok.
methodcard | alipay | sbp | cryptozorunluoccurredAtintegerzorunluUnix zaman damgası, milisaniye cinsinden, UTC.
Yanıtlar
200Alındı, yinelenmiş veya güvenle yok sayıldı.
receivedtruezorunlureplayedbooleanignoredbooleanappliedboolean400Geçersiz JSON, bilinmeyen alan veya geçersiz değer.
errorobjectzorunlu401Ağ geçidi imzası eksik, geçersiz veya kabul edilen zaman penceresinin dışında.
errorobjectzorunlu404Kayıt eksik, genel belirteç geçersiz veya istenen kayıt başka bir kullanıcıya ait.
errorobjectzorunlu409Bir olay kimliği değiştirilmiş içerikle yeniden kullanıldı veya bir ödeme kimliği kayıtlı fatura bağlamasıyla çakışıyor.
errorobjectzorunlu413Gövde 16.384 baytı aşıyor; /api/support/ask ve Telegram webhook'u için sınır 65.536 bayttır.
errorobjectzorunlu415Content-Type: application/json gereklidir.
errorobjectzorunlu429Ağ geçidi meşgul; webhook teslimatını aynı olay kimliğiyle yeniden deneyin.
errorobjectzorunlu502Ağ geçidi yanıtı kullanılamıyor, hatalı veya doğrulanamıyor. Herhangi bir yeniden denemeden önce mevcut ödeme durumunu okuyun.
errorobjectzorunlu503Ağ geçidi yapılandırması veya imzalama sırrı eksik.
errorobjectzorunlu