Ödeme Adımı Tarihçe Listeleme
Servis Adresi
/DealerSale/GetPaymentPlanHistoryList
İstek Parametreleri
DealerSaleAuthentication
Parametre |
Açıklama |
DealerCode(string) |
Ruut sistemi tarafından verilen bayi kodu |
Username (string) |
Ruut sistemi tarafından verilen Api kullanıcı adı |
Password (string) |
Ruut 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. |
DealerSaleRequest
Parametre |
Açıklama |
DealerPaymentPlanId (integer) |
Ruut tarafında ödeme adımının Unique Id’ sidir. Bu ödeme adımının çekim tarihçeleri (denemeleri) gösterilecektir. |
Örnek İstek (JSON)
{
"DealerSaleAuthentication": {
"DealerCode": "xxx",
"Username": "xxx",
"Password": "xxx",
"CheckKey": "aabbccddeeff"
},
"DealerSaleRequest": {
"DealerPaymentPlanId": "1"
}
}
Başarılı İstek Sonucu
Gönderilen istek verileri Ruut’ da başarılı bir şekilde işlenmişse, geri dönüş nesnesinin "ResultCode" alanında "Success" bilgisi yazar.
"Data" alanında ise dönen işlem sonucu bulunur. "Data" içinde yer alan bilgileri kontrol ederek akışlarınızı devam ettirebilirsiniz.
Parametre |
Açıklama |
DealerPaymentPlanId (integer) |
Ruut tarafında ödeme adımının Unique Id’ sidir. |
PaymentPlanHistoryListCount (integer) |
Ödeme adımına ait çekim tarihçelerinin (denemelerinin) sayısı |
PaymentPlanHistoryList (Array) |
Ödeme adımına ait çekim tarihçelerinin listesi
DealerPaymentPlanHistoryId (integer) | Ruut tarafında ödeme adımının tarihçesine verilen Id’ dir. |
HistoryDate (datetime) | Ödeme adımına ait, her bir çekim denemesinin yapıldığı tarih ve saat |
Amount (decimal) | Çekim tutarı |
Currency (string) | Para birimi |
InstallmentNumber (integer) | Taksit miktarı (0 veya 1 ise peşin demektir) |
CreditCardToken (guid) | Hangi karttan çekim denemesi yapıldı. |
DealerCustomerTypeId (integer) | Ödeme isteği göndererek çekim yapıldıysa, müşteri tipi Id’si. |
DealerPaymentId (integer) | Ruut tarafında bu ödeme çekim denemesi için verilen Unique Ödeme Id’ sidir. |
HistoryStatus (integer) | 0 : Başarısız Çekim 1 : Başarılı Çekim |
ServiceMessage (string) | Ödeme servisimizden dönen hata kodu ve mesajı |
|
Başarılı Sonuç Örneği
{
"Data": {
"PaymentPlanHistoryListCount": 1,
"PaymentPlanHistoryList": [
{
"DealerPaymentPlanHistoryId": 1,
"HistoryDate": "2017-08-17T16:52:22.963",
"Amount": 0.01,
"Currency": "",
"InstallmentNumber": 1,
"CreditCardToken": "1635BF45-854F-4D5D-83B7-E40B87C72703",
"DealerCustomerTypeId": 0,
"UserPosPaymentId": 0,
"DealerPaymentId": 29940,
"HistoryStatus": true,
"ServiceMessage": ""
}
]
},
"ResultCode": "Success",
"ResultMessage": "",
"Exception": null
}
Başarısız İstek Sonucu
Gönderilen istek verileri Ruut 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 |
DealerSale.GetPaymentPlanHistoryList.NoDataFound | Veri bulunamadı. |
DealerSale.GetPaymentPlanHistoryList.PaymentPlanNotFound | Ödeme planı bulunamadı. |
DealerSale.GetPaymentPlanHistoryList.DealerPaymentPlanIdIsRequired | Bayi ödeme planı id gereklidir. |
DealerSale.GetPaymentPlanHistoryList.InvalidRequest | CheckKey hatalı ya da nesne hatalı ya da JSON bozuk olabilir. |
EX | Beklenmeyen bir hata oluştu |
Başarısız Sonuç Örneği
{
"Data": null,
"ResultCode": "DealerSale.GetPaymentPlanHistoryList.DealerPaymentPlanIdIsRequired",
"ResultMessage": "",
"Exception": null
}