Genel Kurallar

Base URL & Metot

Tüm veri-düzlemi çağrıları https://<host>/partner/1.0/... altındadır ve POST + JSON gövde kullanır. Kimlik doğrulama için bkz. Kimlik Doğrulama.

Yanıt

Tüm uçlar aynı gövde yapısıyla yanıt verir; asıl veri content alanındadır. correlationId değerini destek taleplerinde isteğinizi bulmak için iletin.

{
  "code": 200,
  "message": "İşlem Başarılı",
  "content": { },
  "correlationId": "3f6d1c2e-…"
}

Para Tanımı

amount, cartAmount, partialAmount gibi tutar alanları decimal gönderilir; kuruş (minor unit) kullanılmaz. 100,50 TL için 100.50 yazılır.

{ "amount": 1234.56, "currency": "TRY" }

Currency

Kabul edilen kodlar: TRY, USD, EUR, GBP, JPY, CHF, RUB, AZN. Listede olmayan bir kod 20002 / invalid input ile reddedilir. Aktif currency listesi merchant başına yapılandırılır.

Tarih Formatı

ISO-8601. Örnek: 2026-07-12T10:15:30.000Z.

Pagination

page 0-tabanlıdır. size boş ya da 0 gönderilirse transaction/search ve payment/link/search 10, recurring/search 20 kullanır; recurring/search ayrıca 200 üstü değerleri 20’ye çeker.

Sayfalı uçlar (transaction/search, payment/link/search, recurring/search) aynı zarfı döner:

{
  "content": [ ],
  "page": 0,
  "size": 20,
  "totalElements": 128,
  "totalPages": 7,
  "last": false
}

Kayıtlı kart listeleme (card/list) sayfalı değildir — doğrudan bir dizi döner.

Tanımlayıcılar

orderNumber — sizin sipariş numaranız. Tekil olmak zorunda değildir (kombine ödeme aynı sipariş için birden fazla işlem satırı üretebilir) ve transaction/search ile aranır.
transactionRef — işlemin tanımlayıcısı. Ödeme yanıtı, transaction/detail, search, capture, cancel, refund ve tahsilat linki detayı hep aynı değeri konuşur. Saklamanız gereken tek değer budur.
Sistem içi tekil referans kodunu sunucu üretir; istekte referenceCode göndermezsiniz. Ödeme yanıtı iç referansları (checkoutId, referenceCode) döndürmez — mutabakat için işlem detayında bulunurlar.

Opsiyonel enum alanlarını boş bırakabilirsiniz; sunucu DEFAULT sentinelini kullanır ve alanın anlamına göre çözer (filtre alanlarında "hepsi", yöntem alanlarında yüzeyin varsayılanı). Tanımsız bir enum değeri gönderirseniz istek 20002 / invalid input ile reddedilir.

İşletme Kapsamı

İşlemler, API anahtarınızın tanımlı olduğu işletme kapsamında gerçekleşir. İstek gövdesinde ayrıca bir işletme bilgisi göndermenize gerek yoktur; kapsam API anahtarınızdan belirlenir.