Skip to main content

Overview of GoCardless gateway integration

Zuora

Overview of GoCardless gateway integration

Introduction

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.

Supported features

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 https://api.gocardless.com
Support Gateway Reconciliation Yes
Support Real-Time Reconciliation Yes
GoCardless production endpoint used for Gateway Reconciliation service https://api.gocardless.com/events

Supported payment methods

The GoCardless gateway integration supports the following payment methods:

  • ACH
  • Bank Transfer, including:
    • Direct Debit UK (BACS)
    • SEPA
    • AU Direct Entry (BECS)
    • Direct Debit NZ (BECS)
    • Denmark Direct Debit (Betalingsservice)
    • Sweden Direct Debit (Autogiro)
    • Canadian Pre-Authorized Debit (PAD)

For the SEPA 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.

Supported currencies

GoCardless supports the following currencies:

  • USD (ACH)
  • GBP (Direct Debit UK, SEPA)
  • EUR (SEPA)
  • 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:
    • Validation
    • Payment
    • Referenced refund
    • Non-referenced refund
    • Void
  • Set up of Service User Number (for Bacs) and Creditor ID (for SEPA)
  • 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 refunds

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 hello@gocardless.com.

Support for Gateway Reconciliation

  1. GoCardless gateway integration supports the following Gateway Reconciliation event types:
  • Settlement
  • Rejection
  • Chargeback
  • 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.

  1. For information about how to enable Real-Time Reconciliation and the limitation, see Real-Time Reconciliation.

  2. 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 forreference 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.