Scope Kataloğu
Her Partner API endpoint'i, entegrasyona verilmiş bir scope gerektirir. Scope'lar, merchant entegrasyonu oluştururken seçilir ve anahtara bağlanır. Bir endpoint'in gerektirdiği scope entegrasyonda yoksa istek reddedilir.
Scope formatı modül:erişim şeklindedir. * (ALL) joker scope'u, mevcut ve gelecekte eklenecek tüm scope'ları kapsar.
Katalog
| Kod | Anlamı |
|---|---|
payment:sale | Ödeme alma — kart ödemesi, QR, provizyon kapatma, kayıtlı kart yönetimi, tekrarlayan plan kurma. |
payment:refund | İşlem iadesi (tam veya kısmi). |
payment:void | İşlem iptali (henüz mahsuplaşmamış işlemin iptali), tekrarlayan plan iptali. |
payment:inquiry | Sorgulama uçları — komisyon önizleme, taksit listeleme, işlem arama/detay, kayıtlı kart listeleme/detay, tekrarlayan plan sorgulama. |
collection:link | Tahsilat linki oluşturma, detay, listeleme, iptal. |
report | Raporlama uçları — dönem özeti. |
merchant:read | İşletme profil bilgisi okuma. |
* | ALL — tüm scope'lara erişim veren joker. Yeni scope eklendiğinde otomatik kapsar. |
Scope'lar merchant tarafından entegrasyon oluşturulurken seçilir. V1'de katalog tümüyle seçilebilir durumdadır.
Anahtar oluşturma ekranındaki katalogda webhook kodu görünebilir; Partner API'de hiçbir uca karşılık gelmez. Olay bildirimi yapılandırması sunucudan sunucuya trafik değil bir kurulum işidir ve işletme panelinden (e-şube) *Entegrasyon → Webhook* ekranından yönetilir.
Anahtar Limitleri
Scope "ne yapabilir" sorusunu, limit "ne kadar" sorusunu cevaplar. Entegrasyon oluşturulurken anahtar başına tavan verilebilir:
| Parametre | Anlamı | Gerekli scope |
|---|---|---|
payment.max_amount | Bu anahtarla alınabilecek azami işlem tutarı. | payment:sale |
link.max_items | Tahsilat linkinde izin verilen azami kalem sayısı. | collection:link |
Boş bırakılan parametre sınırsız demektir; işletme seviyesindeki POS limitleri her hâlükârda uygulanır. Tavan aşılırsa partner.api.amount.limit.exceeded / partner.api.item.limit.exceeded döner.