İptal ve İade

İptal

post

Ödeme işlemini iptal etmek için kullanılır.

Header parameters

AuthorizationstringRequired

Authorization header, IYZWSv2 ile başlayan ve base64 formatında üretilmiş imzalı hash değeridir.

Example: IYZWSv2 YXBpS2V5OnNhbmRib....E0OGI1MTE=

Content-TypestringRequired

İstek içeriğinin formatı.

Example: application/json

Body

application/json

paymentIdstringRequired

İptal edilmek istenen ödeme işlemine ait iyzico tarafından verilen uniq ödeme numarası.

Example: 25180158

conversationIdstringOptional

İstek/yanıt eşleştirmesi için uniq ID. İstekte gönderilen değer yanıtta aynen geri döner.

Example: 123456789

ipstringOptional

İşlemin gönderildiği IP adresi.

Example: 1.1.1.1

localestring · enumOptional

iyzico istek sonucunda dönen metinlerin dilini ayarlamak için kullanılır.

Example: trPossible values:

reasonstring · enumOptional

İptal Nedeni. İptal açıklaması gönderilirse, gönderilmesi zorunlu bir bilgidir.

Example: TRYPossible values:

descriptionstringOptional

İptal açıklaması.

Example: TRY

Responses

200

Başarılı yanıt

application/json

statusstring · enumOptional

Yapılan isteğin sonucunu belirtir.

Possible values:

localestring · enumOptional

Yanıt dili.

Possible values:

systemTimeintegerOptional

Dönen sonucun o anki epoch ms değeridir.

conversationIdstringOptional

İstekte gönderilen conversationId değeri aynen geri döner.

paymentIdstringOptional

İptal edilen ödeme numarası.

pricedecimalOptional

İptal edilen ödeme tutarı.

currencystringOptional

Para birimi (ödemenin yapıldığı para birimi).

authCodestringOptional

Banka tarafından dönen yetkilendirme (auth) kodu.

Example: 581421

hostReferencestringOptional

İşlem referans değeri.

Example: mock00007iyzihostrfn

cancelHostReferencestringOptional

İptal işlemine ait referans değeri.

Example: mock00007iyzihostrfn

400

Başarısız yanıt

application/json

post

/payment/cancel

HTTPcURL

POST https://api.iyzipay.com/payment/cancel
Authorization: IYZWSv2 YXBpS2V5OnNhbmRib....E0OGI1MTE=
Content-Type: application/json

{
  "locale": "tr",
  "conversationId": "123456789",
  "paymentId": "24511629",
  "ip": "1.1.1.1",
  "reason": "OTHER",
  "description": "Test"
}

{
  "status": "success",
  "locale": "tr",
  "systemTime": 1755703480229,
  "conversationId": "123456789",
  "paymentId": "25180158",
  "price": 50,
  "currency": "TRY",
  "authCode": "532238",
  "hostReference": "mock00007iyzihostrfn",
  "cancelHostReference": "mock00007iyzihostrfn"
}

İade

post

Ödeme işleminin iadesi için kullanılır. İade işlemi paymentTransactionId üzerinden, ödeme kırılımı baz alınarak yapılır. Ödeme tutarı için tamamen ya da kısmi iade yapılabilir.

Header parameters

AuthorizationstringRequired

Authorization header, IYZWSv2 ile başlayan ve base64 formatında üretilmiş imzalı hash değeridir.

Example: IYZWSv2 YXBpS2V5OnNhbmRib....E0OGI1MTE=

Content-TypestringRequired

İstek içeriğinin formatı.

Example: application/json

Body

application/json

paymentTransactionIdstringRequired

İade edilecek ödeme kırılımı numarası (paymentTransactionId).

Example: 27169345

conversationIdstringOptional

İstek/yanıt eşleştirmesi için uniq ID.

Example: 123456789

ipstringOptional

İşlemin gönderildiği IP adresi.

Example: 1.1.1.1

localestring · enumOptional

Yanıt dili.

Example: trPossible values:

pricedecimalRequired

İade edilmek istenen tutar. Kırılım tutarından yüksek olmamalıdır.

Example: 5

currencystringOptional

Ödemenin yapıldığı para birimi.

Example: TRY

reasonstring · enumOptional

İade Nedeni. İade açıklaması gönderilirse, gönderilmesi zorunlu bir bilgidir.

Example: TRYPossible values:

descriptionstringOptional

İade açıklaması.

Example: TRY

Responses

200

Başarılı yanıt

application/json

statusstring · enumOptional

Yapılan isteğin sonucunu belirtir.

Possible values:

localestring · enumOptional

Yanıt dili.

Possible values:

systemTimeintegerOptional

Dönen sonucun o anki epoch ms değeridir.

conversationIdstringOptional

İstekte gönderilen conversationId değeri aynen geri döner.

paymentIdstringOptional

Ödeme numarası.

paymentTransactionIdstringOptional

İadesi yapılan ödeme kırılımı numarası.

pricedecimalOptional

İade edilen tutar.

currencystringOptional

Para birimi.

authCodestringOptional

Banka tarafından dönen yetkilendirme (auth) kodu.

Example: 591030

hostReferencestringOptional

Ödemeye ilişkin banka tarafından verilen referans değeri.

Example: mock00007iyzihostrfn

refundHostReferencestringOptionalExample: mock00007iyzihostrfn

retryableboolean · enumOptional

İşlemin tekrar denenebilir olup olmadığını belirtir.

Example: truePossible values:

signaturestringOptional

İmza doğrulaması yapılabilecek signature değeri.

Example: 8202e30aa0f4c690f640ae4f6d4487b92b57a3693e9d560bbaf938638217271b

400

Başarısız yanıt

application/json

post

/payment/refund

HTTPcURL

POST https://api.iyzipay.com/payment/refund
Authorization: IYZWSv2 YXBpS2V5OnNhbmRib....E0OGI1MTE=
Content-Type: application/json

{
  "locale": "tr",
  "conversationId": "conversationId",
  "paymentTransactionId": "27169345",
  "price": 5,
  "ip": "85.34.78.112",
  "currency": "TRY",
  "reason": "OTHER",
  "description": "Test"
}

{
  "status": "success",
  "locale": "tr",
  "systemTime": 1755703798426,
  "conversationId": "conversationId",
  "paymentId": "25180188",
  "paymentTransactionId": "27169345",
  "price": 5,
  "currency": "TRY",
  "authCode": "512821",
  "hostReference": "mock00007iyzihostrfn",
  "refundHostReference": "mock00007iyzihostrfn",
  "retryable": false,
  "signature": "269ce670ac4027fc95644812d38bc1c3c3897848573215c5bf03e8dd86b328fd"
}

İade V2

post

paymentId üzerinden iade yapılmasını sağlar. Ödeme kırılımı belirtilmez; iade edilecek kırılım sistem tarafından otomatik belirlenir. Ödeme tutarı için tamamen ya da kısmi iade yapılabilir.

Header parameters

AuthorizationstringRequired

Authorization header, IYZWSv2 ile başlayan ve base64 formatında üretilmiş imzalı hash değeridir.

Example: IYZWSv2 YXBpS2V5OnNhbmRib....E0OGI1MTE=

Content-TypestringRequired

İstek içeriğinin formatı.

Example: application/json

Body

application/json

paymentIdstringRequired

İade edilecek ödeme numarası.

Example: 25180208

conversationIdstringOptional

İstek/yanıt eşleştirmesi için uniq ID.

Example: 123456789

ipstringOptional

İşlemin gönderildiği IP adresi.

Example: 1.1.1.1

localestring · enumOptional

Yanıt dili.

Example: trPossible values:

pricedecimalRequired

İade edilmek istenen tutar. Ödeme tutarından büyük olmamalıdır.

Example: 5

currencystringOptional

Ödemenin yapıldığı para birimi.

Example: TRY

Responses

200

Başarılı yanıt

application/json

statusstring · enumOptional

Yapılan isteğin sonucunu belirtir.

Possible values:

localestring · enumOptional

Yanıt dili.

Possible values:

systemTimeintegerOptional

Dönen sonucun o anki epoch ms değeridir.

conversationIdstringOptional

İstekte gönderilen conversationId değeri aynen geri döner.

paymentIdstringOptional

İadesi yapılan ödeme numarası.

pricedecimalOptional

İade edilen tutar.

currencystringOptional

Para birimi.

authCodestringOptional

Banka tarafından dönen yetkilendirme (auth) kodu.

Example: 591030

hostReferencestringOptional

Ödemeye ilişkin banka tarafından verilen referans değeri.

Example: mock00007iyzihostrfn

refundHostReferencestringOptionalExample: mock00007iyzihostrfn

retryableboolean · enumOptional

İşlemin tekrar denenebilir olup olmadığını belirtir.

Example: truePossible values:

signaturestringOptional

İmza doğrulaması yapılabilecek signature değeri.

Example: 8202e30aa0f4c690f640ae4f6d4487b92b57a3693e9d560bbaf938638217271b

400

Başarısız yanıt

application/json

post

/v2/payment/refund

HTTPcURL

POST https://api.iyzipay.com/v2/payment/refund
Authorization: IYZWSv2 YXBpS2V5OnNhbmRib....E0OGI1MTE=
Content-Type: application/json

{
  "locale": "tr",
  "conversationId": "123456789",
  "price": 15,
  "paymentId": "25180208",
  "currency": "TRY",
  "ip": "1.1.1.1"
}

{
  "status": "success",
  "locale": "tr",
  "systemTime": 1755704177107,
  "conversationId": "123456789",
  "paymentId": "25180208",
  "price": 15,
  "currency": "TRY",
  "authCode": "581421",
  "hostReference": "mock00007iyzihostrfn",
  "refundHostReference": "mock00007iyzihostrfn",
  "retryable": false,
  "signature": "429ba48e9eef33c89cc942e626c8f4aa4a4784fdc82df64f252caa5ad6233db9"
}