Setting up Zuora GoCardless Payment Gateway and Hosted Payment Page

GoCardless powers recurring payments for over 20,000 merchants, including some of Europe's largest media, software and technology-driven companies. Zuora’s integration to GoCardless makes it simple to accept recurring and one-off payments across the UK and Europe via Bacs, SEPA and AutoGiro Direct Debit.

Supported 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".

Supported Currencies

GoCardless supports the following currencies:

  • 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

  • Set up of Service User Number (for Bacs) and Creditor ID (for SEPA)
  • Set up Direct Debit mandate and validate bank details, either online, over the phone or via paper
  • 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
  • Simple to transfer existing Direct Debit mandates from another provider to GoCardless and Zuora
  • Sandbox environment available for full testing
  • Support for the following ACH payment operations: Validation Payment Refund Credit Void

Supported Gateway Reconciliation Event Types

GoCardless Gateway supports the following Gateway Reconciliation event types:

  • Settlement
  • Rejection
  • Chargeback
  • Mandate Rejected
  • Mandate Cancelled
  • Mandate Expired
  • Mandate Reinstated
  • Mandate Transferred
  • Mandate Replaced

Prerequisites 

You will need to obtain the following information from GoCardless before configuring the GoCardless payment gateway in Zuora:

Configure the GoCardless Gateway Instance

  • Navigate to Zuora Payments Settings > Setup Payment Gateway.
  • Select GoCardless from the Gateway Type drop-down menu.
  • Click create gateway.

Zuora Payment Gateway Configuration Fields

There are some common fields you must complete for every gateway configuration.

  • Type
  • Name
  • Use Gateway Test Environment
  • Default Authorization Amount
  • Verify new payment method (required)
  • Verify updated payment method (optional)
  • Enable gateway reconciliation: If you select this checkbox, it will trigger a daily job to reconcile all payment events processed through the gateway.

In addition to the common fields, you must provide the required information to configure the GoCardless gateway in Zuora.

  • Access token
  • Creditor ID

Once you have entered the necessary information, click save gateway information.

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 on getting the most out of the GoCardless integration for Zuora, contact the GoCardless team on hello@gocardless.com .

Hosted Page Setup

Enable Bank Transfer Payment Method

We need to enable the "Bank Transfer" Payment method in your tenant Payment method settings. To navigate to the payment method page

  • Click your user name at the top right-hand side of the application.
  • Navigate to Settings > Payments Settings > Payment method
  • Click on edit and enable "Bank Transfer" payment method

1942122544635220a24054a052012909daddpaymentmethod.png

To check your Hosted Page to ensure that the default payment gateway setting is pointing to your new payment gateway.

To access, navigate to Settings > Payments > Setup Hosted Pages, then click on Edit under the applicable hosted page
1942122463aeb315869db8e7593b6840cadddefaultgateway.png