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

 

How to Contact Customer Support

For problems with transaction processing or your connection to the server, please contact Customer Support via phone +90 212 3190625 or info(at)paratika.com.tr email.

Phone number: +90 212 3190625
e-Mail: bilgi@paratika.com.tr

 

What is Paratika?

Paratika is an online payment solution developed by Asseco SEE 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 Standards

More about PCI DSS Data Security Standards

 

Security

Paratika is built on a robust and secure communication protocol. Paratika 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. We only allow the merchant to connect to us in secure https mode using SSL v3. This guarantees 128-bit encryption.

 

Supported Languages

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

 

Response Parsing

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

 

Test Environment

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

Paratika API Test URL

					https://test.paratika.com.tr/paratika/api/v2
				
 

Request & Response

 

Paratika API Requests

A request to the Paratika API is made a by sending a POST HTTP request to Paratika API Endpoint URL. Each HTTP 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.

 

Paratika API Responses

The Paratika 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 (RESPONSE is not equal to 00) the ERROR and ERRORCODE parameters will be present in the response.

Possible values for RESPONSECODE and RESPONSEMESSAGE

Response Code Response Message Description
00 Approved Action done successfully
98 General error Action failed due to general error. A general error can be a runtime error during action processing or a payment gateway error that is not yet mapped in our error set.
99 Declined Action failed due to invalid parameters or payment gateway error.

Pagination

TO BE PROVIDED

TO BE PROVIDED

 

Authentication

You 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 HTTP will fail. You must authenticate properly for all requests.

API Request Authentication Parameters

					MERCHANTUSER: [MERCHANTUSER]
MERCHANTPASSWORD: [MERCHANTPASSWORD]
MERCHANT: [MERCHANT]

				
 

How to integrate?

 

Hosted Page (HP)

This model requires the merchants to use Paratika's payment page hosted in Asseco 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 Paratika 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 Paratika 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. Paratika processes the payment accordingly.

Step 4:

Paratika redirects the Customer Browser to Merchant Web Site and also returns the transaction result.

Please note that Step 4 is a browser based HTTP re-direction and it all happens in customer's environment in which Asseco 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.

Hosted Page (HP) Flow

 

Direct POST - MOTO

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

Extra Point Step:

In Direct Post model merchant need to do a query points with SESSIONTOKEN, CARDPAN,CARDEXPIRY parameters. According to QUERYPOINTS response sample form points input should be set as sale by points samples. And to send the payment to related payment system, merchant needs to send payment system name as paymentSystem input parameter at sample form. Payment system name can be get via QUERYPAYMENTSYSTEMS with SESSIONTOKEN and BIN.

Step 4:

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

Step 5:

Paratika processes the payment details via an invisible interim page.

Step 6:

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

TMX Javascript section in the HTML form below is mandatory.

Direct Post (MOTO) Test Form

Direct Post MOTO Flow



Direct POST Response Parameter Set

Paramater Name Get Value Description
merchantPaymentId request.getParameter('merchantPaymentId') Get from sessionToken
apiMerchantId request.getParameter('apiMerchantId') Get from sessionToken
paymentSystem request.getParameter('paymentSystem') Get from card Number PIN
paymentSystemType request.getParameter('paymentSystemType') Payment System Type information
paymentSystemEftCode request.getParameter('paymentSystemEftCode') Eft code of the payment system
pgTranId request.getParameter('pgTranId') Transaction Id which come from bank side
pgTranDate request.getParameter('pgTranDate') Transaction date at bank side
pgTranRefId request.getParameter('pgTranRefId') Transaction Reference Id which is come from bank side
pgOrderId request.getParameter('pgOrderId') PgOrderId which is the order id at bank side
customerId request.getParameter('customerId') customerId which is the customer Id merchant side
sessionToken request.getParameter('sessionToken') Return the session token which is created at sessionToken action
cardToken request.getParameter('cardToken') Returned if transaction make with card Token
random request.getParameter('random') Random value which is used at veriyfing the SD_SHA512 hash value
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))
SD_SHA512 request.getParameter('SD_SHA512') Deprecated / Legacy - Do not use! Used for hash verification. secretKey is the private merchant key defined once for each merchant, formula :SHA512(sessionToken + merchantPaymentId + responseCode + responseMsg + random + secretKey)
pgTranErrorText request.getParameter('pgTranErrorText') Return only in error case; contains bank transaction error message
pgTranErrorCode request.getParameter('pgTranErrorCode') Return only in error case; contains bank transaction error code
pgTranErrorCode request.getParameter('pgTranErrorCode') Return only in error case; contains bank transaction error code
errorCode request.getParameter('errorCode') Return only in error case; contains Paratika error code
errorMsg request.getParameter('errorMsg') Return only in error case; contains Paratika error message
responseCode request.getParameter('responseCode') Response code of the Paratika
responseMsg request.getParameter('responseMsg') Response message of the Paratika

Sample response for Direct Post Non 3D

					
merchantPaymentId: PaymentId-FbnzDdx04fZu
apiMerchantId: 700100000
paymentSystem: My İşbank VPOS Account (Test)
paymentSystemType: ISBANK
paymentSystemEftCode: 0064
pgTranDate: 20170113 12:20:35
pgTranId: 17013MUjC07014059
pgTranRefId: 701300002882
pgOrderId: PaymentId-FbnzDdx04fZu
sessionToken: FOEMQGVTVWOQCJRSS6DARRRV62RQK2FIKUY7ZMXKBNX6SOUJ
random: -349886350
customerId: Customer-QjOnxH8Z
SD_SHA512: bff497614a8767e3176fede4f3f8274225a8f619469a1c5eafe2e785fbc438aeb5345c51be30d976d53db5b73adf026347db1144c52cbc2133364aa13e933d45
sdSha512: 7f1485a24f1790e0791fe9de5ec33d4e98057578f77a4c39fdd4bd874079d6e3af9271da020c57ed8acd7642ec801ad80dae0c574462a58a6722fbfa361a0b65
responseCode: 00
responseMsg: Approved
                      
				
 

Direct POST - 3D Secure

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

Extra Point Step:

In Direct Post model merchant need to do a query points with SESSIONTOKEN, CARDPAN,CARDEXPIRY parameters. According to QUERYPOINTS response sample form points input should be set as sale by points samples. And to send the payment to related payment system, merchant needs to send payment system name as paymentSystem input parameter at sample form. Payment system name can be get via QUERYPAYMENTSYSTEMS with SESSIONTOKEN and BIN.

Step 4:

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

Step 5:

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

Step 6:

Paratika 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 Paratika 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:

Paratika make return the response to merchant return url

TMX Javascript section in the HTML form below is mandatory.

Direct POST (3D Secure) Test Form

Direct POST (3D Secure) Flow



Sample response for Direct Post 3D

					
merchantPaymentId: PaymentId-FVKAjOiFHeuE
apiMerchantId: 700100000
paymentSystem: ISBANK TEST
paymentSystemType: ISBANK
paymentSystemEftCode: 0064
pgTranDate: 20170112 14:13:13
pgTranId: 17012ONNI07013454
pgTranRefId: 701200002832
pgOrderId: PaymentId-FVKAjOiFHeuE
customerId: Customer-u1Q4G1oG
amount: 11.76
installment: 1
sessionToken: VYD7AXJ6C446GIN55V6KKOB677VRTOZHG5HTSMP3EJCMEQYF
random: tpN2ynMYAn
SD_SHA512: 0f2b4945aefc71f547107898c2002c40d9d4a1508f7f00ee894138f6bc247ebc1238ead5aa01b6ba09bc7932a5957235b7837cc0270781d0a45055fe31648b61
sdSha512: 099e32f8df3130457d2b1595b069794ef6ed08c85a679f72336c5371e91087b223536b317fc43643ae0da06ea29e985a3c8185ab611606308760b0c260aa412f
responseCode: 00
responseMsg: Approved
                      
				
 

API & HPP URLs

API URL: https://entegrasyon.paratika.com.tr/paratika/api/v2
Hosted Payment Page URL (HPP): https://entegrasyon.paratika.com.tr/payment/[SECURE_SESSION_TOKEN]
DirectPost 3D URL: https://entegrasyon.paratika.com.tr/paratika/api/v2/post/sale3d/[SECURE_SESSION_TOKEN]
DirectPost Non3D URL: https://entegrasyon.paratika.com.tr/merchant/post/sale/[SECURE_SESSION_TOKEN]

 

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 Code Description
ERR10010 Required but null parameter.
ERR10011 Multi-definition for the same parameter.
ERR10012 Maximum length exceeded for data.
ERR10013 Data type is not valid.
ERR10014 Security algorithm could not be found.
ERR10015 Invalid merchant information.
ERR10016 Invalid amount.
ERR10017 Invalid currency.
ERR10018 Invalid language.
ERR10019 General error
ERR10020 The user is not authenticated.
ERR10021 Parameter is empty
ERR10022 Items total amount does not match items sum
ERR10023 Payment amount does not match calculated value
ERR10024 Invalid tax amount
ERR10025 Tax amount should be zero
ERR10026 Invalid integration model supplied
ERR10027 Invalid card token provided
ERR10028 Payment system not found
ERR10029 Payment type not found
ERR10030 Transaction not found
ERR10031 Transaction not refundable
ERR10032 Invalid refund amount or a refund has already been made on this transaction.
ERR10033 Transaction cannot be voided
ERR10034 Payment not found
ERR10035 No PREAUTH transaction for payment
ERR10036 Invalid POSTAUTH amount
ERR10037 Cardholder does not exist
ERR10038 There is no payment waiting for confirmation
ERR10039 Invalid payment status
ERR10040 Invalid subaction
ERR10041 Card already exists
ERR10042 Card removed from eWallet
ERR10043 Invalid period specified
ERR10044 Invalid date format
ERR10045 Invalid PAN number
ERR10046 Invalid expiration date
ERR10047 User not authorized to make API calls
ERR10048 A successful Transaction already exists with this Merchant Payment ID
ERR10049 Invalid Merchant Group ID
ERR10050 Hash is not valid
ERR10051 No payment systems. Please make sure that you have at least one payment system.
ERR10052 Unsupported merchant currency:
ERR10053 User not authorized for this merchant
ERR10054 Payment expiry time exceeds maximum limit
ERR10055 Payment expiry time is less than the minimal limit
ERR10056 Invalid API action
ERR10057 Card Bin does not exist
ERR10058 Card already activated
ERR10059 Card already deactivated
ERR10060 Invalid user IP address
ERR10062 Card not yet activated
ERR10063 This action is available only for LetsBodrum cards
ERR10064 Please use a LetsBodrum card or an İşbank credit card
ERR10065 PAN number already exists
ERR10066 Inconsistent Date.
ERR10067 Too Long Period.
ERR10068 Invalid Occurance parametar
ERR10069 Quartz error
ERR10070 Start date should be after now
ERR10071 Invalid Recurring Payment status parametar
ERR10072 Recurring plan already active
ERR10073 Recurring plan already inactive
ERR10074 Recurring plan already expired
ERR10075 Logo Error.
ERR10076 Invalid Recurring Plan status parameter
ERR10078 Transaction is locked
ERR10079 This card is already saved.
ERR10080 Please provide Merchant Payment Id or Payment Token
ERR10081 Invalid Transaction Type
ERR10082 User has no permission to perform this operation
ERR10083 Invalid status
ERR10084 Interest or discount rate must have zero value
ERR10085 Valid To can not be bigger than Valid From
ERR10086 Valid To must be bigger than now
ERR10087 Installment count number already exists in a payment type with this payment system
ERR10088 Installment should be from 1 to 12
ERR10089 Card belonging to recurring plan cannot be deleted.
ERR10090 Transaction failed
ERR10091 Payment system is disabled, cannot perform the transaction. Please contact your Merchant Super Admin
ERR10092 Invalid offset
ERR10093 Invalid limit
ERR10094 Card not found.
ERR10095 Card can not be deleted. There are valid related recurring plans.
ERR10096 Session is invalid.
ERR10097 Session is finalized.
ERR10098 This session token has no permission to perform required action.
ERR10099 This transaction belongs to another merchant.
ERR10100 This payment has more than one successful transactions, please use PGTRANID parameter.
ERR10101 Invalid URL Parameter
ERR10102 Invalid BIN information
ERR10103 Transaction request is denied due to fraud possibility reported by Inact RT service.
ERR10104 No Active Commission Schema
ERR10105 No Payment System Available from the pool
ERR10106 Refund can not be done before due date.
ERR10107 This payment has already been done, therefore no payment session can be created for the given Merchant Payment ID
ERR10108 Merchant is not approved
ERR10109 Payment System Pool for this Merchant is not approved
ERR10110 Campaign code is not supported by payment system
ERR10111 Query Points not supported by payment system
ERR10112 Invalid Points format please check points format at API documentation
ERR10113 Point usage is not supported by payment system
ERR10115 Installment number not supported by merchant
ERR10116 Disabled merchant can not to do this action
ERR10117 This merchantpaymentId is used before and its session expired please use different merchantPaymentId
ERR10118 This merchantPaymentId already in use and one of the amount,currency,sessionType,returnUrl or apiAction parameter changed at this request
ERR10119 Exceed precision or scale (22,4)
ERR10120 Recurring plan code already exists
ERR10121 Invalid recurring plan code
ERR10122 Completed recurring plan can not be updated.
ERR10123 Invalid transaction type.
ERR10125 At least one parameter should be passed for reconciliation
ERR10126 Multiple transactions have found.
ERR10127 Payment system points type don't contains one of the point type in request
ERR10128 Invalid parameter value
ERR10129 Partial point usage not allowed by this payment system
ERR10130 The transaction is rejected due to fraud potential. Please contact to support teram for more details. (TMX rejected)
ERR10131 Existing BKM Transaction Found
ERR10132 Requested BKM Transaction Not Found
ERR10133 It's not an updateable transaction
ERR10134 Payment System Type or EFT not given
ERR10135 Extra parameter can not be decoded
ERR10136 Merchant is not set to use HPP
ERR10137 Query Campaign Not Supported By PaymentSystem
ERR10138 Error processing payment with 3D endpoint
ERR10139 Wrong Integration Model set to Merchant
ERR10140 Transaction type not supported by this payment system.
ERR10141 Unhandled payment integration exception
ERR10142 Invalid Referrer Url
ERR10143 This Pay By Link Payment is already PAID or CANCELED
ERR10144 Merchant is not allowed to process transactions with foreign cards
ERR10145 Recurring Plan not found.
ERR10146 Recurring plan card not found.
ERR10147 You do not have permission to add cards without 3D authentication. Please use HPP model to add cards or contact Paratika support desk for assistance
ERR10148 Recurring plan with this card already exists.
ERR10149 Unsupported currency for this action
ERR10150 Discount amount cannot be higher than sum of order items.
ERR10151 Seller Not Found
ERR10152 Seller with this SellerId already Exists
ERR10153 This transaction is rejected by the Finance team
ERR10154 Transaction is failed by 3D restriction.
ERR10155 Seller is disabled, cannot perform action. Please contact your Super Admins.
ERR10156 Unsupported Currency Conversion
ERR10157 No sub-merchant defined for Vakıfbank payment system.
 

Payment Gateway (vPOS) Errors

The Paratika 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.

Error Code Description
ERR20001 Referral - call bank for manual approval.
ERR20002 Fake Approval, but should not be used in a VPOS system, check with your bank.
ERR20003 Invalid merchant or service provider.
ERR20004 Pick-up card.
ERR20005 Do not honour
ERR20006 Error (found only in file update responses).
ERR20007 Pick up card, special condition.
ERR20008 Fake Approval, but should not be used in a VPOS system, check with your bank.
ERR20009 Issuer bank doesn't support instalments for debit cards.
ERR20011 Fake Approved (VIP), but should not be used in a VPOS system, check with your bank.
ERR20012 Transaction is not valid.
ERR20013 Invalid amount.
ERR20014 Invalid account number.
ERR20015 No such issuer.
ERR20019 Reenter, try again.
ERR20020 Invalid amount.
ERR20021 Unable to back out transaction.
ERR20025 Unable to locate record on file.
ERR20026 Transaction not found
ERR20027 Bank decline
ERR20028 Original is denied
ERR20029 Original not found
ERR20030 Format error (switch generated)
ERR20032 Referral (General)
ERR20033 Expired card, pick-up
ERR20034 Suspected fraud, pick-up
ERR20036 Restricted card, pick-up
ERR20037 Pick up card. Issuer wants card returned
ERR20038 Allowable PIN tries exceeded, pick-up
ERR20040 Refund can not be done before end of day settlement.
ERR20041 Lost card, Pick-up
ERR20043 Stolen card, pick-up
ERR20045 Refund is not supported for sale transactions made via points. Please contact your bank for further details.
ERR20051 Insufficient funds
ERR20052 No checking account
ERR20053 No savings account
ERR20054 Expired card.
ERR20055 Incorrect PIN
ERR20056 No card record
ERR20057 Transaction not permitted to cardholder
ERR20058 Transaction not permitted to terminal
ERR20059 Fraud
ERR20061 Activity amount limit exceeded
ERR20062 Restricted card
ERR20063 Security violation
ERR20065 Activity limit exceeded
ERR20075 Allowable number of PIN tries exceeded
ERR20076 Key synchronization error
ERR20077 Inconsistent data
ERR20080 Date is not valid
ERR20081 Encryption Error
ERR20082 CVV Failure or CVV Value supplied is not valid
ERR20083 Cannot verify PIN
ERR20084 Invalid CVV.
ERR20085 Declined (General)
ERR20086 Not authenticated
ERR20091 Issuer or switch is inoperative
ERR20092 Timeout, reversal is trying
ERR20093 Your credit card is not enabled for online payments. Please call your issuer bank.
ERR20096 System malfunction
ERR20098 Duplicate Reversal
ERR20099 Please try again and if the problem continues please use another card.
ERR200YK Card in black list.
ERR200SF Check HOSTMSG for details.
ERR200GK Foreign cards not permitted to the terminal.
ERR30002 3D transaction is not completed successfully.
 

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.

Example 1:

Paratika core error. Error caused by providing a invalid CARDTOKEN value for SALE action

					{ 
    "errorCode" : "ERR10027", 
    "responseCode" : "99", 
    "errorMsg" : "Geçersiz kart bilgisi (TOKEN) belirtilmiş", 
    "responseMsg" : "Declined",
    "violatorParam" : ""
}                       
				

Example 2:

Payment gateway error. Error caused by insufficient funds on the provided card.

					{
    "errorCode":"ERR20051",
    "responseCode":"99",
    "errorMsg":"Belirtilen kredi kartının limiti bu işlem için yeterli değildir",
    "responseMsg":"Declined",
    "violatorParam":""
}						
				

Example 3:

General error. Error caused by payment error not yet mapped in our error set.

					{
    "errorCode":"ERR20099",
    "responseCode":"99",
    "errorMsg":"Lütfen yeniden deneyiniz, sorun devam ederse bankanızla iletişime geçiniz.",
    "responseMsg":"Declined",
    "violatorParam":""
}						
				

Example 4:

Approved action. No errors.

					{
    "apiMerchantId" : "6008138000",
    "paymentSystem" : "Teb test ps",
    "pgTranDate" : "20141215 17:22:54",
    "merchantPaymentId" : "session-a7bAS3AddR5PApN",
    "pgTranId" : "14349RW4Q89120700",
    "pgTranRefId" : "4398417187960",
    "pgOrderId" : "session-a7bRkDJK091pN",
    "responseCode" : "00",
    "responseMsg" : "Approved"
}						
				
 

Notifications

Paratika has a built-in mechanism that is used to notify the respective merchant of events related to financial transactions.
More specifically, Paratika sends notification messages to a merchant about specific events when:

  • An approved transaction is performed
This notification service is triggered for approved transactions when Paratika receives a response from the bank payment gateway for its request initiated for a particular transaction which confirms that this transaction is approved.
Note that a network timeout of 5 seconds applies when attempting to deliver the notification on merchant's endpoint.

 

How It Works?

A merchant should create a listener endpoint and the URL pointing to this endpoint should be added to this merchant's profile. Paratika then sends notifications to the merchant when a particular event occurs which is mentioned in the list above.
When one such time event occurs, Paratika then sends a secure FORM POST to the URL containing the respective parameters shown in the right.

Sample parameters that are sent

					NOTIFICATIONTYPE: TRANSACTIONAPPROVED
CHANNEL: [MERCHANTBUSINESSID]
CUSTOMER: [CUSTOMERID]
CUSTOMERNAME: [CUSTOMERNAME]   
AMOUNT: [AMOUNT]
TRANSACTIONTYPE: [TRANSACTIONTYPE]
CURRENCY: [CURRENCY]
STATUS: [STATUS]
MERCHANTPAYEMNTID: [MERCHANTPAYMENTID]
PGTRANSACTIONID: [PGTRANSACTIONID]
INSTALLMENTCOUNT: [INSTALLMENTCOUNT]
EFTCODE: [INSTALLMENTCOUNT]
				
 

Metadata

Paratika Domain contains some important ojects and shares them with integrated clients.

 

Transaction

Each financial request refers a transaction in Paratika domain. All settlement is done via transaction records.

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

Transaction Types

					/* Sale */ SALE,
/* Pre-authorization */	PREAUTH,
/* Post-authorization */ POSTAUTH,
/* Refund */ REFUND,
/* Partial Refund */ PTREFUND,
/* Credit, Free refund */ CREDIT,
/* Void action */ VOID
				

Transaction Statuses

					/* In Progress, Created */ IP,
/* CAncelled by CardHolder during approval */ CA,
/* FAiled / Declined (Response from the integrated vPOS) */	FA,
/* APproved (Response from the integrated vPOS) */ AP,
/* VoiDed (As secondary process) (Response from the integrated vPOS) */ VD,
/* Needs manual review (Response from the integrated vPOS exists) */ MR
			 
				
				
 

Other Usage Features

You can find other usages of Paratika API below

 

Pay By Link

Providing an URL Link to the Payment Page is an alternative way of inviting card holders via remote channels like SMS, Mobile App Notificatins, Push Messages, e-Mails etc to make a payment. In this model, merchants need to create a payment page link and send it to their customers. When customers click on the link, they will be directed to the payment page where it already has all the neccessary payment information such as payment amount, shopping basket content etc. Then the customer will enter the card information and complete the payment.

In order to create a payment page link, merchants are required to send a SESSIONTOKEN request to Paratika API by supplying all the relevant parameters. Paratika will process this request, generate a session token information and return it to the merchant. This token is then used to generate the payment page link in order to do a sale or preauth transaction and it's sent to the cardholder (customer). The customer is expected to click on the link and complete the transaction before the link expires. When the clicked link has expired, the cardholder will be directed to the "Finalised Session" page. There is also another page called "Invalid Session" page which is served when the provided payment page link does not include a valid session token value. The expiry duration of the payment page link is set by the merchants using SESSIONTOKEN parameter which has a default value of 7 Days.

The response of successfully completed transactions is posted to the URL address specified in RETURNURL parameter of the SESSIONTOKEN request.

Step 1:

Merchant creates a new session token via Paratika API SESSIONTOKEN request.

Step 2:

Merchant generates payment page link with that session token (E.g. https://test.paratika.com.tr/merchant/payment/[SESSIONTOKEN])

Step 3:

Link will be sent via SMS, e-mail, mobile app notification etc. to customer

Step 4:

Customer goes to the payment page via that link and finish the sale action.

Step 5:

Response of sale action will be returned to the URL which was mentioned on RETURNURL parameter's value as a POST request.

 

Test Cards

Here you can find Test Cards for different Banks
For all Nestpay banks, "a" should be used as 3D Secure password.

Bank API Merchant ID API Name API Username Store Key
AKBANK 100658785 api TEST1111 123456
TEB 400658785 api TEST1111 123456
HALKBANK 500658785 api TEST1111 123456
FINANSBANK 600658785 api TEST1111 123456
ISBANK 700658785 api TEST1111 123456
SEKERBANK 220658785 api TEST1111 123456

Test Cards

					
					
Bank Card Number Card Expiry CVV 3D Secure Password
AKBANK-VISA 4355084355084358 12/2030 000 a
AKBANK-MASTER 5571135571135575 12/2030 000 a
TEB-VISA 4402934402934406 12/2030 000 a
TEB-MASTER 5101385101385104 12/2030 000 a
HALKBANK-VISA 4920244920244921 12/2030 001 a
HALKBANK-MASTER 5404355404355405 12/2030 001 a
FINANSBANK-VISA 4022774022774026 12/2030 000 a
FINANSBANK-MASTER 5456165456165454 12/2030 000 a
ISBANK-VISA 4508034508034509 12/2030 000 a
ISBANK-MASTER 5406675406675403 12/2030 000 a
ANADOLUBANK-VISA 4258464258464253 12/2030 000 a
ANADOLUBANK-MASTER 5222405222405229 12/2030 000 a
HSBC 5100051016005572 01/2020 742 a
INGBANK-VISA 4555714555714556 12/2030 000 a
INGBANK-MASTER 5400245400245409 12/2030 000 a
GARANTI 5342614723204016 01/2017 753
GARANTI 4282209027132016 06/2020 165 123456
KUVEYTTURKV2 4025903160410013 07/2020 123
VAKIBANK 4938410114062912 01/2020 956 GS1905vb03
VAKIBANK 4029400185669885 06/2022 237 12ABCDEF
VAKIBANK 4289450189088488 04/2023 060 12ABCDEF
VAKIBANK 4029400140415945 06/2020 136 KSK1912vb01
YKB 4506347048543223 08/2019 000
YKB 4048097006508842 02/2020 000
YKB 4048097007190236 02/2020 000
YKB 4506347022052795 02/2020 000
 

Financial Transaction

The available transaction types in Paratika system are listed and explained below:

 

Sale

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

Request parameters:
ACTION:
SALE, required Max length: 128 Core parameter which specifies the main action for the API call.
MERCHANTUSER:
string, conditional Max length: 128 API User.
MERCHANTPASSWORD:
string, conditional Max length: 128 API User password.
MERCHANT:
string, conditional Max length: 128 Merchant business code defined in the system.
MERCHANTPAYMENTID:
string, conditional Max length: 128 Unique Payment ID given by Merchant.
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 Amount of payment / transaction. Please note that, this amount is tax included, Paratika doesn't consider any other tax calculation.
CURRENCY:
string, conditional Max length: 3 ISO Alpha transaction currency code like TRY, EUR, USD, GBP. Please check https://en.wikipedia.org/wiki/ISO_4217#Position_of_ISO_4217_code_in_amounts for details. See all possible values (33)
SESSIONTOKEN:
string, conditional Max length: 48 Session token.
CUSTOMEREMAIL:
string, conditional Max length: 64 Customer e-mail. This information should be passed correctly if the customer information services are used.
CUSTOMERNAME:
string, conditional Max length: 128 Name of the Customer. This information should be passed correctly if the customer information services are used.
CUSTOMERPHONE:
string, conditional Max length: 64 Customer phone / mobile number. This information should be passed correctly if the customer information services are used.
CUSTOMERIP:
string, conditional Max length: 39 Customer IP Address
CUSTOMERUSERAGENT:
string, optional Max length: 255 Customer User Agent
CUSTOMERBIRTHDAY:
date, optional Max length: 16 Format: [dd-MM-yyyy] Customer Birthday.
TCKN:
string, optional Max length: 16 Customer Identity Number.
CARDTOKEN:
string, conditional Max length: 64 Secure alphanumeric value replacing card number & expiry date. Required when none of the other card information are provided.
CARDPAN:
string, conditional Max length: 19 PAN (Primary account number), card number. Please check https://en.wikipedia.org/wiki/Bank_card_number for details.
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.
CARDCVV:
string, optional Max length: 3 Security number of the card, CVV value.
SAVECARD:
string, optional Max length: 3 If this has 'yes' value all cards are saved automatically on the payment page.
CARDSAVENAME:
string, optional Max length: 64 Given name for the saved card.
INSTALLMENTS:
integer, optional Max length: 2 Default value: '1' Number of installments. Specified number should exist in the payment system as defined.
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 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"}]

    FINANSBANK SALE BY POINTS SAMPLE

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

    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"}]

    AKTIFBANK SALE BY POINTS SAMPLE

  • POINTS must be json String, you can use POINTS argument in SALE method like below
  • POINTS : [{"name":"KULLANPUAN","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":"5160.02"},{"name":"BNS","value":"91462.68"}]

    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":"283567.72"}]

    SEKERBANK SALE BY POINTS SAMPLE

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

    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"}]
BILLTOADDRESSLINE:
string, conditional Max length: 255 Bill To Address Line
BILLTOCITY:
string, conditional Max length: 32 Bill To City
BILLTOPOSTALCODE:
string, conditional Max length: 16 Bill To Postal Code
BILLTOCOUNTRY:
string, conditional Max length: 32 Bill To Country
An alpha-3 code in ISO 3166-1 standard should be sent.
SHIPTOADDRESSLINE:
string, conditional Max length: 255 Ship To Address Line
SHIPTOCITY:
string, conditional Max length: 32 Ship To City
SHIPTOPOSTALCODE:
string, conditional Max length: 16 Ship To Postal Code
SHIPTOCOUNTRY:
string, conditional Max length: 32 Ship To Country
An alpha-3 code in ISO 3166-1 standard should be sent.
FASTSHIPPING:
string, optional Max length: 3 This param indicates that the shipping option is selected as fast, urgent, quick etc. If fast shipment is the option, then the merchant should send this parameter with "yes" value. See all possible values (2)
EXTRA:
string, optional Max length: 1024 Extra Parameter is a custom parameter that is used to pass additional parameters to session token. This parameter is expected to be in JSON(URL-ENCODED) format. If they are mispelled, they will be ignored! Supported parameters are: CardHolderAgreementMode(value: NONE/SHOW/SHOWCHECKED/SHOWCHECKEDDISABLED), AlwaysSaveCard(value: true/false), BuyerType (value: L for logged in customer; A for anonymous, F for the first shopping with memebership. OR it can be 0, 1, 2 for those cases), IsbankBolumKodu(string).
EXTRA: {"AlwaysSaveCard": "true", "BuyerType": "L", "IsbankBolumKodu": 12, "CardHolderAgreementMode": "SHOWCHECKED"}
SHIPTOPHONE:
string, conditional Max length: 32 Phone number of shipment information
BILLTOPHONE:
string, conditional Max length: 32 Phone number of billment information
BUYERTYPE:
string, optional Max length: 1 Default value: 'A' Member/Anonymous user flag See all possible values ()
SELLERID:
string, optional Max length: 1024 description
COMMISSIONAMOUNT:
string, optional Max length: 512 description
DISCOUNTAMOUNT:
decimal, optional Max length: 30 The amount to be discounted from ORDERITEMS total amount. When provided, the AMOUNT field should be equal to the subtraction of ORDERITEMS total amount with DISCOUNTAMOUNT. (AMOUNT = ORDERITEMS - DISCOUNTAMOUNT)
FORGROUP:
string, optional Max length: 3 Default value: 'YES' Specifies the for group featured usages. Available values are 'yes' and 'no'.

Sample request

					
ACTION: SALE
AMOUNT: 18.75
CURRENCY: TRY
MERCHANTPAYMENTID: PaymentId-3gMvdMzXMj2q
MERCHANTUSER: [MERCHANTUSER]
MERCHANTPASSWORD: [MERCHANTPASSWORD]
MERCHANT: [MERCHANT]
CUSTOMER: Customer-Lsw7mJAm
CUSTOMERNAME: Name Lsw7mJAm
CUSTOMEREMAIL: Lsw7mJAm@email.com
CUSTOMERIP: 127.0.0.1
CUSTOMERUSERAGENT: Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/43.0.2357.81 Safari/537.36
NAMEONCARD: Name Lsw7mJAm
CUSTOMERPHONE: +901638874658
CUSTOMERBIRTHDAY: 01-01-2001
BILLTOADDRESSLINE: Road
BILLTOCITY: Istanbul
BILLTOCOUNTRY: Turkey
BILLTOPOSTALCODE: 1103
BILLTOPHONE: 123456789
SHIPTOADDRESSLINE: Road
SHIPTOCITY: Ankara
SHIPTOCOUNTRY: Turkey
SHIPTOPOSTALCODE: 1105
SHIPTOPHONE: 987654321
CARDPAN: 5456165456165454
CARDEXPIRY: 12.2020
CARDCVV: 000
		 
				

Sample response

					{
  "action" : "SALE",
  "merchant" : "10000000",
  "amount" : 18.75,
  "currency" : "TRY",
  "apiMerchantId" : "600600000",
  "paymentSystem" : "My Finans Webpos Online Account (Test)",
  "paymentSystemType" : "FINANS",
  "paymentSystemEftCode" : "0111",
  "pgTranDate" : "20160729 12:18:53",
  "merchantPaymentId" : "PaymentId-3gMvdMzXMj2q",
  "pgTranId" : "16211MS3D00124776",
  "pgTranRefId" : "621112352883",
  "pgOrderId" : "PaymentId-3gMvdMzXMj2q",
  "responseCode" : "00",
  "responseMsg" : "Approved",
  "tmxSessionQueryOutput" : ""
}                       
				
 

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 Core parameter which specifies the main action for the API call.
MERCHANTUSER:
string, conditional Max length: 128 API User.
MERCHANTPASSWORD:
string, conditional Max length: 128 API User password.
MERCHANT:
string, conditional Max length: 128 Merchant business code defined in the system.
MERCHANTPAYMENTID:
string, conditional Max length: 128 Unique Payment ID given by Merchant.
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 Amount of payment / transaction. Please note that, this amount is tax included, Paratika doesn't consider any other tax calculation.
CURRENCY:
string, conditional Max length: 3 ISO Alpha transaction currency code like TRY, EUR, USD, GBP. Please check https://en.wikipedia.org/wiki/ISO_4217#Position_of_ISO_4217_code_in_amounts for details. See all possible values (33)
SESSIONTOKEN:
string, conditional Max length: 48 Session token.
CARDTOKEN:
string, conditional Max length: 64 Secure alphanumeric value replacing card number & expiry date. Required when none of the other card information are provided.
CARDPAN:
string, conditional Max length: 19 PAN (Primary account number), card number. Please check https://en.wikipedia.org/wiki/Bank_card_number for details.
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, conditional Max length: 64 Customer e-mail. This information should be passed correctly if the customer information services are used.
CUSTOMERNAME:
string, conditional Max length: 128 Name of the Customer. This information should be passed correctly if the customer information services are used.
CUSTOMERPHONE:
string, conditional Max length: 64 Customer phone / mobile number. This information should be passed correctly if the customer information services are used.
CUSTOMERIP:
string, conditional Max length: 39 Customer IP Address
CUSTOMERUSERAGENT:
string, optional Max length: 255 Customer User Agent
CUSTOMERBIRTHDAY:
date, optional Max length: 16 Format: [dd-MM-yyyy] Customer Birthday.
TCKN:
string, optional Max length: 16 Customer Identity Number.
INSTALLMENTS:
integer, optional Max length: 2 Default value: '1' Number of installments. Specified number should exist in the payment system as defined.
CARDCVV:
string, optional Max length: 3 Security number of the card, CVV value.
SAVECARD:
string, optional Max length: 3 If this has 'yes' value all cards are saved automatically on the payment page.
CARDSAVENAME:
string, optional Max length: 64 Given name for the saved card.
BILLTOADDRESSLINE:
string, conditional Max length: 255 Bill To Address Line
BILLTOCITY:
string, conditional Max length: 32 Bill To City
BILLTOPOSTALCODE:
string, conditional Max length: 16 Bill To Postal Code
BILLTOCOUNTRY:
string, conditional Max length: 32 Bill To Country
An alpha-3 code in ISO 3166-1 standard should be sent.
SHIPTOADDRESSLINE:
string, conditional Max length: 255 Ship To Address Line
SHIPTOCITY:
string, conditional Max length: 32 Ship To City
SHIPTOPOSTALCODE:
string, conditional Max length: 16 Ship To Postal Code
SHIPTOCOUNTRY:
string, conditional Max length: 32 Ship To Country
An alpha-3 code in ISO 3166-1 standard should be sent.
FASTSHIPPING:
string, optional Max length: 3 This param indicates that the shipping option is selected as fast, urgent, quick etc. If fast shipment is the option, then the merchant should send this parameter with "yes" value. See all possible values (2)
EXTRA:
string, optional Max length: 1024 Extra Parameter is a custom parameter that is used to pass additional parameters to session token. This parameter is expected to be in JSON(URL-ENCODED) format. If they are mispelled, they will be ignored! Supported parameters are: CardHolderAgreementMode(value: NONE/SHOW/SHOWCHECKED/SHOWCHECKEDDISABLED), AlwaysSaveCard(value: true/false), BuyerType (value: L for logged in customer; A for anonymous, F for the first shopping with memebership. OR it can be 0, 1, 2 for those cases), IsbankBolumKodu(string).
EXTRA: {"AlwaysSaveCard": "true", "BuyerType": "L", "IsbankBolumKodu": 12, "CardHolderAgreementMode": "SHOWCHECKED"}
SHIPTOPHONE:
string, conditional Max length: 32 Phone number of shipment information
BILLTOPHONE:
string, conditional Max length: 32 Phone number of billment information
BUYERTYPE:
string, optional Max length: 1 Default value: 'A' Member/Anonymous user flag See all possible values ()
SELLERID:
string, optional Max length: 32 description
COMMISSIONAMOUNT:
decimal, optional Max length: 30 description
DISCOUNTAMOUNT:
decimal, optional Max length: 30 The amount to be discounted from ORDERITEMS total amount. When provided, the AMOUNT field should be equal to the subtraction of ORDERITEMS total amount with DISCOUNTAMOUNT. (AMOUNT = ORDERITEMS - DISCOUNTAMOUNT)
FORGROUP:
string, optional Max length: 3 Default value: 'YES' Specifies the for group featured usages. Available values are 'yes' and 'no'.

Sample request

					ACTION: PREAUTH
AMOUNT: 18.73
CURRENCY: TRY
MERCHANTPAYMENTID: PaymentId-a1aJk7isjUFa
MERCHANTUSER: [MERCHANTUSER]
MERCHANTPASSWORD: [MERCHANTPASSWORD
MERCHANT: [MERCHANT]
CUSTOMER: Customer-8UtUjDuF
CUSTOMERNAME: Name 8UtUjDuF
CUSTOMEREMAIL: 8UtUjDuF@email.com
CUSTOMERIP: 127.0.0.1
CUSTOMERUSERAGENT: Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/43.0.2357.81 Safari/537.36
NAMEONCARD: Name 8UtUjDuF
CUSTOMERPHONE: +903150474176
CUSTOMERBIRTHDAY: 01-01-2001
BILLTOADDRESSLINE: Road
BILLTOCITY: Istanbul
BILLTOCOUNTRY: Turkey
BILLTOPOSTALCODE: 1103
BILLTOPHONE: 123456789
SHIPTOADDRESSLINE: Road
SHIPTOCITY: Ankara
SHIPTOCOUNTRY: Turkey
SHIPTOPOSTALCODE: 1105
SHIPTOPHONE: 987654321
CARDPAN: 4022774022774026   
CARDEXPIRY: 12.2020
CARDCVV: 000
           
				

Sample response

					{
  "action" : "PREAUTH",
  "merchant" : "10000000",
  "amount" : 18.73,
  "currency" : "TRY",
  "apiMerchantId" : "600600000",
  "paymentSystem" : "My Finans Webpos Online Account (Test)",
  "paymentSystemType" : "FINANS",
  "paymentSystemEftCode" : "0111",
  "pgTranDate" : "20160729 12:28:16",
  "merchantPaymentId" : "PaymentId-a1aJk7isjUFa",
  "pgTranId" : "16211McQE00102144",
  "pgTranRefId" : "621112352885",
  "pgOrderId" : "PaymentId-a1aJk7isjUFa",
  "responseCode" : "00",
  "responseMsg" : "Approved",
  "tmxSessionQueryOutput" : ""
}                     
				
 

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 Core parameter which specifies the main action for the API call.
MERCHANT:
string, conditional Max length: 128 Merchant business code defined in the system.
MERCHANTUSER:
string, conditional Max length: 128 API User.
MERCHANTPASSWORD:
string, conditional Max length: 128 API User password.
SESSIONTOKEN:
string, conditional Max length: 48 Session token.
PGTRANID:
string, conditional Max length: 64 Transaction ID given by payment gateway.
MERCHANTPAYMENTID:
string, conditional Max length: 128 Unique Payment ID given by Merchant.
AMOUNT:
decimal, optional Max length: 30 Default value: '0' Amount of payment / transaction. Please note that, this amount is tax included, Paratika doesn't consider any other tax calculation.

Sample request

					ACTION: POSTAUTH
MERCHANT: [MERCHANT]
MERCHANTPASSWORD: [MERCHANTPASSWORD]
MERCHANTUSER: [MERCHANTUSER]
MERCHANTPAYMENTID: paratika-1352728431091    
				

Sample response

					{
    "action"   : "POSTAUTH",
    "merchant" : "testmerchant",
    "amount"   :   "17.22",
    "currency" : "TRY",
    "pgTranId": "12317QR6A12524",
    "merchantPaymentId": "paratika-1352728431091",
    "responseMsg": "Approved",
    "responseCode": "00",
    "pgTranRefId": "231700000252",
    "pgOrderId": "ORDER-12317QQDG12490",
    "apiMerchantId":"700100000",
    "paymentSystem":"ISBANK TEST",
    "pgTranDate":"20140927 14:51:27"
}                        
				
 

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.

Request parameters:
ACTION:
VOID, required Max length: 128 Core parameter which specifies the main action for the API call.
MERCHANT:
string, conditional Max length: 128 Merchant business code defined in the system.
MERCHANTUSER:
string, conditional Max length: 128 API User.
MERCHANTPASSWORD:
string, conditional Max length: 128 API User password.
SESSIONTOKEN:
string, conditional Max length: 48 Session token.
PGTRANID:
string, conditional Max length: 64 Transaction ID given by payment gateway.
MERCHANTPAYMENTID:
string, conditional Max length: 128 Unique Payment ID given by Merchant.

Sample request

					ACTION: VOID
MERCHANTUSER: [MERCHANTUSER]
MERCHANTPASSWORD: [MERCHANTPASSWORD]
MERCHANT: [MERCHANT]
PGTRANID: 14339MfqD01014997   
				

Sample response

					{
    "merchantPaymentId":"session-QKFRg437iRrg",
    "pgTranId":"14339MfqD01014997",
    "pgTranRefId":"433912398111",
    "pgOrderId":"session-QKFRg437iRrg",
    "responseCode":"00",
    "responseMsg":"Approved"
}                       
				
 

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 Core parameter which specifies the main action for the API call.
MERCHANT:
string, conditional Max length: 128 Merchant business code defined in the system.
MERCHANTUSER:
string, conditional Max length: 128 API User.
MERCHANTPASSWORD:
string, conditional Max length: 128 API User password.
SESSIONTOKEN:
string, conditional Max length: 48 Session token.
AMOUNT:
decimal, optional Max length: 30 Amount of payment / transaction. Please note that, this amount is tax included, Paratika doesn't consider any other tax calculation.
CURRENCY:
string, optional Max length: 3 ISO Alpha transaction currency code like TRY, EUR, USD, GBP. Please check https://en.wikipedia.org/wiki/ISO_4217#Position_of_ISO_4217_code_in_amounts for details. See all possible values (33)
PGTRANID:
string, conditional Max length: 64 Transaction ID given by payment gateway.
MERCHANTPAYMENTID:
string, conditional Max length: 128 Unique Payment ID given by Merchant.

Sample request

					ACTION: REFUND
MERCHANTUSER: [MERCHANTUSER]
MERCHANTPASSWORD: [MERCHANTPASSWORD]
MERCHANT: [MERCHANT]
CURRENCY: TRY
AMOUNT: 17.17
PGTRANID: 14339MjuG01015018
				

Sample response

					{
    "merchantPaymentId":"session-deQdckAmzHK4",
    "pgTranId":"14339MkiG01015022",
    "pgTranRefId":"433912398115",
    "pgOrderId":"session-deQdckAmzHK4",
    "responseCode":"00",
    "responseMsg":"Approved",
    "refundType":"FULL"
}                       
				
 

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 obeying the below criteria :

  • If merchant don't have a sucessfull or voided transation with this merchantPaymentId.
  • If session token is still active, it means the creation time of session token is early than 7 days.
  • If all core paramaters(amount, customer,currency,sessionType and returnUrl) of session token is same unless one of this parameter is changed in other attempts with this sessionToken system return an error code.
  • Merchant can send sessionToken request with same merchantPaymentId according to these rules.

    Request parameters:
    ACTION:
    SESSIONTOKEN, required Max length: 128 Core parameter which specifies the main action for the API call.
    MERCHANTUSER:
    string, required Max length: 128 API User.
    MERCHANTPASSWORD:
    string, required Max length: 128 API User password.
    MERCHANT:
    string, required Max length: 128 Merchant business code defined in the system.
    SESSIONTYPE:
    string, required Max length: 15 Session type is a session for payment or wallet (PAYMENTSESSION or WALLETSESSION) See all possible values (2)
    RETURNURL:
    string, required Max length: 256 Return URL after successful / failed payment.
    MERCHANTPAYMENTID:
    string, conditional Max length: 128 Unique Payment ID given by Merchant.
    AMOUNT:
    decimal, conditional Max length: 30 Amount of payment / transaction. Please note that, this amount is tax included, Paratika doesn't consider any other tax calculation.
    CURRENCY:
    string, conditional Max length: 3 ISO Alpha transaction currency code like TRY, EUR, USD, GBP. Please check https://en.wikipedia.org/wiki/ISO_4217#Position_of_ISO_4217_code_in_amounts for details. See all possible values (33)
    CUSTOMER:
    string, required Max length: 128 The Merchant System ID for customer. It must be unique within a Merchant.
    CUSTOMEREMAIL:
    string, required Max length: 64 Customer e-mail. This information should be passed correctly if the customer information services are used.
    CUSTOMERNAME:
    string, required Max length: 128 Name of the Customer. This information should be passed correctly if the customer information services are used.
    CUSTOMERPHONE:
    string, required Max length: 64 Customer phone / mobile number. This information should be passed correctly if the customer information services are used.
    CUSTOMERBIRTHDAY:
    date, optional Max length: 16 Format: [dd-MM-yyyy] Customer Birthday.
    CUSTOMERIP:
    string, required Max length: 39 Customer IP Address
    CUSTOMERUSERAGENT:
    string, optional Max length: 255 Customer User Agent
    ORDERITEMS:
    string, required Max length: 100000 Order items as array in JSON Format. Order items should be URL encoded. Please see the request samples for valid JSON data format.
    TCKN:
    string, optional Max length: 16 Customer Identity Number.
    SESSIONEXPIRY:
    string, optional Max length: 5 Default value: '168h' Session expiry time, default value is 7 days ( 7x24 hours ).
    LANGUAGE:
    string, optional Max length: 2 Default value: 'tr' Locale of pages displayed during payment.
    SHIPPINGCOST:
    decimal, optional Max length: 30 Shipping cost of payment
    BILLTOADDRESSLINE:
    string, required Max length: 255 Bill To Address Line
    BILLTOCITY:
    string, required Max length: 32 Bill To City
    BILLTOPOSTALCODE:
    string, required Max length: 16 Bill To Postal Code
    BILLTOCOUNTRY:
    string, required Max length: 32 Bill To Country
    An alpha-3 code in ISO 3166-1 standard should be sent.
    SHIPTOADDRESSLINE:
    string, required Max length: 255 Ship To Address Line
    SHIPTOCITY:
    string, required Max length: 32 Ship To City
    SHIPTOPOSTALCODE:
    string, required Max length: 32 Ship To Postal Code
    SHIPTOCOUNTRY:
    string, required Max length: 32 Ship To Country
    An alpha-3 code in ISO 3166-1 standard should be sent.
    FASTSHIPPING:
    string, optional Max length: 3 Default value: 'NO' This param indicates that the shipping option is selected as fast, urgent, quick etc. If fast shipment is the option, then the merchant should send this parameter with "yes" value. See all possible values (2)
    EXTRA:
    string, optional Max length: 1024 Extra Parameter is a custom parameter that is used to pass additional parameters to session token. This parameter is expected to be in JSON(URL-ENCODED) format. If they are mispelled, they will be ignored! Supported parameters are: CardHolderAgreementMode(value: NONE/SHOW/SHOWCHECKED/SHOWCHECKEDDISABLED), AlwaysSaveCard(value: true/false), BuyerType (value: L for logged in customer; A for anonymous, F for the first shopping with memebership. OR it can be 0, 1, 2 for those cases), IsbankBolumKodu(string).
    EXTRA: {"AlwaysSaveCard": "true", "BuyerType": "L", "IsbankBolumKodu": 12, "CardHolderAgreementMode": "SHOWCHECKED"}
    SHIPTOPHONE:
    string, required Max length: 32 Phone number of shipment information
    BILLTOPHONE:
    string, required Max length: 32 Phone number of billment information
    DISCOUNTAMOUNT:
    decimal, optional Max length: 30 The amount to be discounted from ORDERITEMS total amount. When provided, the AMOUNT field should be equal to the subtraction of ORDERITEMS total amount with DISCOUNTAMOUNT. (AMOUNT = ORDERITEMS - DISCOUNTAMOUNT)
    SELLERID:
    string, optional Max length: 1024 description
    COMMISSIONAMOUNT:
    string, optional Max length: 512 description

    Request sample for PAYMENTSESSION

    					ACTION: SESSIONTOKEN   
    MERCHANTUSER: [MERCHANTUSER]   
    MERCHANTPASSWORD: [MERCHANTPASSWORD]
    MERCHANT: [MERCHANT]
    AMOUNT: 11.21
    CURRENCY: TRY
    MERCHANTPAYMENTID: PaymentId-FuldmrwwiOpb
    RETURNURL: https://neon-app.asseco-see.com.tr/msu.merchant/index.jsp
    CUSTOMER: Customer-jNPz2qSI
    CUSTOMERNAME: Name jNPz2qSI
    CUSTOMEREMAIL: jNPz2qSI@email.com
    CUSTOMERIP: 127.0.0.1
    CUSTOMERUSERAGENT: Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/43.0.2357.81 Safari/537.36
    NAMEONCARD: Name jNPz2qSI
    CUSTOMERPHONE: 6381053412
    ORDERITEMS:  [ 
            { 
                "code": "T00D3AITCC", 
                "name": "Galaxy Note 3", 
                "description": "Description of Galaxy Note 3", 
                "quantity": 2, 
                "amount": 449.99
            }, 
            { 
                "code": "B00D9AVYBM", 
                "name": "Samsung Galaxy S III", 
                "description": "Samsung Galaxy S III (S3) Triband White (Boost Mobile)", 
                "quantity": 1, 
                "amount": 149.95 
            }, 
            { 
                "code": "B00NQGP5M8", 
                "name": "Apple iPhone 6", 
                "description": "Apple iPhone 6, Gold, 64 GB (Unlocked) by Apple", 
                "quantity": 1, 
                "amount": 139.95 
            }, 
            { 
                "code": "B00U8KSUIG", 
                "name": "Samsung Galaxy S6", 
                "description": "Samsung Galaxy S6 SM-G920F 32GB (FACTORY UNLOCKED) 5.1 QHDBlack-InternationalVersion", 
                "quantity": 1, 
                "amount": 129.95 
            } 
    ] 
    DISCOUNTAMOUNT: 2.50
    BILLTOADDRESSLINE: Road
    BILLTOCITY: Istanbul
    BILLTOCOUNTRY: Turkey
    BILLTOPOSTALCODE: 1103
    BILLTOPHONE: 123456789
    SHIPTOADDRESSLINE: Road
    SHIPTOCITY: Ankara
    SHIPTOCOUNTRY: Turkey
    SHIPTOPOSTALCODE: 1105
    SHIPTOPHONE: 987654321
    SESSIONTYPE: PAYMENTSESSION
    SELLERID: seller01; seller02
    COMMISSIONAMOUNT: 50.55;35.62
    		
    

    Sample response for PAYMENTSESSION

    					{
      "sessionToken" : "HCZVQH5FIR5QBHBQCT6AMUJLVHEHXCMSQ2HA5I6WCGQKQNQX",
      "responseCode" : "00",
      "responseMsg" : "Approved"
    }
    				

    Request sample for WALLETSESSION

    					ACTION: SESSIONTOKEN   
    AMOUNT: 17.82
    CURRENCY: TRY
    MERCHANTPAYMENTID: PaymentId-DkOxtbUcP7gF
    MERCHANTUSER: [MERCHANTUSER] 
    MERCHANTPASSWORD: [MERCHANTPASSWORD]
    MERCHANT: [MERCHANT]
    RETURNURL: https://neon-app.asseco-see.com.tr/msu.merchant/index.jsp
    CUSTOMER: Customer-PJYbATmL
    CUSTOMERNAME: Name PJYbATmL
    CUSTOMEREMAIL: PJYbATmL@email.com
    CUSTOMERIP: 127.0.0.1
    CUSTOMERUSERAGENT: Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/43.0.2357.81 Safari/537.36
    NAMEONCARD: Name PJYbATmL
    CUSTOMERPHONE: 8487817375
    ORDERITEMS:  [ 
            { 
                "code": "T00D3AITCC", 
                "name": "Galaxy Note 3", 
                "description": "Description of Galaxy Note 3", 
                "quantity": 2, 
                "amount": 449.99
            }, 
            { 
                "code": "B00D9AVYBM", 
                "name": "Samsung Galaxy S III", 
                "description": "Samsung Galaxy S III (S3) Triband White (Boost Mobile)", 
                "quantity": 1, 
                "amount": 149.95 
            }, 
            { 
                "code": "B00NQGP5M8", 
                "name": "Apple iPhone 6", 
                "description": "Apple iPhone 6, Gold, 64 GB (Unlocked) by Apple", 
                "quantity": 1, 
                "amount": 139.95 
            }, 
            { 
                "code": "B00U8KSUIG", 
                "name": "Samsung Galaxy S6", 
                "description": "Samsung Galaxy S6 SM-G920F 32GB (FACTORY UNLOCKED) 5.1 QHDBlack-InternationalVersion", 
                "quantity": 1, 
                "amount": 129.95 
            } 
    ] 
    BILLTOADDRESSLINE: Road
    BILLTOCITY: Istanbul
    BILLTOCOUNTRY: Turkey
    BILLTOPOSTALCODE: 1103
    BILLTOPHONE: 123456789
    SHIPTOADDRESSLINE: Road
    SHIPTOCITY: Ankara
    SHIPTOCOUNTRY: Turkey
    SHIPTOPOSTALCODE: 1105
    SHIPTOPHONE: 987654321
    SESSIONTYPE: WALLETSESSION
    
    
    

    Sample response for WALLETSESSION

    					{
      "sessionToken" : "HZ3JBAFJ72AJTWRR75JOKWTFHMVHG7Y6UH6VTAGABLMV7LID",
      "responseCode" : "00",
      "responseMsg" : "Approved"
    }
    				
     

    Recurring Plan Actions

     

    Add Recurring Plan

    The RECURRINGPLAN action is a group of payments which will be executed separately in specified / scheduled time with defined amount(s).

    Request parameters:
    ACTION:
    RECURRINGPLANADD, required Max length: 128 Core parameter which specifies the main action for the API call.
    MERCHANTUSER:
    string, conditional Max length: 128 API User.
    MERCHANTPASSWORD:
    string, conditional Max length: 128 API User password.
    MERCHANT:
    string, conditional Max length: 128 Merchant business code defined in the system.
    SESSIONTOKEN:
    string, conditional Max length: 48 Session token.
    CARDTOKEN:
    string, conditional Max length: 64 Secure alphanumeric value replacing card number & expiry date. Required when none of the other card information are provided.
    CARDPAN:
    string, conditional Max length: 19 PAN (Primary account number), card number. Please check https://en.wikipedia.org/wiki/Bank_card_number for details.
    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.
    CARDSAVENAME:
    string, optional Max length: 64 Given name for the saved card.
    CUSTOMER:
    string, conditional 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. This information should be passed correctly if the customer information services are used.
    CUSTOMEREMAIL:
    string, required Max length: 64 Customer e-mail. This information should be passed correctly if the customer information services are used.
    CUSTOMERPHONE:
    string, optional Max length: 64 Customer phone / mobile number. This information should be passed correctly if the customer information services are used.
    RECURRINGPLANCODE:
    string, required Max length: 16 Unique code of a recurring plan.
    FIRSTAMOUNT:
    decimal, optional Max length: 30 Amount of the first payment of recurring plan.
    RECURRINGAMOUNT:
    decimal, required Max length: 30 Amount of the recurring payments.
    RECURRENCECOUNT:
    decimal, required Max length: 2 Default value: '1' Recurrence count of a recurring plan.
    FREQUENCY:
    string, required Max length: 4 Frequency of a payment. D for day, M for month, Y should be used for years. (Ex. 5D, 3M, 1Y)
    STARTDATE:
    date, optional Max length: 16 Format: [dd-MM-yyyy] Start date of the transaction query.
    CURRENCY:
    string, conditional Max length: 3 ISO Alpha transaction currency code like TRY, EUR, USD, GBP. Please check https://en.wikipedia.org/wiki/ISO_4217#Position_of_ISO_4217_code_in_amounts for details. See all possible values (33)
    PAYMENTSYSTEM:
    string, optional Max length: 128 Name of the payment system (bank payment gateway / vPOS account). Specified name should match the one given in Paratika. If not provided, Paratika smart switch feature will be used.
    FORGROUP:
    string, optional Max length: 3 Default value: 'YES' Specifies the for group featured usages. Available values are 'yes' and 'no'.

    Request sample for RECURRINGPLAN

    					ACTION: RECURRINGPLANADD   
    MERCHANTUSER: [MERCHANTUSER]   
    MERCHANTPASSWORD: [MERCHANTPASSWORD]
    MERCHANT: [MERCHANT]  
    CUSTOMER: merchant-2yQZyloV
    CUSTOMERNAME: CustomerName 2yQZyloV
    CUSTOMEREMAIL: 2yQZyloV@email.com
    CARDPAN: 4242420000004242
    CARDEXPIRY: 12.2020
    NAMEONCARD: Test User
    RECURRINGPLANCODE: Code-JSjAuDXf
    FIRSTAMOUNT: 1.00
    RECURRINGAMOUNT: 100.00
    RECURRENCECOUNT: 5
    FREQUENCY: 5D
    CURRENCY: TRY
    STARTDATE: 01-10-2015
    PAYMENTSYSTEM: GarantiPOS     
    
    

    Sample response for RECURRINGPLAN

    					{
      "responseCode" : "00",
      "responseMsg" : "Approved",
      "recurringPlanCode" : "Code-JSjAuDXf"
    }
    				

    Edit Recurring Plan

     

    Edit Recurring Plan

    The RECURRINGPLANEDIT is an action that allows you to change some properties of Recurring Plans and Recurring Payments. You can change STATUS, CARD INFORMATION, RECURRING AMOUNT and PAYMENT SYSTEM of recurring plan and STATUS, START DATE and AMOUNT of a specific recurring payment.

    Request parameters:
    ACTION:
    RECURRINGPLANEDIT, required Max length: 128 Core parameter which specifies the main action for the API call.
    MERCHANTUSER:
    string, conditional Max length: 128 API User.
    MERCHANTPASSWORD:
    string, conditional Max length: 128 API User password.
    MERCHANT:
    string, conditional Max length: 128 Merchant business code defined in the system.
    SESSIONTOKEN:
    string, conditional Max length: 48 Session token.
    RECURRINGPLANCODE:
    string, required Max length: 16 Unique code of a recurring plan.
    RECURRINGSTATUS:
    string, optional Max length: 16 Recurring Plan and Recurring Payment status.
    RECURRINGAMOUNT:
    decimal, optional Max length: 30 Amount of the recurring payments.
    PAYMENTSYSTEM:
    string, optional Max length: 128 Name of the payment system (bank payment gateway / vPOS account). Specified name should match the one given in Paratika. If not provided, Paratika smart switch feature will be used.
    RECURRENCE:
    decimal, optional Max length: 2 Recurring Payment order which will be edited.
    STARTDATE:
    date, optional Max length: 16 Format: [dd-MM-yyyy] Start date of the transaction query.
    AMOUNT:
    decimal, optional Max length: 30 Amount of payment / transaction. Please note that, this amount is tax included, Paratika doesn't consider any other tax calculation.

    Request sample for RECURRINGPLAN

    					ACTION: RECURRINGPLANEDIT   
    MERCHANTUSER: [MERCHANTUSER]   
    MERCHANTPASSWORD: [MERCHANTPASSWORD]
    MERCHANT: [MERCHANT]  
    CARDPAN: 
    CARDEXPIRY: 
    NAMEONCARD: 
    RECURRINGPLANCODE: Code-JSjAuDXf
    RECURRINGAMOUNT: 50.00
    RECURRINGSTATUS: INACTIVE
    RECURRENCECOUNT:
    STARTDATE: 
    AMOUNT:
    PAYMENTSYSTEM:      
    
    

    Sample response for RECURRINGPLAN

    					{
      "action" : "RECURRINGPLANEDIT",
      "responseCode" : "00",
      "responseMsg" : "Approved"
    }
    				
     

    Recurring Plan Card Actions

     

    Add Recurring Plan Card

    RECURRINGPLANCARDADD action lets you to add card and relate it to recurring plan.

    Request parameters:
    ACTION:
    RECURRINGPLANCARDADD, required Max length: 128 Core parameter which specifies the main action for the API call.
    SESSIONTOKEN:
    string, conditional Max length: 48 Session token.
    MERCHANTUSER:
    string, conditional Max length: 128 API User.
    MERCHANTPASSWORD:
    string, conditional Max length: 128 API User password.
    MERCHANT:
    string, conditional Max length: 128 Merchant business code defined in the system.
    RECURRINGPLANCODE:
    string, required Max length: 16 Unique code of a recurring plan.
    CARDTOKEN:
    string, conditional Max length: 64 Secure alphanumeric value replacing card number & expiry date. Required when none of the other card information are provided.
    CARDPAN:
    string, conditional Max length: 19 PAN (Primary account number), card number. Please check https://en.wikipedia.org/wiki/Bank_card_number for details.
    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.
    CARDSAVENAME:
    string, optional Max length: 64 Given name for the saved card.

    Request sample for RECURRINGPLANCARDADD

    					ACTION: RECURRINGPLANCARDADD   
    MERCHANT: [MERCHANT]  
    MERCHANTUSER: [MERCHANTUSER]   
    MERCHANTPASSWORD: [MERCHANTPASSWORD]
    CARDPAN: 4242420000004242
    CARDEXPIRY: 12.2020
    NAMEONCARD: Test User
    CARDSAVENAME: Test Name
    CARDTOKEN: 
    RECURRINGPLANCODE: Code-JSjAuDXf   
    
    

    Sample response for RECURRINGPLANCARDADD

    					{
      "responseCode" : "00",
      "responseMsg" : "Approved",
      "cardToken" : "T45FWSAXNHZPC4NYCGVQSYY4INTCCPB3GC5MJ2HGD2YKLCG6"
    }
    				
     

    Delete RecurringPlan Card

    RECURRINGPLANCARDDELETE action lets you to remove relation between card and recurring plan.

    Request parameters:
    ACTION:
    RECURRINGPLANCARDDELETE, required Max length: 128 Core parameter which specifies the main action for the API call.
    SESSIONTOKEN:
    string, conditional Max length: 48 Session token.
    MERCHANTUSER:
    string, conditional Max length: 128 API User.
    MERCHANTPASSWORD:
    string, conditional Max length: 128 API User password.
    MERCHANT:
    string, conditional Max length: 128 Merchant business code defined in the system.
    RECURRINGPLANCODE:
    string, required Max length: 16 Unique code of a recurring plan.
    CARDTOKEN:
    string, required Max length: 64 Secure alphanumeric value replacing card number & expiry date. Required when none of the other card information are provided.

    Request sample for RECURRINGPLANCARDDELETE

    					ACTION: RECURRINGPLANCARDDELETE   
    MERCHANT: [MERCHANT]  
    MERCHANTUSER: [MERCHANTUSER]   
    MERCHANTPASSWORD: [MERCHANTPASSWORD]
    CARDTOKEN: [CARDTOKEN]
    RECURRINGPLANCODE: [RECURRINGPLANCODE]
    
    

    Sample response for RECURRINGPLANCARDDELETE

    					{
      "responseCode" : "00",
      "responseMsg" : "Approved"
    }
    				
     

    e-Wallet actions

     

    Edit Card

    The EWALLETEDITCARD request lets you edit the existing cards by providing their token value. The only fields that are allowed to be edited are the card’s expiry date and the saved card name.

    Request parameters:
    ACTION:
    EWALLETEDITCARD, required Max length: 128 Core parameter which specifies the main action for the API call.
    MERCHANT:
    string, conditional Max length: 128 Merchant business code defined in the system.
    MERCHANTUSER:
    string, conditional Max length: 128 API User.
    MERCHANTPASSWORD:
    string, conditional Max length: 128 API User password.
    SESSIONTOKEN:
    string, conditional Max length: 48 Session token.
    CARDTOKEN:
    string, required Max length: 64 Secure alphanumeric value replacing card number & expiry date. Required when none of the other card information are provided.
    CUSTOMER:
    string, conditional Max length: 128 The Merchant System ID for customer. It must be unique within a Merchant.
    CARDEXPIRY:
    string, optional Max length: 7 Expiry date of the card. Format should be [mm.yy].
    NAMEONCARD:
    string, optional Max length: 64 Name on the card.
    CARDSAVENAME:
    string, optional Max length: 64 Given name for the saved card.

    Sample request

    					MERCHANT: [MERCHANT]
    MERCHANTUSER: [MERCHANTUSER]
    MERCHANTPASSWORD: [MERCHANTPASSWORD]
    ACTION: EWALLETEDITCARD
    CARDTOKEN: ZP7BJ24P5HTA4EKKHMOAEAPWJWSWKMCKQ54EWK37IBAEUPPN
    CARDSAVENAME: My Card Name (New)
    CARDEXPIRY: 12.2020     
    				

    Sample response

    					{
        "cardToken":"ZP7BJ24P5HTA4EKKHMOAEAPWJWSWKMCKQ54EWK37IBAEUPPN",
        "responseCode":"00",
        "responseMsg":"Approved"
    }                       
    				
     

    Delete Card

    The EWALLETDELETECARD request allows you to remove customer cards from Paratika system. Once a card is removed it cannot be queried, edited or used for any kind of payment. The ewalletremove request can be sent to Paratika using the following fields:

    Request parameters:
    ACTION:
    EWALLETDELETECARD, required Max length: 128 Core parameter which specifies the main action for the API call.
    MERCHANT:
    string, conditional Max length: 128 Merchant business code defined in the system.
    MERCHANTUSER:
    string, conditional Max length: 128 API User.
    MERCHANTPASSWORD:
    string, conditional Max length: 128 API User password.
    SESSIONTOKEN:
    string, conditional Max length: 48 Session token.
    CARDTOKEN:
    string, required Max length: 64 Secure alphanumeric value replacing card number & expiry date. Required when none of the other card information are provided.

    Sample request

    					ACTION: EWALLETDELETECARD
    MERCHANT: [MERCHANT]
    MERCHANTUSER: [MERCHANTUSER]
    MERCHANTPASSWORD: [MERCHANTPASSWORD]
    CARDTOKEN: ZP7BJ24P5HTA4EKKHMOAEAPWJWSWKMCKQ54EWK37IBAEUPPN
    				

    SampleRespons

    					{
        "responseCode":"00",
        "responseMsg":"Approved"
    }                       
    				
     

    Seller Actions

     

    Add Seller

    The SELLERADD action lets you add a seller. You should give the required parameters also optional parameters like TCKN.

    Request parameters:
    ACTION:
    SELLERADD, required Max length: 128 Core parameter which specifies the main action for the API call.
    SESSIONTOKEN:
    string, conditional Max length: 48 Session token.
    MERCHANTUSER:
    string, conditional Max length: 128 API User.
    MERCHANTPASSWORD:
    string, conditional Max length: 128 API User password.
    MERCHANT:
    string, conditional Max length: 128 Merchant business code defined in the system.
    SELLERID:
    string, required Max length: 32 description
    NAME:
    string, required Max length: 128 Name
    LASTNAME:
    string, required Max length: 128 description
    EMAIL:
    string, required Max length: 128 description
    MOBILENUMBER:
    string, required Max length: 64 description
    TCKN:
    string, optional Max length: 11 Customer Identity Number.
    IBAN:
    string, optional Max length: 34 description
    ACCOUNTOWNERNAME:
    string, optional Max length: 34 description
    ACCOUNTOWNERLASTNAME:
    string, optional Max length: 34 description

    Request sample for SELLERADD

    					ACTION: SELLERADD
    MERCHANT: [MERCHANT]
    MERCHANTUSER: [MERCHANTUSER]
    MERCHANTPASSWORD: [MERCHANTPASSWORD]
    SELLERID: [SELLER ID]
    NAME: [SELLER NAME]
    LASTNAME: [SELLER LASTNAME]
    EMAIL: [seller@email.com]
    MOBILENUMBER: [1234567890]
    TCKN: [012345678911]
    
    

    Sample response for SELLERADD

    					{
      "responseCode" : "00",
      "responseMsg" : "Approved",
      "seller" : {
        "sellerId" : "Seller-vd6ShJUF",
        "name" : "Seller01",
        "lastName" : "LastName-XKGo",
        "email" : "seler01@email.com",
        "mobileNumber" : "+900408866157",
        "status" : "WA",
        "merchant" : {
          "businessId" : "10000000",
          "name" : "MSU Test Merchant",
          "address" : "İTÜ Ayazağa Kampüsü Teknokent ARI 1 Binası No: 12 34469 Maslak",
          "phone" : "+902123650505",
          "webAddress" : "http://www.asseco-see.com.tr/"
        }
      }
    }
    				
     

    Edit Seller

    The SELLEREDIT action lets you edit an existing seller. You should provide seller id and merchant and you can update name, last name, mobile number, email, TCKN and status.

    Request parameters:
    ACTION:
    SELLEREDIT, required Max length: 128 Core parameter which specifies the main action for the API call.
    MERCHANTUSER:
    string, conditional Max length: 128 API User.
    MERCHANTPASSWORD:
    string, conditional Max length: 128 API User password.
    MERCHANT:
    string, conditional Max length: 128 Merchant business code defined in the system.
    SELLERID:
    string, required Max length: 32 description
    NAME:
    string, optional Max length: 128 Name
    LASTNAME:
    string, optional Max length: 128 description
    EMAIL:
    string, optional Max length: 128 description
    MOBILENUMBER:
    string, optional Max length: 64 description
    STATUS:
    string, optional Max length: 2 Status information. See all possible values (3)
    TCKN:
    string, optional Max length: 11 Customer Identity Number.
    IBAN:
    string, optional Max length: 34 description
    ACCOUNTOWNERNAME:
    string, optional Max length: 34 description
    ACCOUNTOWNERLASTNAME:
    string, optional Max length: 34 description

    Request sample for SELLEREDIT

    					ACTION: SELLERADD
    MERCHANT: [MERCHANT]
    MERCHANTUSER: [MERCHANTUSER]
    MERCHANTPASSWORD: [MERCHANTPASSWORD]
    SELLERID: [SELLER ID]
    NAME: []
    LASTNAME: []
    EMAIL: []
    MOBILENUMBER: []
    TCKN: []
    STATUS: []
    
    

    Sample response for SELLEREDIT

    					{
      "responseCode" : "00",
      "responseMsg" : "Approved",
      "seller" : {
        "sellerId" : "Seller-vd6ShJUF",
        "name" : "Seller01",
        "lastName" : "LastName-XKGo",
        "email" : "seler01@email.com",
        "mobileNumber" : "+900408866157",
        "status" : "OK",
        "merchant" : {
          "businessId" : "10000000",
          "name" : "MSU Test Merchant",
          "address" : "İTÜ Ayazağa Kampüsü Teknokent ARI 1 Binası No: 12 34469 Maslak",
          "phone" : "+902123650505",
          "webAddress" : "http://www.asseco-see.com.tr/"
        }
      }
    }
    				
     

    Currency Actions

     

    Currency Exchange

    Currency Exchange

    Request parameters:
    ACTION:
    CURRENCYEXCHANGE, required Max length: 128 Core parameter which specifies the main action for the API call.
    SESSIONTOKEN:
    string, conditional Max length: 48 Session token.
    MERCHANTUSER:
    string, conditional Max length: 128 API User.
    MERCHANTPASSWORD:
    string, conditional Max length: 128 API User password.
    MERCHANT:
    string, conditional Max length: 128 Merchant business code defined in the system.
    FROMCURRENCY:
    string, required Max length: 3 description See all possible values (33)
    TOCURRENCY:
    string, required Max length: 3 description See all possible values (33)
    AMOUNT:
    decimal, optional Max length: 30 Amount of payment / transaction. Please note that, this amount is tax included, Paratika doesn't consider any other tax calculation.

    Sample Request For CURRENCYEXCHANGE

    					ACTION: CURRENCYEXCHANGE
    MERCHANTUSER: apiuser@testmerchant.com   
    MERCHANTPASSWORD: Pluto321`   
    MERCHANT: 10000000      
    FROMCURRENCY: USD   
    TOCURRENCY: TRY   
    AMOUNT: 10.00 
    
    

    Sample Response For CURRENCYEXCHANGE

    				{
    	"fromCurrency": "USD",
    	"toCurrency": "TRY",
    	"amount": "10.00",
    	"convertedAmount": "60.62"
    }
    				
     

    Edit Seller

    The SELLEREDIT action lets you edit an existing seller. You should provide seller id and merchant and you can update name, last name, mobile number, email, TCKN and status.

    Request parameters:
    ACTION:
    SELLEREDIT, required Max length: 128 Core parameter which specifies the main action for the API call.
    MERCHANTUSER:
    string, conditional Max length: 128 API User.
    MERCHANTPASSWORD:
    string, conditional Max length: 128 API User password.
    MERCHANT:
    string, conditional Max length: 128 Merchant business code defined in the system.
    SELLERID:
    string, required Max length: 32 description
    NAME:
    string, optional Max length: 128 Name
    LASTNAME:
    string, optional Max length: 128 description
    EMAIL:
    string, optional Max length: 128 description
    MOBILENUMBER:
    string, optional Max length: 64 description
    STATUS:
    string, optional Max length: 2 Status information. See all possible values (3)
    TCKN:
    string, optional Max length: 11 Customer Identity Number.
    IBAN:
    string, optional Max length: 34 description
    ACCOUNTOWNERNAME:
    string, optional Max length: 34 description
    ACCOUNTOWNERLASTNAME:
    string, optional Max length: 34 description

    Request sample for SELLEREDIT

    					ACTION: SELLERADD
    MERCHANT: [MERCHANT]
    MERCHANTUSER: [MERCHANTUSER]
    MERCHANTPASSWORD: [MERCHANTPASSWORD]
    SELLERID: [SELLER ID]
    NAME: []
    LASTNAME: []
    EMAIL: []
    MOBILENUMBER: []
    TCKN: []
    STATUS: []
    
    

    Sample response for SELLEREDIT

    					{
      "responseCode" : "00",
      "responseMsg" : "Approved",
      "seller" : {
        "sellerId" : "Seller-vd6ShJUF",
        "name" : "Seller01",
        "lastName" : "LastName-XKGo",
        "email" : "seler01@email.com",
        "mobileNumber" : "+900408866157",
        "status" : "OK",
        "merchant" : {
          "businessId" : "10000000",
          "name" : "MSU Test Merchant",
          "address" : "İTÜ Ayazağa Kampüsü Teknokent ARI 1 Binası No: 12 34469 Maslak",
          "phone" : "+902123650505",
          "webAddress" : "http://www.asseco-see.com.tr/"
        }
      }
    }
    				
     

    Query Actions

     

    Query Transaction

    The Query Transaction request will return the details of successful transaction(s) for a specified order/payment (using MerchantPaymentID) or transaction (using PGTRANID) including the status of payment, the bank (payment system / vpos) that processed the transaction, number of installments and the interest rate.

    Request parameters:
    ACTION:
    QUERYTRANSACTION, required Max length: 128 Core parameter which specifies the main action for the API call.
    MERCHANT:
    string, required Max length: 128 Merchant business code defined in the system.
    MERCHANTUSER:
    string, required Max length: 128 API User.
    MERCHANTPASSWORD:
    string, required Max length: 128 API User password.
    PGTRANID:
    string, optional Max length: 64 Transaction ID given by payment gateway.
    TRANSACTIONSTATUS:
    string, optional Max length: 18 Status of Transaction.
    STARTDATE:
    date, optional Max length: 16 Format: [dd-MM-yyyy HH:mm] Start date of the transaction query.
    ENDDATE:
    date, optional Max length: 16 Format: [dd-MM-yyyy HH:mm] End date of the transaction query.
    OFFSET:
    string, optional Max length: 4 Default value: '0' Specifies the number from which the transactions will start for paginated data.
    LIMIT:
    string, optional Max length: 4 Default value: '1000' The maximum number of transactions in response.
    MERCHANTPAYMENTID:
    string, optional Max length: 128 Unique Payment ID given by Merchant.
    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. This information should be passed correctly if the customer information services are used.
    CUSTOMERNAME:
    string, optional Max length: 128 Name of the Customer. This information should be passed correctly if the customer information services are used.
    CUSTOMERPHONE:
    string, optional Max length: 64 Customer phone / mobile number. This information should be passed correctly if the customer information services are used.
    SELLERID:
    string, optional Max length: 32 description
    FORGROUP:
    string, optional Max length: 3 Default value: 'YES' Specifies the for group featured usages. Available values are 'yes' and 'no'.

    Sample request

    					ACTION: QUERYTRANSACTION
    MERCHANT: [MERCHANT]
    MERCHANTUSER: [MERCHANTUSER]
    MERCHANTPASSWORD: [MERCHANTPASSWORD]
    PGTRANID: 18285OQZD14766
    				

    Sample response

    					{
      "responseCode" : "00",
      "responseMsg" : "Approved",
      "transactionCount" : "1",
      "totalTransactionCount" : "1",
      "transactionList" : [ {
        "pgTranTraceAudit" : "828514893296",
        "pgTranReturnCode" : "00",
        "pgOrderId" : "10000000-PaymentId-mQ15HqoF7d8f",
        "pgTranApprCode" : "294906",
        "pgTranId" : "18285OQZD14766",
        "pgTranRefId" : "828514893296",
        "timePsSent" : "2018-10-12 14:16:26.815",
        "timePsReceived" : "2018-10-12 14:16:27.967",
        "timeCreated" : "2018-10-12 14:16:26.474",
        "amount" : 80,
        "transactionStatus" : "AP",
        "currency" : "TRY",
        "paymentSystem" : "My Finans Webpos Online Account (Test)",
        "panLast4" : "4026",
        "transactionType" : "SALE",
        "installmentCount" : 1,
        "cardOwnerMasked" : "N*** G***",
        "customerId" : "Customer-GUZUbLrQ",
        "bin" : "402277",
        "sellers" : [ {
          "sellerId" : "tigran",
          "commissionAmount" : 10
        }, {
          "sellerId" : "benjamin",
          "commissionAmount" : 10
        }, {
          "sellerId" : "aurela",
          "commissionAmount" : 20
        }, {
          "sellerId" : "alfred",
          "commissionAmount" : 4.5
        }, {
          "sellerId" : "john",
          "commissionAmount" : 10
        }, {
          "sellerId" : "alketa",
          "commissionAmount" : 5.5
        }, {
          "sellerId" : "nora",
          "commissionAmount" : 10
        }, {
          "sellerId" : "kate",
          "commissionAmount" : 10
        } ]
      } ]
    }                       
    				
     

    Query Installment

    The QUERYINSTALLMENT request will return the available installments which can be used by card holder.

    Request parameters:
    ACTION:
    QUERYINSTALLMENT, required Max length: 128 Core parameter which specifies the main action for the API call.
    MERCHANT:
    string, conditional Max length: 128 Merchant business code defined in the system.
    MERCHANTUSER:
    string, conditional Max length: 128 API User.
    MERCHANTPASSWORD:
    string, conditional Max length: 128 API User password.
    SESSIONTOKEN:
    string, conditional Max length: 48 Session token.
    BIN:
    string, optional Max length: 6 BIN value (first 6 PAN digits). Please check https://en.wikipedia.org/wiki/Bank_card_number for details.

    Sample request

    					ACTION: QUERYINSTALLMENT
    MERCHANT: [MERCHANT]
    MERCHANTUSER: [MERCHANTUSER]
    MERCHANTPASSWORD: [MERCHANTPASSWORD]
    		           
    				

    Sample response

    					{
      "responseCode" : "00",
      "responseMsg" : "Approved",
      "paymentSystemEftCode" : "0111",
      "paymentSystemNetwork" : "CARD_FNS",
      "paymentSystemList" : [ {
        "name" : "My Finans Webpos Online Account (Test)",
        "paymentSystem" : 1,
        "installmentList" : [ {
          "count" : "NOT_ON_US",
          "customerCostCommissionRate" : 0
        }, {
          "count" : "4",
          "customerCostCommissionRate" : 0
        }, {
          "count" : "5",
          "customerCostCommissionRate" : 0
        }, {
          "count" : "6",
          "customerCostCommissionRate" : 0
        }, {
          "count" : "7",
          "customerCostCommissionRate" : 0
        }, {
          "count" : "8",
          "customerCostCommissionRate" : 0
        } ]
      }, {
        "name" : "My Sanalakpos Account (Test)",
        "paymentSystem" : 2,
        "paymentSystemEftCode" : "0046",
        "paymentSystemNetwork" : "AXESS",
        "installmentList" : [ {
          "count" : "NOT_ON_US",
          "customerCostCommissionRate" : 0
        }, {
          "count" : "4",
          "customerCostCommissionRate" : 0
        }, {
          "count" : "5",
          "customerCostCommissionRate" : 0
        }, {
          "count" : "6",
          "customerCostCommissionRate" : 0
        }, {
          "count" : "7",
          "customerCostCommissionRate" : 0
        }, {
          "count" : "8",
          "customerCostCommissionRate" : 0
        } ]
      }, {
        "name" : "My Halkbank Sanalpos Account (Test)",
        "paymentSystem" : 3,
        "paymentSystemEftCode" : "0012",
        "paymentSystemNetwork" : "PARAF",
        "installmentList" : [ {
          "count" : "NOT_ON_US",
          "customerCostCommissionRate" : 0
        }, {
          "count" : "4",
          "customerCostCommissionRate" : 0
        }, {
          "count" : "5",
          "customerCostCommissionRate" : 0
        }, {
          "count" : "6",
          "customerCostCommissionRate" : 0
        }, {
          "count" : "7",
          "customerCostCommissionRate" : 0
        }, {
          "count" : "8",
          "customerCostCommissionRate" : 0
        } ]
      }, {
        "name" : "ISBANK TEST",
        "paymentSystem" : 4,
        "paymentSystemEftCode" : "0064",
        "paymentSystemNetwork" : "MAXIMUM",
        "installmentList" : [ {
          "count" : "NOT_ON_US",
          "customerCostCommissionRate" : 0
        }, {
          "count" : "4",
          "customerCostCommissionRate" : 0
        }, {
          "count" : "5",
          "customerCostCommissionRate" : 0
        }, {
          "count" : "6",
          "customerCostCommissionRate" : 0
        }, {
          "count" : "7",
          "customerCostCommissionRate" : 0
        }, {
          "count" : "8",
          "customerCostCommissionRate" : 0
        } ]
      } ]
    }                      
    				
     

    Query Card

    The QUERYCARD request can be used to get all the card tokens saved for a particular cardholder (customer) or the details of the card based on the given token value.

    Request parameters:
    ACTION:
    QUERYCARD, required Max length: 128 Core parameter which specifies the main action for the API call.
    MERCHANT:
    string, conditional Max length: 128 Merchant business code defined in the system.
    MERCHANTUSER:
    string, conditional Max length: 128 API User.
    MERCHANTPASSWORD:
    string, conditional Max length: 128 API User password.
    SESSIONTOKEN:
    string, conditional Max length: 48 Session token.
    CARDTOKEN:
    string, optional Max length: 64 Secure alphanumeric value replacing card number & expiry date. Required when none of the other card information are provided.
    CARDSAVENAME:
    string, optional Max length: 64 Given name for the saved card.
    CUSTOMER:
    string, optional Max length: 128 The Merchant System ID for customer. It must be unique within a Merchant.
    FORGROUP:
    string, optional Max length: 3 Default value: 'YES' Specifies the for group featured usages. Available values are 'yes' and 'no'.
    OFFSET:
    integer, optional Max length: 4 Default value: '0' Specifies the number from which the transactions will start for paginated data.
    LIMIT:
    integer, optional Max length: 4 Default value: '1000' The maximum number of transactions in response.

    Sample request

    					ACTION: QUERYCARD
    MERCHANT: [MERCHANT]
    MERCHANTUSER: [MERCHANTUSER]
    MERCHANTPASSWORD: [MERCHANTPASSWORD]
    CUSTOMER: merchant20140920
    				

    Sample response

    					{
        "responseCode":"00",
        "responseMsg":"Approved",
        "cardCount":"1",
        "totalCardCount":"1",
        "cardList":[{
             "cardToken":"YGQHGWH4L3V3T6M2W6HHZ6FGJCZ5EKI5SBFGHHZORD55P6YV", 
             "cardOwner":"NAME SURNAME", 
             "panLast4":"0520", 
             "customer":"merchant20140920", 
             "cardBin":"540667", 
             "cardbrand":"MC", 
             "cardType":"CREDIT", 
             "cardLevel":"CLASSIC", 
             "cardNetwork":"MAXIMUM", 
             "cardIssuer":"T. IS BANKASI A.S.", 
             "cardVirtual":"NO", 
             "cardCountryIso":"TUR", 
             "cardPaymentSystem":"ISBANK TEST", 
             "cardExpiry":"01.2023", 
             "cardName":"ISBANKASI", 
             "pan":"540667***0520" 
        }]
    }                       
    				
     

    Query Card Expiry

    The QUERYCARDEXPIRY request can be used to get all the cards that will be expired in this and the next month.

    Request parameters:
    ACTION:
    QUERYCARDEXPIRY, required Max length: 128 Core parameter which specifies the main action for the API call.
    MERCHANT:
    string, required Max length: 128 Merchant business code defined in the system.
    MERCHANTUSER:
    string, required Max length: 128 API User.
    MERCHANTPASSWORD:
    string, required Max length: 128 API User password.
    CUSTOMER:
    string, required Max length: 128 The Merchant System ID for customer. It must be unique within a Merchant.
    OFFSET:
    string, optional Max length: 4 Default value: '0' Specifies the number from which the transactions will start for paginated data.
    LIMIT:
    string, optional Max length: 4 Default value: '1000' The maximum number of transactions in response.
    FORGROUP:
    string, optional Max length: 3 Default value: 'YES' Specifies the for group featured usages. Available values are 'yes' and 'no'.

    Sample request

    					ACTION: QUERYCARDEXPIRY
    MERCHANT: [MERCHANT]
    MERCHANTUSER: [MERCHANTUSER]
    MERCHANTPASSWORD: [MERCHANTPASSWORD]
    CUSTOMER: merchant20140920
    				

    Sample response

    					{
        "responseCode":"00",
        "responseMsg":"Approved",
        "cardCount":"1",
        "totalCardCount":"1",
        "cardList":[{
            "cardToken" : "YGQHGWH4L3V3T6M2W6HHZ6FGJCZ5EKI5SBFGHHZORD55P6YV",
            "cardOwner" : "NAME SURNAME",
            "panLast4" : "0520",
            "customer" : "merchant20140920",
            "cardBin" : "540667",
            "cardExpiry" : "04.2015",
            "pan" : "540667***0520"
        }]
    }                       
    				
     

    Query Session

    The QUERYSESSION request can be used to get merchant, customer and session information of a valid session.

    Request parameters:
    ACTION:
    QUERYSESSION, required Max length: 128 Core parameter which specifies the main action for the API call.
    SESSIONTOKEN:
    string, required Max length: 48 Session token.

    Sample request

    					ACTION: QUERYSESSION
    SESSIONTOKEN: [SESSIONTOKEN]	
    			
    				

    Sample response

    					{
      "responseCode" : "00",
      "responseMsg" : "Approved",
      "session" : {
        "token" : "EMEVAXFGO7G4UWRTJD3R5QJ5ZOQJLY4YWLAOQJRKE7A2Z36L",
        "apiAction" : "SESSIONTOKEN",
        "merchantPaymentId" : "PaymentId-bl94pcHQ1mpO",
        "firstAmount" : 18.63,
        "amount" : 18.63,
        "currency" : "TRY",
        "returnUrl" : "https://neon-app.asseco-see.com.tr/msu.merchant/index.jsp",
        "language" : "tr",
        "redirectWaitingTime" : 0,
        "itemTotalAmount" : 18.63,
        "shippingCost" : 0,
        "shippingContact" : {
          "address" : "Road",
          "city" : "Ankara",
          "country" : "Turkey",
          "postalCode" : "1105",
          "phone" : "987654321"
        },
        "billingContact" : {
          "address" : "Road",
          "city" : "Istanbul",
          "country" : "Turkey",
          "postalCode" : "1103",
          "phone" : "123456789"
        },
        "fastShipping" : false
      },
      "merchant" : {
        "businessId" : "***",
        "name" : "MSU Test Merchant",
        "tradingName" : "Trading name",
        "address" : "İTÜ Ayazağa Kampüsü Teknokent ARI 1 Binası No: 12 34469 Maslak",
        "phone" : "+902123650505",
        "fax" : "+902123650555",
        "webAddress" : "http://www.asseco-see.com.tr/",
        "additionalDetails" : "Asseco SEE",
        "secretKey" : "***",
        "paymentPolicy" : "THD_ALL",
        "domains" : "www.domain.com,https://www.google.com/,alketa.com",
        "preInformationText" : "

    NA

    ", "remoteSalesAgreement" : "

    NA

    ", "useHpp" : true, "integrationModel" : "API" }, "customer" : { "id" : "Customer-CVnUJCST", "email" : "CVnUJCST@email.com", "phone" : "+906613328056", "name" : "Name CVnUJCST", "birthday" : "2001-01-01", "lastLogin" : "16.10.2017 14:24" }, "orderItems" : [ { "code" : "u91f4", "name" : "seat belt", "description" : "seat belt description ...", "amount" : 9.01, "quantity" : 1 }, { "code" : "1rnxq8", "name" : "lace", "description" : "lace description ...", "amount" : 3.39, "quantity" : 1 }, { "code" : "bdvhiv", "name" : "television", "description" : "television description ...", "amount" : 4.5, "quantity" : 1 }, { "code" : "5cwai", "name" : "mp3 player", "description" : "mp3 player description ...", "amount" : 1.6, "quantity" : 1 }, { "code" : "vhlt5d", "name" : "bookmark", "description" : "bookmark description ...", "amount" : 0.13, "quantity" : 1 } ] }
     

    Query Bin

    The QUERYBIN Request can be used to get BIN information

    Request parameters:
    ACTION:
    QUERYBIN, required Max length: 128 Core parameter which specifies the main action for the API call.
    MERCHANT:
    string, conditional Max length: 128 Merchant business code defined in the system.
    MERCHANTUSER:
    string, conditional Max length: 128 API User.
    MERCHANTPASSWORD:
    string, conditional Max length: 128 API User password.
    SESSIONTOKEN:
    string, conditional Max length: 48 Session token.
    BIN:
    string, conditional Max length: 6 BIN value (first 6 PAN digits). Please check https://en.wikipedia.org/wiki/Bank_card_number for details.
    CARDTOKEN:
    string, conditional Max length: 64 Secure alphanumeric value replacing card number & expiry date. Required when none of the other card information are provided.

    Sample request

    					ACTION: QUERYPAYMENTSYSTEMS
    MERCHANT: [MERCHANT]
    MERCHANTUSER: [MERCHANTUSER]
    MERCHANTPASSWORD: [MERCHANTPASSWORD]
    BIN: 511452
    				

    Sample response

    					{
      "responseCode" : "00",
      "responseMsg" : "Approved",
      "bin" : {
        "bin" : "450803",
        "cardBrand" : "VISA",
        "cardType" : "CREDIT",
        "cardLevel" : "BUSINESS",
        "cardNetwork" : "MAXIMUM",
        "issuer" : "T. IS BANKASI A.S.",
        "virtual" : "NO",
        "countryIsoA3" : "TUR"
      }
    } 	
    				
     

    Payment Systems

    Payment Systems QUERYPAYMENTSYSTEMS Request can be used to get all available payment systems

    Request parameters:
    ACTION:
    QUERYPAYMENTSYSTEMS, required Max length: 128 Core parameter which specifies the main action for the API call.
    SESSIONTOKEN:
    string, conditional Max length: 48 Session token.
    MERCHANT:
    string, conditional Max length: 128 Merchant business code defined in the system.
    MERCHANTUSER:
    string, conditional Max length: 128 API User.
    MERCHANTPASSWORD:
    string, conditional Max length: 128 API User password.
    BIN:
    string, conditional Max length: 6 BIN value (first 6 PAN digits). Please check https://en.wikipedia.org/wiki/Bank_card_number for details.
    CARDTOKEN:
    string, conditional Max length: 64 Secure alphanumeric value replacing card number & expiry date. Required when none of the other card information are provided.

    Sample request

    					ACTION: QUERYPAYMENTSYSTEMS
    MERCHANT: [MERCHANT]
    MERCHANTUSER: [MERCHANTUSER]
    MERCHANTPASSWORD: [MERCHANTPASSWORD]
    BIN: 511452
    				

    Sample response

    					{
      "responseCode" : "00",
      "responseMsg" : "Approved",
      "installmentPaymentSystem" : {
        "name" : "ISBANK TEST",
        "paymentSystem" : 1,
        "paymentSystemEftCode": "0064",
        "installmentList" : [ {
          "count" : "2",
          "customerCostCommissionRate" : 0.5
        }, {
          "count" : "3",
          "customerCostCommissionRate" : 0.5
        }, {
          "count" : "4",
          "customerCostCommissionRate" : 0.5
        }, {
          "count" : "5",
          "customerCostCommissionRate" : 0.5
        }, {
          "count" : "6",
          "customerCostCommissionRate" : 0.5
        } ]
      },
      "oneShotPaymentSystem" : {
        "name" : "My Sanalakpos Account (Test)",
        "paymentSystem" : 1,
        "paymentSystemEftCode" : "0046",
        "installmentList" : [ {
          "count" : "1",
          "customerCostCommissionRate" : 0.3
        } ]
      }
    } 	
    				
     

    Query PAN

    The QUERYPAN request can be used to get BIN information for the specified card pan.

    Request parameters:
    ACTION:
    QUERYPAN, required Max length: 128 Core parameter which specifies the main action for the API call.
    MERCHANT:
    string, conditional Max length: 128 Merchant business code defined in the system.
    MERCHANTUSER:
    string, conditional Max length: 128 API User.
    MERCHANTPASSWORD:
    string, conditional Max length: 128 API User password.
    SESSIONTOKEN:
    string, conditional Max length: 48 Session token.
    CARDPAN:
    string, required Max length: 19 PAN (Primary account number), card number. Please check https://en.wikipedia.org/wiki/Bank_card_number for details.

    Sample request

    					ACTION: QUERYPAN
    MERCHANT: [MERCHANT]
    MERCHANTUSER: [MERCHANTUSER]
    MERCHANTPASSWORD: [MERCHANTPASSWORD]
    CARDPAN: 5406670000000009
    				

    Sample response

    					{
      "responseCode" : "00",
      "responseMsg" : "Approved",
      "bin" : {
        "bin" : "540667",
        "cardBrand" : "MC",
        "cardType" : "CREDIT",
        "cardLevel" : "CLASSIC",
        "cardNetwork" : "MAXIMUM",
        "issuer" : "T. IS BANKASI A.S.",
        "virtual" : "NO",
        "countryIsoA3" : "TUR"
      }
    } 	
    				

    Sample request

    					ACTION: QUERYPAN
    SESSIONTOKEN: [SESSIONTOKEN]
    CARDPAN: 5406670000000009
    				

    Sample response

    					{
      "responseCode" : "00",
      "responseMsg" : "Approved",
      "bin" : {
        "bin" : "540667",
        "cardBrand" : "MC",
        "cardType" : "CREDIT",
        "cardLevel" : "CLASSIC",
        "cardNetwork" : "MAXIMUM",
        "issuer" : "T. IS BANKASI A.S.",
        "virtual" : "NO",
        "countryIsoA3" : "TUR"
      }
    } 	
    			
    		
    	
     

    Query Merchant Content

    The QUERYMERCHANTCONTENT request can be used to get MERCHANT CONTENTS.

    Request parameters:
    ACTION:
    QUERYMERCHANTCONTENT, required Max length: 128 Core parameter which specifies the main action for the API call.
    MERCHANT:
    string, conditional Max length: 128 Merchant business code defined in the system.
    MERCHANTUSER:
    string, conditional Max length: 128 API User.
    MERCHANTPASSWORD:
    string, conditional Max length: 128 API User password.
    SESSIONTOKEN:
    string, conditional Max length: 48 Session token.
    MERCHANTCONTENTID:
    string, optional Max length: 16 Unique Merchant Content ID given by Merchant.

    Sample request

    					ACTION: QUERYMERCHANTCONTENT
    MERCHANT: [MERCHANT]
    MERCHANTUSER: [MERCHANTUSER]
    MERCHANTPASSWORD: [MERCHANTPASSWORD]
    MERCHANTCONTENTID: 00AXVTSiHX99Z
    				

    Sample response

    					{
      "responseCode" : "00",
      "responseMsg" : "Approved",
      "merchantContentList" : [ {
        "merchantContentType" : "tac",
        "language" : "tr",
        "merchant" : "009testID001",
        "displayed" : "true",
        "content" : "test"
      } ]
    }	
    				
     

    Query Points

    The QUERYPOINTS request can be used to get MERCHANT's points. Query made from bank side and a financial transaction.

    Request parameters:
    ACTION:
    QUERYPOINTS, required Max length: 128 Core parameter which specifies the main action for the API call.
    MERCHANT:
    string, conditional Max length: 128 Merchant business code defined in the system.
    MERCHANTUSER:
    string, conditional Max length: 128 API User.
    MERCHANTPASSWORD:
    string, conditional Max length: 128 API User password.
    MERCHANTPAYMENTID:
    string, conditional Max length: 128 Unique Payment ID given by Merchant.
    AMOUNT:
    decimal, conditional Max length: 30 Amount of payment / transaction. Please note that, this amount is tax included, Paratika doesn't consider any other tax calculation.
    CUSTOMER:
    string, conditional Max length: 128 The Merchant System ID for customer. It must be unique within a Merchant.
    CURRENCY:
    string, conditional Max length: 3 ISO Alpha transaction currency code like TRY, EUR, USD, GBP. Please check https://en.wikipedia.org/wiki/ISO_4217#Position_of_ISO_4217_code_in_amounts for details. See all possible values (33)
    SESSIONTOKEN:
    string, conditional Max length: 48 Session token.
    CARDTOKEN:
    string, conditional Max length: 64 Secure alphanumeric value replacing card number & expiry date. Required when none of the other card information are provided.
    CARDPAN:
    string, conditional Max length: 19 PAN (Primary account number), card number. Please check https://en.wikipedia.org/wiki/Bank_card_number for details.
    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.
    CARDCVV:
    string, optional Max length: 3 Security number of the card, CVV value.
    INSTALLMENTS:
    integer, optional Max length: 2 Default value: '1' Number of installments. Specified number should exist in the payment system as defined.
    PAYMENTSYSTEM:
    string, optional Max length: 128 Name of the payment system (bank payment gateway / vPOS account). Specified name should match the one given in Paratika. If not provided, Paratika smart switch feature will be used.
    FORGROUP:
    string, optional Max length: 3 Default value: 'YES' Specifies the for group featured usages. Available values are 'yes' and 'no'.

    Sample request

    					
       ACTION: QUERYPOINTS
       MERCHANTUSER: [MERCHANTUSER]
       MERCHANT: [MERCHANT]  
       MERCHANTPAYMENTID: session-vMMSSxDCxL9o
       MERCHANTPASSWORD: [MERCHANTPASSWORD]
       AMOUNT: 15.25   
       CURRENCY: TRY   
       CUSTOMER: merchant-7CtRNVbX   
       CARDEXPIRY: 12.2020   
       NAMEONCARD: NameOnCard
       CARDCVV: 000   
       CARDPAN: 4355084355084358
       PAYMENTSYSTEM: GarantiPOS 
    				
    				

    Sample response for Akbank

    					
    						{
      "action" : "QUERYPOINTS",
      "merchant" : "testmerchant",
      "amount" : 15.25,
      "currency" : "TRY",
      "apiMerchantId" : "100100000",
      "paymentSystem" : "My Sanalakpos Account (Test)",
      "pgTranDate" : "",
      "merchantPaymentId" : "session-vMMSSxDCxL9o",
      "pgTranId" : "15182NCJB01021266",
      "pgTranRefId" : "",
      "pgOrderId" : "session-vMMSSxDCxL9o",
      "responseCode" : "00",
      "responseMsg" : "Approved",
      "points" : [ {
        "name" : "PCBCHIPPARABAKIYE",
        "value" : "000000009856"
      }, {
        "name" : "CCBCHIPPARABAKIYE",
        "value" : "000000083118"
      }, {
        "name" : "XCBCHIPPARABAKIYE",
        "value" : "000000029196"
      }, {
        "name" : "CCBCHIPPARAACIKLAMA",
        "value" : "ccb chip para aciklama"
      }, {
        "name" : "PCBCHIPPARAACIKLAMA",
        "value" : "pcb chip para aciklama"
      }, {
        "name" : "XCBCHIPPARAACIKLAMA",
        "value" : "xcb chip para aciklama"
      }, {
        "name" : "ERRORCODE",
        "value" : ""
      } ]
    }
    					
    				

    Sample response for İş Bankası

    					
    						{
      "action" : "QUERYPOINTS",
      "merchant" : "testmerchant",
      "amount" : 12.58,
      "currency" : "TRY",
      "apiMerchantId" : "700100000",
      "paymentSystem" : "My İşbank VPOS Account (Test)",
      "pgTranDate" : "",
      "merchantPaymentId" : "session-nmR4PEmEihOO",
      "pgTranId" : "15182PonE07021429",
      "pgTranRefId" : "",
      "pgOrderId" : "session-nmR4PEmEihOO",
      "responseCode" : "00",
      "responseMsg" : "Approved",
      "points" : [ {
        "name" : "NUMCODE",
        "value" : "00"
      }, {
        "name" : "HOSTMSG",
        "value" : "TOPLAMMAXIPUAN: 50.00 TL"
      }, {
        "name" : "HOSTDATE",
        "value" : "0701-154039"
      }, {
        "name" : "MAXIPUAN",
        "value" : "50.00"
      }, {
        "name" : "ERRORCODE",
        "value" : ""
      } ]
    }
    					
    				

    Sample response for Finansbank

    					
    						{
      "action" : "QUERYPOINTS",
      "merchant" : "testmerchant",
      "amount" : 17.31,
      "currency" : "TRY",
      "apiMerchantId" : "600100000",
      "paymentSystem" : "My Finans Webpos Online Account (Test)",
      "pgTranDate" : "",
      "merchantPaymentId" : "session-GHmNvtjCKMos",
      "pgTranId" : "15182PrjH00128947",
      "pgTranRefId" : "",
      "pgOrderId" : "session-GHmNvtjCKMos",
      "responseCode" : "00",
      "responseMsg" : "Approved",
      "points" : [ {
        "name" : "NUMCODE",
        "value" : "00"
      }, {
        "name" : "PARAPUANTRL",
        "value" : "000000002631"
      }, {
        "name" : "SEYAHATAVANSPUANTRL",
        "value" : ""
      }, {
        "name" : "SEYAHATAVANSPUANVADETARIHI",
        "value" : ""
      }, {
        "name" : "PARAPUAN",
        "value" : "000000002631"
      }, {
        "name" : "CAVVRESULTCODE",
        "value" : "3"
      }, {
        "name" : "ERRORCODE",
        "value" : ""
      } ]
    }
    					
    				

    Sample response for VakifBank

    					
    {
      "action" : "QUERYPOINTS",
      "merchant" : "testmerchant",
      "amount" : 17.27,
      "currency" : "TRY",
      "apiMerchantId" : "000100000012656",
      "paymentSystem" : "Vakifbank",
      "paymentSystemType" : "VAKIFBANK",
      "paymentSystemEftCode" : "0015",
      "merchantPaymentId" : "PaymentId-YwOuiloCfCHK",
      "pgTranId" : "bf2a7eef537a4e1bad0ca5be00f07519",
      "pgTranRefId" : "000075283460",
      "responseCode" : "00",
      "responseMsg" : "Approved",
      "points" : [ {
        "name" : "PUAN",
        "value" : "283567.72"
      } ]
    }
    					
    		

    Sample response for HSBC

    					
    {
      "action" : "QUERYPOINTS",
      "merchant" : "10000000",
      "amount" : 11.22,
      "currency" : "TRY",
      "apiMerchantId" : "9916570",
      "paymentSystem" : "HSBC",
      "paymentSystemType" : "HSBC",
      "paymentSystemEftCode" : "0123",
      "pgTranDate" : "",
      "merchantPaymentId" : "PaymentId-7Yx5s2QSMRvP",
      "pgTranId" : "",
      "pgTranRefId" : "",
      "pgOrderId" : "",
      "responseCode" : "00",
      "responseMsg" : "Approved",
      "points" : [ {
        "name" : "ODUL",
        "value" : "5612.47"
      } ]
    }
    					
    		
     

    Query Recurring Plan

    The QUERYRECURRINGPLAN request will return the details of recurring plan(s) for a specified recurring plan by using RECURRINGPLANCODE or by time range (STARTDATE and ENDDATE).

    Request parameters:
    ACTION:
    QUERYRECURRINGPLAN, required Max length: 128 Core parameter which specifies the main action for the API call.
    MERCHANT:
    string, optional Max length: 128 Merchant business code defined in the system.
    MERCHANTUSER:
    string, optional Max length: 128 API User.
    MERCHANTPASSWORD:
    string, optional Max length: 128 API User password.
    SESSIONTOKEN:
    string, conditional Max length: 48 Session token.
    STARTDATE:
    date, conditional Max length: 16 Format: [dd-MM-yyyy] Start date of the transaction query.
    ENDDATE:
    date, conditional Max length: 16 Format: [dd-MM-yyyy] End date of the transaction query.
    RECURRINGPLANCODE:
    string, conditional Max length: 16 Unique code of a recurring plan.
    CARDPAN:
    string, optional Max length: 19 PAN (Primary account number), card number. Please check https://en.wikipedia.org/wiki/Bank_card_number for details.
    CUSTOMER:
    string, optional Max length: 128 The Merchant System ID for customer. It must be unique within a Merchant.

    Sample request

    					ACTION: QUERYRECURRINGPLAN
    MERCHANT: [MERCHANT]
    MERCHANTUSER: [MERCHANTUSER]
    MERCHANTPASSWORD: [MERCHANTPASSWORD]
    RECURRINGPLANCODE: Code-JSjAuDXf
    				

    Sample response

    					{
      "action" : "QUERYRECURRINGPLAN",
      "responseCode" : "00",
      "responseMsg" : "Approved",
      "recurringPlan" : {
        "recurringPlanCode" : "Code-wAasdfMW",
        "firstAmount" : 0,
        "recurringAmount" : 100,
        "startDate" : "01-10-2015 00:00",
        "scheduledEndDate" : "04-10-2015 00:00",
        "recurrenceCount" : 2,
        "completedRecurrence" : 0,
        "frequency" : "3D",
        "currency" : "TRY",
        "paymentSytem" : "My Finans Webpos Online Account",
        "status" : "ACTIVE"
      },
      "recurringPaymentList" : [ {
        "startDate" : "01-10-2015 00:00",
        "status" : "PENDING",
        "executionDate" : "",
        "recurrence" : 1,
        "amount" : 100,
        "tryCount" : 0
      }, {
        "startDate" : "04-10-2015 00:00",
        "status" : "PENDING",
        "executionDate" : "",
        "recurrence" : 2,
        "amount" : 100,
        "tryCount" : 0
      } ],
       "merchant" : {
        "businessId" : "[MERCHANT_BUSINESS_ID]",
        "name" : "[MERCHANTNAME]",
        "address" : "[MERCHANTADDRESS]",
        "phone" : "[MERCHANTPHONE]",
        "fax" : "[MERCHANTFAX]",
        "webAddress" : "http://www.asseco-see.com.tr/",
        "additionalDetails" : "Asseco South Eastern Europe",
        "secretKey" : "[SECRETKEY]",
        "referrer" : "https://www.example.com"
      },
      "customer" : {
        "id" : "MRCH_CUST_ID_123",
        "email" : "customerEmail-DA1y5O0U",
        "phone" : "11111111111111",
        "name" : "CustomerNameDA1y5O0U",
        "lastLogin" : "30.01.2015 16:11"
      },
      "card" : {
        "cardToken" : "CBCANDT5NRAJK2DCKYWZ2LZ6XIPCXXMPOBEKXEXSCD4YZN6O",
        "cardOwner" : "Name oa9iDQNM",
        "panLast4" : "5454",
        "customer" : "Customer-oa9iDQNM",
        "cardBin" : "545616",
        "cardExpiry" : "12.2020"
      }
    }                       
    				
     

    Query Recurring Plan Card

    The QUERYRECURRINGPLANCARD request will return the details of cards for a specified recurring plan by using RECURRINGPLANCODE.

    Request parameters:
    ACTION:
    QUERYRECURRINGPLANCARD, required Max length: 128 Core parameter which specifies the main action for the API call.
    SESSIONTOKEN:
    string, conditional Max length: 48 Session token.
    MERCHANTUSER:
    string, conditional Max length: 128 API User.
    MERCHANTPASSWORD:
    string, conditional Max length: 128 API User password.
    MERCHANT:
    string, conditional Max length: 128 Merchant business code defined in the system.
    RECURRINGPLANCODE:
    string, required Max length: 16 Unique code of a recurring plan.

    Sample request

    					ACTION: QUERYRECURRINGPLANCARD
    MERCHANT: [MERCHANT]
    MERCHANTUSER: [MERCHANTUSER]
    MERCHANTPASSWORD: [MERCHANTPASSWORD]
    RECURRINGPLANCODE: [Code-UPAG0PzB]
    				

    Sample response

    					{
      "responseCode" : "00",
      "responseMsg" : "Approved",
      "cardList" : [ {
        "cardToken" : "BKSJWIERRJQFODRQ27AEI3JLLNLVDZ64Z74I6D2Q6GJ73YBN",
        "cardOwnerMasked" : "N*** A*******",
        "panLast4" : "5454",
        "customer" : "Customer-AtdW4XGx",
        "cardBin" : "545616",
        "cardExpiry" : "12.2020",
        "pan" : "545616***5454"
      }, {
        "cardToken" : "T45FWSAXNHZPC4NYCGVQSYY4INTCCPB3GC5MJ2HGD2YKLCG6",
        "cardOwnerMasked" : "N*** V*******",
        "panLast4" : "5454",
        "customer" : "Customer-Vdsj1bTN",
        "cardBin" : "545616",
        "cardExpiry" : "12.2020",
        "pan" : "545616***5454"
      }, {
        "cardToken" : "RF4DIKGLC65GLBTJWUJJDJAERGKTZ27NN7PPEE7NEPWBJGVP",
        "cardOwnerMasked" : "N*** f*******",
        "panLast4" : "5454",
        "customer" : "Customer-f2EWrLZE",
        "cardBin" : "545616",
        "cardExpiry" : "12.2020",
        "pan" : "545616***5454"
      }, {
        "cardToken" : "Z6VJJMIYBNWDVIXUC3547D356FX5DZZT5KVIZBA4Z3GYAVN5",
        "cardOwnerMasked" : "d***",
        "panLast4" : "9159",
        "customer" : "Customer-f2EWrLZE",
        "cardBin" : "409070",
        "cardExpiry" : "12.2020",
        "pan" : "409070***9159"
      } ]
    }                       
    				
     

    Query Campaign

    The QUERYCAMPAIGN request can be used to get campaigns.

    Request parameters:
    ACTION:
    QUERYCAMPAIGN, required Max length: 128 Core parameter which specifies the main action for the API call.
    MERCHANT:
    string, conditional Max length: 128 Merchant business code defined in the system.
    MERCHANTUSER:
    string, conditional Max length: 128 API User.
    MERCHANTPASSWORD:
    string, conditional Max length: 128 API User password.
    BIN:
    string, conditional Max length: 6 BIN value (first 6 PAN digits). Please check https://en.wikipedia.org/wiki/Bank_card_number for details.
    CARDTOKEN:
    string, conditional Max length: 64 Secure alphanumeric value replacing card number & expiry date. Required when none of the other card information are provided.
    SESSIONTOKEN:
    string, conditional Max length: 48 Session token.

    Sample request

    					ACTION: QUERYCAMPAIGN
    MERCHANT: [MERCHANT]
    MERCHANTUSER: [MERCHANTUSER]
    MERCHANTPASSWORD: [MERCHANTPASSWORD]
    BIN: 511452
    				

    Sample response

    					{ 
      "responseCode" : "00", 
      "responseMsg" : "Approved", 
      "campaignCodeList" : [ { 
        "campaignName" : "Artı iki", 
        "campaignCode" : "KOICODE", 
        "installment" : "2", 
        "totalInstallment" : "4", 
        "installmentAmount" : "10", 
        "currency" : "TRY", 
        "paymentSystemType" : "YKB", 
        "campaignType" : "ADDITIONALINSTALLMENT" 
      }, { 
        "campaignName" : "Ertelet", 
        "campaignCode" : "KOICODE2", 
        "installment" : "4", 
        "totalInstallment" : "2", 
        "installmentAmount" : "10", 
        "currency" : "TRY", 
        "paymentSystemType" : "YKB", 
        "campaignType" : "POSTPONE" 
      } ] 
    }	
    				
     

    Query Campaign Online

    The QUERYCAMPAIGNONLINE request can be used to get card holders' campaigns if they are available to merchants. Query made from bank side and a financial transaction.

    Request parameters:
    ACTION:
    QUERYCAMPAIGNONLINE, required Max length: 128 Core parameter which specifies the main action for the API call.
    MERCHANT:
    string, conditional Max length: 128 Merchant business code defined in the system.
    MERCHANTUSER:
    string, conditional Max length: 128 API User.
    MERCHANTPASSWORD:
    string, conditional Max length: 128 API User password.
    SESSIONTOKEN:
    string, conditional Max length: 48 Session token.
    MERCHANTPAYMENTID:
    string, conditional Max length: 128 Unique Payment ID given by Merchant.
    AMOUNT:
    decimal, conditional Max length: 30 Amount of payment / transaction. Please note that, this amount is tax included, Paratika doesn't consider any other tax calculation.
    INSTALLMENTS:
    integer, required Max length: 2 Number of installments. Specified number should exist in the payment system as defined.
    CURRENCY:
    string, conditional Max length: 3 ISO Alpha transaction currency code like TRY, EUR, USD, GBP. Please check https://en.wikipedia.org/wiki/ISO_4217#Position_of_ISO_4217_code_in_amounts for details. See all possible values (33)
    CUSTOMER:
    string, conditional Max length: 128 The Merchant System ID for customer. It must be unique within a Merchant.
    CARDTOKEN:
    string, conditional Max length: 64 Secure alphanumeric value replacing card number & expiry date. Required when none of the other card information are provided.
    CARDCVV:
    string, optional Max length: 3 Security number of the card, CVV value.
    CARDPAN:
    string, conditional Max length: 19 PAN (Primary account number), card number. Please check https://en.wikipedia.org/wiki/Bank_card_number for details.
    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.
    CUSTOMERIP:
    string, optional Max length: 39 Customer IP Address
    CUSTOMERUSERAGENT:
    string, optional Max length: 255 Customer User Agent
    EXTRA:
    string, optional Max length: 1024 Extra Parameter is a custom parameter that is used to pass additional parameters to session token. This parameter is expected to be in JSON(URL-ENCODED) format. If they are mispelled, they will be ignored! Supported parameters are: CardHolderAgreementMode(value: NONE/SHOW/SHOWCHECKED/SHOWCHECKEDDISABLED), AlwaysSaveCard(value: true/false), BuyerType (value: L for logged in customer; A for anonymous, F for the first shopping with memebership. OR it can be 0, 1, 2 for those cases), IsbankBolumKodu(string).
    EXTRA: {"AlwaysSaveCard": "true", "BuyerType": "L", "IsbankBolumKodu": 12, "CardHolderAgreementMode": "SHOWCHECKED"}
    PAYMENTSYSTEMTYPENAME:
    string, optional Max length: 100 description
    FORGROUP:
    string, optional Max length: 3 Default value: 'YES' Specifies the for group featured usages. Available values are 'yes' and 'no'.

    Sample request

    					
     ACTION: QUERYCAMPAIGNONLINE
     MERCHANTUSER: [MERCHANTUSER]
     MERCHANT: [MERCHANT]  
     MERCHANTPAYMENTID: PaymentId-pqkzBsVhLD3K
     MERCHANTPASSWORD: [MERCHANTPASSWORD]
     AMOUNT: 15.92
     INSTALLMENTS : 3   
     CURRENCY: TRY   
     CUSTOMER: merchant-7CtRNVbX   
     CARDEXPIRY: 12.2020   
     NAMEONCARD: NameOnCard
     CARDCVV: 000   
     CARDPAN: 5406670000000009 
    				
    				

    Sample response for Isbank

    					
    {
      "action" : "QUERYCAMPAIGNONLINE",
      "merchant" : "testmerchant",
      "amount" : 15.92,
      "installment" : "1",
      "currency" : "TRY",
      "apiMerchantId" : "700658785",
      "paymentSystem" : "Türkiye İş Bankası Sanal POS",
      "paymentSystemType" : "ISBANK",
      "paymentSystemEftCode" : "0064",
      "pgTranDate" : "",
      "merchantPaymentId" : "PaymentId-pqkzBsVhLD3K",
      "pgTranId" : "16180OzcC07010161",
      "pgTranRefId" : "",
      "pgOrderId" : "PaymentId-pqkzBsVhLD3K",
      "responseCode" : "00",
      "responseMsg" : "Approved",
      "campaigns" : [ {
        "campaignCode" : "000001",
        "campaignName" : "kampanya1",
        "campaignExtra" : ""
      }, {
        "campaignCode" : "000002",
        "campaignName" : "kampanya2",
        "campaignExtra" : ""
      }, {
        "campaignCode" : "000003",
        "campaignName" : "kampanya3",
        "campaignExtra" : ""
      } ]
    }
    					
    				
     

    Query Payment System Data

    The Query Payment System Data QueryPSData

    Request parameters:
    ACTION:
    QUERYPAYMENTSYSTEMDATA, required Max length: 128 Core parameter which specifies the main action for the API call.
    INSTALLMENTS:
    integer, required Max length: 2 Default value: '1' Number of installments. Specified number should exist in the payment system as defined.
    EFTCODE:
    string, optional Max length: 4 description
    MERCHANT:
    string, conditional Max length: 128 Merchant business code defined in the system.
    MERCHANTUSER:
    string, conditional Max length: 128 API User.
    MERCHANTPASSWORD:
    string, conditional Max length: 128 API User password.
    SESSIONTOKEN:
    string, optional Max length: 48 Session token.
    BIN:
    string, conditional Max length: 6 BIN value (first 6 PAN digits). Please check https://en.wikipedia.org/wiki/Bank_card_number for details.
    PAYMENTSYSTEMTYPE:
    string, conditional Max length: 32 description See all possible values (25)
    CURRENCY:
    string, optional Max length: 3 ISO Alpha transaction currency code like TRY, EUR, USD, GBP. Please check https://en.wikipedia.org/wiki/ISO_4217#Position_of_ISO_4217_code_in_amounts for details. See all possible values (33)

    Sample request

    					ACTION: QUERYPAYMENTSYSTEMDATA
    MERCHANT: [MERCHANT]
    MERCHANTUSER: [MERCHANTUSER]
    MERCHANTPASSWORD: [MERCHANTPASSWORD]
    INSTALLMENTS: 1   
    PAYMENTSYSTEMTYPE: BKMEXPRESS
    				

    Sample response

    					
    {
      "paymentSystemType" : "BKMEXPRESS",
      "responseCode" : "00",
      "responseMsg" : "Approved",
      "paymentSystemName" : "BKMTest",
      "posUrl" : "",
      "posUserId" : "UserName",
      "posPassword" : "ApiPassword",
      "mpiUrl" : "https://delta.asseco-see.com.tr/fim/est3Dgate",
      "mpiUserId" : "msuapi",
      "mpiPassword" : "TEST1111",
      "clientId" : "merchantId",
      "storeKey" : "3dGate",
      "psIntegrationExtraField00" : "ExtraField0",
      "psIntegrationExtraField01" : "ExtraField1"
    }