WorldPay

From WHMCS Documentation

Revision as of 16:40, 11 March 2008 by EcwNick (talk | contribs)

There are two modules for worldpay - one time invoices and FuturePay. For FuturePay, we use the more versatile Limited Agreements payment system. This offers the ultimate in flexibility and allows charges to be taken from the clients card whenever they are needed. So with this, once the user has setup a FuturePay Agreement, any invoice can be charged to their card at any time. This makes all invoice payments automated. There are however some steps involved in configuring it and we'll go through these below.

Setting up the gateway

You first need to activate the WorldPay and/or WorldPay FuturePay module(s) in Config > Payment Gateways and enter your details as requested.

You should set the callback url for payments in your WorldPay control panel to use the WP callback url that is sent with the payment request using <WPDISPLAY ITEM=MC_callback>

FuturePay Specific Items

If using FuturePay, in the Auth Password field, you'll need to enter the password that is setup to allow remote charges to be made. This is also referred to as the Invisible Auth Password and requires that a Remote Admin installation is added to your WorldPay account. This can be achieved by emailing support [at] worldpay [dot] com with your company ID and requesting this (at no extra cost).

You should then go to Configuration > Payment Gateways and setup the FuturePay gateway as show below: Futurepay setup.gif

Next, you need to go to Configuration > Client Custom Fields and setup a custom field with the name FuturePay ID. This should be an admin only field and will store the futurepay id needed to submit charges in the future after the agreement has been setup.

Finally, you need to setup a cron job to run the futurepay charges file which automatically submits the charge requests for all due invoices each day. This needs to be done the your Cron section of your control panel where the WHMCS cron should also be setup. The command you need to use is as follows:

php -q /home/username/public_html/whmcs/modules/gateways/callback/worldpayfuturepaycharges.php

Behavior of the Module

This module has some interesting characteristics that should be noted. Payments are taken immediately when a new customer first creates their FuturePay Agreement and subsequent payments taken when an invoice reaches its due date when the cron runs - as expected.

However, if an existing customer places a new order payment will not be taken until the cron runs and subsequently it could be up to 11 hours before their service is set up. There is a debate surrounding the issue in this thread.

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