Ödeme İadesi
- Endpoint:
/pws/payment/refund - HTTP Method:
POST - Request Content-Type:
application/json - Response Content-Type:
application/json - Yetkilendirme: Geçerli AccessToken zorunludur.
(Bkz: 2. Kimlik Doğrulama – AccessToken Alınması)
Açıklama
Bu servis, Netahsilat portalında daha önce yapılmış bir ödemenin tamamen veya kısmen iade edilmesini sağlar.
İade işlemi yalnızca referenceCode üzerinden yapılır.
- Tam iade (Full Refund): İşlem tutarının tamamı iade edilir.
- Kısmi iade (Partial Refund): İşlem tutarının yalnızca belirli bir kısmı iade edilir.
İade işlemi bankadan alınan provizyon durumuna göre başarılı veya başarısız olarak sonuç döner.
Header Bilgileri
| Header Adı | Zorunlu | Açıklama |
|---|---|---|
| Authorization | Evet | Bearer {AccessToken} formatında geçerli token. |
| Content-Type | Hayır | application/json |
Request Body
| Alan Adı | Tip | Zorunlu | Açıklama |
|---|---|---|---|
| referenceCode | string | Evet | İade edilmek istenen işlemin referans kodu |
| refundAmount | decimal | Hayır | İade edilecek tutar. Gönderilmezse tam iade yapılır |
| reason | string | Hayır | İade sebebi (örn: "Ürün iadesi", "Kullanıcı isteği", "Hatalı işlem") |
- Örnek Request (Tam İade)
- Örnek Request (Kısmi İade)
{
"amount": 1500.500,
"referenceCode": "NTH2P00000002224",
"reason": "Ürün iadesi"
}
{
"amount": 1.500,
"referenceCode": "NTH2P00000002224",
"reason": "Ürün iadesi"
}
- Başarılı Response (Tam İade)
- Başarılı Response (Kısmi İade)
{
"message": null,
"statusCode": 200,
"exceptions": null,
"data": {
"lastAmount": 0.000,
"transactionStatusId": 1,
"errorCode": null,
"errorMessage": null,
"isSuccess": true
},
"oldData": null,
"errors": null
}
{
"message": null,
"statusCode": 200,
"exceptions": null,
"data": {
"lastAmount": 1498.500,
"transactionStatusId": 1,
"errorCode": null,
"errorMessage": null,
"isSuccess": true
},
"oldData": null,
"errors": null
}
Örnek cURL
curl --location 'https://pgw.netahsilatdemo.com/pws/payment/refund' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzY29wZSI6WyJwd3N2MS5hcGkiLCJlcnB2MS5hcGkiLCJjYXR2MS5hcGkiLCJ2ZW5kb3J2MS5hcGkiXSwiYWN0b3J0Ijoic2VydmljZSIsInJvbGUiOiJzZXJ2aWNlIiwiVW5pcXVlIjoiOGE2NjQxZGYtMGU4Ny00OWVkLWEyOTgtNjNjN2M3Y2JjNTk1IiwiVGVuYW50SWQiOiI2NzA2ODNjMS0yZmUwLTQ4NDYtODdiMi02Y2JhOWI3OTNhYjIiLCJodHRwOi8vc2NoZW1hcy5taWNyb3NvZnQuY29tL3dzLzIwMDgvMDYvaWRlbnRpdHkvY2xhaW1zL2V4cGlyYXRpb24iOiI2Mzg5NzA3MjQxNDMzMzI2OTUiLCJuYmYiOjE3NjEzMDI4MTQsImV4cCI6MTc2MTQ3NTYxNCwiaWF0IjoxNzYxMzAyODE0LCJpc3MiOiJzc28uYXBpIiwiYXVkIjoiZWNvenVtLnNzbyJ9.IbmVm9oVxUvDXhzYnCncNMYPBFqqJTXFQLkFYfhSbUA' \
--data '{
"amount": 1498.500,
"referenceCode": "NTH2P00000002224",
"reason": "test refund"
}'
Notlar & En İyi Uygulamalar
-
İade işlemi yalnızca referenceCode üzerinden yapılabilir.
-
Tamamlanmamış veya başarısız işlemler için iade talebi oluşturulamaz.
-
Kısmi iadelerde
refundAmountdeğeri, işlem tutarından büyük olamaz. -
Aynı işlem için birden fazla kısmi iade yapılabilir; toplam iade tutarı işlem tutarını aşmamalıdır.
-
Banka provizyon kuralları gereği, belirli süreyi aşan işlemler için iade mümkün olmayabilir.
-
Başarılı iade sonrası sistemde kalan tutar
lastAmountalanında güncel olarak gösterilir. -
AccessToken, iade işlemini yapmaya yetkili kullanıcıya veya bayiye ait olmalıdır.