latestOpenAPI 3.0.32026-07-232073105.4 KB

46976ce5eed9

Ödeme

İptal

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

post/payment/cancel

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ı.

{"stackTrail":"components:schemas:CancelPaymentResponse:properties:price","oasType":"schema","type":"unknown","description":"İptal edilen ödeme tutarı."}

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.