Overview of GoCardless gateway integration
The following video is provided by GoCardless. It demonstrates the integration between Zuora and the GoCardless gateway. It does not necessarily reflect the latest version of the Zuora UI.
You must use the GoCardless Pro package and have the Custom Payment Page feature enabled to work with the GoCardless integration in Zuora.
The following table provides a quick reference for the supported features. For details about each feature, see the later sections in this article.
|Supported payment methods||ACH, Bank Transfer|
|Supported payment operations||Validation, Payment, Referenced refund, Non-referenced refund, Void|
|Support Gateway Options fields||Yes|
|Gateway provider’s API version||2015-07-06|
|GoCardless production endpoint used for Zuora gateway integration service||
|Support Gateway Reconciliation||Yes|
|Support Real-Time Reconciliation||Yes|
|GoCardless production endpoint used for Gateway Reconciliation service||
|Support GoCardless Instant Bank Pay and Verified Mandates payment flow||Yes|
Supported payment methods
The GoCardless gateway integration supports the following payment methods:
- Bank Transfer, including:
- Direct Debit UK (BACS)
- SEPA Direct Debit
- AU Direct Entry (BECS)
- Direct Debit NZ (BECS)
- Denmark Direct Debit (Betalingsservice)
- Sweden Direct Debit (Autogiro)
- Canadian Pre-Authorized Debit (PAD)
For the SEPA Direct Debit payment method, you must use the International Bank Account Number (IBAN) to create payment methods. Different schemes are used on the GoCardless side corresponding to different country codes in IBAN. For example, if the IBAN is set to "GB60BARC20000055779911", the scheme used by GoCardless will be “Bacs". If IBAN is set to "FR1420041010050500013M02606", the scheme used by GoCardless will be "sepa_core".
For more information about setting up payment methods in Zuora, see Define and set up payment methods.
Support for mandate creation
Zuora supports mandate creation for all supported payment methods. Zuora will generate and pass the mandate to the gateway.
GoCardless supports the following currencies:
- USD (ACH)
- GBP (Direct Debit UK, SEPA Direct Debit)
- EUR (SEPA Direct Debit)
- AUD (AU Direct Entry)
- SEK (Autogiro)
- DKK (Betalingsservice)
- NZD (Direct Debit NZ)
- CAD (Canadian PAD)
Supported payment operations
- Support the following payment operations for ACH and Bank Transfer payment methods:
- Referenced refund
- Non-referenced refund
- Set up of Service User Number (for Bacs) and Creditor ID (for SEPA Direct Debit)
- Set up mandate and validate bank details, either online, over the phone or via paper
- Simple to transfer existing mandates from another provider to GoCardless and Zuora
- Collect payments automatically
- One-off, ad-hoc, recurring and pre-payments
- Real-time alerts for failed or cancelled payments and check status of all payments in Zuora
- Retry failed payments automatically
- Refund payments (full or partial refunds) via Faster Payments or SEPA Credit Transfer
GoCardless payments can only be refunded two days after the payment has been processed. If a refund is performed prior to the two-day delay, the call will fail and return the following error message: "invalid_state – A refund is not possible on this payment."
For further information, contact the GoCardless team on email@example.com.
Support for Gateway Reconciliation
- GoCardless gateway integration supports the following Gateway Reconciliation event types:
- Mandate Rejected
- Mandate Cancelled
- Mandate Expired
- Mandate Reinstated
- Mandate Transferred
- Mandate Replaced
For more information about enabling and configuring the Gateway Reconciliation service, see the following articles:
Support for Real-Time Reconciliation
GoCardless also supports the Real-Time Reconciliation feature. With this feature enabled, the payment gateway can submit notifications to Zuora for various event types on gateway objects, and the corresponding records can be automatically updated in real time.
For information about how to enable Real-Time Reconciliation and the limitation, see Real-Time Reconciliation.
For information about the supported events for GoCardless and the corresponding actions from Zuora, See Real-Time Reconciliation events for GoCardless.
Supported Gateway Options fields
You can submit additional information to the GoCardless gateway using gateway options. Currently, Zuora's GoCardless gateway integration only supports the InvoiceNum field. This field can be used in Payment Pages 2.0 or the following REST API:
Note that this gateway option field is mapped to the
reference field in the Create a payment operation of GoCardless. So the character limit for
reference also applies to the InvoiceNum gateway option field. Refer to GoCardless's documentation for the character limit details.
If you have enabled the Bacs custom mandate feature on the gateway side, refer to Bacs custom mandate reference guide for additional requirements.
Support for GoCardless Instant Bank Pay and Verified Mandates payment flow
Instant Bank Pay and Verified Mandates are services provided by GoCardless. The Verified Mandates service is for quick and easy verification of bank account details in the payment flow. The Instant Bank Pay service is for collecting one-time bank transfer payments that are instantly authorized. With these services, bank accounts are verified without compromising the checkout experience, and bank-to-bank payments are confirmed instantly. It provides better visibility for you and your end customers, saves time chasing one-time payments, and creates a smoother customer experience.
Note that GoCardless provides the Instant Bank Pay and Verified Mandates services only in specific regions. For details, see the following GoCardless documents:
In Zuora, the GoCardless gateway integration supports the GoCardless Instant Bank Pay and Verified Mandates payment flow. You can implement a Payment Page 2.0 to support processing payments through Instant Bank Pay and Verified Mandates with the SEPA Direct Debit payment methods on the GoCardless gateway integration. During the flow, you can take advantage of the flow of adding or updating existing SEPA bank account details to create a Direct Debit mandate without being required to make a payment. You can also create a Direct Debit mandate, complete a SEPA one-time payment, and store the details as a fully tokenized payment method in Zuora for future recurring use.
The support for the GoCardless Instant Bank Pay and Verified Mandates payment flow is in the Early Adopter phase. If you want to enable this feature, submit a request at Zuora Global Support.
For more information about how to implement the GoCardless Instant Bank Pay and Verified Mandates payment flow, see Implement Payment Pages 2.0 to support one-time payment flows.