GoCardless
GoCardless Integration Guide
GoCardless allows you to collect Direct Debit payments from Eurozone for recurring or one-time payments. Learn more about GoCardless
Integration requirements
The first thing that you have to do is to create an Octobat account. Then, you have to own a GoCardless account either in sandbox mode or in live mode. To ensure that all your invoices are correctly generated, you must follow the way of this guide to make GoCardless API calls.
Connect your Octobat and GoCardless accounts
During your registration, you will be able to connect your GoCardless sandbox account and your GoCardless live account.
Testing
The best way for testing the GoCardless integration with Octobat is to connect a GoCardless sandbox account, test (make API calls or create some objects within your GoCardless dashboard) and look what is happening on Octobat.
GoCardless API calls
This Octobat integration is based on the GoCardless API. Octobat uses some GoCardless basic fields to generate compliant invoices and calculate right taxes. But all these fields are not sufficients, so Octobat uses metadata fields.
Reminder
Install the gem 'gocardless_pro'
Create a customer
In the case of a B2C customer:
In the case of a B2B customer:
Create a payment
Create a refund
Create a subscription
Possible metadata fields values
Last updated