Agile Payment Gateway For WHMCS

From ModulesGarden Wiki
Jump to: navigation, search

Contents

About Agile Payment Gateway For WHMCS

Agile Payment Gateway For WHMCS was designed to implement Agile Credit Card and eCheck payment gateways to your system.

With their help, you will be able to obtain ACH payments from your clients using their credit card details and through processing eChecks.

Our module requires an Agile Payment merchant account.

Click here to complete the quick one page app and start saving money accepting credit card and eCheck payments in your WHMCS.
Also, increase revenue from your existing customers that would normally fail re-billing with other merchant account providers.

  • Credit Card Gateway Features:
✔ Payment Tokenization For Recurring Transactions - PCI Compliant
✔ Attempt Early Payment - Manual Only
✔ One Time And Recurring Payments Support
✔ Notify Admin About Clients Without Automated Bill Payment Information
✔ Notify Client About Lack Of Automated Bill Payment Information
✔ Refund Transaction
  • eCheck Gateway Features:
✔ Payment Tokenization For Recurring Transactions
✔ Attempt Early Payment:
✔ Manual
✔ Automatic - X Days Before Due Date
✔ One Time And Recurring Payments Support
✔ Notify Admin About Clients Without Automated Bill Payment Information
✔ Notify Client About Lack Of Automated Bill Payment Information
  • Widget Features:
✔ View eCheck Gateway Transactions Summary
✔ View Credit Card Gateway Transactions Summary
✔ View List Of Transactions With Errors
✔ Define Time Period For Shown Data
  • Supported Credit Cards:
✔ American Express
✔ MasterCard
✔ Discover
✔ Visa
  • General Info:
✔ Supports WHMCS V5 and V6

Installation and Configuration

This tutorial will show you how to successfully install and configure Agile Payment Gateway For WHMCS.

We will guide you step by step through the whole installation and configuration process.

Installation

1. Download Agile Payment Gateway For WHMCS directly from our website.
APG 1.png
2. Upload and extract the module into the main WHMCS directory.

Files in your WHMCS directory should look like these.

APG 2.png

Configuration Of Gateways

3. Now you have to activate the gateways in your WHMCS system.

Log in to your WHMCS admin area. Go to 'Setup' 'Payments' 'Payment Gateways'.
Activate the two gateways: 'Agile Credit Card' and 'Agile eCheck'.

APG 3.png
4. Afterwards, configure the two gateways' settings. Check 'Show on Order Form' and rename them if you wish.

Agile Credit Card:
1. Type in API Login/API Key
2. Secure Transaction Key
3. Account ID
4. Location ID/Merchant ID
5. Use Token for Transaction - if enabled, only four last digits of credit card details will be saved, all the recurring transactions will use the token
6. Notify Clients - send a warning email to clients informing that automated bill payment does not exist.
7. Notify Admins - send an email to admins containing a list of accounts missing bill payment information
8. Test Mode - tick to enable
9. Select Admin Group To Notify - select which admin group should receive notifications about list of accounts missing automated bill payment information
10. Select USD currency to convert to if you are using other currencies!
Save changes!

APG 4.png
Agile eCheck:

1. Type in API Login/API Key
2. Secure Transaction Key
3. Account ID
4. Location ID/Merchant ID
5. Use Token for Transaction - if enabled, all the data will be passed directly over Agile Payment Gateway
6. Charge X Days Before Due Date - enter number of days
7. How Many Charge Attempts - state number of possible attempts
8. Notify Clients - send a warning email to clients informing that automated bill payment does not exist.
9. Notify Admins - send an email to admins containing a list of accounts missing bill payment information
10. Test Mode - tick to enable
11. Select Admin Group To Notify - select which Admin's group should receive notifications about list of accounts missing automated bill payment information
12. Select USD currency to convert to if you are using other currencies!
Save changes!
Note! If both gateways are active, then option: 'Select Admin Group To Notify' is available for one of the gateways only.

APG 5.png
5. You have just successfully installed and configured Agile Payment Gateway For WHMCS!

Management

At this section we will show you the possibilities of Agile Payment Gateway For WHMCS.

Collect payments from your clients using their credit card details as well as accept eChecks.

Agile Payments Methods

Agile Credit Card

Agile Payment Gateway For WHMCS is generally used to pay invoices for placed orders. In order to illustrate its functionalities we have placed an exemplary order.

As you can see on the below order, apart from the agile payment gateways other gateways are also available.
Check 'Agile Credit Card' and complete the order.
Note: If this is your first payment you will be asked now to insert data of your credit card.

APG 6.png
In case this is not your first payment, you will have to make a choice whether you wish to pay with the existing credit card or enter new credit card data.

Remember that no matter which option you choose here, you always have to enter card CVV number.
Info: please note that any saved details are fully secure and you site is sure to meet PCI requirements.

APG 7.png
If you want to pay an outstanding unpaid invoice, then view that invoice, choose payment method and press 'Pay Now'.
APG 7 1.png
You will be redirected to 'Pay by Credit Card' page. Choose whether you want to use your existing card or enter new card information like on the screen below.

1. Choose card type
2. Enter card number
3. Enter expiry date
4. Type in CVV/CVC2 number
Then press 'Submit Payment'.

APG 8.png
Invoice is paid automatically with your credit card.

Agile eCheck

The beginning of the payment process with Agile eCheck gateway is very similar.

Check 'Agile eCheck' on the order form and complete the order.

APG 9.png
You are now being redirected to the gateway you have chosen → 'Agile eCheck'.

Fill out any account details to proceed.
1. Provide the owner name - 'Account Holder'
2. Type in the account number - 'DDA/eCheck Account Number'
3. Type in the routing number
4. Choose account type: 'Checking'/'Savings'
5. Type in the check number
Press 'Submit' to make the payment.
You can also come back to the invoice view from here and change the payment method if you wish, just press 'Return To Invoice' button.

APG 10.png
If entered data are correct, invoice is automatically paid.
In case you have already made any payments with Agile eCheck gateway and 'Use Token for Transaction' is enabled in the gateway settings, an additional option appears.
If you wish you may use details stored in the system, you will not have to fill out the formula again. Simply check the box marked on the screen below.
Note: Please stay assured that tokenization system is fully PCI compliant.
APG 11.png
If you want to add/edit your ACH Agile details then move to 'Your Account' → 'Billing Information' → 'Edit ACH Agile Details'.

On this page you can edit your eCheck payment method details.

APG 12.png

Agile Gateway Widget

Agile Payment Gateway For WHMCS module besides two payment methods offers a useful widget.

The widgets has been implemented to easily keep track on daily incoming revenue and credit card in comparison with revenue split.
Proceed to 'Setup' → 'Staff Management' → 'Administrator Roles' to turn it on. Manage the required administrators group.

APG 14.png
Find 'Agile Gateway Widget' on the list of available widgets (under 'Permissions' section) and save changes.
APG 15.png
Now, you can see it on your WHMCS home page.
APG 16.png
There are data on:
  • Amount in - total income via selected gateway
  • Amount out - total spending via selected gateway (refunds)
  • Transaction count - total number of carried out transactions

These data are shown separately for the two different payment methods.
Note: any amounts in the widget are always displayed in USD currency.

You may choose the time period within which the above data are presented:
  • Day
  • Week
  • Month
  • Year

Here you can also see any failed transaction with the date of the payment attempt, and invoice ID - see 'Transactions With Errors'.

APG 17.png

Tips

1. If you do not want to let your clients choose between payment methods when purchasing some products, unselected this payment option for the group of products in its details.
APG 13.png
2. If you want to simplify the process of recurring payments then use payment tokenization functionality!
Select this option in the required payment gateway configuration.
3. Agile Payment Gateway For WHMCS module besides single and recurring payments fully supports refunds functionality.
If you need to quickly refund a transaction then just use the built-in refunds section in an invoice details site to refund your customer straight to their credit card or eCheck account.

Common Problems

1. When you have problems with connection, check whether your SELinux or firewall does not block ports.
2. If you encounter any problems with making a payment, please refer to 'Billing' → 'Gateway Log' for detailed information.
Personal tools
Namespaces

Variants
Actions
Navigation
WHMCS Modules
cPanel Modules
Magento Extensions
Magento Themes
PrestaShop Modules
Blesta Extensions
General
Social
Agile Payment Gateway For WHMCS