Skip to main content

The Python client library for the GoCardless API

Project description

https://s3-eu-west-1.amazonaws.com/gocardless/images/client-lib-headers/python-lib-header.png

This module provides a wrapper around the GoCardless payments API, the interface to the api is provided by the gocardless.Client object. See the documentation for that class for how to obtain an instance.

By default the library will attempt to use the GoCardless production environment, for testing purposes this is not what you want and you should set the gocardless.environment to “sandbox”.:

>>> gocardless.environment = "sandbox"

Set your account details::

>>> gocardless.set_details(app_id="kzCOPw2JtJvRQxKOPEREQTGvxLvkoMS1Eb0Dgl5QVc1W0NKpOEZDvESfGOI_kkG2l",
>>>     app_secret="IO9AlgPsbYNCtFlcOFGROBrGB3Mi07PFYSn2zx4uK5xaWJI1AzwnYeC86x46ji_g",
>>>     access_token="5EFkzOrUOZ8t+iaP86NggIy+FOFSD0f7QMnMd+Q3P4mQk17Kzq9G1vYrNlEWFldlg",
>>>     merchant_id="02FX1YFDAS")

You can now use the gocardless.client object to generate urls for receiving payments.:

>>> gocardless.client.new_bill_url(10)

Users who click on this link will be taken to the GoCardless website to make a payment to your account.

You can also use it to query the api for information about payments resources using an active resource style API. For example, to get all of a merchants bills:

>>> merchant = client.merchant()
>>> merchant.bills()
>>> [<gocardless.resources.Bill at 0x29a6050>]

Contribute

Fork the repo then clone it to your machine and install in “develop” mode (preferably using a virtualenv):

mkvirtualenv gocardless
git clone https://github.com/<username>/gocardless-python
cd gocardless-python
python setup.py develop

Install the testing dependencies:

pip install -r requirements.txt

and run the test suite:

nosetests

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

gocardless-0.2.1.tar.gz (21.0 kB view details)

Uploaded Source

File details

Details for the file gocardless-0.2.1.tar.gz.

File metadata

  • Download URL: gocardless-0.2.1.tar.gz
  • Upload date:
  • Size: 21.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for gocardless-0.2.1.tar.gz
Algorithm Hash digest
SHA256 662bd2bb72d39fce6d914c43b70d51769f1066c720e3f132d9ddfa2a7753acef
MD5 0484c8053a167ae4d202ffa3ded3a33b
BLAKE2b-256 6c6dd7828e2f99e7c1b6e08a32fa7c4d2d782897fb98d99e288f21717fc95763

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page