İptal / İade

Başarılı gerçekleşen bir ödemeyi iptal veya iade etmek istediğinizde bu servisi kullanabilirsiniz.

İptal / İade işlemi fiziki olarak gerçekleşmek zorundadır. Ceppos işlemleri iyzico paneli üzerinden iade edilememektedir.

POST https://api.iyzipay.com/v2/in-store/payment/refund

Headers

Parametre	Zorunluluk	Veri Tipi	Açıklama
x-api-key	Zorunlu	String	CepPOS API Anahtarı
x-secret-key	Zorunlu	String	CepPOS Güvenlik Anahtarı
x-merchant-id	Zorunlu	Integer	Üye İşyeri Numarası
x-callback-url	Zorunlu	String	İşlem sonrası uygulamanıza geri dönülmesi sağlayan parametredir.

İstek Parametreleri

Parametre	Zorunluluk	Veri Tipi	Açıklama
refundAmount	Evet	Number	İptal/İade edilmek istenen tutar.
paymentId	Evet	Integer	Ödemenin iyzico tarafındaki işlem id'sidir.
email	Evet	String	İlgili üye işyerine ait kullanıcının eposta bilgisidir.

İstek Örneği

{
    "refundAmount": "26",
    "paymentId": 123456,
    "email": "[e-mail]"
}

Yanıt Parametreleri

Kullanıcı listeleme servisinden dönen parametreler aşağıdaki gibidir.

Parametre	Veri Tipi	Açıklama
status	String	Yapılan isteğin sonucunu bildirir.
errorCode	String	İşlem hatalıysa, bu hataya dair belirtilen koddur.
errorMessage	String	İşlem hatalıysa, bu hataya dair belirtilen mesajdır.
errorGroup	String	İşlem hatalıysa, bu hataya dair belirtilen gruptur.
locale	String	İstekte belirtilen locale değeri geri dönülür, varsayılan değeri tr’dir.
systemTime	Integer	Dönen sonucun o anki unix timestamp değeridir.
conversationId	String	İstek esnasında gönderilmişse, sonuçta aynen geri iletilir.
deepLinkUrl	String	Ceppos app'ini uyandırmak için kullanılan link.
paymentSessionToken	String	İşlem başlatılırken kullanılan benzersiz id'dir.

Yanıt Örneği

{
    "status": "success",
    "errorCode": null,
    "errorMessage": null,
    "errorGroup": null,
    "locale": null,
    "systemTime": 1724242498134,
    "conversationId": null,
    "deepLinkUrl": "https://www.iyzico.com/payment?paymentSessionToken=5D5BFC5E336EA9F9",
    "paymentSessionToken": "5D5BFC5E336EA9F9",
}

Yanıtta yer alan deepLinkUrl parametre değeri ile cihazınızda yüklü olan Ceppos uygulamasını uyandırarak iptal / iade işleminizi başlatabilirsiniz.

İşlem tamamlandığında headersta iletilen x-callback-url değerindeki linke yönlendirme olacaktır. Bu link ile sonucu sorgulayabilirsiniz.