İade Talebi İşlemi
Ödemenin ertesi günü veya sonrasında yapılacak iade işlemleri
Servis Adresi
POST /PaymentDealer/DoCreateRefundRequest
İstek Parametreleri
PaymentDealerAuthentication
| 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. |
PaymentDealerRequest
| Parametre | Açıklama |
|---|---|
| VirtualPosOrderId string | Ödeme işlemi sonucunda dönen işlem numarası bilgisidir. 3D ödemelerde trxCode ismiyle dönülen numaradır. Key: trxCode Value : ORDER-17131QQFG04026575 |
| OtherTrxCode string | Ödeme işlemi gönderirken bayinin kendine ait verdiği Unique işlem numarasıdır. VirtualPosOrderId verilmişse bu numarayı boş gönderebilirsiniz. Ya da kendi Unique numaranızı kullanmak istiyorsanız VirtualPosOrderId alanını boş gönderebilirsiniz. |
| Amount decimal | iade edilmesi istenen Tutar alanıdır. Bu alana “Kısmi iade” için en fazla ödeme tutarı kadar bir değer girilebilir. Bu alana sıfır verilirse veya bu alan hiç gönderilmezse, ödemenin tamamı iade edilir veya daha önce kısmi iade yapılmışsa, geri kalan tutarın tamamı iade edilir. |
Örnek İstek (JSON)
{
"PaymentDealerAuthentication":{
"DealerCode":"xxx",
"Username":"xxx",
"Password":"xxx",
"CheckKey":"ff4a6ee22aeafe87f7930f84b5ce2ad9655bfc6b5e430644a88c5b75a09fdee1"
},
"PaymentDealerRequest":{
"VirtualPosOrderId":"ORDER-17131QMlH04026199",
"OtherTrxCode":"",
"Amount":14.25
}
}
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 Ruut'nın size döndüğü işlem bilgileri bulunur. "Data" içinde yer alan "IsSuccessful" alanı true olarak dönecektir. "RefundRequestId" alanında ise iade talebi işleminin kodu bulunmaktadır.
Başarılı Sonuç Örneği
{
"Data" : {
"IsSuccessful":true,
"ResultCode":"",
"ResultMessage":"",
"RefundRequestId":"1356"
},
"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 |
|---|---|
| PaymentDealer.DoCreateRefundRequest.InvalidRequest | CheckKey hatalı ya da nesne hatalı ya da JSON bozuk olabilir. |
| PaymentDealer.DoCreateRefundRequest.InvalidAccount | Böyle bir bayi bulunamadı. |
| PaymentDealer.DoCreateRefundRequest.OtherTrxCodeOrVirtualPosOrderIdMustGiven | Veriler eksik gönderildi. OrderId veya OtherTrxCode girilmeli. |
| PaymentDealer.DoCreateRefundRequest.InvalidAmount | Tutar alanına girilen değer, ödeme tutarından büyük olmamalı. |
| PaymentDealer.DoCreateRefundRequest.PaymentNotFound | İade talebi oluşturulacak bir ödeme kaydı bulunamadı. |
| PaymentDealer.DoCreateRefundRequest.OtherTrxCodeAndVirtualPosOrderIdMismatch | Gönderilen veriler farklı ödemelere ait. |
| PaymentDealer.DoCreateRefundRequest.RefundRequestAlreadyExist | Bu ödemeye ait bekleyen bir iade talebi mevcut. Onun tamamlanması beklenmeli veya talep geri çekilmeli. |
| EX | Beklenmeyen bir hata oluştu |
Başarısız Sonuç Örneği
{
"Data": null,
"ResultCode": "PaymentDealer.DoCreateRefundRequest.InvalidAccount ",
"ResultMessage": "",
"Exception": null
}