GoCardless sample application
The first thing to do is to clone the repository:
$ git clone https://github.com/gocardless/sample-django-app.git $ cd sample-django-app
Create a virtual environment to install dependencies in and activate it:
$ virtualenv2 --no-site-packages env $ source env/bin/activate
Then install the dependencies:
(env)$ pip install -r requirements.txt
(env) in front of the prompt. This indicates that this terminal
session operates in a virtual environment set up by
pip has finished downloading the dependencies:
(env)$ cd project (env)$ python manage.py runserver
And navigate to
In order to test the purchase flows, fill in the account details in
project/gc_app/views.py to match your SANDBOX developer credentials.
Before you interact with the application, go to GoCardless Sandbox and set up
the Redirect URI in the Developer settings. To make it work with this
application, use the value
http://127.0.0.1:8000/gocardless/confirm/. This is to
make sure you are redirected back to your site where the purchase is verified
after you have made a purchase.
The simplest payment type is one-off. By clicking
Make purchase on the sample
appliation website, you are taken through the flow in making a single payment.
A real-world example of one-off purchases is buying something in an online store.
Subscriptions are fixed periodic payments. Upon clicking
Subscribe on the sample
application website, you are taken through the process of registering a subscription
with a merchant.
An example would be subscribing to a magazine or newspaper. The magazine is published once a month and it costs £10, the payment flow sets up an automatic transaction transferring £10 monthly to the merchant's account.
Pre-authorizations are essentially subscriptions, with an added twist that it's
up to the merchant to request funds from the customer's account, and the
customer may be billed up to a certain, authorized amount every billing
period. Upon clicking
Preauthorize on the sample app website, you are taken
through the flow of pre-authorizing a variable direct-debit payment.
An example from the real world would be a type of pay-as-you go service where the customer authorizes the merchant to claim up to a certain amount per interval depending on usage.
In the sample app, you pre-authorize a payment of up to £100 every 3 months.
For further information, refer to the docs.
localtunnel to test out Webhooks. The
localtunnel package should be
installed as a dependency to the project.
Note, however, that the port number is the same as the port that
python manage.py runserver is
running on, which is 8000.
(env)$ localtunnel-beta 8000 => Port 8000 is now publicly accessible from http://5bebd69e5222.v2.localtunnel.com ...
Please refer to the the Webhooks manual for more details.
Test your Webhooks
Once you have the app running with
python manage.py runserver and tunneling
set up with
localtunnel (make sure you verify that by navigating to the URL
localtunnel gives back to you) navigate to the "Web hooks" tab under the
Developer section in GoCardless Sandbox. Make sure that the Webhook URL is the
same you got back from
localtunnel with an added
/gocardless/webhook/ at the
otherwise it does not work. There should be a button for sending a test
webhook. Click that, select
Bill as the object type and click
The data from Webhook is accessible in the
Webhook class-based view in
project/gc_app/views.py in the
To run the tests,
cd into the directory where
(env)$ python manage.py test gc_app