İade Etme

URL

Ödeme iade işlemi için kullanılan endpoint ve http metod bilgisi aşağıda verilmiştir.

HTTP Metod URL
POST /payment/v1/refunds

İstek Parametreleri

İade işlemi gerçekleştirmek için yapılacak isteklerde gönderilmesi beklenen parametreler aşağıdaki tablo ve alt başlıklar altında listelenmiştir.

Parametre Adı Tipi Zorunlu Açıklama
paymentId number Evet İade yapılmak istenen ödemenin ID değeri
conversationId string Hayır İstekle beraber gönderilip, cevapla birlikte alınabilecek, "bumerang" değer. Farklı istekleri birbirleriyle ilişkilendirmek için kullanılabilir. Genellikle üye işyerinin ödemeye ilişkin sipariş numarası kullanılır
refundDestinationType RefundDestinationType Hayır İade karta ise CARD cüzdana ise WALLET girilecek olan alan. Varsayılan değer CARD bknz. İade Tipleri
chargeFromMe boolean Hayır İadeyi üye işyeri üstlensin mi? Pazaryeri ödemesinde satıcı bakiyesinin yetersiz olduğu durumda kullanılabilir

Dönüş Parametreleri

Parametre Adı Tipi Açıklama
id number İade işlemine dair üretilen iade ID değeri
conversationId string İstek ile beraber yollanan conversationId değeri
createdDate date İade yapılan tarih ve saat
status string Başarılı iade işlemleri için SUCCESS başarısız iade işlemleri için FAILURE döner
refundPrice decimal Kırılıma ait iade edilen tutar
refundBankPrice decimal Kırılıma ait iade edilen banka tutarı
refundWalletPrice decimal Kırılıma ait iade edilen cüzdan tutarı
refundType string İptal edilen işlem için CANCEL iade edilen işlem için REFUND değeri döner
refundDestinationType RefundDestinationType İadenin yapıldığı yer. bknz: İade Tipleri
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
currency Currency İade edilen tutarın para birimi. bkz: Para Birimleri
paymentId number İade edilen ödemeye ait ID değeri
paymentTransactionRefunds PaymentTransactionRefundResponse[] İadeye ilişkin kırılım bilgilerini barındırır. bkz: İade Kırılım Bilgileri

İade Kırılım Bilgileri

Yapılan iadenin kırılımlarına ilişkin bilgileri içeren objedir.

Parametre Adı Tipi Açıklama
id number İade işleminin alt kırılımına dair üretilen iade ID değeri
conversationId string İstek ile beraber yollanan conversationId değeri
createdDate date İade yapılan tarih ve saat
status string Başarılı iade işlemleri için SUCCESS başarısız iade işlemleri için FAILURE döner
isAfterSettlement boolean İade edilen kırılım eğer para gönderimi sonrası iade işlemi gerçekleştiyse true para gönderimi öncesi gerçekleştiyse false değeri döner
refundPrice decimal Kırılıma ait iade edilen tutar
refundBankPrice decimal Kırılıma ait iade edilen banka tutarı
refundWalletPrice decimal Kırılıma ait iade edilen cüzdan tutarı
currency Currency İade edilen tutarın para birimi. bkz: Para Birimleri
paymentTransactionId number İade edilen ödemenin kırılımına ait ID değeri
paymentId number İade edilen ödemeye ait ID değeri
refundDestinationType RefundDestinationType İade karta ise CARD cüzdana ise WALLET girilecek olan alan. Default değer CARD. bkz: İade Tipleri

Örnek Kodlar

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