Payment GoCardless

Description

This module enables seamless integration with GoCardless that allows us to manage transactions, tokens, payments, and events directly within Odoo. It simplifies the handling of direct debit operations, offering a smooth and efficient user experience.

Configuration

Navigate to Accounting - - > Configuration - - > Payment Providers. Select GoCardless and fill in the necessary credentials (provided by GoCardless) under the Credentials tab.

 

The payment method is selected as ACH Direct Debit, which specifies the payments that will be processed via GoCardless, and the payment journal is set as GoCardless, where related transactions will be recorded.

Functionality

Navigate to the Contacts module. Under the “GoCardless” tab, users can view details such as the mandate status and associated payment token.

A dedicated "Add Mandate" button is available to initialize a GoCardless mandate for the customer. Once initiated, the GoCardless Information section displays real-time status updates such as Initialization State, Payment Token, and Mandate State.

Upon clicking the "Add Mandate" smart button, a secure GoCardless form will open, prompting the user to enter the customer's bank account details to initiate the direct debit mandate.

Once the information is submitted, the mandate will be saved under the customer's “Saved Payment Methods” smart button for future transactions.

Mandates for contacts are exported from GoCardless and seamlessly imported into Odoo. Upon the successful addition of the mandate for the contact, the GoCardless Initialization State will transition to "Initialization Complete" status.

Navigate to the Sales module and create a sales order for the desired contact. Set the “Payment Method” to GoCardless; the corresponding “GoCardless Mandate” field will automatically populate with the saved mandate linked to the customer.

After validating the delivery order, create and confirm the invoice. A “GoCardless Payment” smart button will then appear, allowing us to register the payment directly through GoCardless.

A payment transaction will be generated, and a log note referencing the payment ID will be automatically added to the related invoice.

A scheduled action, “GoCardless: Sync Events” has been configured for GoCardless integration, which automatically runs every 10 minutes to synchronize payments from Odoo to GoCardless.

For testing purposes, we click “Run Manually” to update the invoice status to “In Payment”.

The payment transaction is in the “Confirmed” state, with both the Provider Reference and Payment Token generated, indicating a successful linkage with GoCardless.

Additionally, an event indicates that a payment was successfully created in GoCardless via the API, with the event type “payment_created” logged against the invoice.

The corresponding payment record for the invoice is shown below, displaying the “Saved Payment Token” linked to the GoCardless journal and payment method. This token ensures that the payment can be securely processed using the authorized mandate.

The payment transaction for the invoice is now in the “Submitted” state, confirming the progression of the payment lifecycle, showing the “payment_created” event followed by the “payment_submitted” event in a few hours, indicating successful submission to GoCardless for processing.

Following submission, the payment status transitions to “payment_confirmed” within two days and subsequently to “payment_paid_out”, finalizing the transaction to the customer’s account via GoCardless.

Note: If a payment is processed incorrectly, the user may cancel the transaction by clicking on the “Void Transaction” button on the Payment Transaction only while its event status is in the created stage; subsequent repayment via GoCardless will generate a new transaction to be processed.

Grouped Invoice Payments

This feature allows users to group multiple invoices by customer and send a single payment request to GoCardless, simplifying the payment process for customers with multiple outstanding invoices. Instead of triggering separate payments for each invoice, users can select multiple invoices and group them into a single payment request, streamlining the experience and reducing the number of requests sent to GoCardless.

Navigate to the Accounting module and go to Invoices under Customers menu. In the list view of the Invoices, Select the relevant invoices for different customers for example, all invoices for a given month grouped by partner and they will be automatically sent to GoCardless for group payment processing. Click on the Actions button and select the “GoCardless: Take Payment” option which is created specifically for this functionality to generate a single GoCardless payment request.

A single GoCardless payment request has been created for the two invoices belonging to the same customer. The Reference will be automatically generated with a prefix indicating the number of invoices (e.g., "2-INV...", where "2" highlights the invoice count), and a common Payment Token assigned to both invoices.

The payment for both invoices has been displayed in the screenshot below.

In GoCardless, the corresponding payment can be seen with a invoice_gc_reference that includes the invoice numbers for which the group payment was applied.

Reduced failed payments with Success+

Success+ is a payment intelligence and automation product that uses machine learning to manage and reduce payment failures. When a payment fails, Success+ retries it on the date it’s most likely to succeed, recovering on average 71% of failed payments.  

Log into the GoCardless dashboard and navigate to the Success+ page. Click Turn on Success+ and choose the scheme/schems that we want to enable Success+ for. Click Enable retries for…. to enable Success+.

Below is a screenshot where “Euro” is enabled to retry payments that fail due to non-sufficient funds.

If Success+ is active, an event will be received automatically, notifying that the payment has been retried by GoCardless.
If this event is not received after a payment failure, it can be assumed that either:

• Success+ has not been enabled by the merchant on their dashboard, or
  
• The payment was not considered eligible for a retry (depending on the reason for failure).

Below is a scenario where there is a payment failure and an event has been automatically received indicating that the payment was scheduled for resubmission automatically by GoCardless.

The “GoCardless Payment” button won’t be visible in the invoice since the payment has been automatically retried by GoCardless.

Refund

If enabled on the account, we will be able to process a refund for a collected payment via the payment's record within the dashboard. Payments can be refunded once they have been marked as confirmed, and you can refund the payment in full or specify a partial amount.

Note: In order to refund a payment, we need to have enough confirmed balance to cover the refund amount. If we refund a payment, this will be deducted confirmed balance and we will see it as a debit in your payouts. If we do not have enough confirmed balance we will not be able to refund payments.

When the invoice in Odoo is in the “Paid Out” state, a refund can be processed for it.

When a credit note is created for an invoice in the “Paid Out” state, the “GoCardless Refund” button becomes available, allowing the refund to be synchronized with GoCardless.

As shown below, the refund has been successfully processed in the GoCardless account, and the full amount of 339.25 EUR has been refunded to the customer.

The corresponding transaction linked to the credit note will have its state updated to “Refund”.

Credits

Contributors

• Sodexis <apps@sodexis.com>

This module is maintained by Sodexis.