In this document, we will delve into the comprehensive of with and provide sample requests, responses, and best practices for a fast, easy, and secure integration.
Pre-Requirements;
Before proceeding, please ensure that you have the following pre-requisites in place:
Pair of API & Secret keys
A software tool to manage API calls; , Insonmina, Github clients
If so, keep going.
Overview
The implementation of requires two subsequent POST requests to be orchestrated one after the other.
In short;
First, we will illustrate a CF-Initialize POST request.
Then, we will cover up with CF-RetrievePOST section.
Steps
Step 1 - CF Initialize
This step involves sending a POST request and the request body contains various parameters such as locale, conversationId, price, basketId, paymentGroup, callbackUrl, currency, paidPrice, enabledInstallments, buyer details, shipping address, billing address, and basket items.
The following object is a sample CF-Initialize request body.
Once you have triggered above request, there are 3(three) scenarios you will monitor mostly.
Happy path includes a variable called, paymentPageUrl.
{
"status": "success",
"locale": "en",
"systemTime": 1687112732811,
"conversationId": "sampleConversationId",
"token": "a5b67652-c24a-4347-b61e-6c957bf30f1b",
"checkoutFormContent": "<script type=\"text/javascript\">if (typeof iyziInit == 'undefined') {var iyziInit = {currency:\"TRY\",token:\"a5b67652-c24a-4347-b61e-6c957bf30f1b\",price:5.20,locale:\"en\",baseUrl:\"https://sandbox-api.iyzipay.com\", merchantGatewayBaseUrl:\"https://sandbox-merchantgw.iyzipay.com\", registerCardEnabled:true,bkmEnabled:true,bankTransferEnabled:true,bankTransferTimeLimit:{\"value\":5,\"type\":\"day\"},bankTransferRedirectUrl:\"YOUR_CALLBACKURL\",bankTransferCustomUIProps:{},campaignEnabled:false,campaignMarketingUiDisplay:null,paymentSourceName:\"zooz\",plusInstallmentResponseList:null,payWithIyzicoSingleTab:true,payWithIyzicoOneTab:false,mixPaymentEnabled:true,creditCardEnabled:true,bankTransferAccounts:[{\"iban\":\"TR020006200035600006294884\",\"legalCompanyTitle\":\"iyzi Ödeme ve Elektronik Para Hizmetleri A.Ş.\",\"currency\":\"TRY\",\"bank\":\"Garanti Bankası\",\"bankId\":62,\"bankLogoUrl\":\"https://static.iyzipay.com/checkoutform/img/banks/62.svg\"},{\"iban\":\"TR080006400000111351092786\",\"legalCompanyTitle\":\"iyzi Ödeme ve Elektronik Para Hizmetleri A.Ş.\",\"currency\":\"TRY\",\"bank\":\"İş Bankası\",\"bankId\":64,\"bankLogoUrl\":\"https://static.iyzipay.com/checkoutform/img/banks/64.svg\"},{\"iban\":\"TR340004600786888000080896\",\"legalCompanyTitle\":\"iyzi Ödeme ve Elektronik Para Hizmetleri A.Ş.\",\"currency\":\"TRY\",\"bank\":\"Akbank\",\"bankId\":46,\"bankLogoUrl\":\"https://static.iyzipay.com/checkoutform/img/banks/46.svg\"},{\"iban\":\"TR910006701000000096073759\",\"legalCompanyTitle\":\"iyzi Ödeme ve Elektronik Para Hizmetleri A.Ş.\",\"currency\":\"TRY\",\"bank\":\"Yapı Kredi Bankası\",\"bankId\":67,\"bankLogoUrl\":\"https://static.iyzipay.com/checkoutform/img/banks/67.svg\"},{\"iban\":\"TR760001001187768823545001\",\"legalCompanyTitle\":\"iyzi Ödeme ve Elektronik Para Hizmetleri A.Ş.\",\"currency\":\"TRY\",\"bank\":\"Ziraat Bankası\",\"bankId\":10,\"bankLogoUrl\":\"https://static.iyzipay.com/checkoutform/img/banks/10.svg\"}],userCards:[],fundEnabled:true,memberCheckoutOtpData:{},force3Ds:false,isSandbox:true,storeNewCardEnabled:true,paymentWithNewCardEnabled:true,enabledApmTypes:[\"SOFORT\",\"IDEAL\",\"QIWI\",\"GIROPAY\"],payWithIyzicoUsed:false,payWithIyzicoEnabled:true,payWithIyzicoCustomUI:{},buyerName:\"Higher\",buyerSurname:\"Faster\",merchantInfo:\"\",merchantName:\"Sandbox Merchant Name - 3389550\",cancelUrl:\"\",buyerProtectionEnabled:false,hide3DS:false,gsmNumber:\"+905555434332\",email:\"stronger@implementation.com\",checkConsumerDetail:{},subscriptionPaymentEnabled:false,ucsEnabled:false,fingerprintEnabled:false,payWithIyzicoFirstTab:false,creditEnabled:true,payWithIyzicoLead:false,goBackUrl:\"\",metadata : {},createTag:function(){var iyziJSTag = document.createElement('script');iyziJSTag.setAttribute('src','https://sandbox-static.iyzipay.com/checkoutform/v2/bundle.js?v=1687112732810');document.head.appendChild(iyziJSTag);}};iyziInit.createTag();}</script>",
"tokenExpireTime": 1800,
"paymentPageUrl": "https://sandbox-cpp.iyzipay.com?token=a5b67652-c24a-4347-b61e-6c957bf30f1b&lang=en",
"payWithIyzicoPageUrl": "https://sandbox-ode.iyzico.com/?token=a5b67652-c24a-4347-b61e-6c957bf30f1b&lang=en"
}
Step 2 - Token + URL
Hereby, token and paymentPageUrl are essential knots of for the rest of payment journey.
In this step, you need to extract the token and paymentPageUrl from the response obtained in the previous step. The token should be saved for later validation, and the paymentPageUrl is used to redirect the user to the payment page.
token; Its expected that merchants saves token parameter to confront and validate payment at the very end of payment journey.
paymentPageUrl; where payment page appears briefly. Redirection to paymentPageUrl provides an interface to accomplish checkouts safely for end-users.
An example of paymentPageUrl interface on the browser;
Step 3 - Redirection
Following up end user interact on CF payment page, iyzico will automatically redirect the page to the address given in the "callbackUrl" parameter. Redirection POST includes;
Input Name
Type
Description
token
String
Unique value created for each checkout form request. This token is used to access the payment result
Step 4 - CF Retrieve
CF-Retrieve is the last step of PWI chain.
Basically, we have just accepted a payment on the previous step.
It is now time to legalize the transaction in this step.
The following example is a sample CF-Retrieve request body.
Once you have triggered above request, there are 2(two) scenarios you will monitor mostly.
Happy path includes SUCCESS parameter in the paymentStatus variable.
mdStatus parameter will only appear on 3DS operations.
Step 5 - Webhook
Webhooks are tail subject of our implementation streamline.
Receiving real-time payment notifications leverages overall CF experience while ensuring that the notifications are coming from trusted sources, preventing any potential tampering or unauthorized access to sensitive data.
Each payment event triggers webhooks;
In 15 seconds.
Until your server responds with 200.
For every 10 minutes.
Max 3 times.
Sample PWI Webhook
Parametere
Type
Description
iyziEventTime
long
Unix timestamp value of first notification.
iyziEventType
string
Shows the request type. Values: API_AUTH, THREE_DS_AUTH, BKM_AUTH
iyziReferenceCode
string
A unique reference code for the notification
paymentId
long
Unique iyzico reference code of related payment
paymentConversationId
string
Merchant's reference id for the related payment
status
string
Payment status. Values: SUCCESS, FAILURE
Happy path includes success parameter in the status variable.
Confirmation
To finalize payment operations successfully, correlation of certain variables plays significant role;
paymentId
status
price
Both of the status parameters should be success
price parameter amounts should be the same
And lastly, Idempotency parameters should be the same as well.
If so, congratulations! Just finished PWI implementation.
Transaction details could get from merchant panel.
Please note that the provided sample requests and responses are for illustration purposes only, and you should adapt them to your specific implementation requirements and API documentation.
CF implementation begins with POST request.
Redirection phase ties and steps overall.
Please check further details around mdStatus .
Other parameters optionally
response and notification have to authenticate each other.
It is crucial to cross-verify the response received from and the data received in the notification. Match the paymentId, status, price, and other relevant parameters to ensure the authenticity and correctness of the transaction.
paymentId on response should be equal to paymentIdfrom Webhook
