Subscription Transactions

The services included in the subscription transactions are listed below.

Initialize Subscription

If you have completed all the steps, you can now start the subscription process.

Subscription can be started in 2 different ways.

Both methods above give the same result, but there is a difference in the way they are used.

The subscription process always starts with an ACTIVE or PENDING status. If the status is PENDING or the status is ACTIVE but a trial period is specified in the payment plan, iyzico only validates the card in the subscription request. Card validation takes place with a 1 TL withdrawal and subsequent refund. Apart from this, no transaction or payment takes place.

If the subscription status is ACTIVE and no trial period is specified in the planning, the payment specified in the plan is taken from the card and the subscription is started.

Each subscription requires a card information. Your customers can start a subscription with the cards they have stored in the iyzico environment or with a new card. When requesting a card update, the subscriptionReferenceCode of the relevant subscription must be sent. In this case, only the card information of the relevant subscription will be updated.

Table of Subscription Status

DURUMUAÇIKLAMA

ACTIVE

Bir abonelik aktif ise ve ödemeler düzenli olarak alınıyorsa status active olur.

PENDING

Bir abonelik durdurulmuşsa status pending olur.

UNPAID

Abonelik sırasında ödeme alınamamış ise status unpaid olur.

UPGRADED

Abonelik başka bir plan ile güncellenmişse status upgraded olur.

CANCELED

Abonelik iptal edilmişse status cancelled olur.

EXPIRED

Abonelik periyodu bitmişse status expired olur. Karttan başka bir ödeme alınmaz.

Initializing Subscription via Checkout Form

To create a checkout form, merchants must submit the following information.

  • Payment Plan Reference Code

  • Customer information

  • Subscription Status

  • CallBackURL (the address where the Checkout Form result will be posted)

CallBackUrl is given by member merchants during the request and determines the page to which the end user will be directed after payment. Redirection occurs as soon as the customer makes the payment. At this point, the payment request was sent to the bank and the result was processed by iyzico. The member business must check whether the payment has been received with a separate request. If the card validation or first payment is successful, all other processes are carried out by iyzico.

If your customer has a card stored in the iyzico environment, the option to pay with a stored card will appear on the checkout form. In this case, our member businesses do not need to send an additional request.

Via iyzico Checkout Form, an htmlContent parameter is returned as a result of the form creation request. When this javascript code snippet is printed on the page, the iyzico library is ready to be loaded into any of the “divs” mentioned below. The checkout form will appear when the page is completely loaded.

The divs where the checkout form will be loaded can be responsive or popup. Examples are given below.

<div id="iyzipay-checkout-form" class="responsive"></div>
<div id="iyzipay-checkout-form" class="popup"></div>

Initialize Subscription via CheckoutForm

POST https://api.iyzipay.com/v2/subscription/checkoutform/initialize

Request Body

NameTypeDescription

locale

String

iyzico istek sonucunda dönen metinlerin dilini ayarlamak için kullanılır. Varsayılan değeri TR.

conversationId

String

İstek esnasında gönderip, sonuçta alabileceğiniz bir değer, request/response eşleşmesi yapmak için kullanılabilir. En yaygın kullanış biçimi üye iş yerinin abonelik numarasıdır.

callbackUrl*

String

Ödeme sonucunun post edileceği url adresi.

shippingAddress.contactName*

String

Kargo iletişim ismi.

shippingAddress.country*

String

Kargo ülkesi.

shippingAddress.city*

String

Kargo şehri.

shippingAddress.zipCode

String

Kargo zip kodu.

shippingAddress.address*

String

Kargo adresi.

billingAddress.contactName*

String

Fatura iletişim ismi.

billingAddress.country*

String

Fatura adresi.

billingAddress.city*

String

Fatura şehri.

billingAddress.zipCode

String

Fatura zip kodu.

billingAddress.address*

String

Fatura adresi.

identityNumber*

String

Müşteri telefon numarası.

gsmNumber*

String

Müşteri email adresi.

email*

String

Müşteri kimlik numarası.

surname*

String

Müşteri soyadı.

name*

String

Müşteri adı.

subscriptionInitialStatus

String

Abonelik başlangıç durumu (PENDING veya ACTIVE)

pricingPlanReferenceCode*

String

Abonelikte uygulanacak plan referans kodu.

{
    "status": "success",
    "locale": "tr",
    "systemTime": 1687095783124,
    "conversationId": "954b389e-b147-43d3-a26a-bc9df9ca2868",
    "token": "8e86b16e-9c0f-450d-a09d-0fd8a27e5197",
    "checkoutFormContent": "<script type=\"text/javascript\">if (typeof iyziInit == 'undefined') {var iyziInit = {currency:\"TRY\",token:\"8e86b16e-9c0f-450d-a09d-0fd8a27e5197\",price:1.00,locale:\"tr\",baseUrl:\"https://sandbox-api.iyzipay.com\", merchantGatewayBaseUrl:\"https://sandbox-merchantgw.iyzipay.com\", registerCardEnabled:false,bkmEnabled:false,bankTransferEnabled:false,bankTransferTimeLimit:{\"value\":5,\"type\":\"day\"},bankTransferRedirectUrl:\"\",bankTransferCustomUIProps:{},campaignEnabled:false,campaignMarketingUiDisplay:null,paymentSourceName:\"\",plusInstallmentResponseList:null,payWithIyzicoSingleTab:false,payWithIyzicoOneTab:false,mixPaymentEnabled:true,creditCardEnabled:true,bankTransferAccounts:[],userCards:[],fundEnabled:false,memberCheckoutOtpData:{},force3Ds:false,isSandbox:true,storeNewCardEnabled:true,paymentWithNewCardEnabled:true,enabledApmTypes:[],payWithIyzicoUsed:false,payWithIyzicoEnabled:false,payWithIyzicoCustomUI:{},buyerName:\"Bünyamin\",buyerSurname:\"Yaşar\",merchantInfo:\"\",merchantName:\"Sandbox Merchant Name - 376927\",cancelUrl:\"\",buyerProtectionEnabled:false,hide3DS:true,gsmNumber:\"+905554443322\",email:\"kerem@altintas.com\",checkConsumerDetail:{},subscriptionPaymentEnabled:true,ucsEnabled:true,fingerprintEnabled:false,payWithIyzicoFirstTab:false,creditEnabled:true,payWithIyzicoLead:false,goBackUrl:\"\",metadata : {\"debitCardAllowed\":\"false\"},createTag:function(){var iyziJSTag = document.createElement('script');iyziJSTag.setAttribute('src','https://sandbox-static.iyzipay.com/checkoutform/v2/bundle.js?v=1687095783108');document.head.appendChild(iyziJSTag);}};iyziInit.createTag();}</script><script type=\"text/javascript\">if (typeof iyziUcsInit == 'undefined') {var iyziUcsInit = {\"baseUrl\":\"https://sandbox-api.iyzipay.com\", \"ucsToken\":\"28fac7ba-d34b-4e21-86a8-89785364d59f\",\"scriptType\":\"UCS_CONSENT\",\"buyerProtectedMerchant\":false,\"maskedGsmNumber\":\"+90****22\",\"gsmNumber\":\"+905554443322\",\"merchantName\":\"Sandbox Merchant Name - 376927\", createTag: function () {var iyziUcsJSTag = document.createElement('script'); iyziUcsJSTag.setAttribute('src', 'https://sandbox-static.iyzipay.com/checkoutform/v2/bundle.js?v=1687095783122'); document.head.appendChild(iyziUcsJSTag);}};if (typeof iyziInit == 'undefined') { iyziUcsInit.createTag(); }}</script><script type=\"text/javascript\">if (typeof iyziSubscriptionInit == 'undefined') {var iyziSubscriptionInit = {\"daysOfTrialPeriod\":\"30\",\"intervalCount\":\"1\",\"subscriptionState\":\"START_WITH_TRIAL_PERIOD\",\"interval\":\"WEEKLY\",\"recurrenceCount\":\"5\",\"pricingPlanPrice\":\"30.00\"}}</script>",
    "tokenExpireTime": 1800
}

Initialize Subscription with Payment Form Returning Parameters

Parametre ismiTipAçıklama

status

String

Yapılan isteğin sonucunu belirtir. Aboneliğin başarılı şekilde başlaması durumunda success değeri döner.

systemTime

Long

Dönen sonucun o anki unix timestamp değeridir.

checkoutFormContent

String

Checkout formun gösterilmesi için gerekli javascript html kodu.

token

String

Checkout form için oluşturulan tekil değer. Her istek için özel üretilir ve işyerine dönülür. Abonelik detaylarını öğrenmek için kullanılmalıdır.

tokenExpireTime

StringInteger

Checkout form için üretilmiş olan token değerinin geçerlilik süresi.

Retrieve Checkout Form Result

When the end user enters his credit card information or completes the payment with his reserved card, if the transaction is successful, the page is redirected to the callBackUrl address specified in the init request. Token information is also sent to this address via the post method. You can get the token value you will use in this query as soon as you create the payment form (init) or from the post data sent to your callbackUrl address.

Retrieve Checkout Form

POST https://api.iyzipay.com/v2/subscription/checkoutform/{{ token }}

Request Body

NameTypeDescription

token*

String

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

{
"status":"success",
"systemTime":1687093881913,
"data":{
    "referenceCode":"2c9025f4-725a-47e0-8114-97642dd63f0b",
    "parentReferenceCode":"47f703ce-76e9-49fd-8ef7-c46dd0942804",
    "pricingPlanReferenceCode":"d128e8bf-60e4-42f8-8d1b-3190d61b755d",
    "customerReferenceCode":"525b7ac7-901a-42cf-bb9f-627c0453fb38",
    "subscriptionStatus":"ACTIVE",
    "trialDays":30,
    "trialStartDate":1687093881545,
    "trialEndDate":1689685881545,
    "createdDate":1687093881545,
    "startDate":1687093881545,
    "endDate":1692709881545
    }
}

Retrieve Checkout Form Response

Parametre ismiTipAçıklama

status

String

Yapılan isteğin sonucunu belirtir. İşlem başarılı ise success değeri döner.

systemTime

Integer

Dönen sonucun o anki unix timestamp değeridir.

referenceCode

String

Abonelik için üretilen eşsiz referans kodu.

parentReferenceCode

String

Abonelik güncellemelerinde üye işeyerinin eşleştirme yapılabileceği eşsiz referans kodu.

pricingPlanReferenceCode

Integer

Aboneliğe ait plan referans kodu.

customerReferenceCode

String

Müşteri bilgilerine istinaden oluşturulmuş eşsiz müşteri kodu. Bu kod email adresi baz alınarak oluşturulur ve müşteri işlemleri bu kod ile de yapılabilir.

subscriptionStatus

String

Abonelik durumunu gösterir. İstek esnasında gönderilmişse, sonuçta aynen geri iletilir. Gönderilmemişse ACTIVE değeri döner.

trialDays

Integer

Ödeme planında belirlenen deneme süresidir. Bu süreç boyunca karttan ödeme alınmaz.

trialStartDate

Integer

Deneme süresinin başlangıç tarihini gösteren unix timestamp değeridir.

trialEndDate

Integer

Deneme süresinin bitiş tarihini gösteren unix timestamp değeridir.

createdDate

Integer

Abonelik oluşturulma tarihinin unix timestamp değeridir.

startDate

Integer

Abonelik başlangıç tarihinin unix timestamp değeridir.

Initializing Subscription via NON-3DS

Merchants can start a subscription by sending the following parameters.

Initializing Subscription via NON-3DS

POST https://api.iyzipay.com/v2/subscription/initialize

Request Body

NameTypeDescription

locale

String

iyzico istek sonucunda dönen metinlerin dilini ayarlamak için kullanılır. Varsayılan değeri TR.

conversationId

String

İstek esnasında gönderip, sonuçta alabileceğiniz bir değer, request/response eşleşmesi yapmak için kullanılabilir. En yaygın kullanış biçimi üye iş yerinin abonelik numarasıdır.

shippingAddress.contactName*

String

Kargo iletişim ismi.

shippingAddress.country*

String

Kargo ülkesi.

shippingAddress.city*

String

Kargo şehri.

shippingAddress.zipCode

String

Kargo zip kodu.

shippingAddress.address*

String

Kargo adresi.

billingAddress.contactName*

String

Fatura iletişim ismi.

billingAddress.country*

String

Fatura adresi.

billingAddress.city*

String

Fatura şehri.

billingAddress.zipCode

String

Fatura zip kodu.

billingAddress.address*

String

Fatura adresi.

identityNumber*

String

Müşteri telefon numarası.

gsmNumber*

String

Müşteri email adresi.

email*

String

Müşteri kimlik numarası.

surname*

String

Müşteri soyadı.

name*

String

Müşteri adı.

subscriptionInitialStatus

String

Abonelik başlangıç durumu (PENDING veya ACTIVE)

pricingPlanReferenceCode*

String

Abonelikte uygulanacak plan referans kodu.

paymentCard.consumerToken

String

Saklı kartın kullanılabilmesi için kullanıcı için oluşturulmuş token. Geçerlilik süresi 30 dakikadır.

paymentCard.cardToken

String

Seçilen karta ait token.

paymentCard.ucsToken

String

Kartın iyzico ortamında çözümlenmesi için kullanıcı için oluşturulmul değer. Geçerlilik süresi 30 dakikadır.

paymentCard.registerConsumerCard*

Boolean

Kartın saklanması için gerekli değer. True gönderilmelidir. Kartın iyzico ortamında saklanacağının onayı alınamlı. detaylı bilgi için iyzico korumalı kart saklama dökümanını inceleyeniz.

paymentCard.cvc

String

Kart CVC kodu

paymentCard.expireMonth

String

Kart son kullanma ayı

paymentCard.expireYear

String

Kart son kullanma yılı.

paymentCard.cardNumber

String

Kredi kartı numarası.

paymentCard.cardHolderName

String

Kart sahibi adı ve soyadı.

{
    "status": "success",
    "systemTime": 1687096973255,
    "data": {
        "referenceCode": "91e96872-1d07-4b53-936f-9afaeeb2594b",
        "parentReferenceCode": "0a523735-db2d-41c2-a861-924fbbb3be7c",
        "pricingPlanReferenceCode": "10d3f566-6554-41e5-81fa-79d3df8edec0",
        "customerReferenceCode": "c38d6334-3096-40b6-95ea-37fb6c92e740",
        "subscriptionStatus": "ACTIVE",
        "trialDays": 30,
        "trialStartDate": 1687096973244,
        "trialEndDate": 1689688973244,
        "createdDate": 1687096973244,
        "startDate": 1687096973244,
        "endDate": 1692712973244
    }
}

If a subscription is to be started with a new card, the registerConsumerCard parameter must be sent to true along with the card information. In addition, approval must be obtained from the customer that his card will be stored in the iyzico environment.

If a subscription is to be initiated with a reserved card, ucsToken, cardToken, consumerToken information must be sent.

Initializing Subscription via NON-3DS Response Parameters

Parametre ismiTipAçıklama

status

String

Yapılan isteğin sonucunu belirtir. İşlem başarılı ise success değeri döner.

systemTime

Integer

Dönen sonucun o anki unix timestamp değeridir.

referenceCode

String

Abonelik için üretilen eşsiz referans kodu.

parentReferenceCode

String

Abonelik güncellemelerinde üye işeyerinin eşleştirme yapılabileceği eşsiz referans kodu.

pricingPlanReferenceCode

Integer

Aboneliğe ait plan referans kodu.

customerReferenceCode

String

Müşteri bilgilerine istinaden oluşturulmuş eşsiz müşteri kodu. Bu kod email adresi baz alınarak oluşturulur ve müşteri işlemleri bu kod ile de yapılabilir.

subscriptionStatus

String

Abonelik durumunu gösterir. İstek esnasında gönderilmişse, sonuçta aynen geri iletilir. Gönderilmemişse ACTIVE değeri döner.

trialDays

Integer

Ödeme planında belirlenen deneme süresidir. Bu süreç boyunca karttan ödeme alınmaz.

trialStartDate

Integer

Deneme süresinin başlangıç tarihini gösteren unix timestamp değeridir.

trialEndDate

Integer

Deneme süresinin bitiş tarihini gösteren unix timestamp değeridir.

createdDate

Integer

Abonelik oluşturulma tarihinin unix timestamp değeridir.

startDate

Integer

Abonelik başlangıç tarihinin unix timestamp değeridir.

Activate Subscription

A subscription in pending status can be activated with this request

Activate Subscription

POST https://api.iyzipay.com/v2/subscription/subscriptions/{subscriptionReferenceCode}/activate

Request Body

NameTypeDescription

subscriptionReferenceCode*

String

Eşsiz abonelik referans numarası

{
    "status": "success",
    "systemTime": 1687096973255
}

Activate Subscription Response Parameters

Parametre ismiTipAçıklama

status

String

Yapılan isteğin sonucunu belirtir. İşlem başarılı ise success değeri döner.

systemTime

Long

Dönen sonucun o anki unix timestamp değeridir.

Retry Subscription Payment

If a payment has failed during the subscription period, this request can be used to renew the transaction and collect the payment.

Retry Subscription Payment

POST https://api.iyzipay.com/operation/retry

Request Body

NameTypeDescription

referenceCode*

String

Başarısız ödemenin referans kodu

{
    "status": "success",
    "systemTime": 1687096973255
}

Retry Subscription Payment Response Parameters

Parametre ismiTipAçıklama

status

String

Yapılan isteğin sonucunu belirtir. İşlem başarılı ise success değeri döner.

systemTime

Long

Dönen sonucun o anki unix timestamp değeridir.

Upgrade Subscription

It is possible to change or upgrade the subscription plan during the subscription period. The only necessary condition for this is that the new plan to be updated must belong to the existing product to which the subscription is linked.

PaymentInterval and PaymentIntervalCount parameters of the plans to be updated must be the same.

Upgrade Subscription

POST https://api.iyzipay.com/v2/subscription/subscriptions/{subscriptionReferenceCode}/upgrade

Request Body

NameTypeDescription

subscriptionReferenceCode*

String

Eşsiz abonelik referans numarası

resetRecurrenceCount

Boolean

Eğer TRUE gönderilirse ve yeni plan recurrence count değerine sahipse abonelik sonlanma süresi yeni değere göre hesaplanır. Eğer FALSE gönderilirse önceki planın sonlanma tarihi yeni plana aktarılır.

useTrial

Boolean

Eğer TRUE gönderilir ise deneme süreci dahil edilir.

upgradePeriod

String

Abonelik güncelleme tarihi.

newPricingPlanReferenceCode

String

Yeni plan referens numarası.

{
    "status": "success",
    "systemTime": 1687096973255
}

Upgrade Subscription Response Parameters

Parametre ismiTipAçıklama

status

String

Yapılan isteğin sonucunu belirtir. İşlem başarılı ise success değeri döner.

systemTime

Long

Dönen sonucun o anki unix timestamp değeridir.

Cancel Subscription

This request cancels an active subscription.

Cancel Subscription

POST https://api.iyzipay.com/v2/subscription/subscriptions/{subscriptionReferenceCode}/cancel

Request Body

NameTypeDescription

locale

String

Yapılan isteğin sonucunu belirtir. İşlem başarılı ise success değeri döner.

subscriptionReferenceCode*

String

Abonelik referans numarası.

conversationId

String

Dönen sonucun o anki unix timestamp değeridir.

{
    "status": "success",
    "systemTime": 1687096973255
}

Cancel Subscription Response Parameters

Parametre ismiTipAçıklama

status

String

Yapılan isteğin sonucunu belirtir. İşlem başarılı ise success değeri döner.

systemTime

Long

Dönen sonucun o anki unix timestamp değeridir.

Subscription Details

All details of a subscription can be seen with this request.

Subscription Details

GET https://api.iyzipay.com/v2/subscription/subscriptions/{subscriptionReferenceCode}

Request Body

NameTypeDescription

subscriptionReferenceCode

String

Abonelik refereans numarası

{
    "status": "success",
    "systemTime": 1687100005457,
    "data": {
        "totalCount": 0,
        "currentPage": 1,
        "pageCount": 0,
        "items": []
    }
}

Subscription Details Response Parameters

Parametre ismiTipAçıklama

status

String

Yapılan isteğin sonucunu belirtir. İşlem başarılı ise success değeri döner.

systemTime

Integer

Dönen sonucun o anki unix timestamp değeridir.

referenceCode

String

Abonelik için üretilen eşsiz referans kodu.

parentReferenceCode

String

Abonelik güncellemelerinde üye işeyerinin eşleştirme yapılabileceği eşsiz referans kodu.

pricingPlanReferenceCode

Integer

Aboneliğe ait plan referans kodu.

customerEmail

String

Müşteri email adresi.

customerReferenceCode

String

Müşteri bilgilerine istinaden oluşturulmuş eşsiz müşteri kodu. Bu kod email adresi baz alınarak oluşturulur ve müşteri işlemleri bu kod ile de yapılabilir.

subscriptionStatus

String

Abonelik durumunu gösterir. İstek esnasında gönderilmişse, sonuçta aynen geri iletilir. Gönderilmemişse ACTIVE değeri döner.

trialDays

Integer

Ödeme planında belirlenen deneme süresidir. Bu süreç boyunca karttan ödeme alınmaz.

trialStartDate

Integer

Deneme süresinin başlangıç tarihini gösteren unix timestamp değeridir.

trialEndDate

Integer

Deneme süresinin bitiş tarihini gösteren unix timestamp değeridir.

createdDate

Integer

Abonelik oluşturulma tarihinin unix timestamp değeridir.

startDate

Integer

Abonelik başlangıç tarihinin unix timestamp değeridir.

Subscriptions

This request allows access to subscription information and payments with different search parameters.

Subscriptions

GET https://api.iyzipay.com/v2/subscription/subscriptions

Request Body

NameTypeDescription

subscriptionReferenceCode

String

Abonelik referans kodu.

count*

Integer

Sayfa başına kaç abonelik listelenceğini belirtir.

page *

Integer

Belirtilen sayfa için abonelik detaylarını getirir.

endDate

Date

Abonelik bitiş tarihi.

startDate

Date

Abonelik başlangıç tarihi.

subscriptionStatus

String

Abonelik durumu.

pricingPlanReferenceCode

Boolean

Abonelikte kullanılan plan refereans numarası.

customerReferenceCode

String

Müşteri referans kodu.

parentReferenceCode

String

Abonelik güncellemelerinde üye işeyerinin eşleştirme yapılabileceği eşsiz referans kodu.

{
    "status": "success",
    "systemTime": 1687100005457,
    "data": {
        "totalCount": 0,
        "currentPage": 1,
        "pageCount": 0,
        "items": []
    }
}

Subscriptions Response Parameters

Parametre ismiTipAçıklama

status

String

Yapılan isteğin sonucunu belirtir. İşlem başarılı ise success değeri döner.

systemTime

Long

Dönen sonucun o anki unix timestamp değeridir.

totalCount

String

Toplam kaç tane sonuç geldiğini belirtir.

currentPage

Integer

Hangi sayfa için listeleme yapıldığını belirtir.

pageCount

Integer

Toplam kaç sayfa sonuç geldiğini belirtir.

items

Array Object

Abonelik detaylarını içeren dizidir.

Subscription Card Update

With this request, the credit card used in a subscription can be updated. Member businesses can easily update card information in cases such as payment errors or card expiration dates. A payment of 1 TL is charged for the validation of the updated credit card and is refunded immediately.

Subscription Card Update

POST https://api.iyzipay.com/v2/subscription/card-update/checkoutform/initialize

Request Body

NameTypeDescription

locale

String

Yapılan isteğin sonucunu belirtir. İşlem başarılı ise success değeri döner.

callBackUrl*

String

Ödeme sonucunun post edileceği url adresi.

subscriptionReferenceCode*

String

Abonelik referans numarası.

conversationId

String

Dönen sonucun o anki unix timestamp değeridir.

{
    "status": "success",
    "systemTime": 1687100005457,
    "checkoutFormContent": "<script type=\"text/javascript\">if (typeof iyziInit == 'undefined') {var iyziInit = {currency:\"TRY\",token:\"8e86b16e-9c0f-450d-a09d-0fd8a27e5197\",price:1.00,locale:\"tr\",baseUrl:\"https://sandbox-api.iyzipay.com\", merchantGatewayBaseUrl:\"https://sandbox-merchantgw.iyzipay.com\", registerCardEnabled:false,bkmEnabled:false,bankTransferEnabled:false,bankTransferTimeLimit:{\"value\":5,\"type\":\"day\"},bankTransferRedirectUrl:\"\",bankTransferCustomUIProps:{},campaignEnabled:false,campaignMarketingUiDisplay:null,paymentSourceName:\"\",plusInstallmentResponseList:null,payWithIyzicoSingleTab:false,payWithIyzicoOneTab:false,mixPaymentEnabled:true,creditCardEnabled:true,bankTransferAccounts:[],userCards:[],fundEnabled:false,memberCheckoutOtpData:{},force3Ds:false,isSandbox:true,storeNewCardEnabled:true,paymentWithNewCardEnabled:true,enabledApmTypes:[],payWithIyzicoUsed:false,payWithIyzicoEnabled:false,payWithIyzicoCustomUI:{},buyerName:\"Bünyamin\",buyerSurname:\"Yaşar\",merchantInfo:\"\",merchantName:\"Sandbox Merchant Name - 376927\",cancelUrl:\"\",buyerProtectionEnabled:false,hide3DS:true,gsmNumber:\"+905554443322\",email:\"kerem@altintas.com\",checkConsumerDetail:{},subscriptionPaymentEnabled:true,ucsEnabled:true,fingerprintEnabled:false,payWithIyzicoFirstTab:false,creditEnabled:true,payWithIyzicoLead:false,goBackUrl:\"\",metadata : {\"debitCardAllowed\":\"false\"},createTag:function(){var iyziJSTag = document.createElement('script');iyziJSTag.setAttribute('src','https://sandbox-static.iyzipay.com/checkoutform/v2/bundle.js?v=1687095783108');document.head.appendChild(iyziJSTag);}};iyziInit.createTag();}</script><script type=\"text/javascript\">if (typeof iyziUcsInit == 'undefined') {var iyziUcsInit = {\"baseUrl\":\"https://sandbox-api.iyzipay.com\", \"ucsToken\":\"28fac7ba-d34b-4e21-86a8-89785364d59f\",\"scriptType\":\"UCS_CONSENT\",\"buyerProtectedMerchant\":false,\"maskedGsmNumber\":\"+90****22\",\"gsmNumber\":\"+905554443322\",\"merchantName\":\"Sandbox Merchant Name - 376927\", createTag: function () {var iyziUcsJSTag = document.createElement('script'); iyziUcsJSTag.setAttribute('src', 'https://sandbox-static.iyzipay.com/checkoutform/v2/bundle.js?v=1687095783122'); document.head.appendChild(iyziUcsJSTag);}};if (typeof iyziInit == 'undefined') { iyziUcsInit.createTag(); }}</script><script type=\"text/javascript\">if (typeof iyziSubscriptionInit == 'undefined') {var iyziSubscriptionInit = {\"daysOfTrialPeriod\":\"30\",\"intervalCount\":\"1\",\"subscriptionState\":\"START_WITH_TRIAL_PERIOD\",\"interval\":\"WEEKLY\",\"recurrenceCount\":\"5\",\"pricingPlanPrice\":\"30.00\"}}</script>",
    "token": "8e86b16e-9c0f-450d-a09d-0fd8a27e5197",
    "tokenExpireTime": 1800
}

Subscription Card Update Response Parameters

Parametre ismiTipAçıklama

status

String

Yapılan isteğin sonucunu belirtir. İşlem başarılı ise ve kart update edilmiş ise success değeri döner.

systemTime

Long

Dönen sonucun o anki unix timestamp değeridir.

checkoutFormContent

String

Checkout formun gösterilmesi için gerekli javascript html kodu.

token

String

Checkout form için oluşturulan tekil değer. Her istek için özel üretilir ve işyerine dönülür.

tokenExpireTime

Integer

Checkout form için üretilmiş olan token değerinin geçerlilik süresi.

Merchants can send the locale and conversationId parameters in all requests, but this is not mandatory. The locale parameter determines the language of the response. If specified as “EN”, error messages will be received in English. Conversation id is a value that software developers can use to match requests and responses. If this parameter is sent, the same value will be received in the response.

With this request, a checkout form is created and when the customer makes the payment, token information is sent to the specified callBackUrl address. In this case, the card has been updated successfully.

Last updated