Difference between revisions of "CCAvenue API v2"

From WHMCS Documentation
Line 1: Line 1:
 +
== About this Module ==
 +
 +
The CCAvenue API v2 payment gateway module is available in WHMCS.
 
{{gateways
 
{{gateways
 
| onetime = yes
 
| onetime = yes
 
}}
 
}}
 +
== Adding the CCAvenue API v2 Payment Gateway==
  
−
==Setup==
+
To set up this payment gateway in WHMCS:
−
 
+
−
Begin by activating the payment gateway under '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Payment Gateways''' or, prior to WHMCS 8.0, '''Setup > Payments > Payment Gateways'''. Choose CCAvenue API v2 from the All Payment Gateways tab.
+
# Go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Payment Gateways]]''' or, prior to WHMCS 8.0, '''Setup > Products/Services > Payment Gateways'''.
−
 
+
# Choose the '''All Payment Gateways''' tab.
−
Once activated, you can then enter the configuration details explained below.
+
# Click '''CCAvenue API v2'''.
−
 
+
# Check '''Show on Order Form''' to display this payment method in the Client Area during checkout.
−
===Access Details===
+
# Configure your access details.
−
All of the login information for API Access can be obtained from CCAvenue M.A.R.S Account under '''Settings -> API Keys'''. If you are unable to locate this option, please contact CCAvenue Support.
+
#* You can find all of the necessary login information from your CCAvenue M.A.R.S. Account at '''Settings -> API Keys''':
 +
#** '''Merchant Id''' — This is a numerical value (for example, 2193).
 +
#** '''Access Code''' — An uppercase mix of letters and numbers (for example, F94007DF1640D69A).
 +
#** '''Working Key''' — An uppercase mix of letters and numbers (for example, FABE114254BDBC7823534894FFFCCC1).
 +
# Click '''Save Changes'''.
  
−
  '''Merchant Id''' - This is a numerical value - eg. 2193
+
=== Test Mode ===  
−
'''Access Code''' - An uppercase mix of letters and numbers - eg. F94007DF1640D69A
 
−
'''Working Key''' - An uppercase mix of letters and numbers - eg. FABE114254BDBC7823534894FFFCCC1
 
  
−
All of these values are required to use the CCAvenue API v2 module
+
You can use test mode to simulate payment processing without actually causing a transaction to occur. This can be useful to test your configuration.
  
−
===Test Mode===
+
== CCAvenue (Legacy) ==
−
CCAvenue do have a test mode available which can be enabled by ticking the Test Mode option in the Gateway Configuration. You may need to contact CCAvenue support to enable a test account.
 
−
 
 
−
=CCAvenue (Legacy)=
 
−
{{gateways
 
−
| onetime = yes
 
−
}}
 
 
<div class="docs-alert-danger">
 
<div class="docs-alert-danger">
 
This module connects to CC Avenue's legacy system at <nowiki>https://www.ccavenue.com/shopzone/cc_details.jsp</nowiki>. CC Avenue have recently introduced a separate new system, the module is not currently compatible with this new system.<br/>
 
This module connects to CC Avenue's legacy system at <nowiki>https://www.ccavenue.com/shopzone/cc_details.jsp</nowiki>. CC Avenue have recently introduced a separate new system, the module is not currently compatible with this new system.<br/>
 
If your account is on the new system, please use the v2 module above.
 
If your account is on the new system, please use the v2 module above.
 
</div>
 
</div>
 +
The legacy CCAvenue module is also available for accounts that use CCAvenue's older system.
 +
{{gateways
 +
| onetime = yes
 +
}}
 +
 +
== Troubleshooting ==
 +
''N/A''
  
 
{{modules}}
 
{{modules}}

Revision as of 19:39, 22 March 2022

About this Module

The CCAvenue API v2 payment gateway module is available in WHMCS.

Supported Features

Type One Time Recurring Refunds Reversals
3rd Party Yes No No

No

Adding the CCAvenue API v2 Payment Gateway

To set up this payment gateway in WHMCS:

  1. Go to Configuration () > System Settings > Payment Gateways or, prior to WHMCS 8.0, Setup > Products/Services > Payment Gateways.
  2. Choose the All Payment Gateways tab.
  3. Click CCAvenue API v2.
  4. Check Show on Order Form to display this payment method in the Client Area during checkout.
  5. Configure your access details.
    • You can find all of the necessary login information from your CCAvenue M.A.R.S. Account at Settings -> API Keys:
      • Merchant Id — This is a numerical value (for example, 2193).
      • Access Code — An uppercase mix of letters and numbers (for example, F94007DF1640D69A).
      • Working Key — An uppercase mix of letters and numbers (for example, FABE114254BDBC7823534894FFFCCC1).
  6. Click Save Changes.

Test Mode

You can use test mode to simulate payment processing without actually causing a transaction to occur. This can be useful to test your configuration.

CCAvenue (Legacy)

This module connects to CC Avenue's legacy system at https://www.ccavenue.com/shopzone/cc_details.jsp. CC Avenue have recently introduced a separate new system, the module is not currently compatible with this new system.
If your account is on the new system, please use the v2 module above.

The legacy CCAvenue module is also available for accounts that use CCAvenue's older system.

Supported Features

Type One Time Recurring Refunds Reversals
3rd Party Yes No No

No


Troubleshooting

N/A

Server Modules
cPanel/WHM - DirectAdmin - Plesk - Helm 3 - Helm 4 - Ensim - InterWorx - WebsitePanel - Cloudmin
Lxadmin - Virtualmin Pro - XPanel - HyperVM - SolusVM - Cloudmin - WHMSonic - VPS.Net
CentovaCast - SCPanel - MediaCP - GameCP - TCAdmin - Reseller Central - Auto Release - Heart Internet

Registrar Modules
Enom - ResellerClub - Nominet - OpenSRS - ResellOne - OnlineNIC - PlanetDomain - Affordable Domains
TPP Wholesale - TPPInternet - Stargate - Namecheap - NetEarthOne - Bizcn - InternetBS - GMO Internet
12Register - Registercom - DotDNS - WebNIC - Dot.TK - HexoNet - Realtime Register - Registereu
RRPProxy - ResellerCamp - TransIP - Heart Internet - IPMirror - NetRegistry - OVH - VentraIP Wholesale
Email - 101Domain

Fraud Modules
MaxMind - VariLogiX FraudCall - Telesign

Gateway Modules
2CheckOut - AsiaPay - Auth.net Echeck - Authorize.net - Authorize.net CIM - Bank Transfer - BidPay
BluePay - BluePay Echeck - BluePay Remote - Boleto - CashU - CC Avenue - ChronoPay - Direct Debit
EMatters - E-Path - eProcessingNetwork - eWAY Tokens - F2B - Finansbank - GarantiBank - Gate2Shop
Inpay - InternetSecure - IP.Pay - Kuveytturk - Modulo Moip - Mail In Payment - Merchant Partners
Merchant Warrior - IDEALMollie - Moneris - Moneris Vault - Skrill 1-Tap - NaviGate - NETbilling
Netregistry Pay - NoChex - Offline Credit Card - Optimal Payments - PagSeguro - Payflow Pro - Pay Junction
Paymate AU and NZ - Payment Express - PayPal - PayPal Card Payments - PayPal Express Checkout
PayPal Payments - PayPal Payments Pro - PayPoint.net (SecPay) - Payson - Planet Authorize - ProtX VSP Form
PSIGate - Quantum Gateway - Quantum Vault - SagePay - SagePay Tokens v2 - SecurePay
SecurePay AU - Secure Trading - TrustCommerce - USA ePay - WorldPay - WorldPay Invisible


Retrieved from "http://3.17.75.209/index.php?title=CCAvenue_API_v2&oldid=31729"