İptal/İade

İade

post

/v2/terminal-host/gmu/payment/refund

Tamamlanmış bir satış işlemi için kısmi veya tam iade gerçekleştirilir. İade yapılabilecek kalemleri öğrenmek için önce İade Edilebilir Satış Bilgisi servisini çağırmanız önerilir.

Authorizations

AuthorizationstringRequired

Access token kullanılarak Bearer Token doğrulaması yapılır.

Header parameters

Content-TypestringRequired

İçerik tipi

Example: application/json

Body

localestringOptional

Dil kodu. Varsayılan TR

Example: TR

conversationIdstringOptional

Korelasyon ID

Example: ref-conv-001

deviceUniqueIdstringRequired

Cihaz benzersiz ID. Maksimum 64 karakter

Example: P00134

paymentIdstringRequired

Satış servisinden dönen paymentId

Example: PAY-9876543

paymentDateintegerRequired

Ödeme tarihi. YYYYMMDD formatında olmalıdır

Example: 20260406

transactionReferenceIdstringRequired

Bu iade işlemine ait referans ID

Example: REF-REFUND-001

saleAppNamestringRequired

Satış uygulaması adı

Example: MyPOS

saleAppVersionstringRequired

Satış uygulaması versiyonu

Example: 1.0.0

notificationPhonestringOptional

SMS bildirimi istenilen telefon numarası

Example: 5551234567

notificationEmailstringOptional

Bildirim istenilen E-posta adresi

Example: musteri@ornek.com

Responses

200

Başarılı iade sonucu

application/json

statusstringOptional

success veya failure

Example: success

errorCodestringOptional

Hata kodu

Example: 0

errorMessagestringOptional

Hata mesajı

Example: Hata mesajı

conversationIdstringOptional

Korelasyon ID

Example: ref-conv-001

systemTimeintegerOptional

Zaman damgası epoch ms

Example: 1743980400000

deviceUniqueIdstringOptional

İşlem yapılan cihaz ID

Example: P00134

transactionReferenceIdstringOptional

İade işlemine ait referans ID

Example: REF-REFUND-001

pricedecimalOptional

İade tutarı

Example: 118

vatAmountdecimalOptional

KDV tutarı

Example: 18

currencystringOptional

Para birimi

Example: TRY

invoiceNostringOptional

Fatura numarası

Example: INV-001

authCodestringOptional

Onay kodu

Example: 123456

hostReferencestringOptional

Host referans numarası

Example: HOST-REFUND-001

binNumberstringOptional

Kartın BIN numarası

Example: 454671

lastFourDigitsstringOptional

Kartın son 4 hanesi

Example: 1234

acquirerNamestringOptional

Acquirer banka adı

Example: Bank A

acquirerIdstringOptional

Acquirer banka ID

Example: 12

batchNostringOptional

Batch numarası

Example: 001

400

Hatalı istek

application/json

post/v2/terminal-host/gmu/payment/refund

POST /v2/terminal-host/gmu/payment/refund HTTP/1.1
Host: api.iyzipay.com
Authorization: Bearer {{access_token}}
Content-Type: application/json

{
  "locale": "TR",
  "conversationId": "ref-conv-001",
  "deviceUniqueId": "P00134",
  "paymentId": "PAY-9876543",
  "paymentDate": 20260406,
  "transactionReferenceId": "REF-REFUND-001",
  "saleAppName": "MyPOS",
  "saleAppVersion": "1.0.0",
  "notificationPhone": "5551234567",
  "notificationEmail": "musteri@ornek.com",
  "saleItems": [
    {
      "name": "Laptop",
      "unitCode": "C62",
      "taxGroupCode": "KDV20",
      "itemQuantity": 1,
      "unitPriceAmount": 100.0,
      "grossPriceAmount": 118.0,
      "totalPriceAmount": 118.0
    }
  ]
}

{
  "status": "success",
  "errorCode": "0",
  "conversationId": "ref-conv-001",
  "systemTime": 1743980400000,
  "deviceUniqueId": "P00134",
  "transactionReferenceId": "REF-REFUND-001",
  "price": 118,
  "vatAmount": 18,
  "currency": "TRY",
  "invoiceNo": "INV-001",
  "authCode": "123456",
  "hostReference": "HOST-REFUND-001",
  "binNumber": "454671",
  "lastFourDigits": "1234",
  "acquirerName": "Bank A",
  "acquirerId": "12",
  "batchNo": "001"
}

İptal

post

/v2/terminal-host/gmu/payment/void

Aynı gün içinde gerçekleştirilen bir ödeme işlemini iptal eder. Gün sonu yapılmış işlemlerde iptal yerine iade kullanılmalıdır.

Authorizations

AuthorizationstringRequired

Access token kullanılarak Bearer Token doğrulaması yapılır.

Header parameters

Content-TypestringRequired

İçerik tipi

Example: application/json

Body

localestringOptional

Dil kodu. Varsayılan TR

Example: TR

conversationIdstringOptional

Korelasyon ID

Example: void-conv-001

deviceUniqueIdstringRequired

Cihaz benzersiz ID. Maksimum 64 karakter

Example: P00134

paymentIdstringRequired

İptal edilecek ödemenin paymentId’si

Example: PAY-9876543

paymentDateintegerRequired

Ödeme tarihi. YYYYMMDD formatında olmalıdır

Example: 20260406

transactionReferenceIdstringRequired

Bu iptal işlemine ait referans ID

Example: REF-VOID-001

reasonstringOptional

İptal nedeni

Example: Müşteri talebi

descriptionstringOptional

Açıklama

Example: Ürün stoğu yok

Responses

200

Başarılı iptal sonucu

application/json

statusstringOptional

success veya failure

Example: success

errorCodestringOptional

Hata kodu

Example: 0

errorMessagestringOptional

Hata mesajı

Example: Hata mesajı

conversationIdstringOptional

Korelasyon ID

Example: void-conv-001

systemTimeintegerOptional

Zaman damgası epoch ms

Example: 1743980400000

deviceUniqueIdstringOptional

Cihaz ID

Example: P00134

transactionReferenceIdstringOptional

İptal referans ID

Example: REF-VOID-001

paymentIdstringOptional

İptal edilen ödeme ID

Example: PAY-9876543

pricedecimalOptional

İptal tutarı

Example: 118

currencystringOptional

Para birimi

Example: TRY

authCodestringOptional

Onay kodu

Example: 123456

hostReferencestringOptional

Orijinal işlemin host referans numarası

Example: HOST-001

cancelHostReferencestringOptional

İptal işlemine ait host referans numarası

Example: HOST-CANCEL-001

transactionDatestringOptional

İşlem tarihi

Example: 2026-04-06

transactionTimestringOptional

İşlem saati

Example: 10:00:00

paymentDateintegerOptional

Ödeme tarihi. YYYYMMDD formatındadır

Example: 20260406

transactionDateTimestringOptional

İşlem tarih ve saat bilgisi

Example: 2026-04-06 10:00:00

binNumberstringOptional

Kartın BIN numarası

Example: 454671

lastFourDigitsstringOptional

Kartın son 4 hanesi

Example: 1234

400

Hatalı istek

application/json

post/v2/terminal-host/gmu/payment/void

POST /v2/terminal-host/gmu/payment/void HTTP/1.1
Host: api.iyzipay.com
Authorization: Bearer {{access_token}}
Content-Type: application/json

{
  "locale": "TR",
  "conversationId": "void-conv-001",
  "deviceUniqueId": "P00134",
  "paymentId": "PAY-9876543",
  "paymentDate": 20260406,
  "transactionReferenceId": "REF-VOID-001",
  "reason": "Müşteri talebi",
  "description": "Ürün stoğu yok"
}

{
  "status": "success",
  "errorCode": "0",
  "conversationId": "void-conv-001",
  "systemTime": 1743980400000,
  "deviceUniqueId": "P00134",
  "transactionReferenceId": "REF-VOID-001",
  "paymentId": "PAY-9876543",
  "price": 118,
  "currency": "TRY",
  "authCode": "123456",
  "hostReference": "HOST-001",
  "cancelHostReference": "HOST-CANCEL-001",
  "transactionDate": "2026-04-06",
  "transactionTime": "10:00:00",
  "paymentDate": 20260406,
  "transactionDateTime": "2026-04-06 10:00:00",
  "binNumber": "454671",
  "lastFourDigits": "1234"
}

İade Edilebilir Satış Bilgisi Alma

post

/v2/terminal-host/gmu/payment/refundable-sale-info

Belirtilen işlem referansına ait satışın iade edilebilir kalem ve tutar bilgisini döndürür. İade işleminden önce çağrılması önerilir; dönen saleUid değeri iade isteğinde relatedSaleId olarak kullanılır.

Authorizations

AuthorizationstringRequired

Access token kullanılarak Bearer Token doğrulaması yapılır.

Header parameters

Content-TypestringRequired

İçerik tipi

Example: application/json

Body

localestringOptional

Dil kodu

Example: TR

conversationIdstringOptional

Korelasyon ID

Example: rsi-conv-001

deviceUniqueIdstringOptional

Cihaz benzersiz ID

Example: P00134

transactionReferenceIdstringRequired

Orijinal satış işleminin referans ID'si

Example: REF-12345

Responses

200

Başarılı iade edilebilir satış bilgisi sonucu

application/json

statusstringOptional

success veya failure

Example: success

errorCodestringOptional

Hata kodu

Example: 0

errorMessagestringOptional

Hata mesajı

Example: Hata mesajı

conversationIdstringOptional

Korelasyon ID

Example: rsi-conv-001

systemTimeintegerOptional

Zaman damgası epoch ms

Example: 1743980400000

saleNumberstringOptional

Satış numarası

Example: SN-001

saleUidstringOptional

Satışın benzersiz ID'si. İade isteğinde relatedSaleId olarak kullanılır.

Example: SALE-001

totalReturnableAmountdecimalOptional

Toplam iade edilebilir tutar

Example: 118

currencystringOptional

Para birimi

Example: TRY

400

Hatalı istek

application/json

post/v2/terminal-host/gmu/payment/refundable-sale-info

POST /v2/terminal-host/gmu/payment/refundable-sale-info HTTP/1.1
Host: api.iyzipay.com
Authorization: Bearer {{access_token}}
Content-Type: application/json

{
  "locale": "TR",
  "conversationId": "rsi-conv-001",
  "deviceUniqueId": "P00134",
  "transactionReferenceId": "REF-12345"
}

{
  "status": "success",
  "conversationId": "rsi-conv-001",
  "systemTime": 1743980400000,
  "saleNumber": "SN-001",
  "saleUid": "SALE-001",
  "totalReturnableAmount": 118,
  "currency": "TRY",
  "saleItems": [
    {
      "id": 1,
      "name": "Laptop",
      "itemQuantity": 1,
      "totalPriceAmount": 118,
      "vatAmount": 18,
      "returnableQuantity": 1,
      "returnableAmount": 118
    }
  ]
}

Last updated 5 months ago