VibeFox CCAvenue for PrestaShop — Help

Requirements

PrestaShop: 8.0 to 9.x.

PHP: 8.0 or later, with the OpenSSL extension (used to encrypt the request and decrypt the response). The module refuses to install on older PHP versions or without OpenSSL.

CCAvenue account: you need a CCAvenue merchant account with a Merchant ID, an Access Code and a Working Key. The Access Code and Working Key are issued for a website domain, so generate them for the domain of this shop. CCAvenue uses the same credentials for the test environment; test access must be enabled for your account by CCAvenue. The module uses the CCAvenue India endpoints.

Currency: the cart currency is sent to CCAvenue as is. CCAvenue accounts accept INR by default; other currencies require multi-currency processing on your CCAvenue account.

VibeFox license key: bought on vibefox.net. One key works on one domain.

Installation

1. In the back office go to Modules > Module Manager and click Upload a module. Choose the module ZIP file.

2. When the upload finishes, click Configure, or find VibeFox CCAvenue Payment in the module list later and click Configure.

3. Paste your VibeFox license key into License key in the license block at the top of the Configure page and click Activate (see License key).

4. Enter the Merchant ID, Access Code and Working Key from your CCAvenue dashboard and turn on Enable/Disable.

5. Keep Test mode on while testing, then switch it off to accept real payments.

On install the module creates two order statuses, Awaiting CCAvenue payment and CCAvenue payment on hold. PrestaShop offers a new payment module for all currencies, countries and customer groups. You can limit them in Payment > Preferences.

Configuration

All settings are on the module page: Modules > Module Manager > VibeFox CCAvenue Payment > Configure. Each section has its own Save button, which saves the whole page. Above the fields the page warns you when CCAvenue is enabled but the Merchant ID, Access Code or Working Key is missing (the payment method is then hidden at checkout until all three are set), shows CCAvenue test mode is on: customers are sent to test.ccavenue.com and no real money is taken. while test mode is on, and reminds you about multi-currency processing when the default currency of the shop is not INR.

CCAvenue

Enable/Disable: Enable CCAvenue Payment Gateway turns the payment method on or off. Default: off.

Title: the payment method name customers see at checkout. It is also the payment method name stored in the order. Default: CCAvenue.

Description: the text shown under the payment method at checkout. Default: Pay securely via Credit/Debit card, Net Banking, UPI or Wallet through CCAvenue.

API credentials

Log in to your CCAvenue merchant dashboard (M.A.R.S.) and open Settings > API Keys. Generate the Access Code and Working Key for the domain of this shop. Spaces in the credentials are removed on save.

Merchant ID: your numeric CCAvenue Merchant ID. If it contains anything other than digits, the message CCAvenue: the Merchant ID must contain digits only — the previous value was kept. is shown on save, the previously saved value stays and the other settings are saved.

Access Code: the Access Code for this website (Settings > API Keys).

Working Key: the Working Key (encryption key) for this website. It encrypts the payment request and is the only way to verify the CCAvenue response, so keep it secret. A saved Working Key is never shown again. The field stays empty and shows Saved — leave empty to keep it. Type a new value only to change it.

Clear saved Working Key: tick it and click Save to remove the saved Working Key. An empty field keeps the saved value.

Test mode: sends customers to the CCAvenue test environment (test.ccavenue.com). CCAvenue uses the same Merchant ID, Access Code and Working Key for test and live; test access must be enabled for your account by CCAvenue. In test mode the checkout shows TEST MODE: no real transactions will be processed. under the payment method. Default: on. Disable it for real payments.

Return URL

CCAvenue returns the customer to the address shown in this section. With friendly URLs it looks like https://your-shop/module/wcp_ccavenue_payment/return, possibly with a language code such as /en/. The module sends this URL with every payment (as the redirect and cancel URL), so there is nothing to configure in CCAvenue. It must belong to the domain registered with CCAvenue.

Advanced

Debug log: writes CCAvenue events to logs/ccavenue_p_debug.log.php in the module folder. The file cannot be opened from the web. Only order references, tracking IDs and statuses are logged; keys, card data, e-mails and addresses are not. Default: off. Nothing is written while it is off, errors included.

Log: shows the size and the latest entries of the log. Click Clear log to empty it.

Delete data on uninstall: when on, uninstalling the module removes the module settings, the log and the CCAvenue order references. Orders and the module's order statuses stay. Default: off.

Checkout

At the payment step the customer chooses the payment method (by default CCAvenue) and confirms. A page shows Thank you for your order. You are being redirected to CCAvenue to complete the payment. and sends the customer to the CCAvenue payment page. Without JavaScript the customer clicks Pay via CCAvenue or Back to checkout. No order exists yet at this point.

Each attempt gets a new CCAvenue order reference made of the cart number and the time. The cart total and currency, the billing details, the delivery address (when it differs from the billing address) and a secret token of the attempt are sent in the encrypted request. Names and addresses are cleaned to the characters and lengths CCAvenue accepts; country and state are sent as names and the phone as digits. The customer chooses the card, Net Banking, UPI, wallet or EMI on the CCAvenue page.

After the payment, CCAvenue returns the customer with an encrypted response. The order is marked paid only after CCAvenue confirms it: the response must decrypt with your Working Key, belong to an attempt of this shop and carry the same amount and currency as were sent and as the cart total. Then the order is created and the customer sees the standard order confirmation page with Your CCAvenue payment has been received. For an Awaited payment the page shows Your CCAvenue payment is awaiting confirmation from your bank. The order will be processed as soon as the payment is confirmed. After an amount or currency mismatch it shows Your payment was received and is being reviewed by the shop. If an awaiting order is later cancelled or fails without a payment, the confirmation page shows Your CCAvenue payment was not completed. Please contact us about this order.

If the payment fails, the customer is back at checkout with Payment was not completed. Please try again or choose a different payment method. If the customer cancels on the CCAvenue page, the message is Payment was cancelled. You may try again. If the response cannot be verified, the message is We could not confirm the payment result. If your account was charged, please contact us before paying again. In these cases no order is created and the cart is kept, so the customer can pay again. If the cart already has an order, a new attempt goes straight to its confirmation page instead of a second payment.

The result is taken only from the customer's return from CCAvenue: there are no server-to-server notifications and no status requests. If the customer closes the browser before returning, no order is created; check the payment in the CCAvenue dashboard. The module has no refunds from PrestaShop, no saved cards, subscriptions or recurring payments, no on-site card form, and no support for CCAvenue UAE or other regional platforms.

Orders

Order statuses

No order yet: the customer was sent to CCAvenue and has not returned, or the payment failed or was cancelled. Only the cart exists. Check the payment in the CCAvenue dashboard if the customer does not come back.

Payment accepted: the payment was confirmed. The payment is recorded with the CCAvenue tracking ID as the transaction ID, and a note shows the bank reference, the tracking ID and the payment mode.

Awaiting CCAvenue payment: CCAvenue reported the payment as Awaited (the bank has not confirmed it yet). The order is never marked failed while the money may still be captured. Verify it in the CCAvenue dashboard before fulfilling. A later response with the same tracking ID is still applied: Success sets Payment accepted, Failure sets Payment error, Aborted sets Canceled.

CCAvenue payment on hold: CCAvenue confirmed a payment whose amount or currency differs from the cart or from what was sent (for example, the cart was changed in another tab after the payment started), or the customer paid after the order had been cancelled. The note shows the received and expected amount. The amount CCAvenue reported is recorded as a payment on the order when the currency matches. Check the payment in the CCAvenue dashboard, then fulfil the order or refund the payment.

A late failure never changes a paid order. If another successful payment arrives for an order that is already paid (for example from two browser tabs), the order is not changed. A note asks you to refund the duplicate in the CCAvenue dashboard.

CCAvenue payment block

The order page shows a CCAvenue payment block with the CCAvenue order ID, the tracking ID, the status, the bank reference, the payment mode and card name, the amount sent and the amount received, the date and the CCAvenue message, and a Test mode badge for test payments. The CCAvenue notes are private messages of the order, visible only in the back office.

Refunds

Refunds from PrestaShop are not supported. Refund the payment in the CCAvenue dashboard, then record the refund in PrestaShop manually.

License key

The module works with a VibeFox license key from vibefox.net. The license block License — VibeFox CCAvenue Payment is the first block on Modules > Module Manager > VibeFox CCAvenue Payment > Configure, above the settings. Paste the key into License key and click Activate. After that the block shows the key masked, the status (for example the date the license is active until and your domain) and the buttons Check now to check the status again, Change key to enter another key and Remove key to remove the key from this shop. Below them are the line Product: presta-payment-ccavenue and the link Manage licenses and domains in your account, which opens your vibefox.net account. Only employees with the Configure permission for the module can change the key. The texts of the block follow the back office language (English and Russian are included).

If the key is not accepted, the block says why, for example Key not found, This key belongs to another product, Domain limit reached or License expired on a date. After the shop address changes, or after you free a domain slot in your account, click Check now. If the license server cannot be reached, the module keeps working on the last known status.

One key works on one domain: the domain of the main shop, also in a multistore setup. Removing the key from the shop does not free its domain slot. Free the slot in your vibefox.net account.

Without an active key, CCAvenue is not shown to customers at checkout. If a payment is started anyway, the customer sees This payment method is not available. Please choose another one. The PrestaShop storefront does not know that you are logged in to the back office, so the payment method is hidden for you too: you can set up the module before you buy a key, but not test it at checkout. A reminder appears in Modules > Module Manager on the Alerts tab. Existing orders are not affected: payments already started are still confirmed when the customer returns from CCAvenue.

When a license expires, the module keeps working, but updates and support need a renewal. The status is checked again automatically while you work in the back office: once a day for the first 14 days after the key is entered, then once a week. No cron job is needed. Uninstalling or resetting the module always removes the license key and license status.

Troubleshooting

CCAvenue does not appear at checkout: check that the license is active, Enable/Disable is on and all three credentials are set: Merchant ID, Access Code and Working Key. The settings page shows a warning when one is missing. In Payment > Preferences check that the module is allowed for the cart currency, the customer's country and the customer's group.

The payment went through, but no order was created: the customer did not return from CCAvenue to your shop, for example because the browser was closed. The module has no server-to-server notifications. Check the payment in the CCAvenue dashboard and create or update the order manually.

Every payment ends with We could not confirm the payment result: the response cannot be decrypted. The Working Key is wrong, belongs to another domain or was copied with extra characters. Generate the keys for the domain of this shop and paste them again. Turn on Debug log and look at the Log field on the module page.

CCAvenue shows an error before the payment page: check that the Access Code and Working Key were generated for this domain, that the return URL belongs to the domain registered with CCAvenue and, in test mode, that CCAvenue enabled test access for your account. For a currency other than INR, multi-currency processing must be enabled on your CCAvenue account.

The customer sees This payment method is temporarily unavailable: one of the credentials is missing, or the cart total is zero. Debug log shows the reason.

The customer sees This payment method is not available: the module is disabled, or it is not allowed for the cart currency, country or customer group in Payment > Preferences.

The customer sees Payment gateway error: encryption failed: the request could not be encrypted. Check that the PHP OpenSSL extension is installed.

The Merchant ID does not change on save: the value contains something other than digits. Enter only the numbers of your Merchant ID.

Order is CCAvenue payment on hold or Awaiting CCAvenue payment: read the order note (see Order statuses). Verify the payment in the CCAvenue dashboard, then fulfil the order or refund the payment.

For developers, the module has the hook actionCcavenueRequestParams (change the data sent to CCAvenue before encryption, for example merchant_param2 to merchant_param5; values must not contain &; do not change amount, currency, order_id or merchant_param1).

Uninstall

Go to Modules > Module Manager, open the menu next to VibeFox CCAvenue Payment and choose Uninstall. The license key and license status of this module are always removed. The confirmation reminds you that settings and CCAvenue references are kept unless Delete data on uninstall is enabled. If it is on, the module settings, the log and the CCAvenue order references are removed. If it is off, everything is kept for a later re-install. The order statuses Awaiting CCAvenue payment and CCAvenue payment on hold are always kept. Existing orders keep their payment notes and transaction IDs.

CCAvenue is a trademark of its respective owner. This module is not affiliated with or endorsed by CCAvenue.