ollywarren/laravel-go-cardless

A Laravel Wrapper for the Go Cardless PHP Client Library

Laravel Go Cardless

, _(*1)

A Laravel 5.5 Wrapper for the Go Cardless PHP Client Library. This package provides simple elegant access to the Go Cardless PHP Client API from across the Laravel Application., _(*2)

The included helper method makes accessing the underlying methods as easy as:, _(*3)

gocardless()->customers()->list(), _(*4)

Installation Laravel 5.5 +

Simply require the package through composer and let the Laravel Package Auto Discovery do the rest., _(*5)

composer require ollywarren/laravel-go-cardless, _(*6)

Publish the vendor configuration:, _(*7)

php artisan vendor:publish (Select the relevant package from the list), _(*8)

Set two environment variables in your Apps .env file:, _(*9)

GOCARDLESS_ENV="sandbox" OR "live"
GOCARDLESS_TOKEN="<YOUR API TOKEN>"

Installation Laravel 5.4

Use composer to add it to your project dependencies:, _(*10)

composer require ollywarren/laravel-go-cardless, _(*11)

Then inside your config/app.php, _(*12)

Add the package service provider to the providers array:, _(*13)

Ollywarren\LaravelGoCardless\GoCardlessServiceProvider::class,, _(*14)

Finally for good measure dump the composer autoloader to make sure we've pulled in the helper method:, _(*15)

composer dump-autoloader, _(*16)

Publish the vendor configuration:, _(*17)

php artisan vendor:publish, _(*18)

Set two environment variables in your Apps .env file:, _(*19)

GOCARDLESS_ENV="sandbox" OR "live"
GOCARDLESS_TOKEN="<YOUR API TOKEN>"

Usage Instructions

This package exposes the underlaying Go Cardless PHP Client Library usign the gocardless() helper method. Any of the methods described in the API Documentation will be accessible., _(*20)

For example:, _(*21)

Get a List of Customers

gocardless()->customers()->list();, _(*22)

Create a New Customer

    gocardless()->customers()->create([
        'params' => [
            "given_name"    => "Jack", 
            "family_name"   => "Sparrow", 
            "email"         => "oljacky@sparrowsnest.com"
        ]
    ]);

For a full breakdown of the API see the Documentation or the PHP Client Library, _(*23)