Steps To Integration
Steps To Integration
Steps To Integration
r Support for server side scripting languages like ASP, PHP & JSP. Steps for integration: 1. Download the integration kit and extract the files in it. You will get the following folders ASP folder: This folder contains the following sample codes: Please note that you could insert your subroutines/functions to the checkout & redirecturl.jsp page & further customize the pages. libfuncs.asp : functions necessary for calculating, verifying checksum checkout.asp : sample code for your ASP checkout page redirecturl.asp : sample code for your ASP redirect page JSP folder: This folder contains the following sample codes: Please note that you could insert your subroutines/functions to the checkout & redirecturl.jsp page & further customize the pages. libFunctions.jsp : functions necessary for calculating ,verifying checksum checkout.jsp : sample code for your JSP checkout page redirecturl.jsp : sample code for your JSP redirect page PHP folder: This folder contains the following sample codes: Please note that you could insert your subroutines/functions to the checkout & redirecturl.php3 page & further customize the pages. libfuncs.php3 : functions necessary for calculating ,verifying checksum checkout.php3 : sample code for your PHP checkout page redirecturl.php3 : sample code for your PHP redirect page
2. From the integration kit upload the code pertaining to your platform. 3. In the checkout page you will see a Form with following parameters. You need to pass corresponding values to these parameters. Merchant_Id: This ID is generated for you at the time of activation of your site. This Member ID uniquely identifies you as a Member of CCAvenue. You can get your CCAvenue Merchant Id/User Id at "Generate Key" of "Settings & Options" section.
Order_Id: A Unique alphanumeric ID generated by you to uniquely identify this order. The Description/Order ID should be unique since it would allow you to identify the transaction easily. Amount: Amount is the total amount of the transaction(greater than 0) in INR, without a currency symbol or other non-numeric character. only a decimal allowed. Checksum: This refers to a random numeric string generated using a mathematical algorithm (a complex quadratic equation) to ensure that data is not tampered along the way. The way it works is lets say a message has to be sent from A to B. A and B both mutually agree on a Key that only both of them possess. A checksum is generated by a mathematical function using the message and the Key as input. This checksum is then sent along with the message to B. B then recalculates this checksum using the Key and the same algorithm. If the checksum that B calculates is different from the checksum that A passed then the data was tampered along the way. Note: This key also known as the Working Key is a 32 bit alphanumeric key is assigned to each merchant. Please note that you have to generate this key by logging in to your CCAvenue merchant account and using the "Generate Key" function at the "Settings & Options" menu. If you would like the Billing/Shipping page on CCAvenue to be auto-filled with the details provided by the customer on your site, please send the following optional parameters with their corresponding values, namely: billing_cust_name billing_cust_address billing_cust_country billing_cust_tel billing_cust_email delivery_cust_name delivery_cust_address delivery_cust_tel billing_cust_notes If the above parameters are sent with "" values (that is without a value) then your customer will be prompted to enter these details on the CCAvenue Shipping/Billing Page. Note: "billing_cust_notes" is again optional i.e. the customer will not be prompted to fill in the same. Merchant_param: This is an optional parameter you can send with any values of your choice. Redirect_Url: Once the customer on your website has finished authenticating the transaction he is returned back to your website. The URL to which the customer returns back is called the Redirect URL. Once the authorization process has been completed the customer will be redirected to this URL to which we pass return values namely the AuthDesc parameter indicating the status of the transaction along with all of the parameters mentioned above. Below is a list of all the variables that you will deal with in any transaction.
List of parameters
Data Length
Input/Output
Compulsor y
Order_Id Amount Merchant_Id Redirect_Url Checksum billing_cust_name billing_cust_address billing_cust_country billing_cust_tel billing_cust_email delivery_cust_name delivery_cust_address delivery_cust_tel billing_cust_notes Merchant_Param AuthDesc
I&O I&O I&O I&O I&O I&O I&O I&O I&O I&O I&O I&O I&O I&O I&O Only O
4. Once all the above integration steps are taken care of and you are ready to go live/test, -Please login to your CCAvenue account -Go to "Settings & Options" -Click the "Generate Working Key" Here, choose the "activate" option & click submit. Please Note: The deactivate option will be checked by default. This means that the authorisation status of an order will not be available to you in real-time, but only by an order mail & at the "View Pending Orders". You could chose to activate/de-activate this real-time authorisation feature anytime by logging in to your CCAvenue account. Once activated, you can test the integration with the gateway by placing an order using a LIVE card number for a nominal amount.(not more than Rs.10).Please enter the key word "SUBMERCHANT TEST" in the Instructions/Notes text area in the CCAvenue Shipping/Billing Page.