Ödemeye ait iadeleri aramak için kullanılan endpoint ve http metod bilgisi aşağıda verilmiştir.
| HTTP Metod | URL |
|---|---|
GET |
/payment-reporting/v1/refunds |
Ödemeye ait iadeleri arama aşağıdaki parametreler kullanılarak yapılabilir.
| Parametre Adı | Tipi | Zorunlu | Açıklama |
|---|---|---|---|
id |
number |
Hayır | İadenin ID'si |
paymentId |
number |
Hayır | Ödemenin id bilgisi |
buyerMemberId |
number |
Hayır | Alıcı üyeyle ilişkilendirilmiş ödemelerde yer alan, ilgili üyenin ID'sini belirten değer |
conversationId |
string |
Hayır | Üye işyeri tarafından iade isteği içerisinde gönderilen conversationId değeri |
status |
Status |
Hayır | Başarılı iade işlemleri için SUCCESS başarısız iade işlemleri için FAILURE döner İade Durumu |
currency |
Currency |
Hayır | bkz: Para Birimleri Ödemenin tahsil edildiği para birimi |
minPaidPrice |
decimal |
Hayır | İade yapılmış minimum tutar bilgisi |
maxPaidPrice |
decimal |
Hayır | İade yapılmış maksimum tutar bilgisi |
minCreatedDate |
date |
Hayır | İadenin geçirildiği minimum tarih bilgisi |
maxCreatedDate |
date |
Hayır | İadenin geçirildiği maksimum tarih bilgisi |
page |
number |
Hayır | Sayfalama için sayfa sayısı |
size |
number |
Hayır | Sayfalama için sonuç sayısı |
Ödeme işleminin sonucunda dönen parametreler de API dokümantasyonu giriş sayfasındaki Dönüş Formatları bölümünde belirtilen kurallara tabidir. Dönen cevaptaki obje yapısı aşağıda belirtilmiştir:
| Parametre Adı | Tipi | Açıklama |
|---|---|---|
id |
number |
İadenin ID'si |
createdDate |
date |
İade yapılan tarih ve saat |
status |
RefundStatus |
Başarılı iade işlemleri için SUCCESS başarısız iade işlemleri için FAILURE döner |
refundDestinationType |
string |
İade karta ya da ödeme kaynağına ise PROVIDER cüzdana ise WALLET döner |
refundPrice |
decimal |
İade edilen tutar |
refundBankPrice |
decimal |
İade edilen banka tutarı |
refundWalletPrice |
decimal |
İade edilen cüzdan tutarı |
conversationId |
string |
Üye işyeri tarafından ödeme iade isteği içerisinde gönderilen conversationId değeri |
authCode |
string |
İade edilen ödemeye ilişkin authCode değeri |
hostReference |
string |
İade edilen ödemeye ilişkin hostReference değeri |
transId |
string |
İade edilen ödemeye ilişkin transId değeri |
paymentType |
PaymentType |
bkz: Ödeme Tipleri |
error |
PaymentError |
İade hata aldıysa, hataya ait detay bilgileri bkz: Ödeme Hata Bilgisi |
paymentId |
number |
İadenin yapıldığı ödeme ID değeri |
Açık kaynak kodlu Craftgate API client'larındaki örnek kodları inceleyebilirsiniz.