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

URL

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

HTTP Metod URL
GET /payment-reporting/v1/payments/:paymentId/transactions/:paymentTransactionId/refunds

İstek Parametreleri

Detaylı ödeme sorgulama sadece ödeme id değeri kullanılarak yapılabilir.

Parametre Adı Tipi Zorunlu Açıklama
paymentId number Evet Sorgulanmak istenen ödeme ID değeri
paymentTransactionId number Evet Sorgulanmak istenen ödeme kırılımı ID değeri

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.