GoCardless gateway for Omnipay payment processing library, using the v2 GoCardless API

0.1.16 2022-01-14 14:05 UTC


Go Cardless driver for the Omnipay PHP payment processing library using the GoCardless v2 API

Build Status Coverage Status Latest Stable Version Total Downloads

Omnipay is a framework agnostic, multi-gateway payment processing library for PHP 5.5+. This package implements GoCardless support for Omnipay.


Omnipay is installed via Composer. To install, simply add it to your composer.json file:

composer require digitickets/gocardlessv2:"^0"

Basic Usage

The following gateways are provided by this package:

  • GoCardless Pro - Release Candidate
  • GoCardless Pro (JS Flow) - Release Candidate
  • GoCardless Redirect Flow - Alpha Release

Please let us know if you are using these release candidates in a production envrionment and we will make a formal release - until that time we may push breaking changes!

Don't know which gateway to use?

  • If you are using GoCardless' own payment screens on their site you want the RedirectGateway.
  • If you are using the GoCardless Javascript to process the card details and return a token then the JSFlowGateway is for you.
  • If you are handling the bank account details on your own server (accepting the highest level of PCI responsibility) then the Pro Gateway is for you.

All the gateways wrap a common core with a lot of shared methods but they differ in mechanism for creating customers, bank accounts and mandates. Redirect returns you a mandate with customer / bank account created behind the scenes. JSFlow returns you a bank account token so you can create a customer, bank account and mandate yourself without handling the bank account details. Pro requires you to submit all the data yourself in individual steps. Creating a subscription or taking a single payment is common to all.

This is still in Development - Only the JS Flow gateway is currently stable.

You need to set your access_token. Setting testMode to true will use the sandbox environment.

This gateway supports single payments or scheduled subscriptions via bank mandate only. For more details about what this gateway supports please consult the documentation

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

Driver specific usage

This driver supports multiple methods of implementation available via GoCardless. Please consult their documentation to confirm which methods are correct for your situation. Not all methods are applicable to every route. This driver does not provide access to the list methods - data may only be retrieved by primary key.

Create customer

$customer = $gateway->createCustomer([
    'customerData' => array(
                            'card' => new \Omnipay\Common\CreditCard( // use the standard omnipay card to hold the customer data
                                    'firstName' => 'Mike',
                                    'lastName' => 'Jones',
                                    'email' => 'mike.jones@example.com',
                                    'address1' => 'Iconic Song House, 47 Penny Lane',
                                    'address2' => 'Wavertree',
                                    'city' => 'Liverpool',
                                    'company' => 'Mike Jones Enterprises',
                                    'country' => 'GB',
                                    'postal_code' => 'L18 1DE',
                                    'state' => 'Merseyside',
                            'customerMetaData' => [
                                'meta1' => 'Lorem Ipsom Dolor Est',
                                'meta2' => 'Far far away, behind the word mountains, far from the countries Vokalia and Consonantia, there live the blind texts.',
                                'meta567890123456789012345678901234567890123456789' => 'Separated they live in Bookmarksgrove right at the coast of the Semantics, a large language ocean. A small river named Duden flows by their place and supplies it with the necessary regelialia.',
                            'swedishIdentityNumber' => '123',

You can find full list of options here.

Find customer (By id)

$customer = $gateway->findCustomer(1)->send();

Parse webhook notification

$notification = $gateway->parseNotification(

This will fetch the event associated with the web hook.

Process repeat billing

TODO - this. Use the standard repeatePurchase() format (see sagepay for example structure)

Suggested generic omnipay driver flow

We are exploring using a simplified set of functions to allow agnostic processing. Each step checks if the method exists on the driver and if it does call it accordingly, before calling getXyzRefernce and adding it to the data passed around. It is hoped that this structure should work with several major gateways - we have considered Stripe, Paypal and the various GoCardless options.

  1. CreateCustomer
  2. completeCustomer
  3. createPaymentMethod (either create card or create bank account)
  4. completePaymentMethod (either complete card or complete bank account)
  5. createMandate
  6. completeMandate

---- above this point is setting up the customer data (effectively taking it to the point of having an authorisation token), below is creating the transaction data

  1. createPlan
  2. completePlan
  3. createSubscription
  4. completeSubscription


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 anouncements, 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 GitHub issue tracker, or better yet, fork the library and submit a pull request.