v1

latestOpenAPI 3.0.32026-07-232073105.4 KB

CheckoutForm

Ödeme Formu (CF) Başlatma

Ödeme formu (Checkout Form) oturumu başlatır ve ödeme sayfasını göstermek için checkoutFormContent / paymentPageUrl ve işleme ait token döner.

post/payment/iyzipos/checkoutform/initialize/auth/ecom

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

locale'tr' | 'en'

Dil kodu. Varsayılan; tr. Ödeme formunun İngilizce oluşturulması için "en" gönderilmelidir.

conversationIdstring

İstek/yanıt eşleştirme ID’si. İstekte gönderilen değer, response'da aynen geri döner.

{"stackTrail":"components:schemas:CFInitializeRequest:properties:price","oasType":"schema","type":"unknown","description":"Sepet toplamı."}

{"stackTrail":"components:schemas:CFInitializeRequest:properties:paidPrice","oasType":"schema","type":"unknown","description":"Tahsil edilecek toplam tutar."}

currency'TRY' | 'USD' | 'EUR' | 'GBP' | 'NOK' | 'CHF' required

Para birimi. Varsayılan; TRY.

basketIdstring

Sepet ID’si.

paymentGroup'PRODUCT' | 'LISTING' | 'SUBSCRIPTION'

Ödeme grubu. Varsayılan; PRODUCT.

callbackUrlstring required

Ödeme akışında üye işyerine başarılı ve hatalı sonucu bildirmek üzere alınan URL adresi. Geçerli bir ssl sertifikasına sahip olmalıdır.

enabledInstallmentsinteger[]

Kullanılabilir taksit seçenekleri.

paymentSourcestring

Bu alan, partner firmalar tarafından iletilen ödeme kaynağı bilgisidir. Eğer bir altyapı sağlayıcısıysanız ve iyzico ile entegrasyon/iş birliğiniz bulunuyorsa bu parametreyi gönderebilirsiniz.

Response

Başarılı yanıt (CF başlatıldı)

status'success' | 'failure'

Gönderilen isteğin sonucu.

localestring

Yanıt dili.

systemTimeinteger

İşlem zamanı (epoch ms).

conversationIdstring

İstek ile eşleşen ID.

tokenstring

Checkout form için oluşturulan tekil değer. Her istek için özel üretilir ve işyerine dönülür. Ödemenin sonucunu öğrenmek için zorunlu bir alandır.

checkoutFormContentstring

Ödeme formunun HTML içeriği (Base64 kodlu).

paymentPageUrlstring

iyzico Ortak Ödeme Sayfası için dönen URL adresi.

signaturestring

İmza doğrulaması için kullanılabilecek signature değeri.