GoCardless Integration
ERPNext integrates with GoCardless to collect payments through Direct Debit schemes such as SEPA. Once configured, businesses can securely send payment requests, manage mandates, and automatically record payments in ERPNext.
Summary
- Accept Direct Debit payments using GoCardless.
- Supports multiple GoCardless payment gateway accounts.
- Automatically creates Payment Gateway and Bank accounts.
- Supports SEPA mandate management.
- Webhook support for automatic mandate updates.
Prerequisites
- An active GoCardless account.
- GoCardless Access Token.
- Webhook Secret (recommended for automatic mandate updates).
Access GoCardless Settings
Navigate to:
Explore > Integrations > GoCardless Settings
Configure GoCardless
- Open GoCardless Settings.
- Enter your Access Token.
- Optionally enter the Webhook Secret Key.
- Save the configuration.
- Enable the GoCardless integration.
What Happens After Enabling?
- A Payment Gateway record is created automatically.
- A Bank account is created in the Chart of Accounts.
- A Payment Gateway Account is generated for payment configuration.
- Multiple GoCardless accounts can be configured if required.
Payment Gateway Account
The Payment Gateway Account acts as the central configuration point for GoCardless payments. From here you can:
- Select the Bank account used for incoming payments.
- Configure the default Payment Request email template.
- Choose which GoCardless account is used for payment collection.
Chart of Accounts Entry
When the integration is enabled, ERPNext automatically creates a Bank-type account in the Chart of Accounts to record GoCardless transactions.
SEPA Payment Flow
GoCardless supports SEPA Direct Debit payments through mandate-based authorization.
- The customer initiates a payment.
- If no mandate exists, the customer enters their IBAN or local bank account details.
- The customer authorizes a SEPA mandate.
- After the mandate is approved, the payment request is submitted to GoCardless.
- If a valid mandate already exists, ERPNext sends the payment request directly to GoCardless without requiring customer approval again.
- GoCardless sends a confirmation email to the customer after the payment request has been processed.
How Existing Mandates Work
Customers who already have an active SEPA mandate do not need to authorize every payment. Future payment requests are submitted directly to GoCardless using the existing mandate.
Webhook Configuration
GoCardless webhooks allow ERPNext to automatically update cancelled or expired mandates.
Configure the following endpoint in your GoCardless account:
https://yoursite.com/api/method/erpnext.erpnext_integrations.doctype.gocardless_settings.webhooks
Important
After creating the webhook, enter the corresponding Webhook Secret Key in GoCardless Settings within ERPNext. This allows ERPNext to securely verify incoming webhook events.
Supported Transaction Currencies
| Supported Currencies |
|---|
| EUR, DKK, GBP, SEK |
Result
After completing the setup, ERPNext can securely collect Direct Debit payments through GoCardless, manage customer mandates, and automatically record payment transactions.
