Skip to content


Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
This branch is 8 commits ahead, 2 commits behind comicrelief:master.

Latest commit


Git stats


Failed to load latest commit information.
Latest commit message
Commit time

Omnipay: Worldpay Hosted Corporate Gateway (XML)

Build Status

WorldPay Hosted driver for the Omnipay PHP payment processing library

This was forked from comicrelief/omnipay-worldpay-cg-hosted which is now not a maintained library. @catharsisjelly did offer to take over the library and continue development of this but so far has been unsuccessful. For more information on the changes implemented please see the CHANGELOG

Omnipay is a framework agnostic, multi-gateway payment processing library for PHP 7.1+. This package implements WorldPay XML Corporate Gateway Hosted support for Omnipay. This implementation has been guided by the documentation available on WorldPay


This library is best installed via Composer e.g.

composer require catharsisjelly/omnipay-worldpay-cg-hosted

Basic Usage

The following gateways are provided by this package:

  • WorldPay Corporate Gateway Hosted

For general usage instructions, please see the main Omnipay repository.

Order description

We currently set the order description to "Merchandise" by default.

To set another one, use PurchaseRequest::setDescription().

Notification setup

This library aims to be able to give sensible answers for isValid(), isAuthorised(), isPending() and isCancelled(), if you select almost every possible type on this screen:

Notification setup

Generally it's good to tick everything you can, so as not to miss notifications you might care about.

However we've had to not tick SENT_FOR_AUTHORISATION because of an apparent Worldpay bug that sends two AUTHORISED notifications when this is selected, instead of sending the additional type.

We have not yet had confirmation from Worldpay on whether this is expected to affect the production gateway or if it will be fixed, so it's safer not to enable this notification for now.

Notification verification

Worldpay recommend the following to receive notifications and check they came from them:

  1. Use server SSL - this should be standard for any payment app!
  2. Check the IP's reverse DNS records - this actually isn't very secure and can be spoofed, but is implemented in this library as a first line of defence. There is an IP fallback for known Worldpay subnets, in case your environment can't do public reverse DNS lookups.
  3. Request for them to send, and validate on your server, their client TLS certificate.

Unfortunately there's no easy server- and environment-agnostic way to implement client TLS verification (point 3) within this library, and for our apps' current infrastructure it wasn't feasible. Some of the work would generally live in your web server anyway rather than this library.

We also considered an additional measure, inquiry requests, but as this document explains they're not enabled by default and are also nowhere near real-time (~5 minutes latency). This means they are not suitable for checking notifications' validity unless you queue them and accept much longer delays.

This means that for now you should not consider notifications shown as 'valid' in this library to be guaranteed valid, i.e. do not ship goods based on this without a later check, using inquiry requests or the Worldpay UI, that gives a matching result.

Any ideas or contributions that you think might improve this situation would be very welcome!


If you are having general issues with Omnipay, we suggest posting on Stack Overflow. Be sure to add the omnipay tag so it can be easily found.

If you want to keep up to date with release announcements, discuss ideas for the project, or ask more detailed questions, there is also a mailing list which you can subscribe to.

If you believe you have found a bug, please report it using the issue tracker, or better yet, fork the library and submit a pull request.


Worldpay Hosted Corporate Gateway (XML) driver for the Omnipay payment processing library








No packages published


  • PHP 100.0%