Introduction

Intended Audience

This overview document is written for technical people with a background in payments services; and implementing online payment functionality to the e-commerce sites and/or internal ERP systems using Payten Payment Gateway.

How to Contact Customer Support

For problems with transaction processing or your connection to the server, contact Customer Support.

What is Payten Payment Gateway?

Payten Payment Gateway is an online payment solution developed by Payten Turkey. It offers a secure, easy and convenient checkout experience for both, customers and merchants. While Customers (Card Holders) enjoy the secure e-wallet and flexible payment features on check out pages; the Merchants are handling the payment without touching the credit card data so they remain PCI DSS compliant; and therefore eliminate the risks around fraud & secure storage of financially sensitive data.

Security

Payten Payment Gateway is built on a robust and secure communication protocol. Payten Payment Gateway API is a set of instructions submitted with standard HTTPS Post requests. At the server end, we use a certificate delivered by Verisign. The SSL encryption guarantees that it is our servers you are communicating with and that your data is transmitted in encrypted form. There is no need for a client SSL certificate. When we receive a request, we check the level of encryption. Directly TLSv1.2 version and next version is supported.

Supported Languages

The API supports all platforms & languages that can implement HTTPS Post methods.

Response Parsing

Payten Payment Gateway responses by default will be in form of JSON format. You can use any JSON parsing tool or framework to process Payten Payment Gateway responses.

Test Environment

An API test environment is available and all API action types given in this document can be tested using by Payten Payment Gateway API Test URL. All API requests should be sent to this URL address using HTTPS POST method.

Request & Response

Payten Payment Gateway API Requests

A request to the Payten Payment Gateway API is made a by sending a POST HTTPS request to Payten Payment Gateway API Endpoint URL. Each HTTPS POST request send to the API URI should have a set of parameter-value pairs encoded in it, depending of the type of request being sent.

Payten Payment Gateway API Responses

The Payten Payment Gateway API response supports JSON data format. Each response, regardless of the success of the action, will return the responseCode and responseMsg parameters. Depending on the successfulness of the action the responseCode and responseMsg can have the specific value pairs. If an error has occurred and the API call is considered to be failed (responseCode is not equal to 00) the error and errorCode parameters will be present in the response.

IMPORTANT NOTE: Responses of our services may vary from service to service, so expect responseCode and responseMessage there may be new response parameters. Please consider optional parameters while parsing JSON response.

Authentication

You first authenticate to the API by providing your user information (secure credentials) in the request. You can manage your API user information from your account or by requesting related change from support team. Every API user have its own e-mail and password information. Your user e-mail and password pair carries many privileges, so be sure to keep them secret!

All API requests must be made over HTTPS. Calls made over plain HTTPS will fail. You must authenticate properly for all requests.

The recommended way is to create a Session Token with these credentials, and then use this token for subsequent API requests

How to integrate?

Hash Control

Hash Control in Virtual POS payment systems is a method used to ensure security during payment transactions by using sdSha512 hash control. In this method, it is used to verify the integrity and accuracy of the data sent during the payment process. This makes it possible to detect and prevent changes made on the server where the payment transaction takes place.

Hashing is a mathematical operation that converts a data set into a unique set. The resulting array is used to verify the integrity of the dataset and to detect whether any changes have been made. In payment systems, the hash value generated by the system after the transaction can be created using different algorithms depending on the device and transaction details.

sdSha512 hash control is a hash value calculated using the SHA-512 algorithm. This hash value is used to verify the integrity and accuracy of the data sent during the payment process. The hash value of the data sent during the payment process is compared with the hash value calculated by the recipient, and when a match is found, the payment transaction is performed.

In summary, sdSha512 hash control is a method used to ensure security in virtual POS payment systems and is used to verify the integrity and accuracy of the data sent during the payment process.

IMPORTANT NOTE:

If you are using the Direct Post Integration and Hosted Payment Page(HPP) models from our integration models, you can compare the accuracy of the payment by calculating the hash value calculated within the sdSha512 parameter found in the browser return using the following formula:

sdSha512 request.getParameter('sdSha512')

Used for hash verification secretKey is the private merchant key defined once for each merchant, formula :SHA512 encodeHexString((merchantPaymentId+'|'+customerId+'|'+sessionToken+'|'+responseCode+'|'+randomKey+'|'+secretKey))

API Model

This integration model is the most simplest and straightforward model which enables the whole secure checkout & ewallet experience to take place behind the scenes. It allows the merchants to continue to use their own payment & wallet pages without directing their customer to a 3rd party environment/page. Available API calls for transaction, query and card management functions enable merchants to enjoy Payten Payment Gateway features from the backend.

However please note that this model still requires you to handle the credit card even if you store it. This is simply because the sensitive financial information will be entering your environment (via your payment page) and it will be received & forwarded to Payten Payment Gateway by your own system. Therefore you won't be 100% free from PCI-DSS regulations and will be subject to certain elements of PCI DSS compliance.

Hosted Page (HP)

This model requires the merchants to use Payten Payment Gateway's payment page hosted in Payten environment. It is based on one way communication of the "transaction result" to the Merchant system occurring at Step 4. HPP model simply assumes that the Merchant site has received the transmitted information and updated its own records accordingly. It has the following steps:

Step 1:

The Merchant Web Site makes a sale request by specifying the integration model as HPP. Order/Billing/Shipping details can also be passed at this stage to be displayed on Payten Payment Gateway payment page for Customer's information only.

Step 2:

The payment request is processed, a session token is created and sent back to the merchant site. Merchant Web Site receives the token and redirects Customer's Browser to Payten Payment Gateway Payment Pages with the given session token.

Step 3:

If there is any saved card detail for the Customer, his/her e-wallet is displayed for quick payment. If not, new card entry screen is displayed. Customer clicks on 'pay' button after entering/selecting the card to be used in payment. Payten Payment Gateway processes the payment accordingly.

Step 4:

Payten Payment Gateway redirects the Customer Browser to Merchant Web Site and also returns the transaction result.

Please note that Step 4 is a browser based HTTPS re-direction and it all happens in customer's environment in which Payten has no control over. There might be cases like where the customer may close the browser screen or internet connection may cuts off during this re-direction etc. Therefore merchants using this model should not completely rely on redirection process to obtain information about the payment result. They should use additional api calls to check the status of the payment. These details are available in API Model Integration document.

Direct Post (Non 3D)

This integration model is based on the scenario that the Payment Page is being hosted by Merchants but its form action is Direct Post to Payten Payment Gateway so that any financially sensitive data will be collected still at the convenience of a merchant hosted page but to be fully compatible with PCI DSS. This will overcome the shortage of the API integration model for the merchants willing 100% compliance with PCI DSS without any additional effort on their side. Please see the flow below for details.

Step 1:

The Merchant Core System makes a Session Token request in order to get a valid key value for defining the session.

Step 2:

This session token request is processed; a session token is created and sent back to the merchant system in the API response.

Step 3:

Merchant system serves the payment page using the given secure session token.

Step 4:

Cardholder interacts with the page and clicks on Confirm button. Merchant system submits all information received via this page to Payten Payment Gateway system.

Extra Point Step :

If merchant wants to provide points usage to cardHolders, merchants need to call Query Points with SESSIONTOKEN, CARDPAN,CARDEXPIRY. According to QUERYPOINTS response merchant need to set hidden points parameter in the form. Points parameter format should be json and it differs bank by bank. Merchants needs to encode points value because it is a json format. So please check sale by points payment type examples.

Step 5:

Payten Payment Gateway processes the payment details via an invisible interim page.

Step 6:

Payten Payment Gateway forwards the payment to the relevant VPOS, receives the result and redirect the cardholder back to merchant return url. The merchant is expected to listen and parse the payment result within the posted form.

				
<form action="https://test.merchantsafeunipay.com/merchant/post/sale/[SECURE_SESSION_TOKEN]" method="post">
	<input type="text" name="cardOwner" placeholder="Card Owner" maxlength="32" />
	<input type="text" name="pan" placeholder="PAN" maxlength="19" />
	<select name="expiryMonth">
		<option value="01">January</option>
		<option value="02">February</option>
	</select> 
	<select name="expiryYear">
		<option value="2019">2019</option>
		<option value="2020">2020</option>
		<option value="2021">2021</option>
	</select>
	<input type="password" name="cvv" placeholder="CVV" maxlength="4" />
	<input type="checkbox" name="saveCard" />
	<input type="text" name="cardName" placeholder="Card Name"/>
	<input type="text" name="cardCutoffDay" placeholder="Card Cutoff Day"/>
	<input type="text" name="installmentCount" placeholder="Installment Count"/>
	<input type="hidden" name="points" />
	<input type="submit" value="Submit" />
</form>
				
				

Pay with Card Token Form

					
<form action="https://test.merchantsafeunipay.com/merchant/post/sale/[SECURE_SESSION_TOKEN]" method="POST">
	<input name="cardToken" type="text"  placeholder="Card Token"size="20" />
	<input name="cvv" type="text" placeholder="CVV" size="4" />
	<input type="submit" value="Complete Payment"/>
</form>
					
				

Direct Post Sale 3D

This integration model is based on the scenario that the Payment Page is being hosted by Merchants but its form action is Direct Post to Payten Payment Gateway so that any financially sensitive data will be collected still at the convenience of a merchant hosted page but to be fully compatible with PCI DSS. This will overcome the shortage of the API integration model for the merchants willing 100% compliance with PCI DSS without any additional effort on their side. Please see the flow below for details.

Step 1:

The Merchant Core System makes a Session Token request in order to get a valid key value for defining the session.

Step 2:

The payment session request is processed; a session token is created and sent back to the merchant system in the API response.

Step 3:

Merchant system serves the payment & wallet page using the given secure session token.

Step 4:

Cardholder interacts with the page and clicks on Confirm button. Merchant system submits all information received via this page to Payten Payment Gateway system.

Extra Point Step :

If merchant wants to provide points usage to cardHolders, merchants need to call Query Points with SESSIONTOKEN, CARDPAN,CARDEXPIRY. According to QUERYPOINTS response merchant need to set hidden points parameter in the form. Points parameter format should be json and it differs bank by bank. Merchants needs to encode points value because it is a json format. So please check sale by points payment type examples.

Step 5:

Payten Payment Gateway processes the payment details (and optionally starts 3D authentication process on behalf of the merchant) via an invisible interim page.

Step 6:

Payten Payment Gateway performs MOTO sale (or optionally directs the cardholder to 3D authentication servers).

Step 7:

ACS server serves the 3D authentication page where the cardholder enters a dynamic code sent to his/her mobile phone.

Step 8:

ACS server authenticates the user and returns back to Payten Payment Gateway invisible interim page.*Depending on authentication response, the transaction sent to bank either with full 3D details (if 3D authentication is done successfully) or as MOTO payment (if 3D authentication has failed)

Step 9:

Payten Payment Gateway make return the response to merchant return url

				
<form action="https://test.merchantsafeunipay.com/msu/api/v2/post/sale3d/[SECURE_SESSION_TOKEN]" method="post">
	<input type="text" name="cardOwner" placeholder="Card Owner" maxlength="32" />
	<input type="text" name="pan" placeholder="PAN" maxlength="19" />
	<select name="expiryMonth">
		<option value="01">January</option>
		<option value="02">February</option>
	</select> 
	<select name="expiryYear">
		<option value="2019">2019</option>
		<option value="2020">2020</option>
		<option value="2021">2021</option>
	</select>
	<input type="password" name="cvv" placeholder="CVV" maxlength="4" />
	<input type="checkbox" name="saveCard" />
	<input type="text" name="cardName" placeholder="Card Name"/>
	<input type="text" name="cardCutoffDay" placeholder="Card Cutoff Day"/>
	<input type="text" name="installmentCount" placeholder="Installment Count"/>
	<input type="hidden" name="points" />
	<input type="submit" value="Submit" />
</form>
				
				

					
<form action="https://test.merchantsafeunipay.com/msu/api/v2/post/sale3d/[SECURE_SESSION_TOKEN]" method="POST">
	<input name="cardToken" type="text"  placeholder="Card Token"size="20" />
	<input name="cvv" type="text" placeholder="CVV" size="4" />
	<input type="submit" value="Complete Payment"/>
</form>	
					
				

Direct Post Preauth 3D

Note: This model support preauth3d too. If you need preauth for same flow please update form action tag as https://test.merchantsafeunipay.com/msu/api/v2/post/preauth3d/[SECURE_SESSION_TOKEN]

Direct Post 3D Authentication

This integration model is based on the scenario that the process of 3D authentication is finished seperately from the Sale / Preauth API Call. Merchant offers a page where Card Holder enters his/her card data and submits them. This is where the process of 3D authentication starts. Depending on the response given from the authentication process, merchant issues authorization via API.

Step 1:

The Merchant Core System makes a Session Token request in order to get a valid key value for defining the session.

Step 2:

The payment session request is processed; a session token is created and sent back to the merchant system in the API response.

Step 3:

Merchant system serves the payment & wallet page using the given secure session token.

Step 4:

Cardholder interacts with the page and clicks on Submit button. Merchant system submits all information received via this page to Payten Payment Gateway system.

Step 5:

Payten Payment Gateway receives POST request from the merchant's page and directs it to the 3D ACS (Access Control Server) in order to continue with the 3D authentication flow.

Step 6:

ACS serves the 3D Security Page where the Card Holder must enter the correct (dynamic) code sent to his/her mobile phone in order to authenticate.

Step 7:

Payten Payment Gateway handles the response of the 3D Authentication of success or failure.

Step 8:

The final response of the 3D Authentication process is forwarded to the merchant's page. The merchant is expected to listen and parse the result within the posted form later on issues authorization via API (Sale / Preauth).

Auth 3D

Merchants can manage their payments in 3D or non-3D formats, depending on the mdStatus value returned by the bank. In this method, a payment-specific creation is sent with the session token and auth3d token, and the payment is processed.

3D Authentication Direct Post Test Form

3D Authentication with Card Data Form

			
<form action="https://test.merchantsafeunipay.com/msu/api/v2/post/auth3d/[SECURE_SESSION_TOKEN]" method="post">
	<input type="text" name="cardOwner" placeholder="Card Owner" maxlength="32" />
	<input type="text" name="pan" placeholder="PAN" maxlength="19" />
	<select name="expiryMonth">
		<option value="01">January</option>
		<option value="02">February</option>
	</select> 
	<select name="expiryYear">
		<option value="2019">2019</option>
		<option value="2020">2020</option>
		<option value="2021">2021</option>
	</select>
	<input type="password" name="cvv" placeholder="CVV" maxlength="4" />
	<input type="checkbox" name="saveCard" />
	<input type="text" name="cardName" placeholder="Card Name"/>
	<input type="text" name="cardCutoffDay" placeholder="Card Cutoff Day"/>
	<input type="text" name="installmentCount" placeholder="Installment Count"/>
	<input type="hidden" name="points" />
	<input type="submit" value="Submit" />
</form>
			
		

3D Authentication with Card Token Form

			
<form action="https://test.merchantsafeunipay.com/msu/api/v2/post/auth3d/[SECURE_SESSION_TOKEN]" method="POST">
	<input name="pan" type="text" size="20" />
	<input name="cardOwner" type="text" size="20" />
	<input name="expiryMonth" type="text" size="2"/>
	<input name="expiryYear" type="text" size="4"/>
	<input name="cvv" type="text" size="4"/>
	<input name="cardCutoffDay" type="text" size="2"/>
	<input name="callbackUrl" value="[merchant-return-url-handler]" />
	<input type="submit" value="Complete Payment"/>
</form>

or if the payment will be done with an existing tokenized card 
			
<form action="https://test.merchantsafeunipay.com/msu/api/v2/post/auth3d/[SECURE_SESSION_TOKEN]" method="POST">
	<input name="cardToken" type="text"  placeholder="Card Token"size="20" />
	<input name="cvv" type="text" placeholder="CVV" size="4" />
	<input type="submit" value="Complete Payment"/>
</form>
			
		

Alternative Payment Methods

In this section, there are integration models of alternative payment methods supported in Payten Payment Gateway. Each one of them may have different integration flow. Generic steps are:

Step 1:

The Merchant Core System makes a Session Token request in order to get a valid key value for defining the session. It is required to pass additional extra parameter(s) to enable that payment method on default payment page. (Session Token)

Step 2:

The payment session request is processed; a session token is created and sent back to the merchant system in the API response.

Step 3:

Merchant system serves the payment using the given secure session token.

Step 4:

Customer interacts with the page and clicks on Submit button. Merchant system submits all information received via this page to Payten Payment Gateway system.

Step 5:

Payten Payment Gateway receives POST request from the merchant's page and directs it to the external system in order to continue with the payment methods of external payment system.

Step 6:

External payment system serves its dedicated payment page where the customer must provide the correct information in order to authenticate or start payment.

Step 7:

External payment system processes the payment at their side if customer approves or waits for session to expire at external system.

Step 8:

The final response of the external system's process is forwarded to the merchant's page.

Client Side Encryption(CSE)

Introduction

Client Side Encryption is a way to encrypt customer sensitive information in the browser, before card data passes any other medium(i.e. merchant server). The model is suitable for merchants wanting to do API SALE/PREAUTH from their servers, because card data will pass encrypted on merchant server, this way avoiding the responsibility of "hosting" any card data on merchant side.

How it works

Merchant must include cse-sdk-js on their payment page. In order to include the sdk in the page, a valid non-expired session token must exist. The steps should be like this:

• Create a Payten Payment Gateway Session Token server side with payment amount and necessary payment information. Make it available on the client
• Include the SDK in the page

  							
  <script type="text/javascript" src="[host]/msu/sdk/{sessionToken}/cse-sdk.js"></script>   
  							
  						

• After user has filled first 6 digits of pan, you can issue a SHOULDDO3D API Call to determine the next steps
• Customer has filled card data and clicks pay. If SHOULDDO3D returned YES, then no CSE is needed as customer sensitive information will pass from Browser directly to Payten Payment Gateway Servers via the Auth 3D flow. One of request parameters of the Auth 3D flow is callbackUrl which is an endpoint on merchant side that will receive the final 3D response, including auth3DToken if 3d authentication was successful. At this point you can call API SALE with the auth3DToken
• If SHOULDDO3D returns NO or OPTIONAL, you may skip the 3D Journey and intercept main payment form by encrypting the data using the CSE SDK Payment With New Card

  						
  //data is some container/collector of card and customer information
  msu.client.encrypt(data.pan, data.cardHolderName, data.expiryMonth, data.expiryYear, data.cvv, data.nonce)
  	.then(encryptedData => {
      	// create a form or append to an existing one
      	//paymentPage.appendFormInput("hidden", "encryptedData", encryptedData);
      	form.submit();
  });
  						
  					

  Payment with existing card/wallet

  						
  //data is some container/collector of card and customer information
  msu.client.encrypt(data.pan, data.cardHolderName, data.expiryMonth, data.expiryYear, data.cvv, data.nonce)
  	.then(encryptedData => {
  		// create a form or append to an existing one
      	//paymentPage.appendFormInput("hidden", "encryptedData", encryptedData);
      	form.submit();
  });
  						
  					

  You must not include "name" in the original form inputs where pan/name/expiry/cvv is entered by customer otherwise they will be sent plain on your server, beating the whole purpose of CSE!
• Encrypt Pan is a way to encrypt card sensitive information in the browser, before card data passes any other medium(i.e. merchant server). The model is suitable for merchants wanting to do API QUERYCARD/QUERYTRANSACTION from their servers, because card data will pass encrypted on merchant server, this way avoiding the responsibility of "hosting" any card data on merchant side.

  						
  //data is some container/collector of card and customer information
  msu.client.encryptPan(data.pan, data.nonce)
  	.then(encryptedData => {
      	// create a form or append to an existing one
      	//paymentPage.appendFormInput("hidden", "encryptedData", encryptedData);
      	form.submit();
  });
  						
  					

CSE Interactive Form

Below you can find a Sandbox form to test the CSE Flow

CSE SDK API Information

Make sure you have included the SDK with the script tag

	
<script type="text/javascript" src="[host]/msu/sdk/{sessionToken}/cse-sdk.js"></script>   
	

• encrypt(pan, cardHolderName, expiryMonth, expiryYear, cvv, nonce): Promise - for new cards
• encrypt(cvv, nonce): Promise - for wallet cards
• encryptPan(pan, nonce): Promise - for pan
• isValidCardHolderName(name): Boolean
• isValidPan(pan): Boolean
• isValidExpiry(expiryMonth, expiryYear): Boolean
• detectBrand(bin): String(possible return values: visa | mastercard | american-express | diners-club | discover | jcb | troy | dinacard)
• hasErrors(): Boolean
• errors(): Array (possible return values: PAN_INVALID | CVV_INVALID | EXPIRY_INVALID | CARD_HOLDER_NAME_INVALID | NONCE_MISSING_OR_INVALID

The SDK does not do any message translation. If an error is thrown, it means client code must handle it. If you're calling encrypt(..) without input validation, validation errors will be collected and they can be accessed with errors(). (See also hasErrors())

Public key used for encryption is also accessible from this endpoint: [host]/msu/cse/publickey

CSE SDK DEMO PAGE

Client Side Encryption is a way to encrypt customer sensitive information in the browser, before card data passes any other medium(i.e. merchant server). The model is suitable for merchants wanting to do API SALE/PREAUTH from their servers, because card data will pass encrypted on merchant server, this way avoiding the responsibility of "hosting" any card data on merchant side.

CSE SDK PAN ENCRYPT DEMO

Client Side Pan Encryption is a way to encrypt customer card pan information in the browser, before card pan passes any other medium(i.e. merchant server). The model is suitable for merchants wanting to do API QUERYCARD/QUERYTRANSACTION from their servers, because card pan will pass encrypted on merchant server, this way avoiding the responsibility of "hosting" any card pan on merchant side.

Error Handling

If a request results in an error the error and errorCode parameters will be present in the response. Generally, there are two types of errors that can occur: core errors and payment gateway originating errors.

Core Errors

Core errors occur mostly because of invalid parameter values. These errors have the following code format: ERR100xx. Error codes can be found in the relevant field in the response returned on their own page.

Payment Gateway (vPOS) Errors

The Payten Payment Gateway API uses a set of error codes for errors that originate from the payment gateway that is being used. This error set is derived from the ISO-8583 field 39 response values. The code format for these errors is ERR200xx.

Integration Errors

The Payten Payment Gateway API uses a set of error codes for integration errors that originate from Threat Metrix or 3D Server integration. The code format for these errors is ERR300xx.

Additional error related response parameters

There are two additional API response parameters that may help you indicate the cause of the error that has occurred in the case where the error originates from the payment gateway. These are pgTranErrorCode and pgTranErrorText . These two parameters are especially useful when you get an error from the payment gateway that is still not mapped in our error set. In this case the PGTRANERRORCODE and PGTRANERRORTEXT can help you determine the cause of the error.

Error response examples

Here are API response examples for multiple cases when an error has occurred.

Notifications

Payten Payment Gateway has a built-in mechanism that is used to notify the respective merchant of events related to financial transactions, and dealer status changes. More specifically, Payten Payment Gateway sends notification messages to a merchant about specific events when:

• An approved transaction is performed
• A dealer is added
• A dealer is edited
• A request for enabling a dealer is made
• A dealer is approved (enabled)
• A dealer is disabled

Response time to transactions from bank is maximum 180 seconds. As a merchant, NOTIFICATION service must be used to check the status of the transaction in the bank. If there is a late response from the bank or there is no response from the bank about transaction, it is important that you must integrate NOTIFICATION service. Through this service, transaction status is acknowledged in Payten Payment Gateway. Based on this acknowledgement you can either update your ERP or cancel the transaction.

How it works?

A merchant should create a listener end point and the URL pointing to this page should be added to this merchant's profile. To send a notification, the merchant must enter the URL from which the notification is expected to be received in the PPG B2B Admin Panel under Settings > Profile, and select the transaction type. For financial notifications, a definition must be made in the Financial Transaction Notifications field. Payten Payment Gateway then sends notifications to the merchant when a particular event occurs which is mentioned in the list above. When one such time event occurs, Payten Payment Gateway then sends a secure FORM POST to the URL containing the respective parameters shown in the right.

All parameters, which is sent in notifications, are encoded with Charset UTF-8. Merchant listener should decode with Charset UTF-8 and then get the exact parameter value. Encoding is necessary to transfer special characters in parameters value.

The SDSHA512 hash is calculated using those attribute, which are seperated by a pipe character:
NOTIFICATIONTYPE|MERCHANTPAYEMNTID|CUSTOMER|AMOUNT|TRANSACTIONTYPE|CURRENCY|INSTALLMENTCOUNT|RANDOM|MERCHANT_SECRET

Profile

URL Descriptions

Payment Page URL: If you want to use a custom payment page URL, you can add it here. If no payment page link is entered, the MSU payment page URL will be used.

Split Payment Page URL: If you want to use a custom split payment page URL, you can add it here. If no split payment page link is entered, the MSU payment page URL will be used.

Recurring Payment Page URL: If you want to use a custom recurring payment page URL, you can add it here. If no recurring payment page link is entered, the MSU payment page URL will be used.

Return URL: You can define a Return URL for the page that will be displayed after your payments are completed.

Metadata

Payten Payment Gateway Domain contains some important objects and shares them with integrated clients.

Transaction

Each financial request refers a transaction in Payten Payment Gateway domain. All settlement is done via transaction records.

A transaction has a type can have one of these status any time. Please see the definitions given right handside.

Diğer Kullanım Özellikleri

Payten Payment Gateway API'nin diğer kullanım alanlarını ve örneklerini aşağıda bulabilirsiniz.

Ödeme Sayfası Bağlantısı (URL) Kullanımı

Ödeme sayfası bağlantısı (URL) kullanımı SMS, mobil uygulama bildirimleri, push mesajlar , e-mail gibi kanallar ile ödemenin yapılacağı linkin müşteri ile paylaşıldığı bir ödeme opsiyonudur. Bu akışta üye iş yeri bir ödeme sayfası linki oluşturarak bu linki ilgili müşteri ile paylaşır. Müşteri kendisine ulaşan ödeme sayfası linkine tıklayarak ödeme sayfasına gider. Bu sayfada ödeme yapacağı tutarı, karşılığında alacağı ürünleri görür. Kart bilgilerini sayfadaki forma girer ve işlemini tamamlar.

Ödeme sayfası bağlantısı oluşturmak isteyen üye iş yeri öncelikli olarak Paratika API üzerinden ilgili parametreler ile bir SESSIONTOKEN isteğinde bulunur. Üye iş yeri başarılı bir şekilde oluşturulan oturum anahtarı bilgisi ile satış ya da ön otorizasyon yapacağı ödeme sayfası linkini oluşturur ve ilgili müşteriyle bu linki paylaşır. Müşteri linkin geçerlilik süresi dolmadan linke tıklayıp işlemi tamamlamalıdır. Geçerlilik süresi dolan linkler "Sonlandırılmış oturum (session) bilgisi." hata sayfasına yönlendirilirken geçersiz bir oturum anahtarı ile oluşturulan linkler ise "Geçersiz oturum (session) bilgisi." sayfasına yönlendirilir. Linklerin geçerlilik süresi SESSIONTOKEN isteğindeki SESSIONEXPIRY parametresi ile belirlenir ve bu parametrenin varsayılan değeri 7gündür.

Başarılı bir şekilde sonlanan işlemlerin cevabı ise SESSIONTOKEN isteğinde gönderilen RETURNURL parametresindeki adrese POST edilir.

Adım 1:

Payten Payment Gateway API üzerinden SESSIONTOKEN isteği ile bir session token oluşuturulur. ([SESSIONTOKEN])

Adım 2:

Bu session token kullanılarak ödeme sayfası linki oluşturulur. (Örn. https://test.merchantsafeunipay.com/merchant/payment/[SESSIONTOKEN])

Adım 3:

Link ilgili müşteriye mail, SMS, bildirim vs. olarak gönderilir.

Adım 4:

Müşteri linke tıklayarak ödeme sayfasına gider ve ödeme işlemini gerçekleştirir.

Adım 5:

Ödeme işleminin sonucu SESSIONTOKEN isteğindeki RETURNURL parametresi ile belirtilen adrese POST edilir.

TEST CARDS

Here you can find Test Cards for different Banks.

Direct Login

Prerequisites

Direct Login Feature should be enabled for merchant by Payten Payment Gateway operator from Settings/Merchant Feature On/Off Management

How It Works

Interactive Form

In this interactive form you can create a JSON Web Token and test the process in interactive mode. You can login to Payten Payment Gateway with the generated token

• TEST

  Test@İstanbul - https://test.merchantsafeunipay.com/msu/admin/merchantdirectlogin
  Prod@İstanbul - https://merchantsafeunipay.com/msu/admin/merchantdirectlogin
  

• NEON

  MsuPretest@İstanbul l - https://neon-app.asseco-see.com.tr/msupretest/admin/merchantdirectlogin
  Msu@İstanbul l - https://neon-app.asseco-see.com.tr/msu/admin/merchantdirectlogin
  

• LOCALHOST

  Msu@localhost - http://localhost:8090/msu/admin/merchantdirectlogin
  

Sample PHP

Here's a PHP sample using standard PHP libraries only.

Sample Java

Here's a Java sample using standard Java libraries only. You can use a JSON library for a more readable code

Md Status

Here you can find md status values.

Financial Transactions

The available transaction types in Payten Payment Gateway system are listed and explained below.

Sale

A Sale transaction is a credit card transaction that immediately charges a customer's credit card.

The character length of MerchantPaymentID varies according to the virtual POS bank. Our recommended maximum length value is 40 characters. Apart from this, the character lengths of the banks should be taken into account. If you are sending a transaction to the PARATIKA application via Payten Payment Gateway, you should send the MerchantPaymentID with a maximum value that is 9 characters shorter. This is because PARATIKA application adds +9 characters to the value sent from the Payten Payment Gateway.

Raiffeisenbank Virtual POS Note: If you are using Raiffeisenbank's Virtual POS or sending transactions to Raiffeisenbank, the MERCHANTPAYMENTID must be limited to a maximum of 20 characters, as this is the maximum supported by the bank.

Request parameters

ACTION:

SALE, required Max length: 128 Description to be provided

MERCHANTUSER:

string, conditional Max length: 128 Üye İşyeri API Kullanıcısı E-posta Adresi

MERCHANTPASSWORD:

string, conditional Max length: 128 Üye İşyeri API Kullanıcısı Şifresi

MERCHANT:

string, conditional Max length: 128 Payten Payment Gateway’de tanımlı olan Üye İşyeri Kodu veya ticari kodudur.

MERCHANTPAYMENTID:

string, conditional Max length: 128 Payment ID given by Merchant (it must be unique).Payment ID given by Merchant (it must be unique).The character length of MerchantPaymentID varies according to the virtual POS bank. Our recommended maximum length value is 40 characters. Apart from this, the character lengths of the banks should be taken into account. If you are sending a transaction to the PARATIKA application via Payten Payment Gateway, you should send the MerchantPaymentID with a maximum value that is 9 characters shorter. This is because PARATIKA application adds +9 characters to the value sent from the Payten Payment Gateway.
Raiffeisenbank Virtual POS Note: If you are using Raiffeisenbank's Virtual POS or sending transactions to Raiffeisenbank, the MERCHANTPAYMENTID must be limited to a maximum of 20 characters, as this is the maximum supported by the bank.

CUSTOMER:

string, conditional Max length: 128 The Merchant System ID for customer. It must be unique within a Merchant.

AMOUNT:

decimal, conditional Max length: 30 İşlem tutarı bilgisidir. Önemli Not: Üye iş yerlerinin Payten Payment Gateway’e ilettikleri tutar KDV dahil tutardır. Payten Payment Gateway ek olarak herhangi bir vergi hesaplaması yapmaz.

CURRENCY:

string, conditional Max length: 3 ISO Alpha transaction currency code like EUR, USD, GBP. See all possible values (37)

SESSIONTOKEN:

string, conditional Max length: 48 İşlem için gerekli değerleri içeren benzersiz bir değerdir.

AUTH3DTOKEN:

string, optional Max length: 16 Başarılı 3D Kimlik Doğrulama işleminden sonra üretilen benzersiz değer.

CUSTOMEREMAIL:

string, optional Max length: 64 Customer e-mail.

CUSTOMERNAME:

string, optional Max length: 128 Name of the Customer.

CUSTOMERPHONE:

string, optional Max length: 64 Customer phone / mobile number.

CUSTOMERIP:

string, optional Max length: 39 CUSTOMERIP alanı Paratika ödeme sistemleri ve PAYCELL DCB işlemleri için zorunludur.

CARDHOLDERPORT:

string, optional Max length: 39 description

CUSTOMERUSERAGENT:

string, optional Max length: 4000 description

ENCRYPTEDDATA:

string, optional Max length: 2048 Şifreli müşteriye duyarlı bilgi içerir.
Şifrelemeden önce: p=5456165456165454&y=2020&m=12&c=000&cn=John Doe&n=n9Kf9wUzQ21Xa63B, nerede p - kart numarası, y - son kullanma tarihi, m - son kullanma ayı, cn - kart sahibinin adı, n - nonce.

CARDTOKEN:

string, conditional Max length: 64 Numeric value replacing card number & expiry date. Required when none of the other card information are provided. If the user wants to make a transaction with the card he/she has previously registered, this unique token is used instead of the card number and expiry date.

CARDPAN:

string, conditional Max length: 25 PAN number of the card.

CARDEXPIRY:

string, conditional Max length: 7 Expiry date of the card. Format should be [mm.yy].

NAMEONCARD:

string, conditional Max length: 64 Kart üzerindeki isim.

CARDCVV:

string, optional Max length: 4 Security number of the card.

CARDSAVENAME:

string, optional Max length: 255 Given name for the saved card.

SAVECARD:

string, optional Max length: 3 Değer "YES" veya "NO" olabilir

ISREFUNDABLE:

string, optional Max length: 3 Default value: 'yes' description

REFLECTCOMMISSION:

string, optional Max length: 3 Tutara komisyon yansıt. Sadece bayiler için çalışmaktadır. See all possible values (2)

INSTALLMENTS:

integer, optional Max length: 2 Default value: '1' Number of installments. Specified number should exist in Payten Payment Gateway as “defined installment”

PAYMENTSYSTEM:

string, optional Max length: 128 Name of the payment system (bank payment gateway / vPOS account). Specified name should match the one given in Payten Payment Gateway If not provided, Payten Payment Gateway smart switch feature will used.

PAYMENTSYSTEMPOOL:

string, optional Max length: 1024 PAYMENTSYSTEMPOOL parameter is a special parameter that is used to include specific Payment Systems and to receive payments only through these payment systems.Bu parametre JSON(URL encoded) formatında olmalıdır.PAYMENTSYSTEMPOOL :[{"PaymentSystemName": "PsName1","isDefault": false, "redirectBanks": {"CardBrand": "ALL","BankCode":"0111"}},{"PaymentSystemName": "PsName2","isDefault": true},{"PaymentSystemName": "PsName3","isDefault": false}]

POINTS:

string, optional Max length: 500

Sale by points can be used via points argument of sale action. This parameter gets its argument as a json format and parse it according to payment system.

AKBANK, AKBANK INHOUSE SALE BY POINTS SAMPLE

• POINTS must be json String, you can use POINTS argument in SALE method like below
• POINTS : [{"name":"XCBCHIPPARA", "value":"10"}]
• MULTIPLE POINTS USAGE: [{"name":"XCBCHIPPARA", "value":"10"},{"name":"PCBCHIPPARA", "value":"10"},{"name":"CCBCHIPPARA", "value":"10"}]

ISBANK SALE BY POINTS SAMPLE

• POINTS must be JSOn String, you can use POINTS argument in SALE method like below
• POINTS : [{"name":"MAXIPUAN","value":"1"}]
• You can not use MAXIPUAN and MAXIMIL together.
• MULTIPLE POINTS USAGE: [{"name": "MAXIPUAN", "value": "1"},{"name": "PAZARAMAPUAN", "value": "1"}]

TEB BANK SALE BY POINTS SAMPLE

• You can use points if and only if KULLANBONUS equal to AMOUNT
• POINTS must be JSon String, you can use POINTS argument in SALE method like below
POINTS : [{"name":"KULLANBONUS","value":"10"}]

HALKBANK SALE BY POINTS SAMPLE

• POINTS must be json String, you can use POINTS argument in SALE method like below
• POINTS : [{"name":"ODUL", "value":"10"}]

GARANTI BANK SALE BY POINTS SAMPLE

• POINTS must be json String, you can use POINTS argument in SALE method like below
• POINTS : [{"name":"FBB","value":"10.00"},{"name":"BNS","value":"10.00"},{"name":"MR","value":"10.00"},{"name":"MIL","value":"10.00"}]

YAPI KREDI BANK SALE BY POINTS SAMPLE

• POINTS must be json String, you can use POINTS argument in SALE method like below
• POINTS : [{"name":"PUAN","value":"10.00"}]

HSBC BANK SALE BY POINTS SAMPLE

• POINTS must be json String, you can use POINTS argument in SALE method like below
• POINTS : [{"name":"ODUL","value":"10.00"}]

VAKIFBANK SALE BY POINTS SAMPLE

• POINTS must be JSOn String, you can use POINTS argument in SALE method like below
• POINTS : [{"name":"PUAN","value":"10.00"}]

DENIZBANK SALE BY POINTS SAMPLE

• POINTS must be JSON String, you can use POINTS argument in SALE method like below
• POINTS : [{"name":"BONUSAMOUNT","value":"10.00"}]

QNB FINANSBANK SALE BY POINTS SAMPLE

• You can use points if and only if AVAILABLEPOINT equal to AMOUNT
• POINTS must be JSON String, you can use POINTS argument in SALE method like below
• POINTS : [{"name":"AVAILABLEPOINT","value":"10"}]

ZIRAATBANK SALE BY POINTS SAMPLE

• POINTS must be JSON String, you can use POINTS argument in SALE method like below
• POINTS : [{"name":"KULLANPUAN","value":"10.00"}]

• Note:

  Partial points are not supported by bank

CAMPAIGNS:

string, optional Max length: 1024 description

CAMPAIGNCODE:

string, optional Max length: 512 A provided code which identifies the campaign defined by merchant.

BILLTOADDRESSLINE:

string, optional Max length: 1024 Bill To Address Line

BILLTOPHONE:

string, optional Max length: 32 description

BILLTOCITY:

string, optional Max length: 32 Bill To City

BILLTOPOSTALCODE:

string, optional Max length: 16 Bill To Postal Code

BILLTOCOUNTRY:

string, optional Max length: 32 Bill To Country

SHIPTOADDRESSLINE:

string, optional Max length: 255 Ship To Address Line

SHIPTOPHONE:

string, optional Max length: 32 description

SHIPTOCITY:

string, optional Max length: 32 Ship To City

SHIPTOPOSTALCODE:

string, optional Max length: 32 Ship To Postal Code

SHIPTOCOUNTRY:

string, optional Max length: 64 Ship To Country

THREATMETRIXSESSIONID:

string, optional Max length: 128 description

TMXSESSIONQUERYINPUT:

string, optional Max length: 4000 description

EXTRA:

string, optional Max length: 4000

Extra Parameter is a custom parameter that is used to pass certain parameters for different banks or other usage. This parameter gets its argument as a JSON(URL encoded) format which is then parsed. EXTRA: {"Name" : Value}

Parameters

Below are given parameters that can be sent on extra and examples for each of them. (parameter name is case-insensitive)

• SaveCard - parameter to differentiate if card should be saved or not. Possible values: YES/NO.
  {"SaveCard": "NO"}
• PopUpOpenWhenChecked - shows Card Saving Terms and Conditions when they are accepted (checked). Possible values: YES/NO.
  {"PopUpOpenWhenChecked": "NO"}
• SAVECARDREMINDERPOPUP - shows a popup that gives the user the option to save the card after a successful Hosted Payment Page payment. Possible values: YES/NO.
  {"SAVECARDREMINDERPOPUP": "YES"}
• BNPLREMINDERPOPUP - shows a popup that gives the user the option to go back to the payment page and continue with loan payment after a failed card transaction on the Hosted Payment Page. Possible values: YES/NO.
  {"BNPLREMINDERPOPUP": "YES"}
• ForceSave - parameter to differentiate if card should be forced to be saved or not. ForceSave and SaveCard can not be sent together. ForceSave has priority over SaveCard. Possible values: YES/NO.
  {"ForceSave": "NO"}
• ListCard - parameter to differentiate if Registered Card panel should be displayed on Wallet Page or not. Registered Cards by default are enabled on Wallet Page. Possible values: YES/NO.
  {"ListCard": "NO"}
• CVV - parameter to differentiate if CVV should be given on HPP or not. CVV input by default is enabled on HPP. Possible values: YES/NO.
  {"CVV": "NO"}
• MailOrder - parameter to specify which merchants' transactions will be sent with moto label autotmatically. Possible values: YES/NO.
  {"MailOrder": "NO"}
• PREAUTH - parameter used to process 3D transactions as a PreAuth transaction instead of Sale. Possible values: YES/NO.
  {"PREAUTH":"YES"}
• SubMerchantCode - additional parameter sent to bank during financial transactions.
  {"SubMerchantCode": "70885124022"}
• IsbankBolumKodu - additional parameter for transactions sent to Isbank, default value is 1.
  {"IsbankBolumKodu": 1}
• IsbankGroupId - additional parameter for transactions sent to Isbank
  {"ISBANK.GROUPID": "string"}
• IMMEDIATEREDIRECTION - redirect immediately to customer URL on successful action, default value is NO.
  {"IMMEDIATEREDIRECTION": "YES"}
• RETURNSCRIPT - if this parameter is sent, the js function sent will be called after a successful card save on wallet page.
  {"RETURNSCRIPT": JS Function provided by merchant!}
• HalkbankKobiKartDestek - if this parameter is sent, Halkbank Kobi Kart tab will be shown on Default HPP. Possible values: YES/NO.
  {"HalkbankKobiKartDestek":"YES"}
• ReturnTime - return time to merchant return url after payment has been processed.
  {"ReturnTime": 2}
• DealerCode - parameter that indicates dealers, when transactions are made. Unique for every dealer.
  {"DealerCode": "Dealer01"}
• QIWI - if this parameter is sent as "YES", authentication is done using GiroGate QIWI payment method. Possible values: YES/NO.
  {"QIWI": "YES"}
• GIROPAY - if this parameter is sent as "YES", authentication is done using GiroGate GIROPAY payment method. Possible values: YES/NO.
  {"GIROPAY": "YES"}
• IDEAL - if this parameter is sent as "YES", authentication is done using GiroGate IDEAL payment method. Possible values: YES/NO.
  {"IDEAL": "YES"}
• SOFORT - if this parameter is sent as "YES", authentication is done using GiroGate SOFORT payment method. Possible values: YES/NO.
  {"SOFORT": "YES"}
• EPS - if this parameter is sent as "YES", authentication is done using GiroGate EPS payment method. Possible values: YES/NO.
  {"EPS": "YES"}
• MULTIBANCO - if this parameter is sent as "YES", authentication is done using GiroGate MULTIBANCO payment method. Possible values: YES/NO.
  {"MULTIBANCO": "YES"}
• MYBANK - if this parameter is sent as "YES", authentication is done using GiroGate MYBANK payment method. Possible values: YES/NO.
  {"MYBANK": "YES"}
• BANCONTACT - if this parameter is sent as "YES", authentication is done using GiroGate BANCONTACT payment method. Possible values: YES/NO.
  {"BANCONTACT": "YES"}
• TRUSTPAY - if this parameter is sent as "YES", authentication is done using GiroGate TRUSTPAY payment method. Possible values: YES/NO.
  {"TRUSTPAY": "YES"}
• SAFETYPAY - if this parameter is sent as "YES", authentication is done using GiroGate SAFETYPAY payment method. Possible values: YES/NO.
  {"SAFETYPAY": "YES"}
• P24 - if this parameter is sent as "YES", authentication is done using GiroGate P24 payment method. Possible values: YES/NO.
  {"P24": "YES"}
• FINNISHONLINEBANKING - if this parameter is sent as "YES", authentication is done using GiroGate FINNISHONLINEBANKING payment method. Possible values: YES/NO.
  {"FINNISHONLINEBANKING": "YES"}
• BOLETO - if this parameter is sent as "YES", authentication is done using GiroGate BOLETO payment method. Possible values: YES/NO.
  {"BOLETO": "YES"}
• ELO - if this parameter is sent as "YES", authentication is done using GiroGate ELO payment method. Possible values: YES/NO.
  {"ELO": "YES"}
• SEPA - if this parameter is sent as "YES", authentication is done using GiroGate SEPA payment method. Possible values: YES/NO.
  {"SEPA": "YES"}
• ALIPAY - if this parameter is sent as "YES", authentication is done using GiroGate ALIPAY payment method. Possible values: YES/NO.
  {"ALIPAY": "YES"}
• COMMERCECODES - if this parameter should be sent as JSON Array of only strings, maximum installments available to card holder will be set in the payments. Possible values: 1-99
  {"COMMERCECODES":["10","20","30"]}
• ReflectCommission - if this parameter is sent as "YES" and DealerCode extra parameter is provided, commission is reflected to amount. It works only for dealers.
  {"ReflectCommission":"YES", "DealerCode":"Dealer01"}
• IgnoreRates - if this parameter is sent as "YES" and DealerCode extra parameter is provided, commission is not reflected to amount. It works only for dealers.
  {"IgnoreRates":"YES", "DealerCode":"Dealer01"}
• User - parameter that indicates the user, who has done payment on behalf of customer.
  {"USER":"user@email.com"}
• SIPAY - if this parameter is sent, Sipay tab will be shown on Default HPP. Possible values: YES/NO.
  {"SIPAY":"YES"}
• WECHATPAY - if this parameter is sent as "YES", authentication is done using GiroGate WECHATPAY payment method. Possible values: YES/NO.
  {"WECHATPAY": "YES"}
• IframeDomainUrl - indicates from which URL address payment will be proceesed.
  {"IframeDomainUrl": "www.w3school.com"}
• APPLYADDITIONALMATURITY - if this parameter is sent as "YES", payment type maturity commissions will be applied to the installments. Possible values: YES/NO.
  {"APPLYADDITIONALMATURITY": "YES"}
• DealerUserEmail - It represents the email of dealer user.
• AxessMobil.Enabled - Activate Axess Mobil Tab. Possible values: YES/NO.
  {"AxessMobil.Enabled": "NO"}
• AxessMobil.PaymentSystem - Activate Axess Mobil Tab. Possible values: StringValue.
  {"AxessMobil.PaymentSystem": "PaymentSystem"}
• COMPAY.LOAN - Activate Compay Loan Tab. Possible values: YES/NO.
  {"COMPAY.LOAN": "YES"}
• COMPAY.TRANSFER - Activate Compay Transfer Tab. Possible values: YES/NO.
  {"COMPAY.TRANSFER": "YES"}
• PAPARA.PAYMENT - Activate Papara Payment Tab. Possible values: YES/NO.
  {"PAPARA.PAYMENT": "YES"}
• INVOICETYPES - used in EXTRA of QUERYINVOICE to query multiple Invoice Types. It is sent as JSON Array. Possible values: SALE, PREAUTH and DISCOUNT.
  {"INVOICETYPES": ["SALE", "DISCOUNT"]}
• SubCustomer - parameter to differentiate the cards of same the customer.
  {"SubCustomer": "SubCustomer1"}
• InvoiceId - parameter to send id of invoice to pay it from other payment pages.
  {"InvoiceId": "id"}
• DealerCode - parameter to send code of dealer of associated invoice to be paid.
  {"DealerCode": "code"}

Split payment parameters

• SpCode - unique code for split payment.
  {"SpCode":"Code-1234567890"}
• SpMaxSplitCount - maximum splits that can be done during payment.
  {"SpMaxSplitCount":3}
• SpTotalAmount - total amount for a split payment.
  {"SpTotalAmount":50}
• SpBusinessMaxInst
  {"SpBusinessMaxInst":4}
• SpPersonalMaxInst
  {"SpPersonalMaxInst":3}
• SpGroupNumber - field for grouping split payments.
  {"SpGroupNumber":"Code-1234"}

Other bank parameters

• BKMEXPRESS - include BKMExpressV2 payment system name like below to have BKM Express tab on Default HPP
  {"BkmExpressV2PaymentSystem":"PaymentSystemName"}
• GARANTIPAY - include GarantiPay payment system name like below to have GarantiPay tab on Default HPP
  {"GarantiPayPaymentSystem":"PaymentSystemName"}
• GARANTI - include "GarantiSubMerchantCode" parameter to override default "SubMerchantCode" parameter
  {"GarantiSubMerchantCode":"123456789"}
• YKB - include "YkbSubMerchantCode" parameter to override default "SubMerchantCode" parameter
  {"YkbSubMerchantCode":"123456789"}
  For payment faciliatior options use:
  {
  "YKB.subMrcId": "152135125",
  "YKB.mrcPfId": "1531235126",
  "YKB.mcc": "1325"
  }
  
• Vakifbank - For insurance companies payments made with submerchant include one of the parameters below:
  {"VakifbankSubMerchantCode":"SubMerchantCode"} or
  {"VakifbankIdentity":"123456789"}
• VAKIFBANK TOS REFUND SERVICE
  {"VakifbankRefundService.RECIPIENTBRANCHCODE":"testBranchCode",
  "VakifbankRefundService.RECIPIENTBANKCODE":"testBankCode",
  "VakifbankRefundService.PAYMENTDATE":"dd-MM-yyyy HH:mm",
  "VakifbankRefundService.DESCRIPTION":"description" }

Payment Facilitator (PF) fields shown below can be sent in EXTRA field in the following way.

• ISBANK
  {"ISBANK.SUBMERCHANTID": 65504389},{"ISBANK.SUBMERCHANTPOSTALCODE": 34234},{"ISBANK.SUBMERCHANTCITY": İstanbul},ISBANK.SUBMERCHANTCOUNTRY": Türkiye},{"ISBANK.SUBMERCHANTMCC": 4829},{"ISBANK.SUBMERCHANTNIN": 123456789},,{"ISBANK.SUBMERCHANTURL": www.merchanturl.com}, {"ISBANK.ORDERTYPE": "01"}, {"ISBANK.ORDERSUBTYPE": "01"}
• DENIZBANK
  {"SubMerchantCode": 123456789012345}
• ZIRAATBANK
  {"SubMerchantCode": VKN/TCKN}
• AKBANK
  {"AKBANK.SUBMERCHANTID": 65504389},{"AKBANK.SUBMERCHANTPOSTALCODE": 34234},{"AKBANK.SUBMERCHANTCITY": İstanbul},{"AKBANK.SUBMERCHANTCOUNTRY": Türkiye},{"AKBANK.SUBMERCHANTMCC": 4829},{"AKBANK.SUBMERCHANTNIN": 123456789},{"AKBANK.SUBMERCHANTURL": www.merchanturl.com},{"AKBANK.VISASUBMERCHANTID": 000000},{"AKBANK.VISAPFID": 1111111},{"AKBANK.PAYMENTMETHOD": AKBANKCUZDAN},{"AKBANK.MOBILEECI": 300},{"AKBANK.WALLETPROGRAMDATA": 300},{"AKBANK.MOBILEASSIGNED": 300000},{"AKBANK.MOBILEDEVICETYPE": 10}
• HALKKOBIKART {"HALKKOBIKART.SUBMERCHANTNAME":"string", "HALKKOBIKART.SUBMERCHANTID":"string", "HALKKOBIKART.SUBMERCHANTPOSTALCODE":"string", "HALKKOBIKART.SUBMERCHANTCITY":"string", "HALKKOBIKART.SUBMERCHANTCOUNTRY":"string", "HALKKOBIKART.SUBMERCHANTMCC":"string", "HALKKOBIKART.HALKKOBIKARTDESTEK":"Yes/No", "HALKKOBIKART.OZELTAKSITLIISLEM":"S/E", "HALKKOBIKART.ODEMESIKLIGI":"1 if OZELTAKSITLIISLEM=E", "HALKKOBIKART.MIKTAR_[1-12]":"decimal", "HALKKOBIKART.TARIH_[1-12]":"YYYYMMDD "}
• HALKBANK
  {"HALKBANK.SUBMERCHANTPOSTALCODE": "153123512", "HALKBANK.SUBMERCHANTNAME": "SubMerchantName", "HALKBANK.SUBMERCHANTMCC": "1535", "HALKBANK.SUBMERCHANTID": "5353535", "HALKBANK.SUBMERCHANTCOUNTRY": "Country", "HALKBANK.SUBMERCHANTCITY": "City"}
  
• TURKIYEFINANS
  {"TURKIYEFINANS.SUBMERCHANTNAME": ASSECOTFKB},{"TURKIYEFINANS.SUBMERCHANTID": 9586886},{"TURKIYEFINANS.SUBMERCHANTCITY": ISTANBUL},{TURKIYEFINANS.SUBMERCHANTCOUNTRY": TR},{"TURKIYEFINANS.SUBMERCHANTMCC": 4814},{"TURKIYEFINANS.SUBMERCHANTFACILITATORID": 00516941},{"TURKIYEFINANS.SUBMERCHANTPOSTALCODE": 34467}
• VAKIFBANK
  {"HostSubmerchantID": ASSECOTFKB}
• QNBFinansSubMerchantCode - Sub merchant code for only new QNB Finansbank
  {"QNBFinansSubMerchantCode": "345"}
• QNBFINANSBANK
  {"QNBFINANS.PAYMENTFACILITATORID": "13151251235", "QNBFINANS.SUBMERCHANTCODE": "56126262345", "QNBFINANS.INDSALESORGID": "9982522523", "QNBFINANS.SUBMERCHANTMCC": "4343", "QNBFINANS.CARDACCEPTORNAME": "AcceptorName", "QNBFINANS.CARDACCEPTORCITY": "AcceptorCity", "QNBFINANS.CARDACCEPTORPOSTALCODE": "AcceptorPostalCode", "QNBFINANS.CARDACCEPTORSTREET": "AcceptorStreet", "QNBFINANS.CARDACCEPTORCOUNTRY": "AcceptorCountry", "QNBFINANS.CARDACCEPTORSTATE": "AcceptorState"}
  
• INGBANK
  {"INGBANK.SUBMERCHANTMCC": "143", "INGBANK.SUBMERCHANTPOSTALCODE": "00000", "INGBANK.SUBMERCHANTNAME": "Name", "INGBANK.SUBMERCHANTCITY": "City", "INGBANK.SUBMERCHANTCOUNTRY": "Country", "INGBANK.SUBMERCHANTFACILITATORID": "1512531515", "INGBANK.SUBMERCHANTORGANIZATIONID": "52523525253", "INGBANK.SUBMERCHANTID": "7121363216"}
  
• SEKERBANK
  {"SEKERBANK.SUBMERCHANTID": "340410030", "SEKERBANK.SUBMERCHANTNAME": "CYBERSOFTPF", "SEKERBANK.SUBMERCHANTCITY": "ISTANBUL", "SEKERBANK.SUBMERCHANTCOUNTRY": "792", "SEKERBANK.SUBMERCHANTPOSTALCODE": "81410", "SEKERBANK.SUBMERCHANTMCC": "2233"}
  
• ODEABANK
  { "ODEABANK.PAYMENTFACILITATORID":"string", "ODEABANK.SUBMERCHANTID":"string", "ODEABANK.INDSALESORGID":"string", "ODEABANK.SUBMERCHANTMCC":"string", "ODEABANK.CARDACCEPTORNAME":"string", "ODEABANK.CARDACCEPTORSTREET":"string", "ODEABANK.CARDACCEPTORCITY":string "ODEABANK.CARDACCEPTORPOSTALCODE":string, "ODEABANK.CARDACCEPTORSTATE":"string" "ODEABANK.CARDACCEPTORCOUNTRY:string}
• ANADOLU
  { "ANADOLU.SUBMERCHANTNAME":"string", "ANADOLU.SUBMERCHANTID":"string", "ANADOLU.SUBMERCHANTPOSTALCODE":"string", "ANADOLU.SUBMERCHANTCITY":"string", "ANADOLU.SUBMERCHANTCOUNTRY":"string", "ANADOLU.SUBMERCHANTMCC":"string" }
• TEB
  {
  "TEB.SUBMERCHANTNAME": "SubMerchantName" }
  
• VPOSTIMEOUT - Specify VPOS timeout in seconds - Works for Nestpay, Garanti, Denizbank, Vakifbank, HSBC. Example: {"VPOSTIMEOUT":30}
• ALBARAKA
  { "ALBARAKA.SUBDEALERCODE":"string", "ALBARAKA.TCKN":"string", "ALBARAKA.TAXID":"string" "AlbarakaMailOrder":"YES or NO" (default:NO) }
• KUVEYTTURK
  { "KUVEYTURK.DESCRIPTION":"string", "KUVEYTURK.IDENTITYTAXNUMBER":"string", "KUVEYTURK.DEFERRINGCOUNT":"string", "KUVEYTURK.SUBMERCHANTID":"string", "KUVEYTURK.SUBMERCHANTIDENTITYTAXNUMBER":"string", "KUVEYTURK.VPOSSUBMERCHANTID":"string",
  "KUVEYTURK.BKMID":"string" }
• ZIRAATBANKKURUMSALKART
  Equal installments
  {
  "ZIRAATBANKKURUMSALKART.KURUMSALKARTISLEMTIPI": "ESITTAKSITLISATIS",
  "ZIRAATBANKKURUMSALKART.TAKSITVEYAVADESAYISI": "5",
  "ZIRAATBANKKURUMSALKART.ODEMEPERIYODU": "2"
  }
  
  Flexible installments - up to 12 installments (MIKTAR_*, TARIH_*)
  {
  "ZIRAATBANKKURUMSALKART.KURUMSALKARTISLEMTIPI": "ESNEKTAKSITLISATIS",
  "ZIRAATBANKKURUMSALKART.TAKSITVEYAVADESAYISI": "3",
  "ZIRAATBANKKURUMSALKART.MIKTAR_1": "100",
  "ZIRAATBANKKURUMSALKART.TARIH_1": "20210916",
  "ZIRAATBANKKURUMSALKART.MIKTAR_2": "50",
  "ZIRAATBANKKURUMSALKART.TARIH_2": "20210916",
  "ZIRAATBANKKURUMSALKART.MIKTAR_3": "50",
  "ZIRAATBANKKURUMSALKART.TARIH_3": "20210916",
  }
  
• MULTINET
  { "MULTINET.MERCHANTPRODUCTID": "142" }
  
• PARATIKA
  { "ParatikaMerchantId": "10000000",
  "MerchantKey":"testKey",
  "ParatikaSellerItems":
  [{"productCode": "Sellers1","amount": 55,"name": "keyboard", "description": "OYUN BİLGİSAYARI","quantity": 1, "productCategoryCode": "4722", "sellerId": "TRFONGG2020001", "sellerPaymentAmount":55}] }

Notification Integration Model

• Example: {"NOTIFICATION_INTEGRATION_MODEL" : "API"} or {"NOTIFICATION_INTEGRATION_MODEL" : "DIRECTPOST_THREED"} or {"NOTIFICATION_INTEGRATION_MODEL" : "DIRECTPOST_NON_THREED"} or

DEALERCODE:

string, optional Max length: 32 B2B Yönetim Paneli > Bayi > Bayi Tipleri bölümündeki Bayi Kodu alanı “Dealer Code” olarak geçmektedir.

DEALERTYPENAME:

string, optional Max length: 256 B2B Yönetim Paneli > Bayi > Bayi Tipleri bölümünde oluşturduğunuz Bayi Tipi'nin adıdır.

FORGROUP:

string, optional Max length: 3 Default value: 'YES' FORGROUP parametresi, aynı Kart Paylaşım Grubundaki diğer satıcıların kaydettikleri kartları kullanarak işlem sorgulamasını ve / veya işlemesini sağlar.

CUSTOMFIELDS:

string, optional Max length: 4000 Bu parametre JSONArray içerisinde UTF-8 URL-Encoded formatta gönderilmeli. Bu parametre gönderildiğinde "integrationCode" ve "value" gereklidir.
Örneğin:[{"code":"code","name":"Field Name","value":"Field Value","group":"Group","integrationCode":"IntegrationCode"},{},{}]

CARDCUTOFFDAY:

integer, optional Max length: 2 description

DEALERUSEREMAIL:

string, optional Max length: 128 description

INITIATORMERCHANTBUSINESSID:

string, optional Max length: 16 description

CARDPANTYPE:

string, optional Max length: 32 description See all possible values (1)

PBORDER:

string, optional Max length: 256 description

PAYMENTSYSTEMPOOL:

string, optional Max length: 1024 PAYMENTSYSTEMPOOL parameter is a special parameter that is used to include specific Payment Systems and to receive payments only through these payment systems.Bu parametre JSON(URL encoded) formatında olmalıdır.PAYMENTSYSTEMPOOL :[{"PaymentSystemName": "PsName1","isDefault": false, "redirectBanks": {"CardBrand": "ALL","BankCode":"0111"}},{"PaymentSystemName": "PsName2","isDefault": true},{"PaymentSystemName": "PsName3","isDefault": false}]

Preauth

A PreAuth transaction is a credit card transaction that reserves funds on a customer's credit card. PreAuth transaction does not charge the card until you perform a PostAuth transaction. Please note that Pre-Authorizations reserve funds for varying periods, depending on the issuing credit card company's policy. The period may be as little as three days or as long as several months. For your protection it is recommended that you confirm delivery of the product/service as soon as possible after pre-authorization.

Request parameters

ACTION:

PREAUTH, required Max length: 128 Description to be provided

MERCHANTUSER:

string, conditional Max length: 128 Merchant API User Email

MERCHANTPASSWORD:

string, conditional Max length: 128 Merchant API User Password

MERCHANT:

string, conditional Max length: 128 Merchant ID, merchant business code defined in Payten Payment Gateway.

MERCHANTPAYMENTID:

string, conditional Max length: 128 Payment ID given by Merchant (it must be unique).The character length of MerchantPaymentID varies according to the virtual POS bank. Our recommended maximum length value is 40 characters. Apart from this, the character lengths of the banks should be taken into account. If you are sending a transaction to the PARATIKA application via Payten Payment Gateway, you should send the MerchantPaymentID with a maximum value that is 9 characters shorter. This is because PARATIKA application adds +9 characters to the value sent from the Payten Payment Gateway.
Raiffeisenbank Virtual POS Note: If you are using Raiffeisenbank's Virtual POS or sending transactions to Raiffeisenbank, the MERCHANTPAYMENTID must be limited to a maximum of 20 characters, as this is the maximum supported by the bank.

CUSTOMER:

string, conditional Max length: 128 The Merchant System ID for customer. It must be unique within a Merchant.

CARDHOLDERPORT:

string, optional Max length: 39 description

AMOUNT:

decimal, conditional Max length: 30 Amount of payment / transaction. Please note that, this amount is tax included, MSU doesn't consider any other tax calculation.

CURRENCY:

string, conditional Max length: 3 ISO Alpha transaction currency code like EUR, USD, GBP. See all possible values (37)

SESSIONTOKEN:

string, conditional Max length: 48 It is a unique value that contains the values for the transaction.

AUTH3DTOKEN:

string, optional Max length: 16 Unique value generated after successful 3D Authentication.

ENCRYPTEDDATA:

string, optional Max length: 2048 Contains customer sensitive information encrypted.
Before encryption: p=5456165456165454&y=2020&m=12&c=000&cn=John Doe&n=n9Kf9wUzQ21Xa63B, where p - pan, y - expiry year, m - expiry month, cn - Card Holder Name/Card Owner, n - nonce(random string max 16 chars).

CARDTOKEN:

string, conditional Max length: 64 Numeric value replacing card number & expiry date. Required when none of the other card information are provided. If the user wants to make a transaction with the card he/she has previously registered, this unique token is used instead of the card number and expiry date.

CARDPAN:

string, conditional Max length: 25 PAN number of the card.

CARDEXPIRY:

string, conditional Max length: 7 Expiry date of the card. Format should be [mm.yy].

NAMEONCARD:

string, conditional Max length: 64 Name on the card.

CUSTOMEREMAIL:

string, optional Max length: 64 Customer e-mail.

CUSTOMERNAME:

string, optional Max length: 128 Name of the Customer.

CUSTOMERPHONE:

string, optional Max length: 64 Customer phone / mobile number.

CUSTOMERIP:

string, optional Max length: 39 CUSTOMERIP parameter is mandatory if the payment system is Paratika and for the PAYCELL DCB transactions.

CUSTOMERUSERAGENT:

string, optional Max length: 4000 description

INSTALLMENTS:

integer, optional Max length: 2 Default value: '1' Number of installments. Specified number should exist in Payten Payment Gateway as “defined installment”

PAYMENTSYSTEM:

string, optional Max length: 128 Name of the payment system (bank payment gateway / vPOS account). Specified name should match the one given in Payten Payment Gateway If not provided, Payten Payment Gateway smart switch feature will be used.

PAYMENTSYSTEMPOOL:

string, optional Max length: 1024 The PAYMENTSYSTEMPOOL parameter is a special parameter that is used to include specific Payment Systems and to receive payments only through these payment systems.This parameter must be JSON(URL encoded) format . PAYMENTSYSTEMPOOL :[{"PaymentSystemName": "PsName1","isDefault": false, "redirectBanks": {"CardBrand": "ALL","BankCode":"0111"}},{"PaymentSystemName": "PsName2","isDefault": true},{"PaymentSystemName": "PsName3","isDefault": false}]

CARDCVV:

string, optional Max length: 4 Security number of the card.

SAVECARD:

string, optional Max length: 3 Value can be "YES" or "NO"

ISREFUNDABLE:

string, optional Max length: 3 Default value: 'yes' description

REFLECTCOMMISSION:

string, optional Max length: 3 Reflect commission to amount. It works only with dealers. See all possible values (2)

CARDSAVENAME:

string, optional Max length: 255 Given name for the saved card.

BILLTOADDRESSLINE:

string, optional Max length: 1024 Bill To Address Line

BILLTOCITY:

string, optional Max length: 32 Bill To City

BILLTOPOSTALCODE:

string, optional Max length: 16 Bill To Postal Code

BILLTOCOUNTRY:

string, optional Max length: 32 Bill To Country

SHIPTOADDRESSLINE:

string, optional Max length: 255 Ship To Address Line

SHIPTOCITY:

string, optional Max length: 32 Ship To City

SHIPTOPOSTALCODE:

string, optional Max length: 32 Ship To Postal Code

SHIPTOCOUNTRY:

string, optional Max length: 64 Ship To Country

THREATMETRIXSESSIONID:

string, optional Max length: 128 description

TMXSESSIONQUERYINPUT:

string, optional Max length: 4000 description

EXTRA:

string, optional Max length: 4000

Extra Parameter is a custom parameter that is used to pass certain parameters for different banks or other usage. This parameter gets its argument as a JSON(URL encoded) format which is then parsed. EXTRA: {"Name" : Value}

Parameters

Below are given parameters that can be sent on extra and examples for each of them. (parameter name is case-insensitive)

• SaveCard - parameter to differentiate if card should be saved or not. Possible values: YES/NO.
  {"SaveCard": "NO"}
• PopUpOpenWhenChecked - shows Card Saving Terms and Conditions when they are accepted (checked). Possible values: YES/NO.
  {"PopUpOpenWhenChecked": "NO"}
• SAVECARDREMINDERPOPUP - shows a popup that gives the user the option to save the card after a successful Hosted Payment Page payment. Possible values: YES/NO.
  {"SAVECARDREMINDERPOPUP": "YES"}
• BNPLREMINDERPOPUP - shows a popup that gives the user the option to go back to the payment page and continue with loan payment after a failed card transaction on the Hosted Payment Page. Possible values: YES/NO.
  {"BNPLREMINDERPOPUP": "YES"}
• ForceSave - parameter to differentiate if card should be forced to be saved or not. ForceSave and SaveCard can not be sent together. ForceSave has priority over SaveCard. Possible values: YES/NO.
  {"ForceSave": "NO"}
• ListCard - parameter to differentiate if Registered Card panel should be displayed on Wallet Page or not. Registered Cards by default are enabled on Wallet Page. Possible values: YES/NO.
  {"ListCard": "NO"}
• CVV - parameter to differentiate if CVV should be given on HPP or not. CVV input by default is enabled on HPP. Possible values: YES/NO.
  {"CVV": "NO"}
• MailOrder - parameter to specify which merchants' transactions will be sent with moto label autotmatically. Possible values: YES/NO.
  {"MailOrder": "NO"}
• PREAUTH - parameter used to process 3D transactions as a PreAuth transaction instead of Sale. Possible values: YES/NO.
  {"PREAUTH":"YES"}
• SubMerchantCode - additional parameter sent to bank during financial transactions.
  {"SubMerchantCode": "70885124022"}
• IsbankBolumKodu - additional parameter for transactions sent to Isbank, default value is 1.
  {"IsbankBolumKodu": 1}
• IsbankGroupId - additional parameter for transactions sent to Isbank
  {"ISBANK.GROUPID": "string"}
• IMMEDIATEREDIRECTION - redirect immediately to customer URL on successful action, default value is NO.
  {"IMMEDIATEREDIRECTION": "YES"}
• RETURNSCRIPT - if this parameter is sent, the js function sent will be called after a successful card save on wallet page.
  {"RETURNSCRIPT": JS Function provided by merchant!}
• HalkbankKobiKartDestek - if this parameter is sent, Halkbank Kobi Kart tab will be shown on Default HPP. Possible values: YES/NO.
  {"HalkbankKobiKartDestek":"YES"}
• ReturnTime - return time to merchant return url after payment has been processed.
  {"ReturnTime": 2}
• DealerCode - parameter that indicates dealers, when transactions are made. Unique for every dealer.
  {"DealerCode": "Dealer01"}
• QIWI - if this parameter is sent as "YES", authentication is done using GiroGate QIWI payment method. Possible values: YES/NO.
  {"QIWI": "YES"}
• GIROPAY - if this parameter is sent as "YES", authentication is done using GiroGate GIROPAY payment method. Possible values: YES/NO.
  {"GIROPAY": "YES"}
• IDEAL - if this parameter is sent as "YES", authentication is done using GiroGate IDEAL payment method. Possible values: YES/NO.
  {"IDEAL": "YES"}
• SOFORT - if this parameter is sent as "YES", authentication is done using GiroGate SOFORT payment method. Possible values: YES/NO.
  {"SOFORT": "YES"}
• EPS - if this parameter is sent as "YES", authentication is done using GiroGate EPS payment method. Possible values: YES/NO.
  {"EPS": "YES"}
• MULTIBANCO - if this parameter is sent as "YES", authentication is done using GiroGate MULTIBANCO payment method. Possible values: YES/NO.
  {"MULTIBANCO": "YES"}
• MYBANK - if this parameter is sent as "YES", authentication is done using GiroGate MYBANK payment method. Possible values: YES/NO.
  {"MYBANK": "YES"}
• BANCONTACT - if this parameter is sent as "YES", authentication is done using GiroGate BANCONTACT payment method. Possible values: YES/NO.
  {"BANCONTACT": "YES"}
• TRUSTPAY - if this parameter is sent as "YES", authentication is done using GiroGate TRUSTPAY payment method. Possible values: YES/NO.
  {"TRUSTPAY": "YES"}
• SAFETYPAY - if this parameter is sent as "YES", authentication is done using GiroGate SAFETYPAY payment method. Possible values: YES/NO.
  {"SAFETYPAY": "YES"}
• P24 - if this parameter is sent as "YES", authentication is done using GiroGate P24 payment method. Possible values: YES/NO.
  {"P24": "YES"}
• FINNISHONLINEBANKING - if this parameter is sent as "YES", authentication is done using GiroGate FINNISHONLINEBANKING payment method. Possible values: YES/NO.
  {"FINNISHONLINEBANKING": "YES"}
• BOLETO - if this parameter is sent as "YES", authentication is done using GiroGate BOLETO payment method. Possible values: YES/NO.
  {"BOLETO": "YES"}
• ELO - if this parameter is sent as "YES", authentication is done using GiroGate ELO payment method. Possible values: YES/NO.
  {"ELO": "YES"}
• SEPA - if this parameter is sent as "YES", authentication is done using GiroGate SEPA payment method. Possible values: YES/NO.
  {"SEPA": "YES"}
• ALIPAY - if this parameter is sent as "YES", authentication is done using GiroGate ALIPAY payment method. Possible values: YES/NO.
  {"ALIPAY": "YES"}
• COMMERCECODES - if this parameter should be sent as JSON Array of only strings, maximum installments available to card holder will be set in the payments. Possible values: 1-99
  {"COMMERCECODES":["10","20","30"]}
• ReflectCommission - if this parameter is sent as "YES" and DealerCode extra parameter is provided, commission is reflected to amount. It works only for dealers.
  {"ReflectCommission":"YES", "DealerCode":"Dealer01"}
• IgnoreRates - if this parameter is sent as "YES" and DealerCode extra parameter is provided, commission is not reflected to amount. It works only for dealers.
  {"IgnoreRates":"YES", "DealerCode":"Dealer01"}
• User - parameter that indicates the user, who has done payment on behalf of customer.
  {"USER":"user@email.com"}
• SIPAY - if this parameter is sent, Sipay tab will be shown on Default HPP. Possible values: YES/NO.
  {"SIPAY":"YES"}
• WECHATPAY - if this parameter is sent as "YES", authentication is done using GiroGate WECHATPAY payment method. Possible values: YES/NO.
  {"WECHATPAY": "YES"}
• IframeDomainUrl - indicates from which URL address payment will be proceesed.
  {"IframeDomainUrl": "www.w3school.com"}
• APPLYADDITIONALMATURITY - if this parameter is sent as "YES", payment type maturity commissions will be applied to the installments. Possible values: YES/NO.
  {"APPLYADDITIONALMATURITY": "YES"}
• DealerUserEmail - It represents the email of dealer user.
• AxessMobil.Enabled - Activate Axess Mobil Tab. Possible values: YES/NO.
  {"AxessMobil.Enabled": "NO"}
• AxessMobil.PaymentSystem - Activate Axess Mobil Tab. Possible values: StringValue.
  {"AxessMobil.PaymentSystem": "PaymentSystem"}
• COMPAY.LOAN - Activate Compay Loan Tab. Possible values: YES/NO.
  {"COMPAY.LOAN": "YES"}
• COMPAY.TRANSFER - Activate Compay Transfer Tab. Possible values: YES/NO.
  {"COMPAY.TRANSFER": "YES"}
• PAPARA.PAYMENT - Activate Papara Payment Tab. Possible values: YES/NO.
  {"PAPARA.PAYMENT": "YES"}
• INVOICETYPES - used in EXTRA of QUERYINVOICE to query multiple Invoice Types. It is sent as JSON Array. Possible values: SALE, PREAUTH and DISCOUNT.
  {"INVOICETYPES": ["SALE", "DISCOUNT"]}
• SubCustomer - parameter to differentiate the cards of same the customer.
  {"SubCustomer": "SubCustomer1"}
• InvoiceId - parameter to send id of invoice to pay it from other payment pages.
  {"InvoiceId": "id"}
• DealerCode - parameter to send code of dealer of associated invoice to be paid.
  {"DealerCode": "code"}
giu0009

Split payment parameters

• SpCode - unique code for split payment.
  {"SpCode":"Code-1234567890"}
• SpMaxSplitCount - maximum splits that can be done during payment.
  {"SpMaxSplitCount":3}
• SpTotalAmount - total amount for a split payment.
  {"SpTotalAmount":50}
• SpBusinessMaxInst
  {"SpBusinessMaxInst":4}
• SpPersonalMaxInst
  {"SpPersonalMaxInst":3}
• SpGroupNumber - field for grouping split payments.
  {"SpGroupNumber":"Code-1234"}

Other bank parameters

• BKMEXPRESS - include BKMExpressV2 payment system name like below to have BKM Express tab on Default HPP
  {"BkmExpressV2PaymentSystem":"PaymentSystemName"}
• GARANTIPAY - include GarantiPay payment system name like below to have GarantiPay tab on Default HPP
  {"GarantiPayPaymentSystem":"PaymentSystemName"}
• GARANTI - include "GarantiSubMerchantCode" parameter to override default "SubMerchantCode" parameter
  {"GarantiSubMerchantCode":"123456789"}
• YKB - include "YkbSubMerchantCode" parameter to override default "SubMerchantCode" parameter
  {"YkbSubMerchantCode":"123456789"}
  For payment faciliatior options use:
  {
  "YKB.subMrcId": "152135125",
  "YKB.mrcPfId": "1531235126",
  "YKB.mcc": "1325"
  }
  
• Vakifbank - For insurance companies payments made with submerchant include one of the parameters below:
  {"VakifbankSubMerchantCode":"SubMerchantCode"} or
  {"VakifbankIdentity":"123456789"}
• VAKIFBANK TOS REFUND SERVICE
  {"VakifbankRefundService.RECIPIENTBRANCHCODE":"testBranchCode",
  "VakifbankRefundService.RECIPIENTBANKCODE":"testBankCode",
  "VakifbankRefundService.PAYMENTDATE":"dd-MM-yyyy HH:mm",
  "VakifbankRefundService.DESCRIPTION":"description" }

Payment Facilitator (PF) fields shown below can be sent in EXTRA field in the following way.

• ISBANK
  {"ISBANK.SUBMERCHANTID": 65504389},{"ISBANK.SUBMERCHANTPOSTALCODE": 34234},{"ISBANK.SUBMERCHANTCITY": İstanbul},ISBANK.SUBMERCHANTCOUNTRY": Türkiye},{"ISBANK.SUBMERCHANTMCC": 4829},{"ISBANK.SUBMERCHANTNIN": 123456789},,{"ISBANK.SUBMERCHANTURL": www.merchanturl.com}, {"ISBANK.ORDERTYPE": "01"}, {"ISBANK.ORDERSUBTYPE": "01"}
• DENIZBANK
  {"SubMerchantCode": 123456789012345}
• ZIRAATBANK
  {"SubMerchantCode": VKN/TCKN}
• AKBANK
  {"AKBANK.SUBMERCHANTID": 65504389},{"AKBANK.SUBMERCHANTPOSTALCODE": 34234},{"AKBANK.SUBMERCHANTCITY": İstanbul},{"AKBANK.SUBMERCHANTCOUNTRY": Türkiye},{"AKBANK.SUBMERCHANTMCC": 4829},{"AKBANK.SUBMERCHANTNIN": 123456789},{"AKBANK.SUBMERCHANTURL": www.merchanturl.com},{"AKBANK.VISASUBMERCHANTID": 000000},{"AKBANK.VISAPFID": 1111111},{"AKBANK.PAYMENTMETHOD": AKBANKCUZDAN},{"AKBANK.MOBILEECI": 300},{"AKBANK.WALLETPROGRAMDATA": 300},{"AKBANK.MOBILEASSIGNED": 300000},{"AKBANK.MOBILEDEVICETYPE": 10}
• HALKKOBIKART {"HALKKOBIKART.SUBMERCHANTNAME":"string", "HALKKOBIKART.SUBMERCHANTID":"string", "HALKKOBIKART.SUBMERCHANTPOSTALCODE":"string", "HALKKOBIKART.SUBMERCHANTCITY":"string", "HALKKOBIKART.SUBMERCHANTCOUNTRY":"string", "HALKKOBIKART.SUBMERCHANTMCC":"string", "HALKKOBIKART.HALKKOBIKARTDESTEK":"Yes/No", "HALKKOBIKART.OZELTAKSITLIISLEM":"S/E", "HALKKOBIKART.ODEMESIKLIGI":"1 if OZELTAKSITLIISLEM=E", "HALKKOBIKART.MIKTAR_[1-12]":"decimal", "HALKKOBIKART.TARIH_[1-12]":"YYYYMMDD "}
• HALKBANK
  {"HALKBANK.SUBMERCHANTPOSTALCODE": "153123512", "HALKBANK.SUBMERCHANTNAME": "SubMerchantName", "HALKBANK.SUBMERCHANTMCC": "1535", "HALKBANK.SUBMERCHANTID": "5353535", "HALKBANK.SUBMERCHANTCOUNTRY": "Country", "HALKBANK.SUBMERCHANTCITY": "City"}
  
• TURKIYEFINANS
  {"TURKIYEFINANS.SUBMERCHANTNAME": ASSECOTFKB},{"TURKIYEFINANS.SUBMERCHANTID": 9586886},{"TURKIYEFINANS.SUBMERCHANTCITY": ISTANBUL},{TURKIYEFINANS.SUBMERCHANTCOUNTRY": TR},{"TURKIYEFINANS.SUBMERCHANTMCC": 4814},{"TURKIYEFINANS.SUBMERCHANTFACILITATORID": 00516941},{"TURKIYEFINANS.SUBMERCHANTPOSTALCODE": 34467}
• VAKIFBANK
  {"HostSubmerchantID": ASSECOTFKB}
• QNBFinansSubMerchantCode - Sub merchant code for only new QNB Finansbank
  {"QNBFinansSubMerchantCode": "345"}
• QNBFINANSBANK
  {"QNBFINANS.PAYMENTFACILITATORID": "13151251235", "QNBFINANS.SUBMERCHANTCODE": "56126262345", "QNBFINANS.INDSALESORGID": "9982522523", "QNBFINANS.SUBMERCHANTMCC": "4343", "QNBFINANS.CARDACCEPTORNAME": "AcceptorName", "QNBFINANS.CARDACCEPTORCITY": "AcceptorCity", "QNBFINANS.CARDACCEPTORPOSTALCODE": "AcceptorPostalCode", "QNBFINANS.CARDACCEPTORSTREET": "AcceptorStreet", "QNBFINANS.CARDACCEPTORCOUNTRY": "AcceptorCountry", "QNBFINANS.CARDACCEPTORSTATE": "AcceptorState"}
  
• INGBANK
  {"INGBANK.SUBMERCHANTMCC": "143", "INGBANK.SUBMERCHANTPOSTALCODE": "00000", "INGBANK.SUBMERCHANTNAME": "Name", "INGBANK.SUBMERCHANTCITY": "City", "INGBANK.SUBMERCHANTCOUNTRY": "Country", "INGBANK.SUBMERCHANTFACILITATORID": "1512531515", "INGBANK.SUBMERCHANTORGANIZATIONID": "52523525253", "INGBANK.SUBMERCHANTID": "7121363216"}
  
• SEKERBANK
  {"SEKERBANK.SUBMERCHANTID": "340410030", "SEKERBANK.SUBMERCHANTNAME": "CYBERSOFTPF", "SEKERBANK.SUBMERCHANTCITY": "ISTANBUL", "SEKERBANK.SUBMERCHANTCOUNTRY": "792", "SEKERBANK.SUBMERCHANTPOSTALCODE": "81410", "SEKERBANK.SUBMERCHANTMCC": "2233"}
  
• ODEABANK
  { "ODEABANK.PAYMENTFACILITATORID":"string", "ODEABANK.SUBMERCHANTID":"string", "ODEABANK.INDSALESORGID":"string", "ODEABANK.SUBMERCHANTMCC":"string", "ODEABANK.CARDACCEPTORNAME":"string", "ODEABANK.CARDACCEPTORSTREET":"string", "ODEABANK.CARDACCEPTORCITY":string "ODEABANK.CARDACCEPTORPOSTALCODE":string, "ODEABANK.CARDACCEPTORSTATE":"string" "ODEABANK.CARDACCEPTORCOUNTRY:string}
• ANADOLU
  { "ANADOLU.SUBMERCHANTNAME":"string", "ANADOLU.SUBMERCHANTID":"string", "ANADOLU.SUBMERCHANTPOSTALCODE":"string", "ANADOLU.SUBMERCHANTCITY":"string", "ANADOLU.SUBMERCHANTCOUNTRY":"string", "ANADOLU.SUBMERCHANTMCC":"string" }
• TEB
  {
  "TEB.SUBMERCHANTNAME": "SubMerchantName" }
  
• VPOSTIMEOUT - Specify VPOS timeout in seconds - Works for Nestpay, Garanti, Denizbank, Vakifbank, HSBC. Example: {"VPOSTIMEOUT":30}
• ALBARAKA
  { "ALBARAKA.SUBDEALERCODE":"string", "ALBARAKA.TCKN":"string", "ALBARAKA.TAXID":"string" "AlbarakaMailOrder":"YES or NO" (default:NO) }
• KUVEYTTURK
  { "KUVEYTURK.DESCRIPTION":"string", "KUVEYTURK.IDENTITYTAXNUMBER":"string", "KUVEYTURK.DEFERRINGCOUNT":"string", "KUVEYTURK.SUBMERCHANTID":"string", "KUVEYTURK.SUBMERCHANTIDENTITYTAXNUMBER":"string", "KUVEYTURK.VPOSSUBMERCHANTID":"string",
  "KUVEYTURK.BKMID":"string" }
• ZIRAATBANKKURUMSALKART
  Equal installments
  {
  "ZIRAATBANKKURUMSALKART.KURUMSALKARTISLEMTIPI": "ESITTAKSITLISATIS",
  "ZIRAATBANKKURUMSALKART.TAKSITVEYAVADESAYISI": "5",
  "ZIRAATBANKKURUMSALKART.ODEMEPERIYODU": "2"
  }
  
  Flexible installments - up to 12 installments (MIKTAR_*, TARIH_*)
  {
  "ZIRAATBANKKURUMSALKART.KURUMSALKARTISLEMTIPI": "ESNEKTAKSITLISATIS",
  "ZIRAATBANKKURUMSALKART.TAKSITVEYAVADESAYISI": "3",
  "ZIRAATBANKKURUMSALKART.MIKTAR_1": "100",
  "ZIRAATBANKKURUMSALKART.TARIH_1": "20210916",
  "ZIRAATBANKKURUMSALKART.MIKTAR_2": "50",
  "ZIRAATBANKKURUMSALKART.TARIH_2": "20210916",
  "ZIRAATBANKKURUMSALKART.MIKTAR_3": "50",
  "ZIRAATBANKKURUMSALKART.TARIH_3": "20210916",
  }
  
• MULTINET
  { "MULTINET.MERCHANTPRODUCTID": "142" }
  
• PARATIKA
  { "ParatikaMerchantId": "10000000",
  "MerchantKey":"testKey",
  "ParatikaSellerItems":
  [{"productCode": "Sellers1","amount": 55,"name": "keyboard", "description": "OYUN BİLGİSAYARI","quantity": 1, "productCategoryCode": "4722", "sellerId": "TRFONGG2020001", "sellerPaymentAmount":55}] }

Notification Integration Model

• Example: {"NOTIFICATION_INTEGRATION_MODEL" : "API"} or {"NOTIFICATION_INTEGRATION_MODEL" : "DIRECTPOST_THREED"} or {"NOTIFICATION_INTEGRATION_MODEL" : "DIRECTPOST_NON_THREED"} or

DEALERCODE:

string, optional Max length: 32 The Dealer Code area at the B2B Admin Panel > Dealer > Dealer Types section is "Dealer Code".

FORGROUP:

string, optional Max length: 3 Default value: 'YES' FORGROUP Parameter enables to do queries and/or transactions using cards saved by other merchants that are in the same Card Sharing Group.

SHIPTOPHONE:

string, optional Max length: 32 description

BILLTOPHONE:

string, optional Max length: 32 description

DEALERTYPENAME:

string, optional Max length: 256 The Dealer Type you created from the B2B Admin Panel > Dealer > Dealer Types section is "Name".

CAMPAIGNCODE:

string, optional Max length: 512 A provided code which identifies the campaign defined by merchant.

CUSTOMFIELDS:

string, optional Max length: 4000 This parameter should be sent in JSON Array with UTF-8 URL-Encoded format. "integrationCode" and "value" are required when sending this parameter.
Example:[{"code":"code","name":"Field Name","value":"Field Value","group":"Group","integrationCode":"IntegrationCode"},{},{}]

CARDCUTOFFDAY:

integer, optional Max length: 2 description

DEALERUSEREMAIL:

string, optional Max length: 128 description

CARDPANTYPE:

string, optional Max length: 32 description See all possible values (1)

Postauth

PostAuth is a credit card transaction that captures the funds on the Customer's card for a specified amount reserved earlier using PreAuth transaction. If you enter a larger total in the PostAuth transaction than what was specified for the PreAuth transaction, the PostAuth transaction may be declined. If you enter a smaller amount than was pre-authorized, an adjustment is made to the authorization to capture only the smaller amount of funds on the Customer's card for the transaction. PostAuth transactions must be completed within certain amount of time after the the pre-authorization is obtained. This time period varies between 3 days and 75 days depending on the card issuer’s policy.

Request parameters

ACTION:

POSTAUTH, required Max length: 128 Description to be provided

MERCHANT:

string, conditional Max length: 128 Merchant ID, merchant business code defined in Payten Payment Gateway.

MERCHANTUSER:

string, conditional Max length: 128 Merchant API User Email

MERCHANTPASSWORD:

string, conditional Max length: 128 Merchant API User Password

SESSIONTOKEN:

string, conditional Max length: 48 It is a unique value that contains the values for the transaction.

PGTRANID:

string, conditional Max length: 64 Transaction ID given by payment gateway.

MERCHANTPAYMENTID:

string, conditional Max length: 128 Payment ID given by Merchant (it must be unique).The character length of MerchantPaymentID varies according to the virtual POS bank. Our recommended maximum length value is 40 characters. Apart from this, the character lengths of the banks should be taken into account. If you are sending a transaction to the PARATIKA application via Payten Payment Gateway, you should send the MerchantPaymentID with a maximum value that is 9 characters shorter. This is because PARATIKA application adds +9 characters to the value sent from the Payten Payment Gateway.
Raiffeisenbank Virtual POS Note: If you are using Raiffeisenbank's Virtual POS or sending transactions to Raiffeisenbank, the MERCHANTPAYMENTID must be limited to a maximum of 20 characters, as this is the maximum supported by the bank.

AMOUNT:

decimal, optional Max length: 30 Default value: '0' Amount of payment / transaction. Please note that, this amount is tax included, MSU doesn't consider any other tax calculation.

INITIATORMERCHANTBUSINESSID:

string, optional Max length: 16 description

INVOICEID:

string, optional Max length: 4000 ID of the invoice

EXTRA:

string, optional Max length: 4000

Extra Parameter is a custom parameter that is used to pass certain parameters for different banks or other usage. This parameter gets its argument as a JSON(URL encoded) format which is then parsed. EXTRA: {"Name" : Value}

Parameters

Below are given parameters that can be sent on extra and examples for each of them. (parameter name is case-insensitive)

• SaveCard - parameter to differentiate if card should be saved or not. Possible values: YES/NO.
  {"SaveCard": "NO"}
• PopUpOpenWhenChecked - shows Card Saving Terms and Conditions when they are accepted (checked). Possible values: YES/NO.
  {"PopUpOpenWhenChecked": "NO"}
• SAVECARDREMINDERPOPUP - shows a popup that gives the user the option to save the card after a successful Hosted Payment Page payment. Possible values: YES/NO.
  {"SAVECARDREMINDERPOPUP": "YES"}
• BNPLREMINDERPOPUP - shows a popup that gives the user the option to go back to the payment page and continue with loan payment after a failed card transaction on the Hosted Payment Page. Possible values: YES/NO.
  {"BNPLREMINDERPOPUP": "YES"}
• ForceSave - parameter to differentiate if card should be forced to be saved or not. ForceSave and SaveCard can not be sent together. ForceSave has priority over SaveCard. Possible values: YES/NO.
  {"ForceSave": "NO"}
• ListCard - parameter to differentiate if Registered Card panel should be displayed on Wallet Page or not. Registered Cards by default are enabled on Wallet Page. Possible values: YES/NO.
  {"ListCard": "NO"}
• CVV - parameter to differentiate if CVV should be given on HPP or not. CVV input by default is enabled on HPP. Possible values: YES/NO.
  {"CVV": "NO"}
• MailOrder - parameter to specify which merchants' transactions will be sent with moto label autotmatically. Possible values: YES/NO.
  {"MailOrder": "NO"}
• PREAUTH - parameter used to process 3D transactions as a PreAuth transaction instead of Sale. Possible values: YES/NO.
  {"PREAUTH":"YES"}
• SubMerchantCode - additional parameter sent to bank during financial transactions.
  {"SubMerchantCode": "70885124022"}
• IsbankBolumKodu - additional parameter for transactions sent to Isbank, default value is 1.
  {"IsbankBolumKodu": 1}
• IsbankGroupId - additional parameter for transactions sent to Isbank
  {"ISBANK.GROUPID": "string"}
• IMMEDIATEREDIRECTION - redirect immediately to customer URL on successful action, default value is NO.
  {"IMMEDIATEREDIRECTION": "YES"}
• RETURNSCRIPT - if this parameter is sent, the js function sent will be called after a successful card save on wallet page.
  {"RETURNSCRIPT": JS Function provided by merchant!}
• HalkbankKobiKartDestek - if this parameter is sent, Halkbank Kobi Kart tab will be shown on Default HPP. Possible values: YES/NO.
  {"HalkbankKobiKartDestek":"YES"}
• ReturnTime - return time to merchant return url after payment has been processed.
  {"ReturnTime": 2}
• DealerCode - parameter that indicates dealers, when transactions are made. Unique for every dealer.
  {"DealerCode": "Dealer01"}
• QIWI - if this parameter is sent as "YES", authentication is done using GiroGate QIWI payment method. Possible values: YES/NO.
  {"QIWI": "YES"}
• GIROPAY - if this parameter is sent as "YES", authentication is done using GiroGate GIROPAY payment method. Possible values: YES/NO.
  {"GIROPAY": "YES"}
• IDEAL - if this parameter is sent as "YES", authentication is done using GiroGate IDEAL payment method. Possible values: YES/NO.
  {"IDEAL": "YES"}
• SOFORT - if this parameter is sent as "YES", authentication is done using GiroGate SOFORT payment method. Possible values: YES/NO.
  {"SOFORT": "YES"}
• EPS - if this parameter is sent as "YES", authentication is done using GiroGate EPS payment method. Possible values: YES/NO.
  {"EPS": "YES"}
• MULTIBANCO - if this parameter is sent as "YES", authentication is done using GiroGate MULTIBANCO payment method. Possible values: YES/NO.
  {"MULTIBANCO": "YES"}
• MYBANK - if this parameter is sent as "YES", authentication is done using GiroGate MYBANK payment method. Possible values: YES/NO.
  {"MYBANK": "YES"}
• BANCONTACT - if this parameter is sent as "YES", authentication is done using GiroGate BANCONTACT payment method. Possible values: YES/NO.
  {"BANCONTACT": "YES"}
• TRUSTPAY - if this parameter is sent as "YES", authentication is done using GiroGate TRUSTPAY payment method. Possible values: YES/NO.
  {"TRUSTPAY": "YES"}
• SAFETYPAY - if this parameter is sent as "YES", authentication is done using GiroGate SAFETYPAY payment method. Possible values: YES/NO.
  {"SAFETYPAY": "YES"}
• P24 - if this parameter is sent as "YES", authentication is done using GiroGate P24 payment method. Possible values: YES/NO.
  {"P24": "YES"}
• FINNISHONLINEBANKING - if this parameter is sent as "YES", authentication is done using GiroGate FINNISHONLINEBANKING payment method. Possible values: YES/NO.
  {"FINNISHONLINEBANKING": "YES"}
• BOLETO - if this parameter is sent as "YES", authentication is done using GiroGate BOLETO payment method. Possible values: YES/NO.
  {"BOLETO": "YES"}
• ELO - if this parameter is sent as "YES", authentication is done using GiroGate ELO payment method. Possible values: YES/NO.
  {"ELO": "YES"}
• SEPA - if this parameter is sent as "YES", authentication is done using GiroGate SEPA payment method. Possible values: YES/NO.
  {"SEPA": "YES"}
• ALIPAY - if this parameter is sent as "YES", authentication is done using GiroGate ALIPAY payment method. Possible values: YES/NO.
  {"ALIPAY": "YES"}
• COMMERCECODES - if this parameter should be sent as JSON Array of only strings, maximum installments available to card holder will be set in the payments. Possible values: 1-99
  {"COMMERCECODES":["10","20","30"]}
• ReflectCommission - if this parameter is sent as "YES" and DealerCode extra parameter is provided, commission is reflected to amount. It works only for dealers.
  {"ReflectCommission":"YES", "DealerCode":"Dealer01"}
• IgnoreRates - if this parameter is sent as "YES" and DealerCode extra parameter is provided, commission is not reflected to amount. It works only for dealers.
  {"IgnoreRates":"YES", "DealerCode":"Dealer01"}
• User - parameter that indicates the user, who has done payment on behalf of customer.
  {"USER":"user@email.com"}
• SIPAY - if this parameter is sent, Sipay tab will be shown on Default HPP. Possible values: YES/NO.
  {"SIPAY":"YES"}
• WECHATPAY - if this parameter is sent as "YES", authentication is done using GiroGate WECHATPAY payment method. Possible values: YES/NO.
  {"WECHATPAY": "YES"}
• IframeDomainUrl - indicates from which URL address payment will be proceesed.
  {"IframeDomainUrl": "www.w3school.com"}
• APPLYADDITIONALMATURITY - if this parameter is sent as "YES", payment type maturity commissions will be applied to the installments. Possible values: YES/NO.
  {"APPLYADDITIONALMATURITY": "YES"}
• DealerUserEmail - It represents the email of dealer user.
• AxessMobil.Enabled - Activate Axess Mobil Tab. Possible values: YES/NO.
  {"AxessMobil.Enabled": "NO"}
• AxessMobil.PaymentSystem - Activate Axess Mobil Tab. Possible values: StringValue.
  {"AxessMobil.PaymentSystem": "PaymentSystem"}
• COMPAY.LOAN - Activate Compay Loan Tab. Possible values: YES/NO.
  {"COMPAY.LOAN": "YES"}
• COMPAY.TRANSFER - Activate Compay Transfer Tab. Possible values: YES/NO.
  {"COMPAY.TRANSFER": "YES"}
• PAPARA.PAYMENT - Activate Papara Payment Tab. Possible values: YES/NO.
  {"PAPARA.PAYMENT": "YES"}
• INVOICETYPES - used in EXTRA of QUERYINVOICE to query multiple Invoice Types. It is sent as JSON Array. Possible values: SALE, PREAUTH and DISCOUNT.
  {"INVOICETYPES": ["SALE", "DISCOUNT"]}
• SubCustomer - parameter to differentiate the cards of same the customer.
  {"SubCustomer": "SubCustomer1"}
• InvoiceId - parameter to send id of invoice to pay it from other payment pages.
  {"InvoiceId": "id"}
• DealerCode - parameter to send code of dealer of associated invoice to be paid.
  {"DealerCode": "code"}
giu0009

Split payment parameters

• SpCode - unique code for split payment.
  {"SpCode":"Code-1234567890"}
• SpMaxSplitCount - maximum splits that can be done during payment.
  {"SpMaxSplitCount":3}
• SpTotalAmount - total amount for a split payment.
  {"SpTotalAmount":50}
• SpBusinessMaxInst
  {"SpBusinessMaxInst":4}
• SpPersonalMaxInst
  {"SpPersonalMaxInst":3}
• SpGroupNumber - field for grouping split payments.
  {"SpGroupNumber":"Code-1234"}

Other bank parameters

• BKMEXPRESS - include BKMExpressV2 payment system name like below to have BKM Express tab on Default HPP
  {"BkmExpressV2PaymentSystem":"PaymentSystemName"}
• GARANTIPAY - include GarantiPay payment system name like below to have GarantiPay tab on Default HPP
  {"GarantiPayPaymentSystem":"PaymentSystemName"}
• GARANTI - include "GarantiSubMerchantCode" parameter to override default "SubMerchantCode" parameter
  {"GarantiSubMerchantCode":"123456789"}
• YKB - include "YkbSubMerchantCode" parameter to override default "SubMerchantCode" parameter
  {"YkbSubMerchantCode":"123456789"}
  For payment faciliatior options use:
  {
  "YKB.subMrcId": "152135125",
  "YKB.mrcPfId": "1531235126",
  "YKB.mcc": "1325"
  }
  
• Vakifbank - For insurance companies payments made with submerchant include one of the parameters below:
  {"VakifbankSubMerchantCode":"SubMerchantCode"} or
  {"VakifbankIdentity":"123456789"}
• VAKIFBANK TOS REFUND SERVICE
  {"VakifbankRefundService.RECIPIENTBRANCHCODE":"testBranchCode",
  "VakifbankRefundService.RECIPIENTBANKCODE":"testBankCode",
  "VakifbankRefundService.PAYMENTDATE":"dd-MM-yyyy HH:mm",
  "VakifbankRefundService.DESCRIPTION":"description" }

Payment Facilitator (PF) fields shown below can be sent in EXTRA field in the following way.

• ISBANK
  {"ISBANK.SUBMERCHANTID": 65504389},{"ISBANK.SUBMERCHANTPOSTALCODE": 34234},{"ISBANK.SUBMERCHANTCITY": İstanbul},ISBANK.SUBMERCHANTCOUNTRY": Türkiye},{"ISBANK.SUBMERCHANTMCC": 4829},{"ISBANK.SUBMERCHANTNIN": 123456789},,{"ISBANK.SUBMERCHANTURL": www.merchanturl.com}, {"ISBANK.ORDERTYPE": "01"}, {"ISBANK.ORDERSUBTYPE": "01"}
• DENIZBANK
  {"SubMerchantCode": 123456789012345}
• ZIRAATBANK
  {"SubMerchantCode": VKN/TCKN}
• AKBANK
  {"AKBANK.SUBMERCHANTID": 65504389},{"AKBANK.SUBMERCHANTPOSTALCODE": 34234},{"AKBANK.SUBMERCHANTCITY": İstanbul},{"AKBANK.SUBMERCHANTCOUNTRY": Türkiye},{"AKBANK.SUBMERCHANTMCC": 4829},{"AKBANK.SUBMERCHANTNIN": 123456789},{"AKBANK.SUBMERCHANTURL": www.merchanturl.com},{"AKBANK.VISASUBMERCHANTID": 000000},{"AKBANK.VISAPFID": 1111111},{"AKBANK.PAYMENTMETHOD": AKBANKCUZDAN},{"AKBANK.MOBILEECI": 300},{"AKBANK.WALLETPROGRAMDATA": 300},{"AKBANK.MOBILEASSIGNED": 300000},{"AKBANK.MOBILEDEVICETYPE": 10}
• HALKKOBIKART {"HALKKOBIKART.SUBMERCHANTNAME":"string", "HALKKOBIKART.SUBMERCHANTID":"string", "HALKKOBIKART.SUBMERCHANTPOSTALCODE":"string", "HALKKOBIKART.SUBMERCHANTCITY":"string", "HALKKOBIKART.SUBMERCHANTCOUNTRY":"string", "HALKKOBIKART.SUBMERCHANTMCC":"string", "HALKKOBIKART.HALKKOBIKARTDESTEK":"Yes/No", "HALKKOBIKART.OZELTAKSITLIISLEM":"S/E", "HALKKOBIKART.ODEMESIKLIGI":"1 if OZELTAKSITLIISLEM=E", "HALKKOBIKART.MIKTAR_[1-12]":"decimal", "HALKKOBIKART.TARIH_[1-12]":"YYYYMMDD "}
• HALKBANK
  {"HALKBANK.SUBMERCHANTPOSTALCODE": "153123512", "HALKBANK.SUBMERCHANTNAME": "SubMerchantName", "HALKBANK.SUBMERCHANTMCC": "1535", "HALKBANK.SUBMERCHANTID": "5353535", "HALKBANK.SUBMERCHANTCOUNTRY": "Country", "HALKBANK.SUBMERCHANTCITY": "City"}
  
• TURKIYEFINANS
  {"TURKIYEFINANS.SUBMERCHANTNAME": ASSECOTFKB},{"TURKIYEFINANS.SUBMERCHANTID": 9586886},{"TURKIYEFINANS.SUBMERCHANTCITY": ISTANBUL},{TURKIYEFINANS.SUBMERCHANTCOUNTRY": TR},{"TURKIYEFINANS.SUBMERCHANTMCC": 4814},{"TURKIYEFINANS.SUBMERCHANTFACILITATORID": 00516941},{"TURKIYEFINANS.SUBMERCHANTPOSTALCODE": 34467}
• VAKIFBANK
  {"HostSubmerchantID": ASSECOTFKB}
• QNBFinansSubMerchantCode - Sub merchant code for only new QNB Finansbank
  {"QNBFinansSubMerchantCode": "345"}
• QNBFINANSBANK
  {"QNBFINANS.PAYMENTFACILITATORID": "13151251235", "QNBFINANS.SUBMERCHANTCODE": "56126262345", "QNBFINANS.INDSALESORGID": "9982522523", "QNBFINANS.SUBMERCHANTMCC": "4343", "QNBFINANS.CARDACCEPTORNAME": "AcceptorName", "QNBFINANS.CARDACCEPTORCITY": "AcceptorCity", "QNBFINANS.CARDACCEPTORPOSTALCODE": "AcceptorPostalCode", "QNBFINANS.CARDACCEPTORSTREET": "AcceptorStreet", "QNBFINANS.CARDACCEPTORCOUNTRY": "AcceptorCountry", "QNBFINANS.CARDACCEPTORSTATE": "AcceptorState"}
  
• INGBANK
  {"INGBANK.SUBMERCHANTMCC": "143", "INGBANK.SUBMERCHANTPOSTALCODE": "00000", "INGBANK.SUBMERCHANTNAME": "Name", "INGBANK.SUBMERCHANTCITY": "City", "INGBANK.SUBMERCHANTCOUNTRY": "Country", "INGBANK.SUBMERCHANTFACILITATORID": "1512531515", "INGBANK.SUBMERCHANTORGANIZATIONID": "52523525253", "INGBANK.SUBMERCHANTID": "7121363216"}
  
• SEKERBANK
  {"SEKERBANK.SUBMERCHANTID": "340410030", "SEKERBANK.SUBMERCHANTNAME": "CYBERSOFTPF", "SEKERBANK.SUBMERCHANTCITY": "ISTANBUL", "SEKERBANK.SUBMERCHANTCOUNTRY": "792", "SEKERBANK.SUBMERCHANTPOSTALCODE": "81410", "SEKERBANK.SUBMERCHANTMCC": "2233"}
  
• ODEABANK
  { "ODEABANK.PAYMENTFACILITATORID":"string", "ODEABANK.SUBMERCHANTID":"string", "ODEABANK.INDSALESORGID":"string", "ODEABANK.SUBMERCHANTMCC":"string", "ODEABANK.CARDACCEPTORNAME":"string", "ODEABANK.CARDACCEPTORSTREET":"string", "ODEABANK.CARDACCEPTORCITY":string "ODEABANK.CARDACCEPTORPOSTALCODE":string, "ODEABANK.CARDACCEPTORSTATE":"string" "ODEABANK.CARDACCEPTORCOUNTRY:string}
• ANADOLU
  { "ANADOLU.SUBMERCHANTNAME":"string", "ANADOLU.SUBMERCHANTID":"string", "ANADOLU.SUBMERCHANTPOSTALCODE":"string", "ANADOLU.SUBMERCHANTCITY":"string", "ANADOLU.SUBMERCHANTCOUNTRY":"string", "ANADOLU.SUBMERCHANTMCC":"string" }
• TEB
  {
  "TEB.SUBMERCHANTNAME": "SubMerchantName" }
  
• VPOSTIMEOUT - Specify VPOS timeout in seconds - Works for Nestpay, Garanti, Denizbank, Vakifbank, HSBC. Example: {"VPOSTIMEOUT":30}
• ALBARAKA
  { "ALBARAKA.SUBDEALERCODE":"string", "ALBARAKA.TCKN":"string", "ALBARAKA.TAXID":"string" "AlbarakaMailOrder":"YES or NO" (default:NO) }
• KUVEYTTURK
  { "KUVEYTURK.DESCRIPTION":"string", "KUVEYTURK.IDENTITYTAXNUMBER":"string", "KUVEYTURK.DEFERRINGCOUNT":"string", "KUVEYTURK.SUBMERCHANTID":"string", "KUVEYTURK.SUBMERCHANTIDENTITYTAXNUMBER":"string", "KUVEYTURK.VPOSSUBMERCHANTID":"string",
  "KUVEYTURK.BKMID":"string" }
• ZIRAATBANKKURUMSALKART
  Equal installments
  {
  "ZIRAATBANKKURUMSALKART.KURUMSALKARTISLEMTIPI": "ESITTAKSITLISATIS",
  "ZIRAATBANKKURUMSALKART.TAKSITVEYAVADESAYISI": "5",
  "ZIRAATBANKKURUMSALKART.ODEMEPERIYODU": "2"
  }
  
  Flexible installments - up to 12 installments (MIKTAR_*, TARIH_*)
  {
  "ZIRAATBANKKURUMSALKART.KURUMSALKARTISLEMTIPI": "ESNEKTAKSITLISATIS",
  "ZIRAATBANKKURUMSALKART.TAKSITVEYAVADESAYISI": "3",
  "ZIRAATBANKKURUMSALKART.MIKTAR_1": "100",
  "ZIRAATBANKKURUMSALKART.TARIH_1": "20210916",
  "ZIRAATBANKKURUMSALKART.MIKTAR_2": "50",
  "ZIRAATBANKKURUMSALKART.TARIH_2": "20210916",
  "ZIRAATBANKKURUMSALKART.MIKTAR_3": "50",
  "ZIRAATBANKKURUMSALKART.TARIH_3": "20210916",
  }
  
• MULTINET
  { "MULTINET.MERCHANTPRODUCTID": "142" }
  
• PARATIKA
  { "ParatikaMerchantId": "10000000",
  "MerchantKey":"testKey",
  "ParatikaSellerItems":
  [{"productCode": "Sellers1","amount": 55,"name": "keyboard", "description": "OYUN BİLGİSAYARI","quantity": 1, "productCategoryCode": "4722", "sellerId": "TRFONGG2020001", "sellerPaymentAmount":55}] }

Notification Integration Model

• Example: {"NOTIFICATION_INTEGRATION_MODEL" : "API"} or {"NOTIFICATION_INTEGRATION_MODEL" : "DIRECTPOST_THREED"} or {"NOTIFICATION_INTEGRATION_MODEL" : "DIRECTPOST_NON_THREED"} or

Void

A void transaction cancels any transaction, apart from itself. Void cannot be voided. You will get success response for void transactions only if they are not included in the end-of-day settlement process taking place at the issuer’s side. This is the process runs at the end of business day to settle all transactions. This is when the actual funds are transferred from the cardholder’s credit card to merchant’s bank account. So, for example; if you would like to void a sale or postauth transaction that is already processed as part of the end-of-day settlement, then you will get a failed error code for the void request. In this case, you will need to use refund as alternative to void action.

Note: For some payment systems, transactions with pre-authorization after settlement, can only be voided partially. Therefore, these transactions should be voided with amount parameter. If it is not present in request and in case first attempt is unsuccessful, system will try auto partial void with amount 1 piastre subtracted.
Partial void supported payment systems: Akbank

Request parameters

ACTION:

VOID, required Max length: 128 Description to be provided

MERCHANT:

string, conditional Max length: 128 Merchant ID, merchant business code defined in Payten Payment Gateway.

MERCHANTUSER:

string, conditional Max length: 128 Merchant API User Email

MERCHANTPASSWORD:

string, conditional Max length: 128 Merchant API User Password

SESSIONTOKEN:

string, conditional Max length: 48 It is a unique value that contains the values for the transaction.

PGTRANID:

string, conditional Max length: 64 Transaction ID given by payment gateway.

MERCHANTPAYMENTID:

string, conditional Max length: 128 Payment ID given by Merchant (it must be unique).The character length of MerchantPaymentID varies according to the virtual POS bank. Our recommended maximum length value is 40 characters. Apart from this, the character lengths of the banks should be taken into account. If you are sending a transaction to the PARATIKA application via Payten Payment Gateway, you should send the MerchantPaymentID with a maximum value that is 9 characters shorter. This is because PARATIKA application adds +9 characters to the value sent from the Payten Payment Gateway.
Raiffeisenbank Virtual POS Note: If you are using Raiffeisenbank's Virtual POS or sending transactions to Raiffeisenbank, the MERCHANTPAYMENTID must be limited to a maximum of 20 characters, as this is the maximum supported by the bank.

SUBSTATUS:

string, optional Max length: 32 description See all possible values (2)

INITIATORMERCHANTBUSINESSID:

string, optional Max length: 16 description

AMOUNT:

decimal, optional Max length: 30 Amount of payment / transaction. Please note that, this amount is tax included, MSU doesn't consider any other tax calculation.

EXTRA:

string, optional Max length: 4000

Extra Parameter is a custom parameter that is used to pass certain parameters for different banks or other usage. This parameter gets its argument as a JSON(URL encoded) format which is then parsed. EXTRA: {"Name" : Value}

Parameters

Below are given parameters that can be sent on extra and examples for each of them. (parameter name is case-insensitive)

• SaveCard - parameter to differentiate if card should be saved or not. Possible values: YES/NO.
  {"SaveCard": "NO"}
• PopUpOpenWhenChecked - shows Card Saving Terms and Conditions when they are accepted (checked). Possible values: YES/NO.
  {"PopUpOpenWhenChecked": "NO"}
• SAVECARDREMINDERPOPUP - shows a popup that gives the user the option to save the card after a successful Hosted Payment Page payment. Possible values: YES/NO.
  {"SAVECARDREMINDERPOPUP": "YES"}
• BNPLREMINDERPOPUP - shows a popup that gives the user the option to go back to the payment page and continue with loan payment after a failed card transaction on the Hosted Payment Page. Possible values: YES/NO.
  {"BNPLREMINDERPOPUP": "YES"}
• ForceSave - parameter to differentiate if card should be forced to be saved or not. ForceSave and SaveCard can not be sent together. ForceSave has priority over SaveCard. Possible values: YES/NO.
  {"ForceSave": "NO"}
• ListCard - parameter to differentiate if Registered Card panel should be displayed on Wallet Page or not. Registered Cards by default are enabled on Wallet Page. Possible values: YES/NO.
  {"ListCard": "NO"}
• CVV - parameter to differentiate if CVV should be given on HPP or not. CVV input by default is enabled on HPP. Possible values: YES/NO.
  {"CVV": "NO"}
• MailOrder - parameter to specify which merchants' transactions will be sent with moto label autotmatically. Possible values: YES/NO.
  {"MailOrder": "NO"}
• PREAUTH - parameter used to process 3D transactions as a PreAuth transaction instead of Sale. Possible values: YES/NO.
  {"PREAUTH":"YES"}
• SubMerchantCode - additional parameter sent to bank during financial transactions.
  {"SubMerchantCode": "70885124022"}
• IsbankBolumKodu - additional parameter for transactions sent to Isbank, default value is 1.
  {"IsbankBolumKodu": 1}
• IsbankGroupId - additional parameter for transactions sent to Isbank
  {"ISBANK.GROUPID": "string"}
• IMMEDIATEREDIRECTION - redirect immediately to customer URL on successful action, default value is NO.
  {"IMMEDIATEREDIRECTION": "YES"}
• RETURNSCRIPT - if this parameter is sent, the js function sent will be called after a successful card save on wallet page.
  {"RETURNSCRIPT": JS Function provided by merchant!}
• HalkbankKobiKartDestek - if this parameter is sent, Halkbank Kobi Kart tab will be shown on Default HPP. Possible values: YES/NO.
  {"HalkbankKobiKartDestek":"YES"}
• ReturnTime - return time to merchant return url after payment has been processed.
  {"ReturnTime": 2}
• DealerCode - parameter that indicates dealers, when transactions are made. Unique for every dealer.
  {"DealerCode": "Dealer01"}
• QIWI - if this parameter is sent as "YES", authentication is done using GiroGate QIWI payment method. Possible values: YES/NO.
  {"QIWI": "YES"}
• GIROPAY - if this parameter is sent as "YES", authentication is done using GiroGate GIROPAY payment method. Possible values: YES/NO.
  {"GIROPAY": "YES"}
• IDEAL - if this parameter is sent as "YES", authentication is done using GiroGate IDEAL payment method. Possible values: YES/NO.
  {"IDEAL": "YES"}
• SOFORT - if this parameter is sent as "YES", authentication is done using GiroGate SOFORT payment method. Possible values: YES/NO.
  {"SOFORT": "YES"}
• EPS - if this parameter is sent as "YES", authentication is done using GiroGate EPS payment method. Possible values: YES/NO.
  {"EPS": "YES"}
• MULTIBANCO - if this parameter is sent as "YES", authentication is done using GiroGate MULTIBANCO payment method. Possible values: YES/NO.
  {"MULTIBANCO": "YES"}
• MYBANK - if this parameter is sent as "YES", authentication is done using GiroGate MYBANK payment method. Possible values: YES/NO.
  {"MYBANK": "YES"}
• BANCONTACT - if this parameter is sent as "YES", authentication is done using GiroGate BANCONTACT payment method. Possible values: YES/NO.
  {"BANCONTACT": "YES"}
• TRUSTPAY - if this parameter is sent as "YES", authentication is done using GiroGate TRUSTPAY payment method. Possible values: YES/NO.
  {"TRUSTPAY": "YES"}
• SAFETYPAY - if this parameter is sent as "YES", authentication is done using GiroGate SAFETYPAY payment method. Possible values: YES/NO.
  {"SAFETYPAY": "YES"}
• P24 - if this parameter is sent as "YES", authentication is done using GiroGate P24 payment method. Possible values: YES/NO.
  {"P24": "YES"}
• FINNISHONLINEBANKING - if this parameter is sent as "YES", authentication is done using GiroGate FINNISHONLINEBANKING payment method. Possible values: YES/NO.
  {"FINNISHONLINEBANKING": "YES"}
• BOLETO - if this parameter is sent as "YES", authentication is done using GiroGate BOLETO payment method. Possible values: YES/NO.
  {"BOLETO": "YES"}
• ELO - if this parameter is sent as "YES", authentication is done using GiroGate ELO payment method. Possible values: YES/NO.
  {"ELO": "YES"}
• SEPA - if this parameter is sent as "YES", authentication is done using GiroGate SEPA payment method. Possible values: YES/NO.
  {"SEPA": "YES"}
• ALIPAY - if this parameter is sent as "YES", authentication is done using GiroGate ALIPAY payment method. Possible values: YES/NO.
  {"ALIPAY": "YES"}
• COMMERCECODES - if this parameter should be sent as JSON Array of only strings, maximum installments available to card holder will be set in the payments. Possible values: 1-99
  {"COMMERCECODES":["10","20","30"]}
• ReflectCommission - if this parameter is sent as "YES" and DealerCode extra parameter is provided, commission is reflected to amount. It works only for dealers.
  {"ReflectCommission":"YES", "DealerCode":"Dealer01"}
• IgnoreRates - if this parameter is sent as "YES" and DealerCode extra parameter is provided, commission is not reflected to amount. It works only for dealers.
  {"IgnoreRates":"YES", "DealerCode":"Dealer01"}
• User - parameter that indicates the user, who has done payment on behalf of customer.
  {"USER":"user@email.com"}
• SIPAY - if this parameter is sent, Sipay tab will be shown on Default HPP. Possible values: YES/NO.
  {"SIPAY":"YES"}
• WECHATPAY - if this parameter is sent as "YES", authentication is done using GiroGate WECHATPAY payment method. Possible values: YES/NO.
  {"WECHATPAY": "YES"}
• IframeDomainUrl - indicates from which URL address payment will be proceesed.
  {"IframeDomainUrl": "www.w3school.com"}
• APPLYADDITIONALMATURITY - if this parameter is sent as "YES", payment type maturity commissions will be applied to the installments. Possible values: YES/NO.
  {"APPLYADDITIONALMATURITY": "YES"}
• DealerUserEmail - It represents the email of dealer user.
• AxessMobil.Enabled - Activate Axess Mobil Tab. Possible values: YES/NO.
  {"AxessMobil.Enabled": "NO"}
• AxessMobil.PaymentSystem - Activate Axess Mobil Tab. Possible values: StringValue.
  {"AxessMobil.PaymentSystem": "PaymentSystem"}
• COMPAY.LOAN - Activate Compay Loan Tab. Possible values: YES/NO.
  {"COMPAY.LOAN": "YES"}
• COMPAY.TRANSFER - Activate Compay Transfer Tab. Possible values: YES/NO.
  {"COMPAY.TRANSFER": "YES"}
• PAPARA.PAYMENT - Activate Papara Payment Tab. Possible values: YES/NO.
  {"PAPARA.PAYMENT": "YES"}
• INVOICETYPES - used in EXTRA of QUERYINVOICE to query multiple Invoice Types. It is sent as JSON Array. Possible values: SALE, PREAUTH and DISCOUNT.
  {"INVOICETYPES": ["SALE", "DISCOUNT"]}
• SubCustomer - parameter to differentiate the cards of same the customer.
  {"SubCustomer": "SubCustomer1"}
• InvoiceId - parameter to send id of invoice to pay it from other payment pages.
  {"InvoiceId": "id"}
• DealerCode - parameter to send code of dealer of associated invoice to be paid.
  {"DealerCode": "code"}
giu0009

Split payment parameters

• SpCode - unique code for split payment.
  {"SpCode":"Code-1234567890"}
• SpMaxSplitCount - maximum splits that can be done during payment.
  {"SpMaxSplitCount":3}
• SpTotalAmount - total amount for a split payment.
  {"SpTotalAmount":50}
• SpBusinessMaxInst
  {"SpBusinessMaxInst":4}
• SpPersonalMaxInst
  {"SpPersonalMaxInst":3}
• SpGroupNumber - field for grouping split payments.
  {"SpGroupNumber":"Code-1234"}

Other bank parameters

• BKMEXPRESS - include BKMExpressV2 payment system name like below to have BKM Express tab on Default HPP
  {"BkmExpressV2PaymentSystem":"PaymentSystemName"}
• GARANTIPAY - include GarantiPay payment system name like below to have GarantiPay tab on Default HPP
  {"GarantiPayPaymentSystem":"PaymentSystemName"}
• GARANTI - include "GarantiSubMerchantCode" parameter to override default "SubMerchantCode" parameter
  {"GarantiSubMerchantCode":"123456789"}
• YKB - include "YkbSubMerchantCode" parameter to override default "SubMerchantCode" parameter
  {"YkbSubMerchantCode":"123456789"}
  For payment faciliatior options use:
  {
  "YKB.subMrcId": "152135125",
  "YKB.mrcPfId": "1531235126",
  "YKB.mcc": "1325"
  }
  
• Vakifbank - For insurance companies payments made with submerchant include one of the parameters below:
  {"VakifbankSubMerchantCode":"SubMerchantCode"} or
  {"VakifbankIdentity":"123456789"}
• VAKIFBANK TOS REFUND SERVICE
  {"VakifbankRefundService.RECIPIENTBRANCHCODE":"testBranchCode",
  "VakifbankRefundService.RECIPIENTBANKCODE":"testBankCode",
  "VakifbankRefundService.PAYMENTDATE":"dd-MM-yyyy HH:mm",
  "VakifbankRefundService.DESCRIPTION":"description" }

Payment Facilitator (PF) fields shown below can be sent in EXTRA field in the following way.

• ISBANK
  {"ISBANK.SUBMERCHANTID": 65504389},{"ISBANK.SUBMERCHANTPOSTALCODE": 34234},{"ISBANK.SUBMERCHANTCITY": İstanbul},ISBANK.SUBMERCHANTCOUNTRY": Türkiye},{"ISBANK.SUBMERCHANTMCC": 4829},{"ISBANK.SUBMERCHANTNIN": 123456789},,{"ISBANK.SUBMERCHANTURL": www.merchanturl.com}, {"ISBANK.ORDERTYPE": "01"}, {"ISBANK.ORDERSUBTYPE": "01"}
• DENIZBANK
  {"SubMerchantCode": 123456789012345}
• ZIRAATBANK
  {"SubMerchantCode": VKN/TCKN}
• AKBANK
  {"AKBANK.SUBMERCHANTID": 65504389},{"AKBANK.SUBMERCHANTPOSTALCODE": 34234},{"AKBANK.SUBMERCHANTCITY": İstanbul},{"AKBANK.SUBMERCHANTCOUNTRY": Türkiye},{"AKBANK.SUBMERCHANTMCC": 4829},{"AKBANK.SUBMERCHANTNIN": 123456789},{"AKBANK.SUBMERCHANTURL": www.merchanturl.com},{"AKBANK.VISASUBMERCHANTID": 000000},{"AKBANK.VISAPFID": 1111111},{"AKBANK.PAYMENTMETHOD": AKBANKCUZDAN},{"AKBANK.MOBILEECI": 300},{"AKBANK.WALLETPROGRAMDATA": 300},{"AKBANK.MOBILEASSIGNED": 300000},{"AKBANK.MOBILEDEVICETYPE": 10}
• HALKKOBIKART {"HALKKOBIKART.SUBMERCHANTNAME":"string", "HALKKOBIKART.SUBMERCHANTID":"string", "HALKKOBIKART.SUBMERCHANTPOSTALCODE":"string", "HALKKOBIKART.SUBMERCHANTCITY":"string", "HALKKOBIKART.SUBMERCHANTCOUNTRY":"string", "HALKKOBIKART.SUBMERCHANTMCC":"string", "HALKKOBIKART.HALKKOBIKARTDESTEK":"Yes/No", "HALKKOBIKART.OZELTAKSITLIISLEM":"S/E", "HALKKOBIKART.ODEMESIKLIGI":"1 if OZELTAKSITLIISLEM=E", "HALKKOBIKART.MIKTAR_[1-12]":"decimal", "HALKKOBIKART.TARIH_[1-12]":"YYYYMMDD "}
• HALKBANK
  {"HALKBANK.SUBMERCHANTPOSTALCODE": "153123512", "HALKBANK.SUBMERCHANTNAME": "SubMerchantName", "HALKBANK.SUBMERCHANTMCC": "1535", "HALKBANK.SUBMERCHANTID": "5353535", "HALKBANK.SUBMERCHANTCOUNTRY": "Country", "HALKBANK.SUBMERCHANTCITY": "City"}
  
• TURKIYEFINANS
  {"TURKIYEFINANS.SUBMERCHANTNAME": ASSECOTFKB},{"TURKIYEFINANS.SUBMERCHANTID": 9586886},{"TURKIYEFINANS.SUBMERCHANTCITY": ISTANBUL},{TURKIYEFINANS.SUBMERCHANTCOUNTRY": TR},{"TURKIYEFINANS.SUBMERCHANTMCC": 4814},{"TURKIYEFINANS.SUBMERCHANTFACILITATORID": 00516941},{"TURKIYEFINANS.SUBMERCHANTPOSTALCODE": 34467}
• VAKIFBANK
  {"HostSubmerchantID": ASSECOTFKB}
• QNBFinansSubMerchantCode - Sub merchant code for only new QNB Finansbank
  {"QNBFinansSubMerchantCode": "345"}
• QNBFINANSBANK
  {"QNBFINANS.PAYMENTFACILITATORID": "13151251235", "QNBFINANS.SUBMERCHANTCODE": "56126262345", "QNBFINANS.INDSALESORGID": "9982522523", "QNBFINANS.SUBMERCHANTMCC": "4343", "QNBFINANS.CARDACCEPTORNAME": "AcceptorName", "QNBFINANS.CARDACCEPTORCITY": "AcceptorCity", "QNBFINANS.CARDACCEPTORPOSTALCODE": "AcceptorPostalCode", "QNBFINANS.CARDACCEPTORSTREET": "AcceptorStreet", "QNBFINANS.CARDACCEPTORCOUNTRY": "AcceptorCountry", "QNBFINANS.CARDACCEPTORSTATE": "AcceptorState"}
  
• INGBANK
  {"INGBANK.SUBMERCHANTMCC": "143", "INGBANK.SUBMERCHANTPOSTALCODE": "00000", "INGBANK.SUBMERCHANTNAME": "Name", "INGBANK.SUBMERCHANTCITY": "City", "INGBANK.SUBMERCHANTCOUNTRY": "Country", "INGBANK.SUBMERCHANTFACILITATORID": "1512531515", "INGBANK.SUBMERCHANTORGANIZATIONID": "52523525253", "INGBANK.SUBMERCHANTID": "7121363216"}
  
• SEKERBANK
  {"SEKERBANK.SUBMERCHANTID": "340410030", "SEKERBANK.SUBMERCHANTNAME": "CYBERSOFTPF", "SEKERBANK.SUBMERCHANTCITY": "ISTANBUL", "SEKERBANK.SUBMERCHANTCOUNTRY": "792", "SEKERBANK.SUBMERCHANTPOSTALCODE": "81410", "SEKERBANK.SUBMERCHANTMCC": "2233"}
  
• ODEABANK
  { "ODEABANK.PAYMENTFACILITATORID":"string", "ODEABANK.SUBMERCHANTID":"string", "ODEABANK.INDSALESORGID":"string", "ODEABANK.SUBMERCHANTMCC":"string", "ODEABANK.CARDACCEPTORNAME":"string", "ODEABANK.CARDACCEPTORSTREET":"string", "ODEABANK.CARDACCEPTORCITY":string "ODEABANK.CARDACCEPTORPOSTALCODE":string, "ODEABANK.CARDACCEPTORSTATE":"string" "ODEABANK.CARDACCEPTORCOUNTRY:string}
• ANADOLU
  { "ANADOLU.SUBMERCHANTNAME":"string", "ANADOLU.SUBMERCHANTID":"string", "ANADOLU.SUBMERCHANTPOSTALCODE":"string", "ANADOLU.SUBMERCHANTCITY":"string", "ANADOLU.SUBMERCHANTCOUNTRY":"string", "ANADOLU.SUBMERCHANTMCC":"string" }
• TEB
  {
  "TEB.SUBMERCHANTNAME": "SubMerchantName" }
  
• VPOSTIMEOUT - Specify VPOS timeout in seconds - Works for Nestpay, Garanti, Denizbank, Vakifbank, HSBC. Example: {"VPOSTIMEOUT":30}
• ALBARAKA
  { "ALBARAKA.SUBDEALERCODE":"string", "ALBARAKA.TCKN":"string", "ALBARAKA.TAXID":"string" "AlbarakaMailOrder":"YES or NO" (default:NO) }
• KUVEYTTURK
  { "KUVEYTURK.DESCRIPTION":"string", "KUVEYTURK.IDENTITYTAXNUMBER":"string", "KUVEYTURK.DEFERRINGCOUNT":"string", "KUVEYTURK.SUBMERCHANTID":"string", "KUVEYTURK.SUBMERCHANTIDENTITYTAXNUMBER":"string", "KUVEYTURK.VPOSSUBMERCHANTID":"string",
  "KUVEYTURK.BKMID":"string" }
• ZIRAATBANKKURUMSALKART
  Equal installments
  {
  "ZIRAATBANKKURUMSALKART.KURUMSALKARTISLEMTIPI": "ESITTAKSITLISATIS",
  "ZIRAATBANKKURUMSALKART.TAKSITVEYAVADESAYISI": "5",
  "ZIRAATBANKKURUMSALKART.ODEMEPERIYODU": "2"
  }
  
  Flexible installments - up to 12 installments (MIKTAR_*, TARIH_*)
  {
  "ZIRAATBANKKURUMSALKART.KURUMSALKARTISLEMTIPI": "ESNEKTAKSITLISATIS",
  "ZIRAATBANKKURUMSALKART.TAKSITVEYAVADESAYISI": "3",
  "ZIRAATBANKKURUMSALKART.MIKTAR_1": "100",
  "ZIRAATBANKKURUMSALKART.TARIH_1": "20210916",
  "ZIRAATBANKKURUMSALKART.MIKTAR_2": "50",
  "ZIRAATBANKKURUMSALKART.TARIH_2": "20210916",
  "ZIRAATBANKKURUMSALKART.MIKTAR_3": "50",
  "ZIRAATBANKKURUMSALKART.TARIH_3": "20210916",
  }
  
• MULTINET
  { "MULTINET.MERCHANTPRODUCTID": "142" }
  
• PARATIKA
  { "ParatikaMerchantId": "10000000",
  "MerchantKey":"testKey",
  "ParatikaSellerItems":
  [{"productCode": "Sellers1","amount": 55,"name": "keyboard", "description": "OYUN BİLGİSAYARI","quantity": 1, "productCategoryCode": "4722", "sellerId": "TRFONGG2020001", "sellerPaymentAmount":55}] }

Notification Integration Model

• Example: {"NOTIFICATION_INTEGRATION_MODEL" : "API"} or {"NOTIFICATION_INTEGRATION_MODEL" : "DIRECTPOST_THREED"} or {"NOTIFICATION_INTEGRATION_MODEL" : "DIRECTPOST_NON_THREED"} or

CUSTOMFIELDS:

string, optional Max length: 4000 This parameter should be sent in JSON Array with UTF-8 URL-Encoded format. "integrationCode" and "value" are required when sending this parameter.
Example:[{"code":"code","name":"Field Name","value":"Field Value","group":"Group","integrationCode":"IntegrationCode"},{},{}]

Refund

A Refund transaction returns funds to a Customer's credit card for an existing order on the system. To perform a refund, you need the transaction number, which you can find in your reports. If you perform a return of the full payment amount, the payment amount will be reset to the original amount.

Request parameters

ACTION:

REFUND, required Max length: 128 Description to be provided

MERCHANT:

string, conditional Max length: 128 Merchant ID, merchant business code defined in Payten Payment Gateway.

MERCHANTUSER:

string, conditional Max length: 128 Merchant API User Email

MERCHANTPASSWORD:

string, conditional Max length: 128 Merchant API User Password

SESSIONTOKEN:

string, conditional Max length: 48 It is a unique value that contains the values for the transaction.

AMOUNT:

decimal, optional Max length: 30 Amount of payment / transaction. Please note that, this amount is tax included, MSU doesn't consider any other tax calculation.

CURRENCY:

string, optional Max length: 3 ISO Alpha transaction currency code like EUR, USD, GBP. See all possible values (37)

PGTRANID:

string, conditional Max length: 64 Transaction ID given by payment gateway.

MERCHANTPAYMENTID:

string, conditional Max length: 128 Payment ID given by Merchant (it must be unique).The character length of MerchantPaymentID varies according to the virtual POS bank. Our recommended maximum length value is 40 characters. Apart from this, the character lengths of the banks should be taken into account. If you are sending a transaction to the PARATIKA application via Payten Payment Gateway, you should send the MerchantPaymentID with a maximum value that is 9 characters shorter. This is because PARATIKA application adds +9 characters to the value sent from the Payten Payment Gateway.
Raiffeisenbank Virtual POS Note: If you are using Raiffeisenbank's Virtual POS or sending transactions to Raiffeisenbank, the MERCHANTPAYMENTID must be limited to a maximum of 20 characters, as this is the maximum supported by the bank.

SUBSTATUS:

string, optional Max length: 32 description See all possible values (2)

INITIATORMERCHANTBUSINESSID:

string, optional Max length: 16 description

EXTRA:

string, optional Max length: 4000

Extra Parameter is a custom parameter that is used to pass certain parameters for different banks or other usage. This parameter gets its argument as a JSON(URL encoded) format which is then parsed. EXTRA: {"Name" : Value}

Parameters

Below are given parameters that can be sent on extra and examples for each of them. (parameter name is case-insensitive)

• SaveCard - parameter to differentiate if card should be saved or not. Possible values: YES/NO.
  {"SaveCard": "NO"}
• PopUpOpenWhenChecked - shows Card Saving Terms and Conditions when they are accepted (checked). Possible values: YES/NO.
  {"PopUpOpenWhenChecked": "NO"}
• SAVECARDREMINDERPOPUP - shows a popup that gives the user the option to save the card after a successful Hosted Payment Page payment. Possible values: YES/NO.
  {"SAVECARDREMINDERPOPUP": "YES"}
• BNPLREMINDERPOPUP - shows a popup that gives the user the option to go back to the payment page and continue with loan payment after a failed card transaction on the Hosted Payment Page. Possible values: YES/NO.
  {"BNPLREMINDERPOPUP": "YES"}
• ForceSave - parameter to differentiate if card should be forced to be saved or not. ForceSave and SaveCard can not be sent together. ForceSave has priority over SaveCard. Possible values: YES/NO.
  {"ForceSave": "NO"}
• ListCard - parameter to differentiate if Registered Card panel should be displayed on Wallet Page or not. Registered Cards by default are enabled on Wallet Page. Possible values: YES/NO.
  {"ListCard": "NO"}
• CVV - parameter to differentiate if CVV should be given on HPP or not. CVV input by default is enabled on HPP. Possible values: YES/NO.
  {"CVV": "NO"}
• MailOrder - parameter to specify which merchants' transactions will be sent with moto label autotmatically. Possible values: YES/NO.
  {"MailOrder": "NO"}
• PREAUTH - parameter used to process 3D transactions as a PreAuth transaction instead of Sale. Possible values: YES/NO.
  {"PREAUTH":"YES"}
• SubMerchantCode - additional parameter sent to bank during financial transactions.
  {"SubMerchantCode": "70885124022"}
• IsbankBolumKodu - additional parameter for transactions sent to Isbank, default value is 1.
  {"IsbankBolumKodu": 1}
• IsbankGroupId - additional parameter for transactions sent to Isbank
  {"ISBANK.GROUPID": "string"}
• IMMEDIATEREDIRECTION - redirect immediately to customer URL on successful action, default value is NO.
  {"IMMEDIATEREDIRECTION": "YES"}
• RETURNSCRIPT - if this parameter is sent, the js function sent will be called after a successful card save on wallet page.
  {"RETURNSCRIPT": JS Function provided by merchant!}
• HalkbankKobiKartDestek - if this parameter is sent, Halkbank Kobi Kart tab will be shown on Default HPP. Possible values: YES/NO.
  {"HalkbankKobiKartDestek":"YES"}
• ReturnTime - return time to merchant return url after payment has been processed.
  {"ReturnTime": 2}
• DealerCode - parameter that indicates dealers, when transactions are made. Unique for every dealer.
  {"DealerCode": "Dealer01"}
• QIWI - if this parameter is sent as "YES", authentication is done using GiroGate QIWI payment method. Possible values: YES/NO.
  {"QIWI": "YES"}
• GIROPAY - if this parameter is sent as "YES", authentication is done using GiroGate GIROPAY payment method. Possible values: YES/NO.
  {"GIROPAY": "YES"}
• IDEAL - if this parameter is sent as "YES", authentication is done using GiroGate IDEAL payment method. Possible values: YES/NO.
  {"IDEAL": "YES"}
• SOFORT - if this parameter is sent as "YES", authentication is done using GiroGate SOFORT payment method. Possible values: YES/NO.
  {"SOFORT": "YES"}
• EPS - if this parameter is sent as "YES", authentication is done using GiroGate EPS payment method. Possible values: YES/NO.
  {"EPS": "YES"}
• MULTIBANCO - if this parameter is sent as "YES", authentication is done using GiroGate MULTIBANCO payment method. Possible values: YES/NO.
  {"MULTIBANCO": "YES"}
• MYBANK - if this parameter is sent as "YES", authentication is done using GiroGate MYBANK payment method. Possible values: YES/NO.
  {"MYBANK": "YES"}
• BANCONTACT - if this parameter is sent as "YES", authentication is done using GiroGate BANCONTACT payment method. Possible values: YES/NO.
  {"BANCONTACT": "YES"}
• TRUSTPAY - if this parameter is sent as "YES", authentication is done using GiroGate TRUSTPAY payment method. Possible values: YES/NO.
  {"TRUSTPAY": "YES"}
• SAFETYPAY - if this parameter is sent as "YES", authentication is done using GiroGate SAFETYPAY payment method. Possible values: YES/NO.
  {"SAFETYPAY": "YES"}
• P24 - if this parameter is sent as "YES", authentication is done using GiroGate P24 payment method. Possible values: YES/NO.
  {"P24": "YES"}
• FINNISHONLINEBANKING - if this parameter is sent as "YES", authentication is done using GiroGate FINNISHONLINEBANKING payment method. Possible values: YES/NO.
  {"FINNISHONLINEBANKING": "YES"}
• BOLETO - if this parameter is sent as "YES", authentication is done using GiroGate BOLETO payment method. Possible values: YES/NO.
  {"BOLETO": "YES"}
• ELO - if this parameter is sent as "YES", authentication is done using GiroGate ELO payment method. Possible values: YES/NO.
  {"ELO": "YES"}
• SEPA - if this parameter is sent as "YES", authentication is done using GiroGate SEPA payment method. Possible values: YES/NO.
  {"SEPA": "YES"}
• ALIPAY - if this parameter is sent as "YES", authentication is done using GiroGate ALIPAY payment method. Possible values: YES/NO.
  {"ALIPAY": "YES"}
• COMMERCECODES - if this parameter should be sent as JSON Array of only strings, maximum installments available to card holder will be set in the payments. Possible values: 1-99
  {"COMMERCECODES":["10","20","30"]}
• ReflectCommission - if this parameter is sent as "YES" and DealerCode extra parameter is provided, commission is reflected to amount. It works only for dealers.
  {"ReflectCommission":"YES", "DealerCode":"Dealer01"}
• IgnoreRates - if this parameter is sent as "YES" and DealerCode extra parameter is provided, commission is not reflected to amount. It works only for dealers.
  {"IgnoreRates":"YES", "DealerCode":"Dealer01"}
• User - parameter that indicates the user, who has done payment on behalf of customer.
  {"USER":"user@email.com"}
• SIPAY - if this parameter is sent, Sipay tab will be shown on Default HPP. Possible values: YES/NO.
  {"SIPAY":"YES"}
• WECHATPAY - if this parameter is sent as "YES", authentication is done using GiroGate WECHATPAY payment method. Possible values: YES/NO.
  {"WECHATPAY": "YES"}
• IframeDomainUrl - indicates from which URL address payment will be proceesed.
  {"IframeDomainUrl": "www.w3school.com"}
• APPLYADDITIONALMATURITY - if this parameter is sent as "YES", payment type maturity commissions will be applied to the installments. Possible values: YES/NO.
  {"APPLYADDITIONALMATURITY": "YES"}
• DealerUserEmail - It represents the email of dealer user.
• AxessMobil.Enabled - Activate Axess Mobil Tab. Possible values: YES/NO.
  {"AxessMobil.Enabled": "NO"}
• AxessMobil.PaymentSystem - Activate Axess Mobil Tab. Possible values: StringValue.
  {"AxessMobil.PaymentSystem": "PaymentSystem"}
• COMPAY.LOAN - Activate Compay Loan Tab. Possible values: YES/NO.
  {"COMPAY.LOAN": "YES"}
• COMPAY.TRANSFER - Activate Compay Transfer Tab. Possible values: YES/NO.
  {"COMPAY.TRANSFER": "YES"}
• PAPARA.PAYMENT - Activate Papara Payment Tab. Possible values: YES/NO.
  {"PAPARA.PAYMENT": "YES"}
• INVOICETYPES - used in EXTRA of QUERYINVOICE to query multiple Invoice Types. It is sent as JSON Array. Possible values: SALE, PREAUTH and DISCOUNT.
  {"INVOICETYPES": ["SALE", "DISCOUNT"]}
• SubCustomer - parameter to differentiate the cards of same the customer.
  {"SubCustomer": "SubCustomer1"}
• InvoiceId - parameter to send id of invoice to pay it from other payment pages.
  {"InvoiceId": "id"}
• DealerCode - parameter to send code of dealer of associated invoice to be paid.
  {"DealerCode": "code"}
giu0009

Split payment parameters

• SpCode - unique code for split payment.
  {"SpCode":"Code-1234567890"}
• SpMaxSplitCount - maximum splits that can be done during payment.
  {"SpMaxSplitCount":3}
• SpTotalAmount - total amount for a split payment.
  {"SpTotalAmount":50}
• SpBusinessMaxInst
  {"SpBusinessMaxInst":4}
• SpPersonalMaxInst
  {"SpPersonalMaxInst":3}
• SpGroupNumber - field for grouping split payments.
  {"SpGroupNumber":"Code-1234"}

Other bank parameters

• BKMEXPRESS - include BKMExpressV2 payment system name like below to have BKM Express tab on Default HPP
  {"BkmExpressV2PaymentSystem":"PaymentSystemName"}
• GARANTIPAY - include GarantiPay payment system name like below to have GarantiPay tab on Default HPP
  {"GarantiPayPaymentSystem":"PaymentSystemName"}
• GARANTI - include "GarantiSubMerchantCode" parameter to override default "SubMerchantCode" parameter
  {"GarantiSubMerchantCode":"123456789"}
• YKB - include "YkbSubMerchantCode" parameter to override default "SubMerchantCode" parameter
  {"YkbSubMerchantCode":"123456789"}
  For payment faciliatior options use:
  {
  "YKB.subMrcId": "152135125",
  "YKB.mrcPfId": "1531235126",
  "YKB.mcc": "1325"
  }
  
• Vakifbank - For insurance companies payments made with submerchant include one of the parameters below:
  {"VakifbankSubMerchantCode":"SubMerchantCode"} or
  {"VakifbankIdentity":"123456789"}
• VAKIFBANK TOS REFUND SERVICE
  {"VakifbankRefundService.RECIPIENTBRANCHCODE":"testBranchCode",
  "VakifbankRefundService.RECIPIENTBANKCODE":"testBankCode",
  "VakifbankRefundService.PAYMENTDATE":"dd-MM-yyyy HH:mm",
  "VakifbankRefundService.DESCRIPTION":"description" }

Payment Facilitator (PF) fields shown below can be sent in EXTRA field in the following way.

• ISBANK
  {"ISBANK.SUBMERCHANTID": 65504389},{"ISBANK.SUBMERCHANTPOSTALCODE": 34234},{"ISBANK.SUBMERCHANTCITY": İstanbul},ISBANK.SUBMERCHANTCOUNTRY": Türkiye},{"ISBANK.SUBMERCHANTMCC": 4829},{"ISBANK.SUBMERCHANTNIN": 123456789},,{"ISBANK.SUBMERCHANTURL": www.merchanturl.com}, {"ISBANK.ORDERTYPE": "01"}, {"ISBANK.ORDERSUBTYPE": "01"}
• DENIZBANK
  {"SubMerchantCode": 123456789012345}
• ZIRAATBANK
  {"SubMerchantCode": VKN/TCKN}
• AKBANK
  {"AKBANK.SUBMERCHANTID": 65504389},{"AKBANK.SUBMERCHANTPOSTALCODE": 34234},{"AKBANK.SUBMERCHANTCITY": İstanbul},{"AKBANK.SUBMERCHANTCOUNTRY": Türkiye},{"AKBANK.SUBMERCHANTMCC": 4829},{"AKBANK.SUBMERCHANTNIN": 123456789},{"AKBANK.SUBMERCHANTURL": www.merchanturl.com},{"AKBANK.VISASUBMERCHANTID": 000000},{"AKBANK.VISAPFID": 1111111},{"AKBANK.PAYMENTMETHOD": AKBANKCUZDAN},{"AKBANK.MOBILEECI": 300},{"AKBANK.WALLETPROGRAMDATA": 300},{"AKBANK.MOBILEASSIGNED": 300000},{"AKBANK.MOBILEDEVICETYPE": 10}
• HALKKOBIKART {"HALKKOBIKART.SUBMERCHANTNAME":"string", "HALKKOBIKART.SUBMERCHANTID":"string", "HALKKOBIKART.SUBMERCHANTPOSTALCODE":"string", "HALKKOBIKART.SUBMERCHANTCITY":"string", "HALKKOBIKART.SUBMERCHANTCOUNTRY":"string", "HALKKOBIKART.SUBMERCHANTMCC":"string", "HALKKOBIKART.HALKKOBIKARTDESTEK":"Yes/No", "HALKKOBIKART.OZELTAKSITLIISLEM":"S/E", "HALKKOBIKART.ODEMESIKLIGI":"1 if OZELTAKSITLIISLEM=E", "HALKKOBIKART.MIKTAR_[1-12]":"decimal", "HALKKOBIKART.TARIH_[1-12]":"YYYYMMDD "}
• HALKBANK
  {"HALKBANK.SUBMERCHANTPOSTALCODE": "153123512", "HALKBANK.SUBMERCHANTNAME": "SubMerchantName", "HALKBANK.SUBMERCHANTMCC": "1535", "HALKBANK.SUBMERCHANTID": "5353535", "HALKBANK.SUBMERCHANTCOUNTRY": "Country", "HALKBANK.SUBMERCHANTCITY": "City"}
  
• TURKIYEFINANS
  {"TURKIYEFINANS.SUBMERCHANTNAME": ASSECOTFKB},{"TURKIYEFINANS.SUBMERCHANTID": 9586886},{"TURKIYEFINANS.SUBMERCHANTCITY": ISTANBUL},{TURKIYEFINANS.SUBMERCHANTCOUNTRY": TR},{"TURKIYEFINANS.SUBMERCHANTMCC": 4814},{"TURKIYEFINANS.SUBMERCHANTFACILITATORID": 00516941},{"TURKIYEFINANS.SUBMERCHANTPOSTALCODE": 34467}
• VAKIFBANK
  {"HostSubmerchantID": ASSECOTFKB}
• QNBFinansSubMerchantCode - Sub merchant code for only new QNB Finansbank
  {"QNBFinansSubMerchantCode": "345"}
• QNBFINANSBANK
  {"QNBFINANS.PAYMENTFACILITATORID": "13151251235", "QNBFINANS.SUBMERCHANTCODE": "56126262345", "QNBFINANS.INDSALESORGID": "9982522523", "QNBFINANS.SUBMERCHANTMCC": "4343", "QNBFINANS.CARDACCEPTORNAME": "AcceptorName", "QNBFINANS.CARDACCEPTORCITY": "AcceptorCity", "QNBFINANS.CARDACCEPTORPOSTALCODE": "AcceptorPostalCode", "QNBFINANS.CARDACCEPTORSTREET": "AcceptorStreet", "QNBFINANS.CARDACCEPTORCOUNTRY": "AcceptorCountry", "QNBFINANS.CARDACCEPTORSTATE": "AcceptorState"}
  
• INGBANK
  {"INGBANK.SUBMERCHANTMCC": "143", "INGBANK.SUBMERCHANTPOSTALCODE": "00000", "INGBANK.SUBMERCHANTNAME": "Name", "INGBANK.SUBMERCHANTCITY": "City", "INGBANK.SUBMERCHANTCOUNTRY": "Country", "INGBANK.SUBMERCHANTFACILITATORID": "1512531515", "INGBANK.SUBMERCHANTORGANIZATIONID": "52523525253", "INGBANK.SUBMERCHANTID": "7121363216"}
  
• SEKERBANK
  {"SEKERBANK.SUBMERCHANTID": "340410030", "SEKERBANK.SUBMERCHANTNAME": "CYBERSOFTPF", "SEKERBANK.SUBMERCHANTCITY": "ISTANBUL", "SEKERBANK.SUBMERCHANTCOUNTRY": "792", "SEKERBANK.SUBMERCHANTPOSTALCODE": "81410", "SEKERBANK.SUBMERCHANTMCC": "2233"}
  
• ODEABANK
  { "ODEABANK.PAYMENTFACILITATORID":"string", "ODEABANK.SUBMERCHANTID":"string", "ODEABANK.INDSALESORGID":"string", "ODEABANK.SUBMERCHANTMCC":"string", "ODEABANK.CARDACCEPTORNAME":"string", "ODEABANK.CARDACCEPTORSTREET":"string", "ODEABANK.CARDACCEPTORCITY":string "ODEABANK.CARDACCEPTORPOSTALCODE":string, "ODEABANK.CARDACCEPTORSTATE":"string" "ODEABANK.CARDACCEPTORCOUNTRY:string}
• ANADOLU
  { "ANADOLU.SUBMERCHANTNAME":"string", "ANADOLU.SUBMERCHANTID":"string", "ANADOLU.SUBMERCHANTPOSTALCODE":"string", "ANADOLU.SUBMERCHANTCITY":"string", "ANADOLU.SUBMERCHANTCOUNTRY":"string", "ANADOLU.SUBMERCHANTMCC":"string" }
• TEB
  {
  "TEB.SUBMERCHANTNAME": "SubMerchantName" }
  
• VPOSTIMEOUT - Specify VPOS timeout in seconds - Works for Nestpay, Garanti, Denizbank, Vakifbank, HSBC. Example: {"VPOSTIMEOUT":30}
• ALBARAKA
  { "ALBARAKA.SUBDEALERCODE":"string", "ALBARAKA.TCKN":"string", "ALBARAKA.TAXID":"string" "AlbarakaMailOrder":"YES or NO" (default:NO) }
• KUVEYTTURK
  { "KUVEYTURK.DESCRIPTION":"string", "KUVEYTURK.IDENTITYTAXNUMBER":"string", "KUVEYTURK.DEFERRINGCOUNT":"string", "KUVEYTURK.SUBMERCHANTID":"string", "KUVEYTURK.SUBMERCHANTIDENTITYTAXNUMBER":"string", "KUVEYTURK.VPOSSUBMERCHANTID":"string",
  "KUVEYTURK.BKMID":"string" }
• ZIRAATBANKKURUMSALKART
  Equal installments
  {
  "ZIRAATBANKKURUMSALKART.KURUMSALKARTISLEMTIPI": "ESITTAKSITLISATIS",
  "ZIRAATBANKKURUMSALKART.TAKSITVEYAVADESAYISI": "5",
  "ZIRAATBANKKURUMSALKART.ODEMEPERIYODU": "2"
  }
  
  Flexible installments - up to 12 installments (MIKTAR_*, TARIH_*)
  {
  "ZIRAATBANKKURUMSALKART.KURUMSALKARTISLEMTIPI": "ESNEKTAKSITLISATIS",
  "ZIRAATBANKKURUMSALKART.TAKSITVEYAVADESAYISI": "3",
  "ZIRAATBANKKURUMSALKART.MIKTAR_1": "100",
  "ZIRAATBANKKURUMSALKART.TARIH_1": "20210916",
  "ZIRAATBANKKURUMSALKART.MIKTAR_2": "50",
  "ZIRAATBANKKURUMSALKART.TARIH_2": "20210916",
  "ZIRAATBANKKURUMSALKART.MIKTAR_3": "50",
  "ZIRAATBANKKURUMSALKART.TARIH_3": "20210916",
  }
  
• MULTINET
  { "MULTINET.MERCHANTPRODUCTID": "142" }
  
• PARATIKA
  { "ParatikaMerchantId": "10000000",
  "MerchantKey":"testKey",
  "ParatikaSellerItems":
  [{"productCode": "Sellers1","amount": 55,"name": "keyboard", "description": "OYUN BİLGİSAYARI","quantity": 1, "productCategoryCode": "4722", "sellerId": "TRFONGG2020001", "sellerPaymentAmount":55}] }

Notification Integration Model

• Example: {"NOTIFICATION_INTEGRATION_MODEL" : "API"} or {"NOTIFICATION_INTEGRATION_MODEL" : "DIRECTPOST_THREED"} or {"NOTIFICATION_INTEGRATION_MODEL" : "DIRECTPOST_NON_THREED"} or

CUSTOMFIELDS:

string, optional Max length: 4000 This parameter should be sent in JSON Array with UTF-8 URL-Encoded format. "integrationCode" and "value" are required when sending this parameter.
Example:[{"code":"code","name":"Field Name","value":"Field Value","group":"Group","integrationCode":"IntegrationCode"},{},{}]

Detached Refund

A Detached Refund allows you to send funds to a customer without the original associated transaction. Detached refund is only supported for Finans and Is Bank payment systems.

Request parameters

ACTION:

DETACHEDREFUND, required Max length: 128 Description to be provided

MERCHANT:

string, required Max length: 128 Merchant ID, merchant business code defined in Payten Payment Gateway.

MERCHANTUSER:

string, required Max length: 128 Merchant API User Email

MERCHANTPASSWORD:

string, required Max length: 128 Merchant API User Password

MERCHANTPAYMENTID:

string, required Max length: 128 Payment ID given by Merchant (it must be unique).The character length of MerchantPaymentID varies according to the virtual POS bank. Our recommended maximum length value is 40 characters. Apart from this, the character lengths of the banks should be taken into account. If you are sending a transaction to the PARATIKA application via Payten Payment Gateway, you should send the MerchantPaymentID with a maximum value that is 9 characters shorter. This is because PARATIKA application adds +9 characters to the value sent from the Payten Payment Gateway.
Raiffeisenbank Virtual POS Note: If you are using Raiffeisenbank's Virtual POS or sending transactions to Raiffeisenbank, the MERCHANTPAYMENTID must be limited to a maximum of 20 characters, as this is the maximum supported by the bank.

AMOUNT:

decimal, required Max length: 30 Amount of payment / transaction. Please note that, this amount is tax included, MSU doesn't consider any other tax calculation.

CURRENCY:

string, required Max length: 3 ISO Alpha transaction currency code like EUR, USD, GBP. See all possible values (37)

PAYMENTSYSTEM:

string, required Max length: 128 Name of the payment system (bank payment gateway / vPOS account). Specified name should match the one given in Payten Payment Gateway If not provided, Payten Payment Gateway smart switch feature will be used.

INSTALLMENTS:

integer, optional Max length: 2 Number of installments. Specified number should exist in Payten Payment Gateway as “defined installment”

CUSTOMER:

string, required Max length: 128 The Merchant System ID for customer. It must be unique within a Merchant.

CUSTOMERNAME:

string, optional Max length: 128 Name of the Customer.

CUSTOMEREMAIL:

string, optional Max length: 64 Customer e-mail.

CUSTOMERPHONE:

string, optional Max length: 64 Customer phone / mobile number.

CARDTOKEN:

string, conditional Max length: 64 Numeric value replacing card number & expiry date. Required when none of the other card information are provided. If the user wants to make a transaction with the card he/she has previously registered, this unique token is used instead of the card number and expiry date.

NAMEONCARD:

string, conditional Max length: 64 Name on the card.

CARDPAN:

string, conditional Max length: 23 PAN number of the card.

CARDEXPIRY:

string, conditional Max length: 7 Expiry date of the card. Format should be [mm.yy].

CARDCVV:

string, optional Max length: 4 Security number of the card.

CARDPANTYPE:

string, optional Max length: 32 description See all possible values (1)

EXTRA:

string, optional Max length: 4000

Extra Parameter is a custom parameter that is used to pass certain parameters for different banks or other usage. This parameter gets its argument as a JSON(URL encoded) format which is then parsed. EXTRA: {"Name" : Value}

Parameters

Below are given parameters that can be sent on extra and examples for each of them. (parameter name is case-insensitive)

• SaveCard - parameter to differentiate if card should be saved or not. Possible values: YES/NO.
  {"SaveCard": "NO"}
• PopUpOpenWhenChecked - shows Card Saving Terms and Conditions when they are accepted (checked). Possible values: YES/NO.
  {"PopUpOpenWhenChecked": "NO"}
• SAVECARDREMINDERPOPUP - shows a popup that gives the user the option to save the card after a successful Hosted Payment Page payment. Possible values: YES/NO.
  {"SAVECARDREMINDERPOPUP": "YES"}
• BNPLREMINDERPOPUP - shows a popup that gives the user the option to go back to the payment page and continue with loan payment after a failed card transaction on the Hosted Payment Page. Possible values: YES/NO.
  {"BNPLREMINDERPOPUP": "YES"}
• ForceSave - parameter to differentiate if card should be forced to be saved or not. ForceSave and SaveCard can not be sent together. ForceSave has priority over SaveCard. Possible values: YES/NO.
  {"ForceSave": "NO"}
• ListCard - parameter to differentiate if Registered Card panel should be displayed on Wallet Page or not. Registered Cards by default are enabled on Wallet Page. Possible values: YES/NO.
  {"ListCard": "NO"}
• CVV - parameter to differentiate if CVV should be given on HPP or not. CVV input by default is enabled on HPP. Possible values: YES/NO.
  {"CVV": "NO"}
• MailOrder - parameter to specify which merchants' transactions will be sent with moto label autotmatically. Possible values: YES/NO.
  {"MailOrder": "NO"}
• PREAUTH - parameter used to process 3D transactions as a PreAuth transaction instead of Sale. Possible values: YES/NO.
  {"PREAUTH":"YES"}
• SubMerchantCode - additional parameter sent to bank during financial transactions.
  {"SubMerchantCode": "70885124022"}
• IsbankBolumKodu - additional parameter for transactions sent to Isbank, default value is 1.
  {"IsbankBolumKodu": 1}
• IsbankGroupId - additional parameter for transactions sent to Isbank
  {"ISBANK.GROUPID": "string"}
• IMMEDIATEREDIRECTION - redirect immediately to customer URL on successful action, default value is NO.
  {"IMMEDIATEREDIRECTION": "YES"}
• RETURNSCRIPT - if this parameter is sent, the js function sent will be called after a successful card save on wallet page.
  {"RETURNSCRIPT": JS Function provided by merchant!}
• HalkbankKobiKartDestek - if this parameter is sent, Halkbank Kobi Kart tab will be shown on Default HPP. Possible values: YES/NO.
  {"HalkbankKobiKartDestek":"YES"}
• ReturnTime - return time to merchant return url after payment has been processed.
  {"ReturnTime": 2}
• DealerCode - parameter that indicates dealers, when transactions are made. Unique for every dealer.
  {"DealerCode": "Dealer01"}
• QIWI - if this parameter is sent as "YES", authentication is done using GiroGate QIWI payment method. Possible values: YES/NO.
  {"QIWI": "YES"}
• GIROPAY - if this parameter is sent as "YES", authentication is done using GiroGate GIROPAY payment method. Possible values: YES/NO.
  {"GIROPAY": "YES"}
• IDEAL - if this parameter is sent as "YES", authentication is done using GiroGate IDEAL payment method. Possible values: YES/NO.
  {"IDEAL": "YES"}
• SOFORT - if this parameter is sent as "YES", authentication is done using GiroGate SOFORT payment method. Possible values: YES/NO.
  {"SOFORT": "YES"}
• EPS - if this parameter is sent as "YES", authentication is done using GiroGate EPS payment method. Possible values: YES/NO.
  {"EPS": "YES"}
• MULTIBANCO - if this parameter is sent as "YES", authentication is done using GiroGate MULTIBANCO payment method. Possible values: YES/NO.
  {"MULTIBANCO": "YES"}
• MYBANK - if this parameter is sent as "YES", authentication is done using GiroGate MYBANK payment method. Possible values: YES/NO.
  {"MYBANK": "YES"}
• BANCONTACT - if this parameter is sent as "YES", authentication is done using GiroGate BANCONTACT payment method. Possible values: YES/NO.
  {"BANCONTACT": "YES"}
• TRUSTPAY - if this parameter is sent as "YES", authentication is done using GiroGate TRUSTPAY payment method. Possible values: YES/NO.
  {"TRUSTPAY": "YES"}
• SAFETYPAY - if this parameter is sent as "YES", authentication is done using GiroGate SAFETYPAY payment method. Possible values: YES/NO.
  {"SAFETYPAY": "YES"}
• P24 - if this parameter is sent as "YES", authentication is done using GiroGate P24 payment method. Possible values: YES/NO.
  {"P24": "YES"}
• FINNISHONLINEBANKING - if this parameter is sent as "YES", authentication is done using GiroGate FINNISHONLINEBANKING payment method. Possible values: YES/NO.
  {"FINNISHONLINEBANKING": "YES"}
• BOLETO - if this parameter is sent as "YES", authentication is done using GiroGate BOLETO payment method. Possible values: YES/NO.
  {"BOLETO": "YES"}
• ELO - if this parameter is sent as "YES", authentication is done using GiroGate ELO payment method. Possible values: YES/NO.
  {"ELO": "YES"}
• SEPA - if this parameter is sent as "YES", authentication is done using GiroGate SEPA payment method. Possible values: YES/NO.
  {"SEPA": "YES"}
• ALIPAY - if this parameter is sent as "YES", authentication is done using GiroGate ALIPAY payment method. Possible values: YES/NO.
  {"ALIPAY": "YES"}
• COMMERCECODES - if this parameter should be sent as JSON Array of only strings, maximum installments available to card holder will be set in the payments. Possible values: 1-99
  {"COMMERCECODES":["10","20","30"]}
• ReflectCommission - if this parameter is sent as "YES" and DealerCode extra parameter is provided, commission is reflected to amount. It works only for dealers.
  {"ReflectCommission":"YES", "DealerCode":"Dealer01"}
• IgnoreRates - if this parameter is sent as "YES" and DealerCode extra parameter is provided, commission is not reflected to amount. It works only for dealers.
  {"IgnoreRates":"YES", "DealerCode":"Dealer01"}
• User - parameter that indicates the user, who has done payment on behalf of customer.
  {"USER":"user@email.com"}
• SIPAY - if this parameter is sent, Sipay tab will be shown on Default HPP. Possible values: YES/NO.
  {"SIPAY":"YES"}
• WECHATPAY - if this parameter is sent as "YES", authentication is done using GiroGate WECHATPAY payment method. Possible values: YES/NO.
  {"WECHATPAY": "YES"}
• IframeDomainUrl - indicates from which URL address payment will be proceesed.
  {"IframeDomainUrl": "www.w3school.com"}
• APPLYADDITIONALMATURITY - if this parameter is sent as "YES", payment type maturity commissions will be applied to the installments. Possible values: YES/NO.
  {"APPLYADDITIONALMATURITY": "YES"}
• DealerUserEmail - It represents the email of dealer user.
• AxessMobil.Enabled - Activate Axess Mobil Tab. Possible values: YES/NO.
  {"AxessMobil.Enabled": "NO"}
• AxessMobil.PaymentSystem - Activate Axess Mobil Tab. Possible values: StringValue.
  {"AxessMobil.PaymentSystem": "PaymentSystem"}
• COMPAY.LOAN - Activate Compay Loan Tab. Possible values: YES/NO.
  {"COMPAY.LOAN": "YES"}
• COMPAY.TRANSFER - Activate Compay Transfer Tab. Possible values: YES/NO.
  {"COMPAY.TRANSFER": "YES"}
• PAPARA.PAYMENT - Activate Papara Payment Tab. Possible values: YES/NO.
  {"PAPARA.PAYMENT": "YES"}
• INVOICETYPES - used in EXTRA of QUERYINVOICE to query multiple Invoice Types. It is sent as JSON Array. Possible values: SALE, PREAUTH and DISCOUNT.
  {"INVOICETYPES": ["SALE", "DISCOUNT"]}
• SubCustomer - parameter to differentiate the cards of same the customer.
  {"SubCustomer": "SubCustomer1"}
• InvoiceId - parameter to send id of invoice to pay it from other payment pages.
  {"InvoiceId": "id"}
• DealerCode - parameter to send code of dealer of associated invoice to be paid.
  {"DealerCode": "code"}
giu0009

Split payment parameters

• SpCode - unique code for split payment.
  {"SpCode":"Code-1234567890"}
• SpMaxSplitCount - maximum splits that can be done during payment.
  {"SpMaxSplitCount":3}
• SpTotalAmount - total amount for a split payment.
  {"SpTotalAmount":50}
• SpBusinessMaxInst
  {"SpBusinessMaxInst":4}
• SpPersonalMaxInst
  {"SpPersonalMaxInst":3}
• SpGroupNumber - field for grouping split payments.
  {"SpGroupNumber":"Code-1234"}

Other bank parameters

• BKMEXPRESS - include BKMExpressV2 payment system name like below to have BKM Express tab on Default HPP
  {"BkmExpressV2PaymentSystem":"PaymentSystemName"}
• GARANTIPAY - include GarantiPay payment system name like below to have GarantiPay tab on Default HPP
  {"GarantiPayPaymentSystem":"PaymentSystemName"}
• GARANTI - include "GarantiSubMerchantCode" parameter to override default "SubMerchantCode" parameter
  {"GarantiSubMerchantCode":"123456789"}
• YKB - include "YkbSubMerchantCode" parameter to override default "SubMerchantCode" parameter
  {"YkbSubMerchantCode":"123456789"}
  For payment faciliatior options use:
  {
  "YKB.subMrcId": "152135125",
  "YKB.mrcPfId": "1531235126",
  "YKB.mcc": "1325"
  }
  
• Vakifbank - For insurance companies payments made with submerchant include one of the parameters below:
  {"VakifbankSubMerchantCode":"SubMerchantCode"} or
  {"VakifbankIdentity":"123456789"}
• VAKIFBANK TOS REFUND SERVICE
  {"VakifbankRefundService.RECIPIENTBRANCHCODE":"testBranchCode",
  "VakifbankRefundService.RECIPIENTBANKCODE":"testBankCode",
  "VakifbankRefundService.PAYMENTDATE":"dd-MM-yyyy HH:mm",
  "VakifbankRefundService.DESCRIPTION":"description" }

Payment Facilitator (PF) fields shown below can be sent in EXTRA field in the following way.

• ISBANK
  {"ISBANK.SUBMERCHANTID": 65504389},{"ISBANK.SUBMERCHANTPOSTALCODE": 34234},{"ISBANK.SUBMERCHANTCITY": İstanbul},ISBANK.SUBMERCHANTCOUNTRY": Türkiye},{"ISBANK.SUBMERCHANTMCC": 4829},{"ISBANK.SUBMERCHANTNIN": 123456789},,{"ISBANK.SUBMERCHANTURL": www.merchanturl.com}, {"ISBANK.ORDERTYPE": "01"}, {"ISBANK.ORDERSUBTYPE": "01"}
• DENIZBANK
  {"SubMerchantCode": 123456789012345}
• ZIRAATBANK
  {"SubMerchantCode": VKN/TCKN}
• AKBANK
  {"AKBANK.SUBMERCHANTID": 65504389},{"AKBANK.SUBMERCHANTPOSTALCODE": 34234},{"AKBANK.SUBMERCHANTCITY": İstanbul},{"AKBANK.SUBMERCHANTCOUNTRY": Türkiye},{"AKBANK.SUBMERCHANTMCC": 4829},{"AKBANK.SUBMERCHANTNIN": 123456789},{"AKBANK.SUBMERCHANTURL": www.merchanturl.com},{"AKBANK.VISASUBMERCHANTID": 000000},{"AKBANK.VISAPFID": 1111111},{"AKBANK.PAYMENTMETHOD": AKBANKCUZDAN},{"AKBANK.MOBILEECI": 300},{"AKBANK.WALLETPROGRAMDATA": 300},{"AKBANK.MOBILEASSIGNED": 300000},{"AKBANK.MOBILEDEVICETYPE": 10}
• HALKKOBIKART {"HALKKOBIKART.SUBMERCHANTNAME":"string", "HALKKOBIKART.SUBMERCHANTID":"string", "HALKKOBIKART.SUBMERCHANTPOSTALCODE":"string", "HALKKOBIKART.SUBMERCHANTCITY":"string", "HALKKOBIKART.SUBMERCHANTCOUNTRY":"string", "HALKKOBIKART.SUBMERCHANTMCC":"string", "HALKKOBIKART.HALKKOBIKARTDESTEK":"Yes/No", "HALKKOBIKART.OZELTAKSITLIISLEM":"S/E", "HALKKOBIKART.ODEMESIKLIGI":"1 if OZELTAKSITLIISLEM=E", "HALKKOBIKART.MIKTAR_[1-12]":"decimal", "HALKKOBIKART.TARIH_[1-12]":"YYYYMMDD "}
• HALKBANK
  {"HALKBANK.SUBMERCHANTPOSTALCODE": "153123512", "HALKBANK.SUBMERCHANTNAME": "SubMerchantName", "HALKBANK.SUBMERCHANTMCC": "1535", "HALKBANK.SUBMERCHANTID": "5353535", "HALKBANK.SUBMERCHANTCOUNTRY": "Country", "HALKBANK.SUBMERCHANTCITY": "City"}
  
• TURKIYEFINANS
  {"TURKIYEFINANS.SUBMERCHANTNAME": ASSECOTFKB},{"TURKIYEFINANS.SUBMERCHANTID": 9586886},{"TURKIYEFINANS.SUBMERCHANTCITY": ISTANBUL},{TURKIYEFINANS.SUBMERCHANTCOUNTRY": TR},{"TURKIYEFINANS.SUBMERCHANTMCC": 4814},{"TURKIYEFINANS.SUBMERCHANTFACILITATORID": 00516941},{"TURKIYEFINANS.SUBMERCHANTPOSTALCODE": 34467}
• VAKIFBANK
  {"HostSubmerchantID": ASSECOTFKB}
• QNBFinansSubMerchantCode - Sub merchant code for only new QNB Finansbank
  {"QNBFinansSubMerchantCode": "345"}
• QNBFINANSBANK
  {"QNBFINANS.PAYMENTFACILITATORID": "13151251235", "QNBFINANS.SUBMERCHANTCODE": "56126262345", "QNBFINANS.INDSALESORGID": "9982522523", "QNBFINANS.SUBMERCHANTMCC": "4343", "QNBFINANS.CARDACCEPTORNAME": "AcceptorName", "QNBFINANS.CARDACCEPTORCITY": "AcceptorCity", "QNBFINANS.CARDACCEPTORPOSTALCODE": "AcceptorPostalCode", "QNBFINANS.CARDACCEPTORSTREET": "AcceptorStreet", "QNBFINANS.CARDACCEPTORCOUNTRY": "AcceptorCountry", "QNBFINANS.CARDACCEPTORSTATE": "AcceptorState"}
  
• INGBANK
  {"INGBANK.SUBMERCHANTMCC": "143", "INGBANK.SUBMERCHANTPOSTALCODE": "00000", "INGBANK.SUBMERCHANTNAME": "Name", "INGBANK.SUBMERCHANTCITY": "City", "INGBANK.SUBMERCHANTCOUNTRY": "Country", "INGBANK.SUBMERCHANTFACILITATORID": "1512531515", "INGBANK.SUBMERCHANTORGANIZATIONID": "52523525253", "INGBANK.SUBMERCHANTID": "7121363216"}
  
• SEKERBANK
  {"SEKERBANK.SUBMERCHANTID": "340410030", "SEKERBANK.SUBMERCHANTNAME": "CYBERSOFTPF", "SEKERBANK.SUBMERCHANTCITY": "ISTANBUL", "SEKERBANK.SUBMERCHANTCOUNTRY": "792", "SEKERBANK.SUBMERCHANTPOSTALCODE": "81410", "SEKERBANK.SUBMERCHANTMCC": "2233"}
  
• ODEABANK
  { "ODEABANK.PAYMENTFACILITATORID":"string", "ODEABANK.SUBMERCHANTID":"string", "ODEABANK.INDSALESORGID":"string", "ODEABANK.SUBMERCHANTMCC":"string", "ODEABANK.CARDACCEPTORNAME":"string", "ODEABANK.CARDACCEPTORSTREET":"string", "ODEABANK.CARDACCEPTORCITY":string "ODEABANK.CARDACCEPTORPOSTALCODE":string, "ODEABANK.CARDACCEPTORSTATE":"string" "ODEABANK.CARDACCEPTORCOUNTRY:string}
• ANADOLU
  { "ANADOLU.SUBMERCHANTNAME":"string", "ANADOLU.SUBMERCHANTID":"string", "ANADOLU.SUBMERCHANTPOSTALCODE":"string", "ANADOLU.SUBMERCHANTCITY":"string", "ANADOLU.SUBMERCHANTCOUNTRY":"string", "ANADOLU.SUBMERCHANTMCC":"string" }
• TEB
  {
  "TEB.SUBMERCHANTNAME": "SubMerchantName" }
  
• VPOSTIMEOUT - Specify VPOS timeout in seconds - Works for Nestpay, Garanti, Denizbank, Vakifbank, HSBC. Example: {"VPOSTIMEOUT":30}
• ALBARAKA
  { "ALBARAKA.SUBDEALERCODE":"string", "ALBARAKA.TCKN":"string", "ALBARAKA.TAXID":"string" "AlbarakaMailOrder":"YES or NO" (default:NO) }
• KUVEYTTURK
  { "KUVEYTURK.DESCRIPTION":"string", "KUVEYTURK.IDENTITYTAXNUMBER":"string", "KUVEYTURK.DEFERRINGCOUNT":"string", "KUVEYTURK.SUBMERCHANTID":"string", "KUVEYTURK.SUBMERCHANTIDENTITYTAXNUMBER":"string", "KUVEYTURK.VPOSSUBMERCHANTID":"string",
  "KUVEYTURK.BKMID":"string" }
• ZIRAATBANKKURUMSALKART
  Equal installments
  {
  "ZIRAATBANKKURUMSALKART.KURUMSALKARTISLEMTIPI": "ESITTAKSITLISATIS",
  "ZIRAATBANKKURUMSALKART.TAKSITVEYAVADESAYISI": "5",
  "ZIRAATBANKKURUMSALKART.ODEMEPERIYODU": "2"
  }
  
  Flexible installments - up to 12 installments (MIKTAR_*, TARIH_*)
  {
  "ZIRAATBANKKURUMSALKART.KURUMSALKARTISLEMTIPI": "ESNEKTAKSITLISATIS",
  "ZIRAATBANKKURUMSALKART.TAKSITVEYAVADESAYISI": "3",
  "ZIRAATBANKKURUMSALKART.MIKTAR_1": "100",
  "ZIRAATBANKKURUMSALKART.TARIH_1": "20210916",
  "ZIRAATBANKKURUMSALKART.MIKTAR_2": "50",
  "ZIRAATBANKKURUMSALKART.TARIH_2": "20210916",
  "ZIRAATBANKKURUMSALKART.MIKTAR_3": "50",
  "ZIRAATBANKKURUMSALKART.TARIH_3": "20210916",
  }
  
• MULTINET
  { "MULTINET.MERCHANTPRODUCTID": "142" }
  
• PARATIKA
  { "ParatikaMerchantId": "10000000",
  "MerchantKey":"testKey",
  "ParatikaSellerItems":
  [{"productCode": "Sellers1","amount": 55,"name": "keyboard", "description": "OYUN BİLGİSAYARI","quantity": 1, "productCategoryCode": "4722", "sellerId": "TRFONGG2020001", "sellerPaymentAmount":55}] }

Notification Integration Model

• Example: {"NOTIFICATION_INTEGRATION_MODEL" : "API"} or {"NOTIFICATION_INTEGRATION_MODEL" : "DIRECTPOST_THREED"} or {"NOTIFICATION_INTEGRATION_MODEL" : "DIRECTPOST_NON_THREED"} or

External Refund

EXTERNALREFUND API for refunding transactions in external systems. Same PaymentSystem credentials have to be used when the primary transaction is processed.

Request parameters

ACTION:

EXTERNALREFUND, required Max length: 128 Description to be provided

MERCHANT:

string, required Max length: 128 Merchant ID, merchant business code defined in Payten Payment Gateway.

MERCHANTUSER:

string, required Max length: 128 Merchant API User Email

MERCHANTPASSWORD:

string, required Max length: 128 Merchant API User Password

PAYMENTSYSTEM:

string, required Max length: 128 Name of the payment system (bank payment gateway / vPOS account). Specified name should match the one given in Payten Payment Gateway If not provided, Payten Payment Gateway smart switch feature will be used.

AMOUNT:

decimal, required Max length: 30 Amount of payment / transaction. Please note that, this amount is tax included, MSU doesn't consider any other tax calculation.

CURRENCY:

string, required Max length: 3 ISO Alpha transaction currency code like EUR, USD, GBP. See all possible values (37)

CUSTOMER:

string, optional Max length: 128 The Merchant System ID for customer. It must be unique within a Merchant.

CUSTOMERNAME:

string, optional Max length: 128 Name of the Customer.

CUSTOMEREMAIL:

string, optional Max length: 64 Customer e-mail.

CUSTOMERPHONE:

string, optional Max length: 64 Customer phone / mobile number.

TCKN:

string, optional Max length: 11 Identity Number. Required when VKN is not provided.

VKN:

string, optional Max length: 11 Taxpayer Identification Number. Required when TCKN is not provided.

MERCHANTPAYMENTID:

string, required Max length: 128 Payment ID given by Merchant (it must be unique).The character length of MerchantPaymentID varies according to the virtual POS bank. Our recommended maximum length value is 40 characters. Apart from this, the character lengths of the banks should be taken into account. If you are sending a transaction to the PARATIKA application via Payten Payment Gateway, you should send the MerchantPaymentID with a maximum value that is 9 characters shorter. This is because PARATIKA application adds +9 characters to the value sent from the Payten Payment Gateway.
Raiffeisenbank Virtual POS Note: If you are using Raiffeisenbank's Virtual POS or sending transactions to Raiffeisenbank, the MERCHANTPAYMENTID must be limited to a maximum of 20 characters, as this is the maximum supported by the bank.

CUSTOMFIELDS:

string, optional Max length: 4000 This parameter should be sent in JSON Array with UTF-8 URL-Encoded format. "integrationCode" and "value" are required when sending this parameter.
Example:[{"code":"code","name":"Field Name","value":"Field Value","group":"Group","integrationCode":"IntegrationCode"},{},{}]

Bank Based Mappings for MERCHANTPAYMENTID

• YKB: OrderId
• AKBANK,FINANS,ISBANK: OrderId
• DENIZBANK: OrderId
• GARANTI: OrderId
• ODEABANK: OrderId
• VAKIFBANK: OrderId
• OTHERS: "ERR10072 - External refund is not supported by selected payment system" message is given

QR Payment

The Proxy QR Payment API provides a seamless and secure method for facilitating financial transactions through proxy QR codes. This API is designed to enable businesses and developers to integrate QR code-based payment solutions into their applications, allowing users to make transactions conveniently and securely.

Request parameters

ACTION:

QRPAYMENT, required Max length: 128 Description to be provided

MERCHANTUSER:

string, conditional Max length: 128 Merchant API User Email

MERCHANTPASSWORD:

string, conditional Max length: 128 Merchant API User Password

MERCHANT:

string, conditional Max length: 128 Merchant ID, merchant business code defined in Payten Payment Gateway.

SESSIONTOKEN:

string, conditional Max length: 48 It is a unique value that contains the values for the transaction.

MERCHANTPAYMENTID:

string, conditional Max length: 128 Payment ID given by Merchant (it must be unique).The character length of MerchantPaymentID varies according to the virtual POS bank. Our recommended maximum length value is 40 characters. Apart from this, the character lengths of the banks should be taken into account. If you are sending a transaction to the PARATIKA application via Payten Payment Gateway, you should send the MerchantPaymentID with a maximum value that is 9 characters shorter. This is because PARATIKA application adds +9 characters to the value sent from the Payten Payment Gateway.
Raiffeisenbank Virtual POS Note: If you are using Raiffeisenbank's Virtual POS or sending transactions to Raiffeisenbank, the MERCHANTPAYMENTID must be limited to a maximum of 20 characters, as this is the maximum supported by the bank.

AMOUNT:

decimal, conditional Max length: 30 Amount of payment / transaction. Please note that, this amount is tax included, MSU doesn't consider any other tax calculation.

CURRENCY:

string, conditional Max length: 3 ISO Alpha transaction currency code like EUR, USD, GBP. See all possible values (37)

CUSTOMERNAME:

string, optional Max length: 128 Name of the Customer.

CUSTOMERIP:

string, conditional Max length: 128 CUSTOMERIP parameter is mandatory if the payment system is Paratika and for the PAYCELL DCB transactions.

PAYMENTSYSTEMTYPE:

string, required Max length: 32 Payment System Type See all possible values (98)

INSTALLMENTS:

integer, optional Max length: 2 Default value: '1' Number of installments. Specified number should exist in Payten Payment Gateway as “defined installment”

THREED:

string, optional Max length: 3 description See all possible values (2)

QRTOKENID:

string, optional Max length: 30 description

Approve Actions

Approval mechanism for different types of objects in Payten Payment Gateway are listed and explained below.

Approve Transaction

Transactions that are flagged as Waiting for Approval will be approved and processed through this call.

Request parameters

ACTION:

APPROVETRANSACTION, required Max length: 128 Description to be provided

SESSIONTOKEN:

string, conditional Max length: 48 It is a unique value that contains the values for the transaction.

MERCHANT:

string, conditional Max length: 128 Merchant ID, merchant business code defined in Payten Payment Gateway.

MERCHANTUSER:

string, conditional Max length: 128 Merchant API User Email

MERCHANTPASSWORD:

string, conditional Max length: 128 Merchant API User Password

PGTRANID:

string, required Max length: 64 Transaction ID given by payment gateway.

Approve Dealer

The DEALERAPPROVE action lets you to APPROVE the Dealer that was requested to be Enabled. After approving the Dealer will be enabled again

Request parameters

ACTION:

DEALERAPPROVE, required Max length: 128 Description to be provided

SESSIONTOKEN:

string, conditional Max length: 48 It is a unique value that contains the values for the transaction.

MERCHANT:

string, conditional Max length: 128 Merchant ID, merchant business code defined in Payten Payment Gateway.

MERCHANTUSER:

string, conditional Max length: 128 Merchant API User Email

MERCHANTPASSWORD:

string, conditional Max length: 128 Merchant API User Password

DEALERCODE:

string, required Max length: 32 The Dealer Code area at the B2B Admin Panel > Dealer > Dealer Types section is "Dealer Code".

Reject Actions

Rejection of different types of objects in Payten Payment Gateway are listed and explained below.

Approve Transaction

A transaction may be waiting for a first or last approval. This API Action rejects it by setting its status to RJ(Rejected))

Request parameters

ACTION:

REJECTTRANSACTION, required Max length: 128 Description to be provided

SESSIONTOKEN:

string, conditional Max length: 48 It is a unique value that contains the values for the transaction.

MERCHANT:

string, conditional Max length: 128 Merchant ID, merchant business code defined in Payten Payment Gateway.

MERCHANTUSER:

string, conditional Max length: 128 Merchant API User Email

MERCHANTPASSWORD:

string, conditional Max length: 128 Merchant API User Password

MERCHANTPAYMENTID:

string, conditional Max length: 128 Payment ID given by Merchant (it must be unique).The character length of MerchantPaymentID varies according to the virtual POS bank. Our recommended maximum length value is 40 characters. Apart from this, the character lengths of the banks should be taken into account. If you are sending a transaction to the PARATIKA application via Payten Payment Gateway, you should send the MerchantPaymentID with a maximum value that is 9 characters shorter. This is because PARATIKA application adds +9 characters to the value sent from the Payten Payment Gateway.
Raiffeisenbank Virtual POS Note: If you are using Raiffeisenbank's Virtual POS or sending transactions to Raiffeisenbank, the MERCHANTPAYMENTID must be limited to a maximum of 20 characters, as this is the maximum supported by the bank.

Session

Session Token

Session token can be used both for browser based integrations and API integrations. System return a key which has an access to API in a limited time (default 7 days, it is configurable). Generally session token action expect that each session should have an unique merchantPaymentId parameter. In case when you redirect your customer with same parameter set you can use same session token unless it is obey the below criteria:

NOTE: Wallet session which has preauth feature shouldn't contain merchantPaymentId. System use merchantPaymentId generated randomly.

The character length of MerchantPaymentID varies according to the virtual POS bank. Our recommended maximum length value is 40 characters. Apart from this, the character lengths of the banks should be taken into account. If you are sending a transaction to the PARATIKA application via Payten Payment Gateway, you should send the MerchantPaymentID with a maximum value that is 9 characters shorter. This is because PARATIKA application adds +9 characters to the value sent from the Payten Payment Gateway.

Request parameters

ACTION:

SESSIONTOKEN, required Max length: 128 Description to be provided

SESSIONTOKEN:

string, conditional Max length: 48 It is a unique value that contains the values for the transaction.

SESSIONTYPE:

string, required Max length: 30 QUERYOPERATIONSESSION : Used to obtain sessiontoken to be used in query operations.
PAYMENTSESSION : Used to create a payment session.
SPLITPAYMENTSESSION : Used to create a partial payment session.
WALLETSESSION : Used to create a wallet session for payment with a registered card or for payment by registering a card. See all possible values (4)

CUSTOMER:

string, conditional Max length: 128 The Merchant System ID for customer. It must be unique within a Merchant.

RETURNURL:

string, required Max length: 512 description

MERCHANTUSER:

string, conditional Max length: 128 Merchant API User Email

MERCHANTPASSWORD:

string, conditional Max length: 128 Merchant API User Password

MERCHANT:

string, conditional Max length: 128 Merchant ID, merchant business code defined in Payten Payment Gateway.

MERCHANTPAYMENTID:

string, conditional Max length: 128 Payment ID given by Merchant (it must be unique).The character length of MerchantPaymentID varies according to the virtual POS bank. Our recommended maximum length value is 40 characters. Apart from this, the character lengths of the banks should be taken into account. If you are sending a transaction to the PARATIKA application via Payten Payment Gateway, you should send the MerchantPaymentID with a maximum value that is 9 characters shorter. This is because PARATIKA application adds +9 characters to the value sent from the Payten Payment Gateway.
Raiffeisenbank Virtual POS Note: If you are using Raiffeisenbank's Virtual POS or sending transactions to Raiffeisenbank, the MERCHANTPAYMENTID must be limited to a maximum of 20 characters, as this is the maximum supported by the bank.

AMOUNT:

decimal, conditional Max length: 30 Amount of payment / transaction. Please note that, this amount is tax included, MSU doesn't consider any other tax calculation.

CURRENCY:

string, conditional Max length: 3 ISO Alpha transaction currency code like EUR, USD, GBP. See all possible values (37)

CARDPANTYPE:

string, optional Max length: 32 description See all possible values (1)

PAYMENTSYSTEM:

string, optional Max length: 128 Name of the payment system (bank payment gateway / vPOS account). Specified name should match the one given in Payten Payment Gateway If not provided, Payten Payment Gateway smart switch feature will be used.

CUSTOMEREMAIL:

string, optional Max length: 64 Customer e-mail.

CUSTOMERNAME:

string, optional Max length: 128 Name of the Customer.

CUSTOMERPHONE:

string, optional Max length: 64 Customer phone / mobile number.

CUSTOMERIP:

string, optional Max length: 39 CUSTOMERIP parameter is mandatory if the payment system is Paratika and for the PAYCELL DCB transactions.

CUSTOMERUSERAGENT:

string, optional Max length: 4000 description

SESSIONEXPIRY:

string, optional Max length: 5 Default value: '168h' It is the period of time until the session expires.

LANGUAGE:

string, optional Max length: 2 Default value: 'tr' description

CAMPAIGNCODE:

string, optional Max length: 512 A provided code which identifies the campaign defined by merchant.

ORDERITEMS:

string, optional Max length: 100000 Order items as an array in JSON Format. Order items should be URL encoded. Please see the request samples for valid JSON data format.

TMXSESSIONQUERYINPUT:

string, optional Max length: 4000 description

EXTRA:

string, optional Max length: 4000

Extra Parameter is a custom parameter that is used to pass certain parameters for different banks or other usage. This parameter gets its argument as a JSON(URL encoded) format which is then parsed. EXTRA: {"Name" : Value}

Parameters

Below are given parameters that can be sent on extra and examples for each of them. (parameter name is case-insensitive)

• SaveCard - parameter to differentiate if card should be saved or not. Possible values: YES/NO.
  {"SaveCard": "NO"}
• PopUpOpenWhenChecked - shows Card Saving Terms and Conditions when they are accepted (checked). Possible values: YES/NO.
  {"PopUpOpenWhenChecked": "NO"}
• SAVECARDREMINDERPOPUP - shows a popup that gives the user the option to save the card after a successful Hosted Payment Page payment. Possible values: YES/NO.
  {"SAVECARDREMINDERPOPUP": "YES"}
• BNPLREMINDERPOPUP - shows a popup that gives the user the option to go back to the payment page and continue with loan payment after a failed card transaction on the Hosted Payment Page. Possible values: YES/NO.
  {"BNPLREMINDERPOPUP": "YES"}
• ForceSave - parameter to differentiate if card should be forced to be saved or not. ForceSave and SaveCard can not be sent together. ForceSave has priority over SaveCard. Possible values: YES/NO.
  {"ForceSave": "NO"}
• ListCard - parameter to differentiate if Registered Card panel should be displayed on Wallet Page or not. Registered Cards by default are enabled on Wallet Page. Possible values: YES/NO.
  {"ListCard": "NO"}
• CVV - parameter to differentiate if CVV should be given on HPP or not. CVV input by default is enabled on HPP. Possible values: YES/NO.
  {"CVV": "NO"}
• MailOrder - parameter to specify which merchants' transactions will be sent with moto label autotmatically. Possible values: YES/NO.
  {"MailOrder": "NO"}
• PREAUTH - parameter used to process 3D transactions as a PreAuth transaction instead of Sale. Possible values: YES/NO.
  {"PREAUTH":"YES"}
• SubMerchantCode - additional parameter sent to bank during financial transactions.
  {"SubMerchantCode": "70885124022"}
• IsbankBolumKodu - additional parameter for transactions sent to Isbank, default value is 1.
  {"IsbankBolumKodu": 1}
• IsbankGroupId - additional parameter for transactions sent to Isbank
  {"ISBANK.GROUPID": "string"}
• IMMEDIATEREDIRECTION - redirect immediately to customer URL on successful action, default value is NO.
  {"IMMEDIATEREDIRECTION": "YES"}
• RETURNSCRIPT - if this parameter is sent, the js function sent will be called after a successful card save on wallet page.
  {"RETURNSCRIPT": JS Function provided by merchant!}
• HalkbankKobiKartDestek - if this parameter is sent, Halkbank Kobi Kart tab will be shown on Default HPP. Possible values: YES/NO.
  {"HalkbankKobiKartDestek":"YES"}
• ReturnTime - return time to merchant return url after payment has been processed.
  {"ReturnTime": 2}
• DealerCode - parameter that indicates dealers, when transactions are made. Unique for every dealer.
  {"DealerCode": "Dealer01"}
• QIWI - if this parameter is sent as "YES", authentication is done using GiroGate QIWI payment method. Possible values: YES/NO.
  {"QIWI": "YES"}
• GIROPAY - if this parameter is sent as "YES", authentication is done using GiroGate GIROPAY payment method. Possible values: YES/NO.
  {"GIROPAY": "YES"}
• IDEAL - if this parameter is sent as "YES", authentication is done using GiroGate IDEAL payment method. Possible values: YES/NO.
  {"IDEAL": "YES"}
• SOFORT - if this parameter is sent as "YES", authentication is done using GiroGate SOFORT payment method. Possible values: YES/NO.
  {"SOFORT": "YES"}
• EPS - if this parameter is sent as "YES", authentication is done using GiroGate EPS payment method. Possible values: YES/NO.
  {"EPS": "YES"}
• MULTIBANCO - if this parameter is sent as "YES", authentication is done using GiroGate MULTIBANCO payment method. Possible values: YES/NO.
  {"MULTIBANCO": "YES"}
• MYBANK - if this parameter is sent as "YES", authentication is done using GiroGate MYBANK payment method. Possible values: YES/NO.
  {"MYBANK": "YES"}
• BANCONTACT - if this parameter is sent as "YES", authentication is done using GiroGate BANCONTACT payment method. Possible values: YES/NO.
  {"BANCONTACT": "YES"}
• TRUSTPAY - if this parameter is sent as "YES", authentication is done using GiroGate TRUSTPAY payment method. Possible values: YES/NO.
  {"TRUSTPAY": "YES"}
• SAFETYPAY - if this parameter is sent as "YES", authentication is done using GiroGate SAFETYPAY payment method. Possible values: YES/NO.
  {"SAFETYPAY": "YES"}
• P24 - if this parameter is sent as "YES", authentication is done using GiroGate P24 payment method. Possible values: YES/NO.
  {"P24": "YES"}
• FINNISHONLINEBANKING - if this parameter is sent as "YES", authentication is done using GiroGate FINNISHONLINEBANKING payment method. Possible values: YES/NO.
  {"FINNISHONLINEBANKING": "YES"}
• BOLETO - if this parameter is sent as "YES", authentication is done using GiroGate BOLETO payment method. Possible values: YES/NO.
  {"BOLETO": "YES"}
• ELO - if this parameter is sent as "YES", authentication is done using GiroGate ELO payment method. Possible values: YES/NO.
  {"ELO": "YES"}
• SEPA - if this parameter is sent as "YES", authentication is done using GiroGate SEPA payment method. Possible values: YES/NO.
  {"SEPA": "YES"}
• ALIPAY - if this parameter is sent as "YES", authentication is done using GiroGate ALIPAY payment method. Possible values: YES/NO.
  {"ALIPAY": "YES"}
• COMMERCECODES - if this parameter should be sent as JSON Array of only strings, maximum installments available to card holder will be set in the payments. Possible values: 1-99
  {"COMMERCECODES":["10","20","30"]}
• ReflectCommission - if this parameter is sent as "YES" and DealerCode extra parameter is provided, commission is reflected to amount. It works only for dealers.
  {"ReflectCommission":"YES", "DealerCode":"Dealer01"}
• IgnoreRates - if this parameter is sent as "YES" and DealerCode extra parameter is provided, commission is not reflected to amount. It works only for dealers.
  {"IgnoreRates":"YES", "DealerCode":"Dealer01"}
• User - parameter that indicates the user, who has done payment on behalf of customer.
  {"USER":"user@email.com"}
• SIPAY - if this parameter is sent, Sipay tab will be shown on Default HPP. Possible values: YES/NO.
  {"SIPAY":"YES"}
• WECHATPAY - if this parameter is sent as "YES", authentication is done using GiroGate WECHATPAY payment method. Possible values: YES/NO.
  {"WECHATPAY": "YES"}
• IframeDomainUrl - indicates from which URL address payment will be proceesed.
  {"IframeDomainUrl": "www.w3school.com"}
• APPLYADDITIONALMATURITY - if this parameter is sent as "YES", payment type maturity commissions will be applied to the installments. Possible values: YES/NO.
  {"APPLYADDITIONALMATURITY": "YES"}
• DealerUserEmail - It represents the email of dealer user.
• AxessMobil.Enabled - Activate Axess Mobil Tab. Possible values: YES/NO.
  {"AxessMobil.Enabled": "NO"}
• AxessMobil.PaymentSystem - Activate Axess Mobil Tab. Possible values: StringValue.
  {"AxessMobil.PaymentSystem": "PaymentSystem"}
• COMPAY.LOAN - Activate Compay Loan Tab. Possible values: YES/NO.
  {"COMPAY.LOAN": "YES"}
• COMPAY.TRANSFER - Activate Compay Transfer Tab. Possible values: YES/NO.
  {"COMPAY.TRANSFER": "YES"}
• PAPARA.PAYMENT - Activate Papara Payment Tab. Possible values: YES/NO.
  {"PAPARA.PAYMENT": "YES"}
• INVOICETYPES - used in EXTRA of QUERYINVOICE to query multiple Invoice Types. It is sent as JSON Array. Possible values: SALE, PREAUTH and DISCOUNT.
  {"INVOICETYPES": ["SALE", "DISCOUNT"]}
• SubCustomer - parameter to differentiate the cards of same the customer.
  {"SubCustomer": "SubCustomer1"}
• InvoiceId - parameter to send id of invoice to pay it from other payment pages.
  {"InvoiceId": "id"}
• DealerCode - parameter to send code of dealer of associated invoice to be paid.
  {"DealerCode": "code"}
giu0009

Split payment parameters

• SpCode - unique code for split payment.
  {"SpCode":"Code-1234567890"}
• SpMaxSplitCount - maximum splits that can be done during payment.
  {"SpMaxSplitCount":3}
• SpTotalAmount - total amount for a split payment.
  {"SpTotalAmount":50}
• SpBusinessMaxInst
  {"SpBusinessMaxInst":4}
• SpPersonalMaxInst
  {"SpPersonalMaxInst":3}
• SpGroupNumber - field for grouping split payments.
  {"SpGroupNumber":"Code-1234"}

Other bank parameters

• BKMEXPRESS - include BKMExpressV2 payment system name like below to have BKM Express tab on Default HPP
  {"BkmExpressV2PaymentSystem":"PaymentSystemName"}
• GARANTIPAY - include GarantiPay payment system name like below to have GarantiPay tab on Default HPP
  {"GarantiPayPaymentSystem":"PaymentSystemName"}
• GARANTI - include "GarantiSubMerchantCode" parameter to override default "SubMerchantCode" parameter
  {"GarantiSubMerchantCode":"123456789"}
• YKB - include "YkbSubMerchantCode" parameter to override default "SubMerchantCode" parameter
  {"YkbSubMerchantCode":"123456789"}
  For payment faciliatior options use:
  {
  "YKB.subMrcId": "152135125",
  "YKB.mrcPfId": "1531235126",
  "YKB.mcc": "1325"
  }
  
• Vakifbank - For insurance companies payments made with submerchant include one of the parameters below:
  {"VakifbankSubMerchantCode":"SubMerchantCode"} or
  {"VakifbankIdentity":"123456789"}
• VAKIFBANK TOS REFUND SERVICE
  {"VakifbankRefundService.RECIPIENTBRANCHCODE":"testBranchCode",
  "VakifbankRefundService.RECIPIENTBANKCODE":"testBankCode",
  "VakifbankRefundService.PAYMENTDATE":"dd-MM-yyyy HH:mm",
  "VakifbankRefundService.DESCRIPTION":"description" }

Payment Facilitator (PF) fields shown below can be sent in EXTRA field in the following way.

• ISBANK
  {"ISBANK.SUBMERCHANTID": 65504389},{"ISBANK.SUBMERCHANTPOSTALCODE": 34234},{"ISBANK.SUBMERCHANTCITY": İstanbul},ISBANK.SUBMERCHANTCOUNTRY": Türkiye},{"ISBANK.SUBMERCHANTMCC": 4829},{"ISBANK.SUBMERCHANTNIN": 123456789},,{"ISBANK.SUBMERCHANTURL": www.merchanturl.com}, {"ISBANK.ORDERTYPE": "01"}, {"ISBANK.ORDERSUBTYPE": "01"}
• DENIZBANK
  {"SubMerchantCode": 123456789012345}
• ZIRAATBANK
  {"SubMerchantCode": VKN/TCKN}
• AKBANK
  {"AKBANK.SUBMERCHANTID": 65504389},{"AKBANK.SUBMERCHANTPOSTALCODE": 34234},{"AKBANK.SUBMERCHANTCITY": İstanbul},{"AKBANK.SUBMERCHANTCOUNTRY": Türkiye},{"AKBANK.SUBMERCHANTMCC": 4829},{"AKBANK.SUBMERCHANTNIN": 123456789},{"AKBANK.SUBMERCHANTURL": www.merchanturl.com},{"AKBANK.VISASUBMERCHANTID": 000000},{"AKBANK.VISAPFID": 1111111},{"AKBANK.PAYMENTMETHOD": AKBANKCUZDAN},{"AKBANK.MOBILEECI": 300},{"AKBANK.WALLETPROGRAMDATA": 300},{"AKBANK.MOBILEASSIGNED": 300000},{"AKBANK.MOBILEDEVICETYPE": 10}
• HALKKOBIKART {"HALKKOBIKART.SUBMERCHANTNAME":"string", "HALKKOBIKART.SUBMERCHANTID":"string", "HALKKOBIKART.SUBMERCHANTPOSTALCODE":"string", "HALKKOBIKART.SUBMERCHANTCITY":"string", "HALKKOBIKART.SUBMERCHANTCOUNTRY":"string", "HALKKOBIKART.SUBMERCHANTMCC":"string", "HALKKOBIKART.HALKKOBIKARTDESTEK":"Yes/No", "HALKKOBIKART.OZELTAKSITLIISLEM":"S/E", "HALKKOBIKART.ODEMESIKLIGI":"1 if OZELTAKSITLIISLEM=E", "HALKKOBIKART.MIKTAR_[1-12]":"decimal", "HALKKOBIKART.TARIH_[1-12]":"YYYYMMDD "}
• HALKBANK
  {"HALKBANK.SUBMERCHANTPOSTALCODE": "153123512", "HALKBANK.SUBMERCHANTNAME": "SubMerchantName", "HALKBANK.SUBMERCHANTMCC": "1535", "HALKBANK.SUBMERCHANTID": "5353535", "HALKBANK.SUBMERCHANTCOUNTRY": "Country", "HALKBANK.SUBMERCHANTCITY": "City"}
  
• TURKIYEFINANS
  {"TURKIYEFINANS.SUBMERCHANTNAME": ASSECOTFKB},{"TURKIYEFINANS.SUBMERCHANTID": 9586886},{"TURKIYEFINANS.SUBMERCHANTCITY": ISTANBUL},{TURKIYEFINANS.SUBMERCHANTCOUNTRY": TR},{"TURKIYEFINANS.SUBMERCHANTMCC": 4814},{"TURKIYEFINANS.SUBMERCHANTFACILITATORID": 00516941},{"TURKIYEFINANS.SUBMERCHANTPOSTALCODE": 34467}
• VAKIFBANK
  {"HostSubmerchantID": ASSECOTFKB}
• QNBFinansSubMerchantCode - Sub merchant code for only new QNB Finansbank
  {"QNBFinansSubMerchantCode": "345"}
• QNBFINANSBANK
  {"QNBFINANS.PAYMENTFACILITATORID": "13151251235", "QNBFINANS.SUBMERCHANTCODE": "56126262345", "QNBFINANS.INDSALESORGID": "9982522523", "QNBFINANS.SUBMERCHANTMCC": "4343", "QNBFINANS.CARDACCEPTORNAME": "AcceptorName", "QNBFINANS.CARDACCEPTORCITY": "AcceptorCity", "QNBFINANS.CARDACCEPTORPOSTALCODE": "AcceptorPostalCode", "QNBFINANS.CARDACCEPTORSTREET": "AcceptorStreet", "QNBFINANS.CARDACCEPTORCOUNTRY": "AcceptorCountry", "QNBFINANS.CARDACCEPTORSTATE": "AcceptorState"}
  
• INGBANK
  {"INGBANK.SUBMERCHANTMCC": "143", "INGBANK.SUBMERCHANTPOSTALCODE": "00000", "INGBANK.SUBMERCHANTNAME": "Name", "INGBANK.SUBMERCHANTCITY": "City", "INGBANK.SUBMERCHANTCOUNTRY": "Country", "INGBANK.SUBMERCHANTFACILITATORID": "1512531515", "INGBANK.SUBMERCHANTORGANIZATIONID": "52523525253", "INGBANK.SUBMERCHANTID": "7121363216"}
  
• SEKERBANK
  {"SEKERBANK.SUBMERCHANTID": "340410030", "SEKERBANK.SUBMERCHANTNAME": "CYBERSOFTPF", "SEKERBANK.SUBMERCHANTCITY": "ISTANBUL", "SEKERBANK.SUBMERCHANTCOUNTRY": "792", "SEKERBANK.SUBMERCHANTPOSTALCODE": "81410", "SEKERBANK.SUBMERCHANTMCC": "2233"}
  
• ODEABANK
  { "ODEABANK.PAYMENTFACILITATORID":"string", "ODEABANK.SUBMERCHANTID":"string", "ODEABANK.INDSALESORGID":"string", "ODEABANK.SUBMERCHANTMCC":"string", "ODEABANK.CARDACCEPTORNAME":"string", "ODEABANK.CARDACCEPTORSTREET":"string", "ODEABANK.CARDACCEPTORCITY":string "ODEABANK.CARDACCEPTORPOSTALCODE":string, "ODEABANK.CARDACCEPTORSTATE":"string" "ODEABANK.CARDACCEPTORCOUNTRY:string}
• ANADOLU
  { "ANADOLU.SUBMERCHANTNAME":"string", "ANADOLU.SUBMERCHANTID":"string", "ANADOLU.SUBMERCHANTPOSTALCODE":"string", "ANADOLU.SUBMERCHANTCITY":"string", "ANADOLU.SUBMERCHANTCOUNTRY":"string", "ANADOLU.SUBMERCHANTMCC":"string" }
• TEB
  {
  "TEB.SUBMERCHANTNAME": "SubMerchantName" }
  
• VPOSTIMEOUT - Specify VPOS timeout in seconds - Works for Nestpay, Garanti, Denizbank, Vakifbank, HSBC. Example: {"VPOSTIMEOUT":30}
• ALBARAKA
  { "ALBARAKA.SUBDEALERCODE":"string", "ALBARAKA.TCKN":"string", "ALBARAKA.TAXID":"string" "AlbarakaMailOrder":"YES or NO" (default:NO) }
• KUVEYTTURK
  { "KUVEYTURK.DESCRIPTION":"string", "KUVEYTURK.IDENTITYTAXNUMBER":"string", "KUVEYTURK.DEFERRINGCOUNT":"string", "KUVEYTURK.SUBMERCHANTID":"string", "KUVEYTURK.SUBMERCHANTIDENTITYTAXNUMBER":"string", "KUVEYTURK.VPOSSUBMERCHANTID":"string",
  "KUVEYTURK.BKMID":"string" }
• ZIRAATBANKKURUMSALKART
  Equal installments
  {
  "ZIRAATBANKKURUMSALKART.KURUMSALKARTISLEMTIPI": "ESITTAKSITLISATIS",
  "ZIRAATBANKKURUMSALKART.TAKSITVEYAVADESAYISI": "5",
  "ZIRAATBANKKURUMSALKART.ODEMEPERIYODU": "2"
  }
  
  Flexible installments - up to 12 installments (MIKTAR_*, TARIH_*)
  {
  "ZIRAATBANKKURUMSALKART.KURUMSALKARTISLEMTIPI": "ESNEKTAKSITLISATIS",
  "ZIRAATBANKKURUMSALKART.TAKSITVEYAVADESAYISI": "3",
  "ZIRAATBANKKURUMSALKART.MIKTAR_1": "100",
  "ZIRAATBANKKURUMSALKART.TARIH_1": "20210916",
  "ZIRAATBANKKURUMSALKART.MIKTAR_2": "50",
  "ZIRAATBANKKURUMSALKART.TARIH_2": "20210916",
  "ZIRAATBANKKURUMSALKART.MIKTAR_3": "50",
  "ZIRAATBANKKURUMSALKART.TARIH_3": "20210916",
  }
  
• MULTINET
  { "MULTINET.MERCHANTPRODUCTID": "142" }
  
• PARATIKA
  { "ParatikaMerchantId": "10000000",
  "MerchantKey":"testKey",
  "ParatikaSellerItems":
  [{"productCode": "Sellers1","amount": 55,"name": "keyboard", "description": "OYUN BİLGİSAYARI","quantity": 1, "productCategoryCode": "4722", "sellerId": "TRFONGG2020001", "sellerPaymentAmount":55}] }

Notification Integration Model

• Example: {"NOTIFICATION_INTEGRATION_MODEL" : "API"} or {"NOTIFICATION_INTEGRATION_MODEL" : "DIRECTPOST_THREED"} or {"NOTIFICATION_INTEGRATION_MODEL" : "DIRECTPOST_NON_THREED"} or

MAXINSTALLMENTCOUNT:

integer, optional Max length: 2 If you want to limit the maximum number of installments that can be applied, you can use this parameter.

BUSINESSMAXINSTALLMENTCOUNT:

integer, optional Max length: 2 If you want to limit to business credit card the maximum number of installments that can be applied, you can use this parameter.

SPLITPAYMENTTYPE:

string, optional Max length: 7 description

DEALERTYPENAME:

string, optional Max length: 256 The Dealer Type you created from the B2B Admin Panel > Dealer > Dealer Types section is "Name".

BILLTOADDRESSLINE:

string, optional Max length: 1024 Bill To Address Line

BILLTOCITY:

string, optional Max length: 32 Bill To City

BILLTOPOSTALCODE:

string, optional Max length: 16 Bill To Postal Code

BILLTOCOUNTRY:

string, optional Max length: 32 Bill To Country

SHIPTOADDRESSLINE:

string, optional Max length: 255 Ship To Address Line

SHIPTOCITY:

string, optional Max length: 32 Ship To City

SHIPTOPOSTALCODE:

string, optional Max length: 32 Ship To Postal Code

SHIPTOCOUNTRY:

string, optional Max length: 64 Ship To Country

SHIPTOPHONE:

string, optional Max length: 32 description

BILLTOPHONE:

string, optional Max length: 32 description

CUSTOMFIELDS:

string, optional Max length: 4000 This parameter should be sent in JSON Array with UTF-8 URL-Encoded format. "integrationCode" and "value" are required when sending this parameter.
Example:[{"code":"code","name":"Field Name","value":"Field Value","group":"Group","integrationCode":"IntegrationCode"},{},{}]

MERCHANTORDERID:

string, optional Max length: 128 description

SETINSTALLMENT:

integer, optional Max length: 2 description

FORGROUP:

string, optional Max length: 3 Default value: 'YES' FORGROUP Parameter enables to do queries and/or transactions using cards saved by other merchants that are in the same Card Sharing Group.

INITIATORMERCHANTBUSINESSID:

string, optional Max length: 16 description

PBORDER:

string, optional Max length: 256 description

PAYMENTSYSTEMPOOL:

string, optional Max length: 1024 The PAYMENTSYSTEMPOOL parameter is a special parameter that is used to include specific Payment Systems and to receive payments only through these payment systems.This parameter must be JSON(URL encoded) format . PAYMENTSYSTEMPOOL :[{"PaymentSystemName": "PsName1","isDefault": false, "redirectBanks": {"CardBrand": "ALL","BankCode":"0111"}},{"PaymentSystemName": "PsName2","isDefault": true},{"PaymentSystemName": "PsName3","isDefault": false}]

Extend Session

The SESSIONEXTEND action is used for extending an existing session.

Request parameters

ACTION:

SESSIONEXTEND, required Max length: 128 Description to be provided

SESSIONTOKEN:

string, conditional Max length: 48 It is a unique value that contains the values for the transaction.

MERCHANTUSER:

string, conditional Max length: 128 Merchant API User Email

MERCHANTPASSWORD:

string, conditional Max length: 128 Merchant API User Password

MERCHANT:

string, conditional Max length: 128 Merchant ID, merchant business code defined in Payten Payment Gateway.

TOKEN:

string, required Max length: 48 Description to be provided

SESSIONEXPIRY:

string, required Max length: 6 Default value: '168h' It is the period of time until the session expires.

Session Kill

The SESSIONKILL action is used to make sure that session tokens are expired after being used.

Request parameters

ACTION:

SESSIONKILL, required Max length: 128 Description to be provided

MERCHANTUSER:

string, conditional Max length: 128 Merchant API User Email

MERCHANTPASSWORD:

string, conditional Max length: 128 Merchant API User Password

MERCHANT:

string, conditional Max length: 16 Merchant ID, merchant business code defined in Payten Payment Gateway.

SESSIONTOKEN:

string, required Max length: 48 It is a unique value that contains the values for the transaction.

Edit Session Token

The EDITSESSIONTOKEN action is used to update session token AMOUNT and RETURNURL values.

Request parameters

ACTION:

EDITSESSIONTOKEN, required Max length: 128 Description to be provided

MERCHANTUSER:

string, required Max length: 128 Merchant API User Email

MERCHANTPASSWORD:

string, required Max length: 128 Merchant API User Password

MERCHANT:

string, required Max length: 128 Merchant ID, merchant business code defined in Payten Payment Gateway.

SESSIONTOKEN:

string, required Max length: 48 It is a unique value that contains the values for the transaction.

RETURNURL:

string, optional Max length: 512 description

AMOUNT:

decimal, optional Max length: 30 Amount of payment / transaction. Please note that, this amount is tax included, MSU doesn't consider any other tax calculation.

Pay by Link Payment Actions

Add Pay by Link Payment

See Description

NOTE: If Pay By Link Payment is created with existing customer just parameter CUSTOMER should be sent, otherwise if it's new customer parameters CUSTOMERNAME, CUSTOMERPHONE and CUSTOMEREMAIL are required and should be sent on request. To send a Pay by Link payment, you must log in to the B2B Admin Panel, then go to Control Panel > Settings > MerchantProfile > Update SMTP/SMS Profile and add the email content from content management.

we should add "pay by link" description area if merchant wants to this feature, they should add SMTP and SMS Profie from B2B admin panel> Settings > User area and Setting > Content Management > Pay By Link Email Content

The character length of MerchantPaymentID varies according to the virtual POS bank. Our recommended maximum length value is 40 characters. Apart from this, the character lengths of the banks should be taken into account. If you are sending a transaction to the PARATIKA application via Payten Payment Gateway, you should send the MerchantPaymentID with a maximum value that is 9 characters shorter. This is because PARATIKA application adds +9 characters to the value sent from the Payten Payment Gateway.

Request parameters

ACTION:

PAYBYLINKPAYMENT, required Max length: 128 Description to be provided

SESSIONEXPIRY:

string, required Max length: 6 Default value: '168h' It is the period of time until the session expires.

SESSIONTYPE:

string, optional Max length: 20 QUERYOPERATIONSESSION : Used to obtain sessiontoken to be used in query operations.
PAYMENTSESSION : Used to create a payment session.
SPLITPAYMENTSESSION : Used to create a partial payment session.
WALLETSESSION : Used to create a wallet session for payment with a registered card or for payment by registering a card. See all possible values (4)

MERCHANTPAYMENTID:

string, required Max length: 128 Payment ID given by Merchant (it must be unique).The character length of MerchantPaymentID varies according to the virtual POS bank. Our recommended maximum length value is 40 characters. Apart from this, the character lengths of the banks should be taken into account. If you are sending a transaction to the PARATIKA application via Payten Payment Gateway, you should send the MerchantPaymentID with a maximum value that is 9 characters shorter. This is because PARATIKA application adds +9 characters to the value sent from the Payten Payment Gateway.
Raiffeisenbank Virtual POS Note: If you are using Raiffeisenbank's Virtual POS or sending transactions to Raiffeisenbank, the MERCHANTPAYMENTID must be limited to a maximum of 20 characters, as this is the maximum supported by the bank.

AMOUNT:

decimal, required Max length: 30 Amount of payment / transaction. Please note that, this amount is tax included, MSU doesn't consider any other tax calculation.

CURRENCY:

string, required Max length: 3 ISO Alpha transaction currency code like EUR, USD, GBP. See all possible values (37)

RETURNURL:

string, optional Max length: 512 description

MERCHANTUSER:

string, conditional Max length: 128 Merchant API User Email

MERCHANTPASSWORD:

string, conditional Max length: 128 Merchant API User Password

MERCHANT:

string, conditional Max length: 128 Merchant ID, merchant business code defined in Payten Payment Gateway.

SESSIONTOKEN:

string, conditional Max length: 48 It is a unique value that contains the values for the transaction.

CUSTOMER:

string, optional Max length: 128 The Merchant System ID for customer. It must be unique within a Merchant.

CUSTOMEREMAIL:

string, optional Max length: 64 Customer e-mail.

CUSTOMERNAME:

string, optional Max length: 128 Name of the Customer.

CUSTOMERPHONE:

string, optional Max length: 64 Customer phone / mobile number.

TCKN:

string, optional Max length: 11 Identity Number. Required when VKN is not provided.

LANGUAGE:

string, optional Max length: 2 Default value: 'tr' description

ORDERITEMS:

string, optional Max length: 100000 Order items as an array in JSON Format. Order items should be URL encoded. Please see the request samples for valid JSON data format.

NOTIFICATIONCHANNELS:

string, optional Max length: 16 NOTIFICATIONCHANNELS parameter can be used to specify sending channels(comma separated). Example EMAIL, SMS.

MAXINSTALLMENTCOUNT:

integer, optional Max length: 2 If you want to limit the maximum number of installments that can be applied, you can use this parameter.

BUSINESSMAXINSTALLMENTCOUNT:

integer, optional Max length: 2 If you want to limit to business credit card the maximum number of installments that can be applied, you can use this parameter.

DEALERTYPENAME:

string, optional Max length: 256 The Dealer Type you created from the B2B Admin Panel > Dealer > Dealer Types section is "Name".

EXTRA:

string, optional Max length: 4000

Extra Parameter is a custom parameter that is used to pass certain parameters for different banks or other usage. This parameter gets its argument as a JSON(URL encoded) format which is then parsed. EXTRA: {"Name" : Value}

Parameters

Below are given parameters that can be sent on extra and examples for each of them. (parameter name is case-insensitive)

• SaveCard - parameter to differentiate if card should be saved or not. Possible values: YES/NO.
  {"SaveCard": "NO"}
• PopUpOpenWhenChecked - shows Card Saving Terms and Conditions when they are accepted (checked). Possible values: YES/NO.
  {"PopUpOpenWhenChecked": "NO"}
• SAVECARDREMINDERPOPUP - shows a popup that gives the user the option to save the card after a successful Hosted Payment Page payment. Possible values: YES/NO.
  {"SAVECARDREMINDERPOPUP": "YES"}
• BNPLREMINDERPOPUP - shows a popup that gives the user the option to go back to the payment page and continue with loan payment after a failed card transaction on the Hosted Payment Page. Possible values: YES/NO.
  {"BNPLREMINDERPOPUP": "YES"}
• ForceSave - parameter to differentiate if card should be forced to be saved or not. ForceSave and SaveCard can not be sent together. ForceSave has priority over SaveCard. Possible values: YES/NO.
  {"ForceSave": "NO"}
• ListCard - parameter to differentiate if Registered Card panel should be displayed on Wallet Page or not. Registered Cards by default are enabled on Wallet Page. Possible values: YES/NO.
  {"ListCard": "NO"}
• CVV - parameter to differentiate if CVV should be given on HPP or not. CVV input by default is enabled on HPP. Possible values: YES/NO.
  {"CVV": "NO"}
• MailOrder - parameter to specify which merchants' transactions will be sent with moto label autotmatically. Possible values: YES/NO.
  {"MailOrder": "NO"}
• PREAUTH - parameter used to process 3D transactions as a PreAuth transaction instead of Sale. Possible values: YES/NO.
  {"PREAUTH":"YES"}
• SubMerchantCode - additional parameter sent to bank during financial transactions.
  {"SubMerchantCode": "70885124022"}
• IsbankBolumKodu - additional parameter for transactions sent to Isbank, default value is 1.
  {"IsbankBolumKodu": 1}
• IsbankGroupId - additional parameter for transactions sent to Isbank
  {"ISBANK.GROUPID": "string"}
• IMMEDIATEREDIRECTION - redirect immediately to customer URL on successful action, default value is NO.
  {"IMMEDIATEREDIRECTION": "YES"}
• RETURNSCRIPT - if this parameter is sent, the js function sent will be called after a successful card save on wallet page.
  {"RETURNSCRIPT": JS Function provided by merchant!}
• HalkbankKobiKartDestek - if this parameter is sent, Halkbank Kobi Kart tab will be shown on Default HPP. Possible values: YES/NO.
  {"HalkbankKobiKartDestek":"YES"}
• ReturnTime - return time to merchant return url after payment has been processed.
  {"ReturnTime": 2}
• DealerCode - parameter that indicates dealers, when transactions are made. Unique for every dealer.
  {"DealerCode": "Dealer01"}
• QIWI - if this parameter is sent as "YES", authentication is done using GiroGate QIWI payment method. Possible values: YES/NO.
  {"QIWI": "YES"}
• GIROPAY - if this parameter is sent as "YES", authentication is done using GiroGate GIROPAY payment method. Possible values: YES/NO.
  {"GIROPAY": "YES"}
• IDEAL - if this parameter is sent as "YES", authentication is done using GiroGate IDEAL payment method. Possible values: YES/NO.
  {"IDEAL": "YES"}
• SOFORT - if this parameter is sent as "YES", authentication is done using GiroGate SOFORT payment method. Possible values: YES/NO.
  {"SOFORT": "YES"}
• EPS - if this parameter is sent as "YES", authentication is done using GiroGate EPS payment method. Possible values: YES/NO.
  {"EPS": "YES"}
• MULTIBANCO - if this parameter is sent as "YES", authentication is done using GiroGate MULTIBANCO payment method. Possible values: YES/NO.
  {"MULTIBANCO": "YES"}
• MYBANK - if this parameter is sent as "YES", authentication is done using GiroGate MYBANK payment method. Possible values: YES/NO.
  {"MYBANK": "YES"}
• BANCONTACT - if this parameter is sent as "YES", authentication is done using GiroGate BANCONTACT payment method. Possible values: YES/NO.
  {"BANCONTACT": "YES"}
• TRUSTPAY - if this parameter is sent as "YES", authentication is done using GiroGate TRUSTPAY payment method. Possible values: YES/NO.
  {"TRUSTPAY": "YES"}
• SAFETYPAY - if this parameter is sent as "YES", authentication is done using GiroGate SAFETYPAY payment method. Possible values: YES/NO.
  {"SAFETYPAY": "YES"}
• P24 - if this parameter is sent as "YES", authentication is done using GiroGate P24 payment method. Possible values: YES/NO.
  {"P24": "YES"}
• FINNISHONLINEBANKING - if this parameter is sent as "YES", authentication is done using GiroGate FINNISHONLINEBANKING payment method. Possible values: YES/NO.
  {"FINNISHONLINEBANKING": "YES"}
• BOLETO - if this parameter is sent as "YES", authentication is done using GiroGate BOLETO payment method. Possible values: YES/NO.
  {"BOLETO": "YES"}
• ELO - if this parameter is sent as "YES", authentication is done using GiroGate ELO payment method. Possible values: YES/NO.
  {"ELO": "YES"}
• SEPA - if this parameter is sent as "YES", authentication is done using GiroGate SEPA payment method. Possible values: YES/NO.
  {"SEPA": "YES"}
• ALIPAY - if this parameter is sent as "YES", authentication is done using GiroGate ALIPAY payment method. Possible values: YES/NO.
  {"ALIPAY": "YES"}
• COMMERCECODES - if this parameter should be sent as JSON Array of only strings, maximum installments available to card holder will be set in the payments. Possible values: 1-99
  {"COMMERCECODES":["10","20","30"]}
• ReflectCommission - if this parameter is sent as "YES" and DealerCode extra parameter is provided, commission is reflected to amount. It works only for dealers.
  {"ReflectCommission":"YES", "DealerCode":"Dealer01"}
• IgnoreRates - if this parameter is sent as "YES" and DealerCode extra parameter is provided, commission is not reflected to amount. It works only for dealers.
  {"IgnoreRates":"YES", "DealerCode":"Dealer01"}
• User - parameter that indicates the user, who has done payment on behalf of customer.
  {"USER":"user@email.com"}
• SIPAY - if this parameter is sent, Sipay tab will be shown on Default HPP. Possible values: YES/NO.
  {"SIPAY":"YES"}
• WECHATPAY - if this parameter is sent as "YES", authentication is done using GiroGate WECHATPAY payment method. Possible values: YES/NO.
  {"WECHATPAY": "YES"}
• IframeDomainUrl - indicates from which URL address payment will be proceesed.
  {"IframeDomainUrl": "www.w3school.com"}
• APPLYADDITIONALMATURITY - if this parameter is sent as "YES", payment type maturity commissions will be applied to the installments. Possible values: YES/NO.
  {"APPLYADDITIONALMATURITY": "YES"}
• DealerUserEmail - It represents the email of dealer user.
• AxessMobil.Enabled - Activate Axess Mobil Tab. Possible values: YES/NO.
  {"AxessMobil.Enabled": "NO"}
• AxessMobil.PaymentSystem - Activate Axess Mobil Tab. Possible values: StringValue.
  {"AxessMobil.PaymentSystem": "PaymentSystem"}
• COMPAY.LOAN - Activate Compay Loan Tab. Possible values: YES/NO.
  {"COMPAY.LOAN": "YES"}
• COMPAY.TRANSFER - Activate Compay Transfer Tab. Possible values: YES/NO.
  {"COMPAY.TRANSFER": "YES"}
• PAPARA.PAYMENT - Activate Papara Payment Tab. Possible values: YES/NO.
  {"PAPARA.PAYMENT": "YES"}
• INVOICETYPES - used in EXTRA of QUERYINVOICE to query multiple Invoice Types. It is sent as JSON Array. Possible values: SALE, PREAUTH and DISCOUNT.
  {"INVOICETYPES": ["SALE", "DISCOUNT"]}
• SubCustomer - parameter to differentiate the cards of same the customer.
  {"SubCustomer": "SubCustomer1"}
• InvoiceId - parameter to send id of invoice to pay it from other payment pages.
  {"InvoiceId": "id"}
• DealerCode - parameter to send code of dealer of associated invoice to be paid.
  {"DealerCode": "code"}
giu0009

Split payment parameters

• SpCode - unique code for split payment.
  {"SpCode":"Code-1234567890"}
• SpMaxSplitCount - maximum splits that can be done during payment.
  {"SpMaxSplitCount":3}
• SpTotalAmount - total amount for a split payment.
  {"SpTotalAmount":50}
• SpBusinessMaxInst
  {"SpBusinessMaxInst":4}
• SpPersonalMaxInst
  {"SpPersonalMaxInst":3}
• SpGroupNumber - field for grouping split payments.
  {"SpGroupNumber":"Code-1234"}

Other bank parameters

• BKMEXPRESS - include BKMExpressV2 payment system name like below to have BKM Express tab on Default HPP
  {"BkmExpressV2PaymentSystem":"PaymentSystemName"}
• GARANTIPAY - include GarantiPay payment system name like below to have GarantiPay tab on Default HPP
  {"GarantiPayPaymentSystem":"PaymentSystemName"}
• GARANTI - include "GarantiSubMerchantCode" parameter to override default "SubMerchantCode" parameter
  {"GarantiSubMerchantCode":"123456789"}
• YKB - include "YkbSubMerchantCode" parameter to override default "SubMerchantCode" parameter
  {"YkbSubMerchantCode":"123456789"}
  For payment faciliatior options use:
  {
  "YKB.subMrcId": "152135125",
  "YKB.mrcPfId": "1531235126",
  "YKB.mcc": "1325"
  }
  
• Vakifbank - For insurance companies payments made with submerchant include one of the parameters below:
  {"VakifbankSubMerchantCode":"SubMerchantCode"} or
  {"VakifbankIdentity":"123456789"}
• VAKIFBANK TOS REFUND SERVICE
  {"VakifbankRefundService.RECIPIENTBRANCHCODE":"testBranchCode",
  "VakifbankRefundService.RECIPIENTBANKCODE":"testBankCode",
  "VakifbankRefundService.PAYMENTDATE":"dd-MM-yyyy HH:mm",
  "VakifbankRefundService.DESCRIPTION":"description" }

Payment Facilitator (PF) fields shown below can be sent in EXTRA field in the following way.

• ISBANK
  {"ISBANK.SUBMERCHANTID": 65504389},{"ISBANK.SUBMERCHANTPOSTALCODE": 34234},{"ISBANK.SUBMERCHANTCITY": İstanbul},ISBANK.SUBMERCHANTCOUNTRY": Türkiye},{"ISBANK.SUBMERCHANTMCC": 4829},{"ISBANK.SUBMERCHANTNIN": 123456789},,{"ISBANK.SUBMERCHANTURL": www.merchanturl.com}, {"ISBANK.ORDERTYPE": "01"}, {"ISBANK.ORDERSUBTYPE": "01"}
• DENIZBANK
  {"SubMerchantCode": 123456789012345}
• ZIRAATBANK
  {"SubMerchantCode": VKN/TCKN}
• AKBANK
  {"AKBANK.SUBMERCHANTID": 65504389},{"AKBANK.SUBMERCHANTPOSTALCODE": 34234},{"AKBANK.SUBMERCHANTCITY": İstanbul},{"AKBANK.SUBMERCHANTCOUNTRY": Türkiye},{"AKBANK.SUBMERCHANTMCC": 4829},{"AKBANK.SUBMERCHANTNIN": 123456789},{"AKBANK.SUBMERCHANTURL": www.merchanturl.com},{"AKBANK.VISASUBMERCHANTID": 000000},{"AKBANK.VISAPFID": 1111111},{"AKBANK.PAYMENTMETHOD": AKBANKCUZDAN},{"AKBANK.MOBILEECI": 300},{"AKBANK.WALLETPROGRAMDATA": 300},{"AKBANK.MOBILEASSIGNED": 300000},{"AKBANK.MOBILEDEVICETYPE": 10}
• HALKKOBIKART {"HALKKOBIKART.SUBMERCHANTNAME":"string", "HALKKOBIKART.SUBMERCHANTID":"string", "HALKKOBIKART.SUBMERCHANTPOSTALCODE":"string", "HALKKOBIKART.SUBMERCHANTCITY":"string", "HALKKOBIKART.SUBMERCHANTCOUNTRY":"string", "HALKKOBIKART.SUBMERCHANTMCC":"string", "HALKKOBIKART.HALKKOBIKARTDESTEK":"Yes/No", "HALKKOBIKART.OZELTAKSITLIISLEM":"S/E", "HALKKOBIKART.ODEMESIKLIGI":"1 if OZELTAKSITLIISLEM=E", "HALKKOBIKART.MIKTAR_[1-12]":"decimal", "HALKKOBIKART.TARIH_[1-12]":"YYYYMMDD "}
• HALKBANK
  {"HALKBANK.SUBMERCHANTPOSTALCODE": "153123512", "HALKBANK.SUBMERCHANTNAME": "SubMerchantName", "HALKBANK.SUBMERCHANTMCC": "1535", "HALKBANK.SUBMERCHANTID": "5353535", "HALKBANK.SUBMERCHANTCOUNTRY": "Country", "HALKBANK.SUBMERCHANTCITY": "City"}
  
• TURKIYEFINANS
  {"TURKIYEFINANS.SUBMERCHANTNAME": ASSECOTFKB},{"TURKIYEFINANS.SUBMERCHANTID": 9586886},{"TURKIYEFINANS.SUBMERCHANTCITY": ISTANBUL},{TURKIYEFINANS.SUBMERCHANTCOUNTRY": TR},{"TURKIYEFINANS.SUBMERCHANTMCC": 4814},{"TURKIYEFINANS.SUBMERCHANTFACILITATORID": 00516941},{"TURKIYEFINANS.SUBMERCHANTPOSTALCODE": 34467}
• VAKIFBANK
  {"HostSubmerchantID": ASSECOTFKB}
• QNBFinansSubMerchantCode - Sub merchant code for only new QNB Finansbank
  {"QNBFinansSubMerchantCode": "345"}
• QNBFINANSBANK
  {"QNBFINANS.PAYMENTFACILITATORID": "13151251235", "QNBFINANS.SUBMERCHANTCODE": "56126262345", "QNBFINANS.INDSALESORGID": "9982522523", "QNBFINANS.SUBMERCHANTMCC": "4343", "QNBFINANS.CARDACCEPTORNAME": "AcceptorName", "QNBFINANS.CARDACCEPTORCITY": "AcceptorCity", "QNBFINANS.CARDACCEPTORPOSTALCODE": "AcceptorPostalCode", "QNBFINANS.CARDACCEPTORSTREET": "AcceptorStreet", "QNBFINANS.CARDACCEPTORCOUNTRY": "AcceptorCountry", "QNBFINANS.CARDACCEPTORSTATE": "AcceptorState"}
  
• INGBANK
  {"INGBANK.SUBMERCHANTMCC": "143", "INGBANK.SUBMERCHANTPOSTALCODE": "00000", "INGBANK.SUBMERCHANTNAME": "Name", "INGBANK.SUBMERCHANTCITY": "City", "INGBANK.SUBMERCHANTCOUNTRY": "Country", "INGBANK.SUBMERCHANTFACILITATORID": "1512531515", "INGBANK.SUBMERCHANTORGANIZATIONID": "52523525253", "INGBANK.SUBMERCHANTID": "7121363216"}
  
• SEKERBANK
  {"SEKERBANK.SUBMERCHANTID": "340410030", "SEKERBANK.SUBMERCHANTNAME": "CYBERSOFTPF", "SEKERBANK.SUBMERCHANTCITY": "ISTANBUL", "SEKERBANK.SUBMERCHANTCOUNTRY": "792", "SEKERBANK.SUBMERCHANTPOSTALCODE": "81410", "SEKERBANK.SUBMERCHANTMCC": "2233"}
  
• ODEABANK
  { "ODEABANK.PAYMENTFACILITATORID":"string", "ODEABANK.SUBMERCHANTID":"string", "ODEABANK.INDSALESORGID":"string", "ODEABANK.SUBMERCHANTMCC":"string", "ODEABANK.CARDACCEPTORNAME":"string", "ODEABANK.CARDACCEPTORSTREET":"string", "ODEABANK.CARDACCEPTORCITY":string "ODEABANK.CARDACCEPTORPOSTALCODE":string, "ODEABANK.CARDACCEPTORSTATE":"string" "ODEABANK.CARDACCEPTORCOUNTRY:string}
• ANADOLU
  { "ANADOLU.SUBMERCHANTNAME":"string", "ANADOLU.SUBMERCHANTID":"string", "ANADOLU.SUBMERCHANTPOSTALCODE":"string", "ANADOLU.SUBMERCHANTCITY":"string", "ANADOLU.SUBMERCHANTCOUNTRY":"string", "ANADOLU.SUBMERCHANTMCC":"string" }
• TEB
  {
  "TEB.SUBMERCHANTNAME": "SubMerchantName" }
  
• VPOSTIMEOUT - Specify VPOS timeout in seconds - Works for Nestpay, Garanti, Denizbank, Vakifbank, HSBC. Example: {"VPOSTIMEOUT":30}
• ALBARAKA
  { "ALBARAKA.SUBDEALERCODE":"string", "ALBARAKA.TCKN":"string", "ALBARAKA.TAXID":"string" "AlbarakaMailOrder":"YES or NO" (default:NO) }
• KUVEYTTURK
  { "KUVEYTURK.DESCRIPTION":"string", "KUVEYTURK.IDENTITYTAXNUMBER":"string", "KUVEYTURK.DEFERRINGCOUNT":"string", "KUVEYTURK.SUBMERCHANTID":"string", "KUVEYTURK.SUBMERCHANTIDENTITYTAXNUMBER":"string", "KUVEYTURK.VPOSSUBMERCHANTID":"string",
  "KUVEYTURK.BKMID":"string" }
• ZIRAATBANKKURUMSALKART
  Equal installments
  {
  "ZIRAATBANKKURUMSALKART.KURUMSALKARTISLEMTIPI": "ESITTAKSITLISATIS",
  "ZIRAATBANKKURUMSALKART.TAKSITVEYAVADESAYISI": "5",
  "ZIRAATBANKKURUMSALKART.ODEMEPERIYODU": "2"
  }
  
  Flexible installments - up to 12 installments (MIKTAR_*, TARIH_*)
  {
  "ZIRAATBANKKURUMSALKART.KURUMSALKARTISLEMTIPI": "ESNEKTAKSITLISATIS",
  "ZIRAATBANKKURUMSALKART.TAKSITVEYAVADESAYISI": "3",
  "ZIRAATBANKKURUMSALKART.MIKTAR_1": "100",
  "ZIRAATBANKKURUMSALKART.TARIH_1": "20210916",
  "ZIRAATBANKKURUMSALKART.MIKTAR_2": "50",
  "ZIRAATBANKKURUMSALKART.TARIH_2": "20210916",
  "ZIRAATBANKKURUMSALKART.MIKTAR_3": "50",
  "ZIRAATBANKKURUMSALKART.TARIH_3": "20210916",
  }
  
• MULTINET
  { "MULTINET.MERCHANTPRODUCTID": "142" }
  
• PARATIKA
  { "ParatikaMerchantId": "10000000",
  "MerchantKey":"testKey",
  "ParatikaSellerItems":
  [{"productCode": "Sellers1","amount": 55,"name": "keyboard", "description": "OYUN BİLGİSAYARI","quantity": 1, "productCategoryCode": "4722", "sellerId": "TRFONGG2020001", "sellerPaymentAmount":55}] }

Notification Integration Model

• Example: {"NOTIFICATION_INTEGRATION_MODEL" : "API"} or {"NOTIFICATION_INTEGRATION_MODEL" : "DIRECTPOST_THREED"} or {"NOTIFICATION_INTEGRATION_MODEL" : "DIRECTPOST_NON_THREED"} or

ISVALIDATED:

string, optional Max length: 3 description

PAYBYLINKSTATUS:

string, optional Max length: 2 Status of Pay By Link Payment. See all possible values (7)

CUSTOMFIELDS:

string, optional Max length: 4000 This parameter should be sent in JSON Array with UTF-8 URL-Encoded format. "integrationCode" and "value" are required when sending this parameter.
Example:[{"code":"code","name":"Field Name","value":"Field Value","group":"Group","integrationCode":"IntegrationCode"},{},{}]

Edit Pay by Link Payment

The PAYBYLINKPAYMENTEDIT action is used for editing amount & returnUrl of Pay By Link Payment

Request parameters

ACTION:

PAYBYLINKPAYMENTEDIT, required Max length: 128 Description to be provided

SESSIONTOKEN:

string, required Max length: 48 It is a unique value that contains the values for the transaction.

MERCHANTUSER:

string, required Max length: 128 Merchant API User Email

MERCHANTPASSWORD:

string, required Max length: 128 Merchant API User Password

MERCHANT:

string, required Max length: 128 Merchant ID, merchant business code defined in Payten Payment Gateway.

AMOUNT:

decimal, optional Max length: 30 Amount of payment / transaction. Please note that, this amount is tax included, MSU doesn't consider any other tax calculation.

RETURNURL:

string, optional Max length: 512 description

Cancel Pay by Link Payment

The PAYBYLINKPAYMENTCANCEL action is used for cancelling a Pay By Link Payment

Request parameters

ACTION:

PAYBYLINKPAYMENTCANCEL, required Max length: 128 Description to be provided

SESSIONTOKEN:

string, conditional Max length: 48 It is a unique value that contains the values for the transaction.

MERCHANTUSER:

string, conditional Max length: 128 Merchant API User Email

MERCHANTPASSWORD:

string, conditional Max length: 128 Merchant API User Password

MERCHANT:

string, conditional Max length: 128 Merchant ID, merchant business code defined in Payten Payment Gateway.

PAYBYLINKTOKEN:

string, required Max length: 48 description

Resend Pay by Link Payment

The PAYBYLINKPAYMENTRESEND action is used for resending a remainder email to Card Holder to complete the payment.

Request parameters

ACTION:

PAYBYLINKPAYMENTRESEND, required Max length: 128 Description to be provided

SESSIONTOKEN:

string, conditional Max length: 48 It is a unique value that contains the values for the transaction.

MERCHANTUSER:

string, conditional Max length: 128 Merchant API User Email

MERCHANTPASSWORD:

string, conditional Max length: 128 Merchant API User Password

MERCHANT:

string, conditional Max length: 128 Merchant ID, merchant business code defined in Payten Payment Gateway.

PAYBYLINKTOKEN:

string, required Max length: 48 description

NOTIFICATIONCHANNELS:

string, optional Max length: 16 NOTIFICATIONCHANNELS parameter can be used to specify sending channels(comma separated). Example EMAIL, SMS.

Invoice Actions

Add Invoice

The Invoice ADD action lets you to add a Invoice. You should give below parameters to create new invoice for a specific dealer.

On EXTRA parameter you can send the restrictions per installment or maxInstallmentCount parameter which will be applied to invoice on this format: - {"restrictInstallments":[{"maxInstallmentCount":4,"paymentSystemName":"Akbank"},{"maxInstallmentCount":3,"paymentSystemName":"Isbank"}]} So, for Akbank we will list just 4 installments, even if bank supports more than 4 installments. If you want to use Compay, you can send on EXTRA also these parameters to identify if you want to use Loan or Transfer for Compay. {"COMPAY.LOAN": "YES"} or {"COMPAY.TRANSFER":"YES"} or both of them. - {"maxInstallmentCount" : 3}, it will get priority over restrictInstallments.

Request parameters

ACTION:

INVOICEADD, required Max length: 128 Description to be provided

SESSIONTOKEN:

string, conditional Max length: 48 It is a unique value that contains the values for the transaction.

MERCHANT:

string, conditional Max length: 16 Merchant ID, merchant business code defined in Payten Payment Gateway.

MERCHANTUSER:

string, conditional Max length: 128 Merchant API User Email

MERCHANTPASSWORD:

string, conditional Max length: 128 Merchant API User Password

DEALERCODE:

string, required Max length: 32 The Dealer Code area at the B2B Admin Panel > Dealer > Dealer Types section is "Dealer Code".

INVOICEID:

string, conditional Max length: 4000 ID of the invoice

MERCHANTORDERID:

string, conditional Max length: 128 description

NAME:

string, optional Max length: 250 Name

ISSUEDATE:

date, required Max length: 16 Format: [dd-MM-yyyy] Date when the invoice has been issued.

DUEDATE:

date, optional Max length: 16 Format: [dd-MM-yyyy] Due Date of Payment.

AMOUNT:

decimal, required Max length: 30 Default value: '0' Amount of payment / transaction. Please note that, this amount is tax included, MSU doesn't consider any other tax calculation.

ORIGINALAMOUNT:

decimal, optional Max length: 30 Default value: '0' The original amount of the invoice when issued.

CURRENCY:

string, conditional Max length: 3 ISO Alpha transaction currency code like EUR, USD, GBP. See all possible values (37)

DEALERTYPENAME:

string, optional Max length: 256 The Dealer Type you created from the B2B Admin Panel > Dealer > Dealer Types section is "Name".

INVOICETYPE:

string, optional Max length: 8 For INVOICEADD/INVOICEEDIT action this determines the type of the invoice you send. Valid values are SALE, PREAUTH and DISCOUNT. If you omit this parameter on your request, and do not include PREAUTH:YES/NO under EXTRA, it defaults to SALE type. For QUERYINVOICE, you can send this in your request to filter the type of invoice. If you omit this parameter, all three types of invoices are listed. See all possible values (3)

EXTRA:

string, optional Max length: 4000

Extra Parameter is a custom parameter that is used to pass certain parameters for different banks or other usage. This parameter gets its argument as a JSON(URL encoded) format which is then parsed. EXTRA: {"Name" : Value}

Parameters

Below are given parameters that can be sent on extra and examples for each of them. (parameter name is case-insensitive)

• Preauth - parameter to pay invoices by performing Preauthorization. Possible values: YES/NO.
  {"Preauth":"NO"}
• DESCRIPTION - parameter to add description to invoice.
  {"DESCRIPTION":"invoice-description"}
• DisallowCreditCardPayment - parameter to control credit card payments in Dealer Portal Payment Page. The value must be true/false (default value is "false").
  {"DisallowCreditCardPayment":"true"}
• SPLIT PAYMENT PARAMETERS - Those parameter can be sent on extra to be able to make Invoice Split Payment. You need to send set all parameters together
  SpCode - unique code for split payment.
  {"SpCode":"Code-1234567890"}
  SpExactMatch is TRUE/FALSE
  {"SpExactMatch":"true"}
  SpMaxSplitCount is numerical, set up to allow max 3 splits
  {"SpMaxSplitCount":"3"}
  SpGroupNumber field for grouping split payments.
  {"SpGroupNumber":"Code-1234"}
  SpExpirationTime is supposed to be in minutes.
  {"SpExpirationTime":"55"}
• SpExpirationStart The value must be true/false
  {"SpExpirationStart":"true"}