Ö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 |
İ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 |
| 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 |
string |
İade edilen cüzdan tutarı |
paymentId |
number |
İade edilen ödemeye ait ID değeri |
currency |
string |
İade edilen tutarın para birimi |
paymentTransactionRefunds |
PaymentTransactionRefundResponse[] |
İadeye ilişkin kırılım bilgilerini barındırır bkz: İ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 |
Açık kaynak kodlu ÖderoPay API client'larındaki örnek kodları inceleyebilirsiniz