Pazar Yeri - Ödeme Transaction Listesi

Transaction Gerçekleşme Tarihine Göre Liste

Servis Adresi

/PaymentDealer/GetPaymentTrxListMarketPlace

Ne İçin Kullanılır?

Bu servis, ana ödeme kaydına ait Transaction' ların gerçekleştirilme tarihine göre listelenmesini sağlar. Ana ödeme kaydı bilgilerini de döner. Örneğin 15.01.2021 tarihinde başarılı bir ödeme yapılmışsa ve de 21.01.2021 tarihinde başarılı bir kısmi iade gerçekleştirilmişse, Bu servise 21.01.2021 tarihini verirseniz, sadece kısmi iadeye ait transaction kaydını listelersiniz.

İstek Parametreleri

PaymentDealerAuthentication

Parametre	Açıklama
DealerCode(string)	Moka sistemi tarafından verilen bayi kodu
Username (string)	Moka sistemi tarafından verilen Api kullanıcı adı
Password (string)	Moka sistemi tarafından verilen Api şifresi
CheckKey (string)	Kontrol anahtarı (DealerCode + "MK" + Username + "PD" + Password) String olarak birleştirilen bu bilgilerin SHA-256 hash algoritmasından geçirilmesiyle oluşturulur. Buraya tıklayarak deneme ekranına gidebilirsiniz.

PaymentDealerRequest

Parametre	Açıklama
TrxStartDate	Transaction’ ın başladığı tarih ve saat (yyyy-MM-dd HH:mm)
TrxEndDate	Transaction’ ın bittiği tarih ve saat (yyyy-MM-dd HH:mm)
TrxType (integer)	Transaction’ ın ne tip bir işlem olduğunu gösterir. Ana ödeme kaydının durumu transaction’ ın tipine ve başarılı olup olmamasına göre değişir. 0 : Ödeme Talebi 1 : Ön Provizyon 2 : Ödeme 3 : İptal 4 : Tam İade Opsiyonel alandır, boş gönderilirse veya hiç gönderilmezse tüm TrxType’ lar listelenir.
TrxStatus (integer)	Yapılan işlemin sonucunu gösterir. 0 : Bekleyen işlem 1 : Başarılı işlem 2 : Başarısız işlem Opsiyonel alandır, boş gönderilirse veya hiç gönderilmezse tüm TrxStatus’ ler listelenir.
SubDealerId (integer) (opsiyonel)	Alt bayinin numarasıdır. Eğer bu alan gönderilmezse üst bayiye ait tüm işlemler listelenir.

Örnek İstek (JSON)


{
   "PaymentDealerAuthentication":{
      "DealerCode":"xxx",
      "Username":"xxx",
      "Password":"xxx",
      "CheckKey":"28ba1f316e661ee7a0477a13aa30613da548c94a8098829af9255b04d7e916e3"
   },
   "PaymentDealerRequest":{
      "TrxStartDate":"2020-07-12 09:00",
      "TrxEndDate":"2020-08-12 09:00",
      "TrxType":"2",
      "TrxStatus":"1",
      "SubDealerId":""
   }
}

Başarılı İstek Sonucu

Gönderilen istek verileri Moka’ da başarılı bir şekilde işlenmişse, geri dönüş nesnesinin "ResultCode" alanında "Success" bilgisi yazar. "Data" alanında ise Moka’ dan dönen işlem sonucu bulunur. "Data" içinde yer alan "IsSuccessful" (true/false) alanı kontrol edilerek işlemin durumu kontrol edilir. Bu alanda false dönmesi durumunda aynı nesne içindeki ResultCode ve ResultMessage alanları kontrol edilerek işlemin neden başarısız olduğu görülebilir. "IsSuccessful": true olması durumunda ise "ListItemCount" alanında transaction sayısı yazar ve “PaymentTrxList” nesnesi içinde hem ana ödeme kaydı bilgileri hem de o girilen tarih aralığındaki transaction’ a ait bilgiler döner.
Ana ödeme kaydı ile bu ödemeye ait Transaction kayıtlarının birbiriyle ilişkisini daha detaylı öğrenebilmek için lütfen alttaki GetDealerPaymentTrxDetailList servisimizi de inceleyiniz.

PaymentTrxList Array’ i içinde dönen Ödeme ana kaydı durumları şu şekildedir;

PaymentStatus	PaymentTrxStatus	Açıklama
0 - Beklemede	0 - Beklemede	Ödeme onayı bekliyor
1 - Ön Provizyon	1 - Başarılı	Ön Provizyon başarılı
1 - Ön Provizyon	2 - Başarısız	Ön Provizyon başarısız
2 - Ödeme	1 - Başarılı	Ödeme başarılı
2 - Ödeme	2 - Başarısız	Ödeme başarısız
3 - İptal	1 - Başarılı	İptal başarılı
4 - Tam İade	1 - Başarılı	İade başarılı

Yine aynı PaymentTrxList Array’ i içinde dönen Ödeme transaction durumları şöyledir;

TrxType	TrxStatus	Açıklama
1	1	Ön Provizyon başarılı
1	2	Ön Provizyon başarısız
2	1	Ödeme başarılı
2	2	Ödeme başarısız
3	1	İptal başarılı
3	2	İptal başarısız
4	1	İade başarılı
4	2	İade başarısız

Bu servisle dönen Ana Ödeme kayıt bilgilerinin anlamları üstteki Ödeme Listesi (GetPaymentList) servisimizde açıklanmıştır.

Bu servisle dönen Transaction kayıt bilgileri DealerPaymentTrxId ve sonraki bilgilerdir.
Bu bilgilerin anlamları alttaki Ödeme Detay Listesi (GetDealerPaymentTrxDetailList) servisimizde detaylı bir şekilde açıklanmıştır.

Bu serviste en fazla 1000 adet kayıt gösterilmektedir.

Başarılı Sonuç Örneği


                     "DealerPaymentDealerId":33578,
                     "DealerId":1,
                     "Amount":1.00,
                     "RefAmount":0.00,
                     "DealerCommissionAmount":0.02,
                     "DealerGroupCommissionAmount":0.02
                  }
               ]
            },
            "PaymentTrxDetailList":[
               {
                  "DealerPaymentTrxId":41748,
                  "TrxCode":"1500274c-8034-4357-b144-fb0a7ba0be52",
                  "TrxDate":"2020-07-27T13:06:39.997",
                  "Amount":1.00,
                  "TrxType":2,
                  "TrxStatus":1,
                  "PaymentReason":1,
                  "VoidRefundReason":0,
                  "VirtualPosOrderId":"ORDER-20209NHXA05020598",
                  "ResultMessage":"",
                  "SubPaymentTrxList":[
                     {
                        "DealerPaymentTrxDealerId":41284,
                        "DealerPaymentDealerId":33578,
                        "DealerId":1,
                        "Amount":1.00,
                        "DealerCommissionAmount":0.02,
                        "DealerGroupCommissionAmount":0.02,
                        "DealerStatementId":0
                     }
                  ]
               }
            ]
         }
      ]
   },
   "ResultCode":"Success",
   "ResultMessage":"",
   "Exception":null
}

Başarısız İstek Sonucu

Gönderilen istek verileri Moka akışları içerisinde işlenemediyse, geri dönüş nesnesinin "ResultCode" alanında alttaki tablodaki hata kodlarından birisi bulunur.
Beklenmeyen yazılımsal bir hata oluştuğunda ise, "ResultCode" alanında EX yazar ve "ResultMessage" alanında alınan hata mesajı (Exception) yer alır.
Her iki durumda da, "Data" nesnesi null olarak gelir.

ResultCode	Açıklama
PaymentDealer.CheckPaymentDealerAuthentication.InvalidRequest	CheckKey hatalı ya da nesne hatalı ya da JSON bozuk olabilir.
PaymentDealer.CheckPaymentDealerAuthentication.InvalidAccount	Böyle bir bayi bulunamadı.
PaymentDealer.GetPaymentTrxListMarketPlace.InvalidDateTimeFormat	Tarih formatı "yyyy-MM-dd HH:mm" şeklinde olmalıdır.
PaymentDealer.GetPaymentTrxListMarketPlace.DealerNotAuthorized	Bayinin izni yok.
PaymentDealer.GetPaymentTrxListMarketPlace.InvalidTrxType	Geçersiz TrxType değeri girildi.
PaymentDealer.GetPaymentTrxListMarketPlace.InvalidTrxStatus	Geçersiz TrxStatus değeri girildi.
EX	Beklenmeyen bir hata oluştu

Başarısız Sonuç Örneği


{
   "Data":null,
   "ResultCode":"PaymentDealer.CheckPaymentDealerAuthentication.InvalidAccount ",
   "ResultMessage":"",
   "Exception":null
}