GoCardless Tips

For instructions on the setup of GoCardless payment gateways in Zuora, visit the following article from Zuora's Knowledge Center:

https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/M_Payment_Gateways/Supported_Payment_Gateways/GoCardless_Gateway

For additional information beyond Zuora's documentation, PeakCommerce has comprised the following three tips.

1. In Zuora the Setup of the GoCardless payment gateway requires an OAuth token. If you do not already have an OAuth token set up, the steps to do so are below.

gateway setup .png

Navigate in Zuora to your username in the top right corner where the dropdown options are provided. Click Payments > Gateway Authentication.

gateway authentication.png

Click "create authentication."

Enter a name, the type should be GoCardless, and if this is for the Sandbox I believe you will want to select "Use Gateway Test Environment."

Screen Shot 2021-01-06 at 12.41.52 PM.png

When you click save it redirects you to a GoCardless Merchant account login page. You must log into your account in order for the token to authenticate.

Screen Shot 2021-01-06 at 12.40.33 PM.png

2. Testing bank transfers when using a GoCardless gateway instead of a test gateway, has specific requirements. Certain fields are required depending on the payment method/country, and only GoCardless test bank numbers can be used. Make sure the GoCardless required fields for each payment method/country are marked as required in the corresponding Hosted Page's settings. If any of these fields are left out by the customer, the payment may not process.

We have found that the following fields are required by GoCardless for each bank transfer type.

Direct Debit UK

Account Number
Account Name
Bank/Branch Code
First Name
Last Name
Email
image.png

SEPA

Account Number (IBAN)
Account Name
First Name
Last Name
Email
(Country is not required, but recommended)

image.png

ACH

Routing Number
Account Number
Bank Name
Account Name
Account Type
Country
State
City
Postal Code
Street Address
Email

image.png

PAD

Account Number
Account Name
Branch Code
Bank Code
First Name
Last Name
Email

image.png

GoCardless provides basic test bank details from this link: https://developer.gocardless.com/getting-started/developer-tools/test-bank-details. More information on the required fields and test bank details for each country can be found at the end of the appendix using this link: https://developer.gocardless.com/api-reference/2015-07-06/#appendix-local-bank-details.

3. Certain payment method types are only availble when GoCardless is the Default Payment Gateway on an account in Zuora. One example is PAD. You will be unable to add a PAD payment method directly in Zuora, or through PeakCommerce unless the Default Payment Gateway on the account is first set to GoCardless.