A client library for the GoCardless Pro API.
Project description
A Python client for interacting with the GoCardless Pro API.
Tested against Python 2.7, 3.3, 3.4, 3.5, 3.6 and 3.7.
- “Getting Started” guide with copy and paste Python code samples
- API reference
Install from PyPI:
$ pip install gocardless_pro
Usage
Create a Client instance, providing your access token and the environment you want to use:
import gocardless_pro token = os.environ['ACCESS_TOKEN'] client = gocardless_pro.Client(access_token=token, environment='live')
Access API endpoints using the corresponding methods on the client object:
# Create a new customer. We automatically add idempotency keys to requests to create # resources, stopping duplicates accidentally getting created if something goes wrong # with the API (e.g. networking problems) - see https://developer.gocardless.com/api # -reference/#making-requests-idempotency-keys for details customer = client.customers.create(params={'email': 'jane@example.com'}) # Fetch a payment by its ID payment = client.payments.get("PA123") # Loop through a page of payments, printing each payment's amount for payment in client.payments.list().records: decimal_amount = decimal.Decimal(payment.amount) / 100 print('Payment for £{0}'.format(decimal_amount)) # Create a mandate PDF in a specific language client.mandate_pdfs.create( params={'links': {'mandate': 'MD00001234XYZ'}}, headers={'Accept-Language': 'fr'} )
For full documentation, see our API reference.
Available resources
Bank details lookups
# Perform a bank details lookup client.bank_details_lookups.create(params={...})
Creditors
# Create a creditor client.creditors.create(params={...}) # List creditors client.creditors.list(params={...}) # Iterate through all creditors client.creditors.all(params={...}) # Get a single creditor client.creditors.get('CR123', params={...}) # Update a creditor client.creditors.update('CR123', params={...})
Creditor bank accounts
# Create a creditor bank account client.creditor_bank_accounts.create(params={...}) # List creditor bank accounts client.creditor_bank_accounts.list(params={...}) # Iterate through all creditor_bank_accounts client.creditor_bank_accounts.all(params={...}) # Get a single creditor bank account client.creditor_bank_accounts.get('BA123', params={...}) # Disable a creditor bank account client.creditor_bank_accounts.disable('BA123', params={...})
Currency exchange rates
# List exchange rates client.currency_exchange_rates.list(params={...}) # Iterate through all currency_exchange_rates client.currency_exchange_rates.all(params={...})
Customers
# Create a customer client.customers.create(params={...}) # List customers client.customers.list(params={...}) # Iterate through all customers client.customers.all(params={...}) # Get a single customer client.customers.get('CU123', params={...}) # Update a customer client.customers.update('CU123', params={...}) # Remove a customer client.customers.remove('CU123', params={...})
Customer bank accounts
# Create a customer bank account client.customer_bank_accounts.create(params={...}) # List customer bank accounts client.customer_bank_accounts.list(params={...}) # Iterate through all customer_bank_accounts client.customer_bank_accounts.all(params={...}) # Get a single customer bank account client.customer_bank_accounts.get('BA123', params={...}) # Update a customer bank account client.customer_bank_accounts.update('BA123', params={...}) # Disable a customer bank account client.customer_bank_accounts.disable('BA123', params={...})
Customer notifications
# Handle a notification client.customer_notifications.handle('PCN123', params={...})
Events
# List events client.events.list(params={...}) # Iterate through all events client.events.all(params={...}) # Get a single event client.events.get('EV123', params={...})
Instalment schedules
# Create (with dates) client.instalment_schedules.create_with_dates(params={...}) # Create (with schedule) client.instalment_schedules.create_with_schedule(params={...}) # List instalment schedules client.instalment_schedules.list(params={...}) # Iterate through all instalment_schedules client.instalment_schedules.all(params={...}) # Get a single instalment schedule client.instalment_schedules.get('IS123', params={...}) # Update an instalment schedule client.instalment_schedules.update('IS123', params={...}) # Cancel an instalment schedule client.instalment_schedules.cancel('IS123', params={...})
Mandates
# Create a mandate client.mandates.create(params={...}) # List mandates client.mandates.list(params={...}) # Iterate through all mandates client.mandates.all(params={...}) # Get a single mandate client.mandates.get('MD123', params={...}) # Update a mandate client.mandates.update('MD123', params={...}) # Cancel a mandate client.mandates.cancel('MD123', params={...}) # Reinstate a mandate client.mandates.reinstate('MD123', params={...})
Mandate imports
# Create a new mandate import client.mandate_imports.create(params={...}) # Get a mandate import client.mandate_imports.get('IM000010790WX1', params={...}) # Submit a mandate import client.mandate_imports.submit('IM000010790WX1', params={...}) # Cancel a mandate import client.mandate_imports.cancel('IM000010790WX1', params={...})
Mandate import entries
# Add a mandate import entry client.mandate_import_entries.create(params={...}) # List all mandate import entries client.mandate_import_entries.list(params={...}) # Iterate through all mandate_import_entries client.mandate_import_entries.all(params={...})
Mandate pdfs
# Create a mandate PDF client.mandate_pdfs.create(params={...})
Payments
# Create a payment client.payments.create(params={...}) # List payments client.payments.list(params={...}) # Iterate through all payments client.payments.all(params={...}) # Get a single payment client.payments.get('PM123', params={...}) # Update a payment client.payments.update('PM123', params={...}) # Cancel a payment client.payments.cancel('PM123', params={...}) # Retry a payment client.payments.retry('PM123', params={...})
Payouts
# List payouts client.payouts.list(params={...}) # Iterate through all payouts client.payouts.all(params={...}) # Get a single payout client.payouts.get('PO123', params={...}) # Update a payout client.payouts.update('PO123', params={...})
Payout items
# Get all payout items in a single payout client.payout_items.list(params={...}) # Iterate through all payout_items client.payout_items.all(params={...})
Redirect flows
# Create a redirect flow client.redirect_flows.create(params={...}) # Get a single redirect flow client.redirect_flows.get('RE123456', params={...}) # Complete a redirect flow client.redirect_flows.complete('RE123456', params={...})
Refunds
# Create a refund client.refunds.create(params={...}) # List refunds client.refunds.list(params={...}) # Iterate through all refunds client.refunds.all(params={...}) # Get a single refund client.refunds.get('RF123', params={...}) # Update a refund client.refunds.update('RF123', params={...})
Subscriptions
# Create a subscription client.subscriptions.create(params={...}) # List subscriptions client.subscriptions.list(params={...}) # Iterate through all subscriptions client.subscriptions.all(params={...}) # Get a single subscription client.subscriptions.get('SB123', params={...}) # Update a subscription client.subscriptions.update('SB123', params={...}) # Pause a subscription client.subscriptions.pause('SB123', params={...}) # Resume a subscription client.subscriptions.resume('SB123', params={...}) # Cancel a subscription client.subscriptions.cancel('SB123', params={...})
Tax rates
# List tax rates client.tax_rates.list(params={...}) # Iterate through all tax_rates client.tax_rates.all(params={...}) # Get a single tax rate client.tax_rates.get('GB_VAT_1', params={...})
Running tests
First, install the development dependencies:
$ pip install -r requirements-dev.txt
To run the test suite against the current Python version, run nosetests.
To run the test suite against multiple Python versions, run tox.
If you don’t have all versions of Python installed, you can run the tests in a Docker container by running make.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
| Filename, size | File type | Python version | Upload date | Hashes |
|---|---|---|---|---|
| Filename, size gocardless_pro-1.22.0.tar.gz (35.9 kB) | File type Source | Python version None | Upload date | Hashes View |
