Zuora Logo

GoCardless Gateway

Knowledge Center > Billing and Payments > Payment Gateways > Supported Payment Gateways > GoCardless Gateway

GoCardless Gateway

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.

The following video is provided by GoCardless for your reference. It demonstrates the integration between Zuora and the GoCardless gateway. It does not necessarily reflect the latest version of the Zuora UI. You can click GoCardlessVideoCCIcon.png on the video toolbar to change the subtitles to your preferred language.

Supported Payment Method

  • Direct Debit UK (BACS)
  • SEPA
  • AU Direct Entry (BECS)
  • Direct Debit NZ (BECS)
  • Denmark Direct Debit (Betalingsservice)
  • Sweden Direct Debit (Autogiro)
  • 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 (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

  1. Supported Gateway Reconciliation Event Types

  2. GoCardless Gateway supports the following Gateway Reconciliation event types:
  • Settlement
  • Rejection
  • Chargeback
  • Mandate Rejected
  • Mandate Cancelled
  • Mandate Expired
  • Mandate Reinstated
  • Mandate Transferred
  • Mandate Replaced

Configure the GoCardless Gateway 

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

Zuora Configuration Fields

There are some common fields you must complete for every gateway configuration. We recommend reviewing Setting Up Payment Gateways for information on these fields: 

  • 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.

Configure the GoCardless Gateway

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

GoCardless Refunds

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

  2. For further information on getting the most out of the GoCardless integration for Zuora, contact the GoCardless team on hello@gocardless.com.

  3. GR Event Mapping between GoCardless and Zuora 

    Within a gateway reconciliation job, every record in the gateway reconciliation report is parsed into an event and matched with the corresponding Zuora transaction.

  4. The following table lists the event mapping between GoCardless and Zuora in gateway reconciliation.

  5. Object GoCardless Action Zuora Event Zuora Action
    Mandate reinstated MandateReinstated Zuora reactivates the payment method.
    Mandate canceled MandateCanceled Zuora closes the payment method.
    Mandate failed MandateRejected Zuora closes the payment method.
    Mandate expired MandateExpired Zuora closes the payment method.
    Mandate resubmission_requested MandateReinstated Zuora reactivates the payment method.
    Payment customer_approval_denied TransactionRejected
    • Zuora updates the Gateway State to "Failed to Settle" on the Payment transaction.
    • Zuora creates an External Refund with the Reason Code set to "Payment Rejection".
    Payment confirmed TransactionSettled Zuora updates the Gateway State to "Settled" and the Settled On date field of the Payment event.
    Payment cancelled TransactionRejected
    • Zuora updates the Gateway State to "Failed to Settle" on the Payment transaction.
    • Zuora creates an External Refund with the Reason Code set to "Payment Rejection".
    Payment failed TransactionRejected
    • Zuora updates the Gateway State to "Failed to Settle" on the Payment transaction.
    • Zuora creates an External Refund with the Reason Code set to "Payment Rejection".
    Payment charged_back TransactionReversed Optionally, Zuora creates an External Refund with the Reason Code set to "Payment Reversal."
    Payment late_failure_settled TransactionReversed Optionally, Zuora creates an External Refund with the Reason Code set to "Payment Reversal."
    Refund paid TransactionSettled Zuora updates the Gateway State to "Settled" and the Settled On date field of the Refund event.
    Refund refund_settled TransactionSettled Zuora updates the Gateway State to "Settled" and the Settled On date field of the Refund event.
Last modified

Tags

Classifications

(not set)
Powered by MindTouch ®