Ödeme

İptal

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

post/payment/cancel

Request

Base URL
https://sandbox-api.iyzipay.com
Auth
none declared. Required headers: Authorization, Content-Type
TypeScript
https://skmtc.dev/iyzico/apis/bin-and-installment/docs/payment/cancel/post.ts
A function with typed inputs. Its response is checked against the schema.

Headers

Authorizationstring required

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

Content-Typestring required

Content-Type değeri.

Request body

paymentIdstring required

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

conversationIdstring

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

ipstring

İşlemin gönderildiği IP adresi.

locale'tr' | 'en'

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

reason'OTHER' | 'FRAUD' | 'BUYER_REQUEST' | 'DOUBLE_PAYMENT'

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

descriptionstring

İptal açıklaması.

Response

Başarılı yanıt

status'success' | 'failure'

Yapılan isteğin sonucunu belirtir.

locale'tr' | 'en'

Yanıt dili.

systemTimeinteger

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

conversationIdstring

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

paymentIdstring

İptal edilen ödeme numarası.

priceunknown

currencystring

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

authCodestring

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

hostReferencestring

İşlem referans değeri.

cancelHostReferencestring

İptal işlemine ait referans değeri.

Changes

No recorded changes to this operation across all 1 revision of this API.