Servis Adresi
/DealerSale/GetPaymentPlanList
İstek Parametreleri
DealerSaleAuthentication
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. |
DealerSaleRequest
Parametre |
Açıklama |
DealerSaleId (integer) |
Moka tarafında satışın Unique Id’ sidir. SaleCode gönderilirse zorunlu değil. |
SaleCode (string) |
Satışın bayi tarafındaki kodudur. DealerSaleId gönderilirse zorunlu değil. |
PaymentPlanPaymentDateStart (string) |
Hangi tarihler arasındaki ödeme adımları isteniyor. |
PaymentPlanPaymentDateEnd (string) |
Başlangıç ve bitiş tarihleri "YYYYMMDD" formatında verilir. |
Örnek İstek (JSON)
{
"DealerSaleAuthentication": {
"DealerCode": "xxx",
"Username": "xxx",
"Password": "xxx",
"CheckKey": "aabbccddeeff"
},
"DealerSaleRequest": {
"DealerSaleId": "1",
"SaleCode": "",
"PaymentPlanPaymentDateStart": "20171120",
"PaymentPlanPaymentDateEnd": "20171130"
}
}
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 dönen işlem sonucu bulunur. "Data" içinde yer alan bilgileri kontrol ederek akışlarınızı devam ettirebilirsiniz.
Parametre |
Açıklama |
PaymentPlanListCount (integer) |
Girilen tarihler arasındaki, o satışa ait ödeme adımlarının sayısıdır. |
PaymentPlanList (Array) |
Ödeme adımlarının listesi
DealerPaymentPlanId (integer) | Moka tarafında bu ödeme adımı için verilen Unique Id’ dir. |
DealerSaleId (integer) | Moka 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ılmaya başlandığı tarih |
Amount (decimal) | Çekim tutarı |
Currency (string) | Para birimi |
InstallmentNumber (integer) | Taksit miktarı (0 veya 1 ise peşin demektir) |
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 son denenen 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", Moka sistemi tarafından, bayinin zaman programına göre otomatik olarak oluşturulduysa "false" döner. |
PlanStatus (integer) | 0 : Plan olustu, ç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. |
DealerCustomerId (integer) | Ödemenin çekileceği müşteri ID si. |
CustomerCode (string) | Bayi tarafında bu müşterinin kodudur. |
UserId (integer) | Ödemenin çekileceği MOKA kullanıcısı ID si |
UserCode (string) | MOKA kullanıcısı kodu |
TrialCount (integer) | Çekimin kaç kere denendiğini gösterir. |
|
Başarılı Sonuç Örneği
{
"Data": {
"PaymentPlanListCount": 1,
"PaymentPlanList": [
{
"DealerPaymentPlanId": 2,
"DealerSaleId": 1,
"SaleCode": "ABD1",
"PaymentDate": "20171121",
"PlanStatus": 0,
"HistoryDate": "",
"Amount": 0.01,
"Currency": "",
"InstallmentNumber": 1,
"IsManualPlan": false,
"DealerCustomerId": 1,
"CustomerCode": "CODE1",
"UserId": 0,
"UserCode": "",
"CardToken": "",
"DealerPaymentId": 0,
"DealerCustomerTypeId": 0,
"UserPosPaymentId": 0,
"TrialCount": 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 |
DealerSale.GetPaymentPlanList.InvalidRequest | CheckKey hatalı ya da nesne hatalı ya da JSON bozuk olabilir. |
DealerSale.GetPaymentPlanList.PaymentPlanPaymentDateStartIsRequired | Ödeme planı başlangıç tarihi gereklidir. |
DealerSale.GetPaymentPlanList.PaymentPlanPaymentDateEndIsRequired | Ödeme planı bitiş tarihi gereklidir. |
DealerSale.GetPaymentPlanList.NoDataFound | Veri bulunamadı. |
DealerSale.GetPaymentPlanList.InvalidDateFormatPaymentPlanPaymentDateStart | Ödeme planı başlangıç tarihi formatı geçersiz. |
DealerSale.GetPaymentPlanList.InvalidDateFormatPaymentPlanPaymentDateEnd | Ödeme planı bitiş tarihi formatı geçersiz. |
DealerSale.GetPaymentPlanList.SaleCodeOrDealerSaleIdMustBeGiven | Satış kodu veya bayi satış id girilmelidir. |
EX | Beklenmeyen bir hata oluştu |
Başarısız Sonuç Örneği
{
"Data": null,
"ResultCode": "DealerSale.GetPaymentPlanList.SaleCodeOrDealerSaleIdMustBeGiven",
"ResultMessage": "",
"Exception": null
}