Servis Adresi
POST /DealerSale/UpdatePaymentPlan
İ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ı güncellenecektir. Ödeme tarihi henüz gelmemiş olmalıdır. |
| PaymentDate string |
Hangi tarihte çekim yapılacak ("YYYYMMDD" formatında) |
| Amount decimal |
Çekilecek tutar. ( örn: 25.45 ) |
| Currency string |
Zorunlu alan değildir. Hiç gönderilmezse veya boş string gönderilirse varsayılan para birimi TL’dir. (diğer değerler : "USD", "EUR") |
| InstallmentNumber integer |
Taksit miktarı (1: Tek çekim, 2: 2 Taksit ...) |
Örnek İstek (JSON)
{
"DealerSaleAuthentication": {
"DealerCode": "xxx",
"Username": "xxx",
"Password": "xxx",
"CheckKey": "aabbccddeeff"
},
"DealerSaleRequest": {
"DealerPaymentPlanId": "1003",
"PaymentDate": "20170825",
"Amount": "1",
"Currency": "TL",
"InstallmentNumber": "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 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 henüz gelmediği için boş döner. |
| CardToken guid |
Ödeme tarihi henüz gelmediği için boş döner. |
| DealerCustomerTypeId integer |
Ödeme isteği gönderilerek ödeme yapılma durumunda dolu gelir. |
| UserPosPaymentId integer |
Ödeme isteği gönderilerek - Ödeme tarihi henüz gelmediği için boş döner |
| DealerPaymentId integer |
Ödeme tarihi henüz gelmediği için boş döner. |
| IsManualPlan boolean |
Manuel girilen bir ödeme adımı olduğu için "true" döner. |
| PlanStatus integer |
0 : Plan oluştu, çekime henüz sıra gelmedi. |
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.UpdatePaymentPlan.InvalidRequest | CheckKey hatalı ya da nesne hatalı ya da JSON bozuk olabilir. |
| DealerSale.UpdatePaymentPlan.DealerPaymentPlanIdIsRequired | Bayi ödeme plan id bilgisi gerekli. |
| DealerSale.UpdatePaymentPlan.AmountMustBeGreaterThanZero | Miktar sıfırdan büyük olmalıdır. |
| DealerSale.UpdatePaymentPlan.PaymentPlanNotFound | Ödeme planı bulunamadı. |
| DealerSale.UpdatePaymentPlan.DealerSaleNotFound | Bayi satışı bulunamadı. |
| DealerSale.UpdatePaymentPlan.DealerSaleIsNotManualPlan | Bayi satışı manual plan değil. |
| DealerSale.UpdatePaymentPlan.PaymentDatePassed | Çekim yapılacak tarih geçti. |
| DealerSale.UpdatePaymentPlan.InvalidDateFormatPaymentDate | Çekim yapılacak tarih bilgisi formatı geçersiz. |
| DealerSale.UpdatePaymentPlan.SaleEndDatePassed | Satış için çekim yapılacak son tarih geçti. |
| DealerSale.UpdatePaymentPlan.PaymentDateCannotUpdatedToPassedDate | Ödeme tarihi geçmiş tarihle güncellenemez. |
| DealerSale.UpdatePaymentPlan.PaymentDateMustBeAfterSaleBeginDate | Ödeme tarihi satışın başlama tarihinden sonra olmalıdır. |
| DealerSale.UpdatePaymentPlan.PaymentDateMustBeBeforeSaleEndDate | Ödeme tarihi satış bitiş tarihinden önce olmalıdır. |
| DealerSale.UpdatePaymentPlan.InvalidCurrencyCode | Para birimi kodu geçersiz. |
| EX | Beklenmeyen bir hata oluştu |
Başarısız Sonuç Örneği
{
"Data": null,
"ResultCode": "DealerSale.UpdatePaymentPlan.PaymentPlanNotFound",
"ResultMessage": "",
"Exception": null
}