Ödeme Kırılımdan İade Arama

URL

Kırılımdan iadeleri aramak için kullanılan endpoint ve http metod bilgisi aşağıda verilmiştir.

HTTP Metod URL
GET /payment-reporting/v1/refund-transactions

İstek Parametreleri

Ödeme arama aşağıdaki parametreler kullanılarak yapılabilir.

Parametre Adı Tipi Zorunlu Açıklama
id number Hayır Kırılımdan iadenin ID'si
paymentId number Hayır Ödemenin id bilgisi
paymentTransactionId number Hayır Ödeme kırılımının 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 ödeme 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
isAfterSettlement boolean Hayır Kırılımdan iadenin para gönderimi sonrasında yapılmış olma durumu
minPaidPrice decimal Hayır Kırılımdan iade yapılmış minimum tutar bilgisi
maxPaidPrice decimal Hayır Kırılımdan iade yapılmış maksimum tutar bilgisi
minCreatedDate date Hayır Kırılımdan iadenin geçirildiği minimum tarih bilgisi
maxCreatedDate date Hayır Kırılımdan iadenin 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ı

Dönüş Parametreleri

Ö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 Kırılımdan iadenin ID'si
createdDate date Kırılımdan iade yapılan tarih ve saat
status RefundStatus Başarılı Kırılımdan iade işlemleri için SUCCESS başarısız iade işlemleri için FAILURE döner
refundDestinationType string Kırılımdan iade karta ise CARD cüzdana ise WALLET girilecek olan alan. Default değer CARD
refundPrice decimal Kırılımdan iade edilen tutar
refundBankPrice decimal Kırılımdan iade edilen banka tutarı
refundWalletPrice decimal Kırılımdan iade edilen cüzdan tutarı
conversationId string Üye işyeri tarafından ödeme iade isteği içerisinde gönderilen conversationId değeri
authCode string Kırılımdan iade edilen ödemeye ilişkin authCode değeri
hostReference string Kırılımdan iade edilen ödemeye ilişkin hostReference değeri
transId string Kırılımdan iade edilen ödemeye ilişkin transId değeri
isAfterSettlement boolean Kırılımdan iadenin para gönderimi sonrası iade edilip edilmediği bilgisi
paymentType PaymentType bkz: Ödeme Tipleri
error PaymentError Kırılımdan iade hata aldıysa, hataya ait detay bilgileri bkz: Ödeme Hata Bilgisi
paymentTransactionId number Kırılımdan iadenin yapıldığı ödeme kırılımı ID değeri

Örnek Kodlar

Açık kaynak kodlu Craftgate API client'larındaki örnek kodları inceleyebilirsiniz.