> For the complete documentation index, see [llms.txt](https://docs.iyzico.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.iyzico.com/urunler/fiziki-pos/terminal-api-entegrasyonu/vuk-509-servisleri/iptal-iade.md). # İptal/İade ### Void Payment ## POST /v2/terminal-host/payment/void > Bu servis, uygun durumdaki bir ödemeyi iptal eder.\ > Örnek: "paymentId ve paymentDate ile iptal işlemi başlatılır. Kart pos cihazı üzerinde okutularak iptal işlemi tamamlanır."\ > \ > Authorization (Bearer Token):\ > \- Token değeri OAuth token servisinden dönen access\_token'dır.\ > \- Header formatı:\ > Authorization: Bearer {access\_token}
```json {"openapi":"3.0.3","info":{"title":"Terminal API – Outside Flow","version":"1.0.3"},"tags":[{"name":"Terminal Host"}],"servers":[{"url":"https://api.iyzipay.com"},{"url":"https://sandbox-api.iyzipay.com"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Bearer Token ile yetkilendirme.\nHeader formatı:\nAuthorization: Bearer {access_token}\n\naccess_token, OAuth token servisinden üretilir ve Terminal Host servislerinde kullanılır.\n"}},"schemas":{"VoidPaymentRequest":{"description":"Ödeme İade Servisi.","type":"object","required":["conversationId","locale","paymentId","paymentDate","deviceUniqueId","transactionReferenceId"],"properties":{"conversationId":{"type":"string","description":"İstek ve yanıt eşleşmesi yapılacak ID değeri. Üye işyeri tarafından belirlenir, istekte gönderilen bilgi yanıtta geri döner."},"locale":{"type":"string","description":"Yanıt dili.","enum":["tr","en"]},"paymentId":{"type":"string","description":"İptal Edilecek Ödeme Numarası"},"paymentDate":{"type":"string","description":"İşlemin muhasebeleştirildiği tarih (YYYYMMDD)."},"deviceUniqueId":{"type":"string","description":"İşlemin gerçekleştirildiği terminal / cihaz için tanımlı benzersiz kimlik bilgisi."},"transactionReferenceId":{"type":"string","description":"İptal işlemine ait üretilen benzersiz bir referans numarası"},"reason":{"type":"string","description":"İptal nedi"},"description":{"type":"string","description":"İptal açıklaması"}}},"TerminalPaymentSuccessResponse":{"type":"object","properties":{"conversationId":{"type":"string","description":"İstek–cevap eşleştirmesi ve işlem takibi için üye işyeri tarafından gönderilen benzersiz değer."},"locale":{"type":"string","description":"Yanıt dili","enum":["tr","en"]},"deviceUniqueId":{"type":"string","description":"İşlemin gerçekleştirildiği terminal / cihaz için tanımlı benzersiz kimlik bilgisi."},"transactionReferenceId":{"type":"string","description":"Satış uygulaması tarafından üretilen, işlem bazında benzersiz referans numarası."},"status":{"type":"string","description":"İşlem sonucu. (SUCCESS, FAILURE vb.)"},"errorCode":{"type":"string","description":"İşlem başarısız ise dönen hata kodu. Başarılı işlemlerde boş döner."},"errorMessage":{"type":"string","description":"\tHata oluşması durumunda açıklayıcı hata mesajı."},"errorGroup":{"type":"string","description":"Hatanın ait olduğu grup / kategori bilgisi."},"systemTime":{"type":"integer","format":"int64","description":"İşlemin iyzico sistemlerinde işlendiği zamanın Unix timestamp değeri."},"transactionDateTime":{"type":"string","description":"İşlemin terminal/host üzerinde gerçekleştiği tarih ve saat bilgisi (ISO-8601)."},"authCode":{"type":"string","description":"Banka/host tarafından üretilen onay (authorization) kodu."},"paymentId":{"type":"string","description":"iyzico tarafından üretilen, işlem bazında benzersiz ödeme kimliği."},"paymentDate":{"type":"string","description":"İşlemin muhasebeleştirildiği tarih (YYYYMMDD)."},"price":{"type":"number","format":"double","description":"İşlem tutarı."},"installment":{"type":"integer","format":"int32","description":"Taksit sayısı. Tek çekim işlemlerde 0 veya 1 olarak döner."},"currency":{"type":"string","description":"İşlem para birimi (örn. TRY)."},"binNumber":{"type":"string","description":"Kartın ilk 6 hanesi (BIN)."},"lastFourDigits":{"type":"string","description":"Kart numarasının son 4 hanesi."},"hostReference":{"type":"string","description":"Banka/host sistemi tarafından üretilen işlem referans numarası."},"cardType":{"type":"string","description":"Kart tipi. (CREDIT_CARD, DEBIT_CARD vb.)"},"acquirerId":{"type":"string","description":"İşlemi gerçekleştiren banka (acquirer) kurum kimliği."},"issuerId":{"type":"string","description":"Kartı çıkaran banka (issuer) kurum kimliği."},"bankMerchantId":{"type":"string","description":"Banka nezdinde üye işyerine tanımlı merchant numarası."},"bankTerminalId":{"type":"string","description":"Banka nezdinde terminal için tanımlı terminal numarası."},"batchNo":{"type":"string","description":"İşlemin dahil olduğu batch (günsonu) numarası."},"stanNo":{"type":"string","description":"Sistem Takip Numarası (STAN – System Trace Audit Number)."},"posEntryModeCode":{"type":"string","description":"Kart bilgilerinin POS'a giriş yöntemini belirten kod (örn. chip, manyetik, contactless)."},"cancelHostReference":{"type":"string","description":"İptal işlemi referans numarası"},"refundHostReference":{"type":"string","description":"İade işlemi referans numarası"}}},"TerminalFailureResponse":{"type":"object","properties":{"status":{"type":"string","description":"İşlem sonucu. (SUCCESS, FAILURE vb.)"},"errorCode":{"type":"string","description":"İşlem başarısız ise dönen hata kodu. Başarılı işlemlerde boş döner."},"errorMessage":{"type":"string","description":"Hata oluşması durumunda açıklayıcı hata mesajı."},"errorGroup":{"type":"string","description":"Hatanın ait olduğu grup / kategori bilgisi."},"systemTime":{"type":"integer","format":"int64","description":"İşlemin iyzico sistemlerinde işlendiği zamanın Unix timestamp değeri."},"consumerErrorMessage":{"type":"string","description":"Son kullanıcıya gösterilmek üzere üretilmiş, teknik detay içermeyen hata mesajı."}}}}},"paths":{"/v2/terminal-host/payment/void":{"post":{"tags":["Terminal Host"],"summary":null,"description":"Bu servis, uygun durumdaki bir ödemeyi iptal eder.\nÖrnek: \"paymentId ve paymentDate ile iptal işlemi başlatılır. Kart pos cihazı üzerinde okutularak iptal işlemi tamamlanır.\"\n\nAuthorization (Bearer Token):\n- Token değeri OAuth token servisinden dönen access_token'dır.\n- Header formatı:\n Authorization: Bearer {access_token}\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VoidPaymentRequest"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TerminalPaymentSuccessResponse"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TerminalFailureResponse"}}}}}}}}} ``` ### Örnek Collection
Postman
### Refund Payment ## POST /v2/terminal-host/payment/refund > Bu servis, uygun durumdaki bir ödemeye iade işlemi uygular (partial/total).\ > Örnek: "paymentId ve price ile iade işlemi başlatılır. Kart pos cihazı üzerinde okutularak iptal işlemi tamamlanır."\ > \ > Authorization (Bearer Token):\ > \- Token değeri OAuth token servisinden dönen access\_token'dır.\ > \- Header formatı:\ > Authorization: Bearer {access\_token}
```json {"openapi":"3.0.3","info":{"title":"Terminal API – Outside Flow","version":"1.0.3"},"tags":[{"name":"Terminal Host"}],"servers":[{"url":"https://api.iyzipay.com"},{"url":"https://sandbox-api.iyzipay.com"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Bearer Token ile yetkilendirme.\nHeader formatı:\nAuthorization: Bearer {access_token}\n\naccess_token, OAuth token servisinden üretilir ve Terminal Host servislerinde kullanılır.\n"}},"schemas":{"RefundPaymentRequest":{"type":"object","required":["conversationId","locale","paymentId","deviceUniqueId","price","transactionReferenceId","paymentDate"],"properties":{"conversationId":{"type":"string","description":"İstek ve yanıt eşleşmesi yapılacak ID değeri. Üye işyeri tarafından belirlenir, istekte gönderilen bilgi yanıtta geri döner."},"locale":{"type":"string","description":"İstek dili.","enum":["tr","en"]},"paymentId":{"type":"string","description":"İade yapılacak ödeme numarası"},"deviceUniqueId":{"type":"string","description":"İşlemin gerçekleştirildiği terminal / cihaz için tanımlı benzersiz kimlik bilgisi."},"price":{"type":"number","format":"double","description":"İşlem tutarı."},"transactionReferenceId":{"type":"string","description":"İade işlemi için satış uygulaması tarafından üretilen, benzersiz referans numarası."},"paymentDate":{"type":"string","description":"İşlemin muhasebeleştirildiği tarih (YYYYMMDD)."},"reason":{"type":"string","description":"İade Nedeni"},"description":{"type":"string","description":"İade Açıklaması"}}},"TerminalPaymentSuccessResponse":{"type":"object","properties":{"conversationId":{"type":"string","description":"İstek–cevap eşleştirmesi ve işlem takibi için üye işyeri tarafından gönderilen benzersiz değer."},"locale":{"type":"string","description":"Yanıt dili","enum":["tr","en"]},"deviceUniqueId":{"type":"string","description":"İşlemin gerçekleştirildiği terminal / cihaz için tanımlı benzersiz kimlik bilgisi."},"transactionReferenceId":{"type":"string","description":"Satış uygulaması tarafından üretilen, işlem bazında benzersiz referans numarası."},"status":{"type":"string","description":"İşlem sonucu. (SUCCESS, FAILURE vb.)"},"errorCode":{"type":"string","description":"İşlem başarısız ise dönen hata kodu. Başarılı işlemlerde boş döner."},"errorMessage":{"type":"string","description":"\tHata oluşması durumunda açıklayıcı hata mesajı."},"errorGroup":{"type":"string","description":"Hatanın ait olduğu grup / kategori bilgisi."},"systemTime":{"type":"integer","format":"int64","description":"İşlemin iyzico sistemlerinde işlendiği zamanın Unix timestamp değeri."},"transactionDateTime":{"type":"string","description":"İşlemin terminal/host üzerinde gerçekleştiği tarih ve saat bilgisi (ISO-8601)."},"authCode":{"type":"string","description":"Banka/host tarafından üretilen onay (authorization) kodu."},"paymentId":{"type":"string","description":"iyzico tarafından üretilen, işlem bazında benzersiz ödeme kimliği."},"paymentDate":{"type":"string","description":"İşlemin muhasebeleştirildiği tarih (YYYYMMDD)."},"price":{"type":"number","format":"double","description":"İşlem tutarı."},"installment":{"type":"integer","format":"int32","description":"Taksit sayısı. Tek çekim işlemlerde 0 veya 1 olarak döner."},"currency":{"type":"string","description":"İşlem para birimi (örn. TRY)."},"binNumber":{"type":"string","description":"Kartın ilk 6 hanesi (BIN)."},"lastFourDigits":{"type":"string","description":"Kart numarasının son 4 hanesi."},"hostReference":{"type":"string","description":"Banka/host sistemi tarafından üretilen işlem referans numarası."},"cardType":{"type":"string","description":"Kart tipi. (CREDIT_CARD, DEBIT_CARD vb.)"},"acquirerId":{"type":"string","description":"İşlemi gerçekleştiren banka (acquirer) kurum kimliği."},"issuerId":{"type":"string","description":"Kartı çıkaran banka (issuer) kurum kimliği."},"bankMerchantId":{"type":"string","description":"Banka nezdinde üye işyerine tanımlı merchant numarası."},"bankTerminalId":{"type":"string","description":"Banka nezdinde terminal için tanımlı terminal numarası."},"batchNo":{"type":"string","description":"İşlemin dahil olduğu batch (günsonu) numarası."},"stanNo":{"type":"string","description":"Sistem Takip Numarası (STAN – System Trace Audit Number)."},"posEntryModeCode":{"type":"string","description":"Kart bilgilerinin POS'a giriş yöntemini belirten kod (örn. chip, manyetik, contactless)."},"cancelHostReference":{"type":"string","description":"İptal işlemi referans numarası"},"refundHostReference":{"type":"string","description":"İade işlemi referans numarası"}}},"TerminalFailureResponse":{"type":"object","properties":{"status":{"type":"string","description":"İşlem sonucu. (SUCCESS, FAILURE vb.)"},"errorCode":{"type":"string","description":"İşlem başarısız ise dönen hata kodu. Başarılı işlemlerde boş döner."},"errorMessage":{"type":"string","description":"Hata oluşması durumunda açıklayıcı hata mesajı."},"errorGroup":{"type":"string","description":"Hatanın ait olduğu grup / kategori bilgisi."},"systemTime":{"type":"integer","format":"int64","description":"İşlemin iyzico sistemlerinde işlendiği zamanın Unix timestamp değeri."},"consumerErrorMessage":{"type":"string","description":"Son kullanıcıya gösterilmek üzere üretilmiş, teknik detay içermeyen hata mesajı."}}}}},"paths":{"/v2/terminal-host/payment/refund":{"post":{"tags":["Terminal Host"],"description":"Bu servis, uygun durumdaki bir ödemeye iade işlemi uygular (partial/total).\nÖrnek: \"paymentId ve price ile iade işlemi başlatılır. Kart pos cihazı üzerinde okutularak iptal işlemi tamamlanır.\"\n\nAuthorization (Bearer Token):\n- Token değeri OAuth token servisinden dönen access_token'dır.\n- Header formatı:\n Authorization: Bearer {access_token}\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefundPaymentRequest"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TerminalPaymentSuccessResponse"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TerminalFailureResponse"}}}}}}}}} ``` ### Örnek Collection
Postman