Ödeme Adımı Görme
Servis Adresi
/DealerSale/GetPaymentPlan
İ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. |
Örnek İstek (JSON)
{
"DealerSaleAuthentication": {
"DealerCode": "xxx",
"Username": "xxx",
"Password": "xxx",
"CheckKey": "aabbccddeeff"
},
"DealerSaleRequest": {
"DealerPaymentPlanId": "1003"
}
}
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 bu ödeme adımı için verilen Unique Id’ dir. |
DealerSaleId (integer) | Ruut tarafında bu ödeme adımının eklendiği satışın Id’ sidir. |
SaleCode (integer) | Bayi tarafında bu ödeme adımının eklendiği satışın kodudur. |
PaymentDate (string) | Çekimin yapılacağı tarih |
Amount (decimal) | Çekilecek tutar |
Currency (string) | Para birimi |
InstallmentNumber (integer) | Taksit bilgisi |
HistoryDate (datetime) | Ödeme tarihi geldiyse ve ödeme işlemine başlanmışsa son çekim denemesinin tarihi döner, diğer türlü boş döner. |
CardToken (guid) | Ödeme tarihi geldiyse ve ödeme işlemine başlanmışsa kredi kartının Token' ı döner, diğer türlü boş döner. |
DealerCustomerTypeId (integer) | Ödeme isteği gönderilerek ödeme yapılma durumunda dolu gelir. |
UserPosPaymentId (integer) | Ödeme tarihi geldiyse ve ödeme işlemine başlanmışsa, ödeme isteği gönderilerek ödeme yapılma durumunda dolu gelir. |
DealerPaymentId (integer) | Ödeme tarihi geldiyse ve ödeme işlemine başlanmışsa son çekimin ödeme ID' si döner, diğer türlü boş döner. |
IsManualPlan (boolean) | Manuel girilen bir ödeme adımıysa "true", Ruut sistemi tarafından, bayinin zaman programına göre otomatik olarak oluşturulduysa "false" döner. |
PlanStatus (integer) | 0 : Plan oluştu, çekime henüz sıra gelmedi. 1 : Çekim başarıyla tamamlandı. 2 : Çekim başarısız oldu tekrar denenecek. 3 : Çekim başarısız oldu bir daha denenmeyecek. |
Başarılı Sonuç Örneği
{
"Data": {
"DealerPaymentPlanId": 1003,
"DealerSaleId": 1003,
"SaleCode": "satis",
"PaymentDate": "20170825",
"Amount": 1,
"Currency": "TL",
"InstallmentNumber": 1,
"HistoryDate": "",
"CardToken": "",
"DealerCustomerTypeId": 0,
"UserPosPaymentId": 0,
"DealerPaymentId": 0,
"IsManualPlan": true,
"PlanStatus": 0
},
"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.GetPaymentPlan.PaymentPlanNotFound | Ödeme planı bulunamadı. |
DealerSale.GetPaymentPlan.DealerPaymentPlanIdIsRequired | Bayi ödeme planı id gereklidir. |
DealerSale.GetPaymentPlan.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.GetPaymentPlan.DealerPaymentPlanIdIsRequired",
"ResultMessage": "",
"Exception": null
}