Ödeme Kırılımı Onay Verme

URL

Ödeme kırılımı onaylamak için kullanılan endpoint ve http metod bilgisi aşağıda verilmiştir.

HTTP Metod URL
POST /payment/v1/payment-transactions/approve

İstek Parametreleri

Ödeme kırılımı onayı vermek için yapılacak isteklerde gönderilmesi beklenen parametreler aşağıdaki tablo ve alt başlıklar altında listelenmiştir.

Parametre Adı Tipi Zorunlu Açıklama
paymentTransactionIds number[] Evet Onay verilmek istenen ödeme kırılımlarının ID değerlerini barındırır
isTransactional boolean Hayır Onaylama işlemi sırasında eğer herhangi bir ödeme kırılımı süreçsel nedenlerden dolayı onaylanamazsa bu değer true ise hiçbir ödeme kırılımı onaylanmaz. Eğer bu değer false ise onaylanabilen ödeme kırılımları onaylanır onaylanamayanlar ise onaylanamamış durumda kalır.

Dönüş Parametreleri

Ödeme işleminin sonucunda dönen parametreler de API dokümantasyonu giriş sayfasındaki Dönüş Formatları bölümünde belirtilen kurallara tabidir. Sistemsel ya da kurgusal bir hata bulunmadığı durumda data parametresinde dönen objenin alt parametreleri aşağıdaki gibidir:

Parametre Adı Tipi Her Zaman Mevcut Açıklama
size number Evet Onaylama işlemi sonucunda etkilenen ödeme kırılımı sayısı
items PaymentTransactionApproval[] Evet Onaylama işlemine dair bilgileri taşıyan obje bkz: Ödeme Kırılımı Onay Bilgileri
paymentTransactions PaymentTransaction[] Evet bkz: Ödeme Kırılımı Onay Bilgileri

Ödeme Kırılımı Onay Bilgileri

Ödeme kırılımı onay ve onay geri çekme isteği yapılırken dönüş objesi içerisinde yapılan işleme ve ödeme kırılımına ait bilgiler içeren objedir.

Parametre Adı Tipi Her Zaman Mevcut Açıklama
paymentTransactionId long Evet Ödeme kırılımının ID'si
approvalStatus string Evet Ödeme kırılımı sonucu başarılı ise SUCCESS başarısız ise FAILURE değerini barındırır
failedReason string Evet Ödeme kırılımı onaylama ya da onay geri çekme sonucu hatalı ise hata detayına dair bilgi barındırır

Ödeme Kırılımı Onay Geri Alma

URL

Ödeme kırılımı onayını geri almak için kullanılan endpoint ve http metod bilgisi aşağıda verilmiştir.

HTTP Metod URL
POST /payment/v1/payment-transactions/disapprove

İstek Parametreleri

Ödeme kırılımı onayı geri almak için yapılacak isteklerde gönderilmesi beklenen parametreler aşağıdaki tablo ve alt başlıklar altında listelenmiştir.

Parametre Adı Tipi Zorunlu Açıklama
paymentTransactionIds number[] Evet Daha önce verilmiş olan onayı geri almak istenen ödeme kırılımlarının ID değerlerini barındırır
isTransactional boolean Hayır Onaylama işlemi sırasında eğer herhangi bir ödeme kırılımı süreçsel nedenlerden dolayı onay geri çekilemezse bu değer true ise hiçbir ödeme kırılımının onayı geri çekilmez. Eğer bu değer false ise onayı geri çekilebilen ödeme kırılımlarının onayları geri alınır onaylanamayanlar ise onaylanamamış durumda kalır.

Dönüş Parametreleri

Ödeme işleminin sonucunda dönen parametreler de API dokümantasyonu giriş sayfasındaki Dönüş Formatları bölümünde belirtilen kurallara tabidir. Sistemsel ya da kurgusal bir hata bulunmadığı durumda data parametresinde dönen objenin alt parametreleri aşağıdaki gibidir:

Parametre Adı Tipi Her Zaman Mevcut Açıklama
size number Evet Onaylama işlemi sonucunda etkilenen ödeme kırılımı sayısı
items PaymentTransactionApproval[] Evet Onaylama işlemine dair bilgileri taşıyan obje bkz: Ödeme Kırılımı Onay Bilgileri
paymentTransactions PaymentTransaction[] Evet bkz: Ödeme Kırılımı Onay Bilgileri

Ödeme Kırılımı Onay Bilgileri

Ödeme kırılımı onay ve onay geri çekme isteği yapılırken dönüş objesi içerisinde yapılan işleme ve ödeme kırılımına ait bilgiler içeren objedir.

Parametre Adı Tipi Her Zaman Mevcut Açıklama
paymentTransactionId long Evet Ödeme kırılımının ID'si
approvalStatus string Evet Ödeme kırılımı sonucu başarılı ise SUCCESS başarısız ise FAILURE değerini barındırır
failedReason string Evet Ödeme kırılımı onaylama ya da onay geri çekme sonucu hatalı ise hata detayına dair bilgi barındırır

Ödeme Kırılımı Güncelleme

Ürün ödemelerinde, satıcının değişmesi veya satıcı(alt üye işyeri) fiyatının değişmesi gibi nedenlerden dolayı dilerseniz alt üye işyerini ve/veya alt üye işyeri fiyatını güncelleyebilirsiniz. Servisi kullanabilmek için Pazaryeri tipinde bir üye işyeri olmalı ve ürün tipinde ödeme geçirmiş olmanız gerekmektedir.

Dikkat Edilmesi Gereken Noktalar

  • Bu servis, sadece pazaryerleri tarafından kullanılabilir.
  • Bu servis, sadece başarılı ödemeler için kullanılabilir.
  • Ödeme grubu, ürün olan ödeme kırılımları güncellenebilir.
  • Ödeme kırılımının para gönderimi durumu PAYOUT_STARTED(gönderiliyor) yada PAYOUT_COMPLETED(gönderildi) ise servis kullanılamaz.
  • Servisi kullanırken alt üye işyeri veya alt üye işyeri fiyatından en az biri değişmiş olmalıdır.
  • Ödeme ve ödeme kırılımı daha önce iptal/iade edilmemiş olmalıdır.
  • Bir ödeme kırılımı için dilediğiniz kadar güncelleme yapabilirsiniz.
  • Alt üye işyeri fiyatı, ödeme kırılımının fiyatından büyük olamaz.
  • Ödeme kırılımının işlem durumu onay bekliyor durumunda olmalıdır.

URL

Ödeme kırılımını güncellemek için kullanılan endpoint ve http metod bilgisi aşağıda verilmiştir.

HTTP Metod URL URL Parametreleri
PUT /payment/v1/payment-transactions/:id id: Ödeme kırılımı ID değeri

İstek Parametreleri

Ödeme kırılımı onayı geri almak için yapılacak isteklerde gönderilmesi beklenen parametreler aşağıdaki tablo ve alt başlıklar altında listelenmiştir.

Parametre Adı Tipi Zorunlu Açıklama
subMerchantId number Evet Alt üye işyeri ID değeri
subMerchantPrice decimal Evet Alt üye işyeri fiyatı

Dönüş Parametreleri

Ödeme kırılımı güncelleme işleminin sonucunda dönen parametreler de API dokümantasyonu giriş sayfasındaki Dönüş Formatları bölümünde belirtilen kurallara tabidir. Sistemsel ya da kurgusal bir hata bulunmadığı durumda data parametresinde dönen objenin alt parametreleri aşağıdaki gibidir:

Parametre Adı Tipi Her Zaman Mevcut Açıklama
id long Evet Ödeme kırılımının ID'si
name string Hayır Ödeme isteğinde gönderilen, ödeme kırılımına ilişkin isim
externalId string Hayır Ödeme isteğinde gönderilen, ödeme kırılımına ilişkin dış ID değeri
transactionStatus TransactionStatus Evet (bkz: Para Gönderimi Durumları) Kırılıma ilişkin para gönderim durumunu ifade eden değer
price decimal Evet Ödeme kırılımının sepetteki tutarı
paidPrice decimal Evet Ödeme için tahsil edilen toplam tutarın, ilgili kırılıma düşen payı
walletPrice decimal Evet Ödeme için cüzdandan tahsil edilen toplam tutarın, ilgili kırılıma düşen payı
merchantPayoutAmount decimal Evet Ödemeye ilişkin üye işyerine gönderilecek olan paranın, ilgili kırılıma düşen payı
subMerchantId long Hayır Ödeme kırılımının ilişkili olduğu alt üye işyeri ID'si
subMerchantPrice decimal Evet Ödeme kırılımının bir alt üye işyeriyle ilişkili olduğu durumda yer alır. Ödeme tutarından alt üye işyerine aktarılacak toplam tutarın, ilgili kırılıma düşen payıdır
subMerchantPayoutRate decimal Evet Ödeme kırılımının bir alt üye işyeriyle ilişkili olduğu durumda yer alır. Ödemeye ilişkin alt üye işyerine gönderilecek olan paranın, üye işyerine gönderilecek paraya olan oranıdır
subMerchantPayoutAmount decimal Evet Ödeme kırılımının bir alt üye işyeriyle ilişkili olduğu durumda yer alır. Ödemeye ilişkin alt üye işyerine gönderilecek olan tutarı ifade eder
payout Payout Evet (bkz: Ödeme Kırılımı Para Gönderim Dağılımı) Ödeme kırılıma ilişkin para gönderim tutarlarının üye işyeri, alt üye işyeri ve ÖderoPay arasındaki dağılımını içerir

Güncel ek kırılım işlemleri

HTTP metodu URL Açıklama
POST /payment/v1/payment-transactions/approveWithUpdate Bir kırılımı onaylarken subMerchantId ve/veya subMerchantPrice alanlarını günceller.
POST /payment/v1/payment-transactions/reorganize Bir ödemenin en fazla 250 kırılımını yeniden düzenler.

approveWithUpdate; zorunlu paymentTransactionId ile opsiyonel subMerchantId ve pozitif subMerchantPrice alanlarını alır. reorganize; paymentId ve boş olmayan items listesini alır. Her item zorunlu paymentTransactionId ile opsiyonel price, subMerchantId ve externalId alanlarını içerir.

Güncel kırılım response modeli ayrıca subExternalId, pointPrice, giftCardPrice, loyaltyPointPrice, withHoldingPrice ve blockageResolvedDate alanlarını içerir.