Tek kayıt endpointi GET /payment/v1/refund-transactions/{refundTxId}'dır. Ayrıca GET /payment/v1/refund-transactions ile paymentId, conversationId ve paymentTransactionId filtreleri kullanılarak koleksiyon aranabilir.

URL

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

HTTP Metod URL
GET /payment/v1/refund-transactions/{refundTxId}

İstek Parametreleri

Yapılmış iade işlemlerini sorgulamak 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 string Hayır İade karta ise CARD cüzdana ise WALLET girilecek olan alan. Default değer CARD

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
refundStatus string Başarılı iade işlemleri için SUCCESS başarısız iade işlemleri için FAILURE döner
refundPrice decimal İade edilen tutar
refundBankPrice decimal İade edilen banka tutarı
refundWalletPrice decimal İade edilen cüzdan tutarı
refundDestinationType string İade edilen cüzdan tutarı
currency string İade edilen tutarın para birimi
paymentId number İade edilen ödemenin ID değeri
currency string İade edilen tutarın para birimi
paymentTransactionRefunds PaymentTransactionRefundResponse[] İadeye ilişkin kırılım bilgilerini barındıran obje iade 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 string İade edilen tutarın para birimi
paymentTransactionId number İade edilen ödemenin kırılımına ait ID değeri
paymentId number İade edilen ödemeye ait ID değeri
currency string İade edilen tutarın para birimi
refundDestinationType string İade karta ise CARD cüzdana ise WALLET girilecek olan alan. Default değer CARD

Örnek Kodlar

Açık kaynak kodlu ÖderoPay API client'larındaki örnek kodları inceleyebilirsiniz