İptal / İade

Tamamlanmış bir ödeme için /payment/refund endpoint'ini kullanabilirsiniz. refundAmount alanını doldurursanız kısmi iade, boş bırakırsanız tam iade gerçekleştirilir. Süreç, ödeme başlatmaya benzer şekilde işler: dönen deepLinkUrl üzerinden müşteri onayı alınır ve sonuç callback URL'inize iletilir.

Ödeme İade İşlemi

post

https://sandbox-api.iyzipay.com/v3/in-storehttps://api.iyzipay.com/v3/in-store

/payment/refund

Tamamlanmış bir ödemenin tamamını veya bir kısmını iade etmek için kullanılır.

Header parameters

x-api-keystringRequired

iyzico panelinizdeki CepPOS API anahtarı

Example: YOUR_API_KEY

x-secret-keystringRequired

iyzico panelinizdeki CepPOS güvenlik anahtarı

Example: YOUR_SECRET_KEY

x-merchant-idstringRequired

iyzico hesabınızın üye işyeri numarası

Example: YOUR_MERCHANT_ID

x-callback-urlstringRequired

İşlem sonucu bildirimi için callback URL

Example: YOUR_CALLBACK_URL

Body

application/json

userIdstringRequired

İşlemi başlatan kullanıcı ID'si.

Example: user-01

paymentIdlongRequired

İade edilecek ödemenin ID'si.

Example: 1000001

refundPriceBigDecimal · floatOptional

İade edilecek tutar. Boş bırakılırsa eğer tam iade yapılır.

Example: 50

Responses

200

İade talebi başarıyla alındı

application/json

statusstringOptional

İşlemin sonucunu gösterir. Başarılı durumlarda "success" döner.

Example: success

deepLinkUrlstringOptional

Müşteriyi iade onay ekranına yönlendiren deep link URL'i. İade akışı bu link üzerinden tamamlanır.

Example: iyzico://refund?token=def456

paymentSessionTokenstringOptional

İade oturumuna özgü token. Callback sonrasında şifre çözmek için kullanılır.

Example: def456uvw

paymentIdLongOptional

İade işlemi başlatılan orijinal ödemenin kimliği.

Example: 1000001

400

Geçersiz parametre veya iade edilemez durum

application/json

post/payment/refund

HTTPcURLJavaScriptPython

POST /v3/in-store/payment/refund HTTP/1.1
Host: sandbox-api.iyzipay.com
x-api-key: YOUR_API_KEY
x-secret-key: YOUR_SECRET_KEY
x-merchant-id: YOUR_MERCHANT_ID
x-callback-url: YOUR_CALLBACK_URL
Content-Type: application/json
Accept: */*
Content-Length: 59

{
  "userId": "user-01",
  "paymentId": "1000001",
  "refundPrice": 50
}

{
  "status": "success",
  "deepLinkUrl": "iyzico://refund?token=def456",
  "paymentSessionToken": "def456uvw",
  "paymentId": "1000001"
}