The following is a guide to building custom payment pages for merchants using GoCardless Pro or GoCardless Custom, and for partners.
What are payment pages?
Payers in Australia need to complete a Direct Debit Request (DDR) to authorise merchants to take payments from them via BECS AU, the local Direct Debit payment scheme.
With GoCardless Pro and GoCardless Custom, you may offer payers the option to complete the DDR online, on paper, or over the phone. Payers use payment pages to complete DDRs online.
Merchants using GoCardless Pro or GoCardless Custom have the option to use GoCardless’ own payment pages, or to build their own custom payment pages.
Partners can opt to build and use custom payment pages as well. This will enable merchants who are using GoCardless through their app to offer their customers (payers) a consistent branding experience.
You may also build your own payment notifications to further customise your payers’ experience.
Custom payment pages will need to be approved by GoCardless before being implemented.
How to build custom payment pages
There are 5 steps to ensure compliance with the BECS AU scheme rules and GoCardless processes:
- HTTPS hosted payment pages
- Information entry page
- Summary and confirmation page
- Setup success page
- Submit payment pages to GoCardless for approval
The details for each are below, and there’s a summary table here.
1. Host your payment pages with HTTPS
To ensure payers’ details are safely transmitted, your website must be configured to only accept secure (SSL - minimum of SHA-256 SSL support TLS.1 or TLS1.2) connections.
2. Information entry page
This is the sign-up page for your product / services, which is used to capture the payer information necessary to set up a DDR.
There are 3 compulsory elements and 1 recommended element.
Compulsory:
- Page heading that is identifiable to payers. Title it ‘Set up a Direct Debit Request with [merchant name]’.
- For partners - make a GET request to the creditors endpoint, and pull the ‘name’ field to populate the merchant name
- Entry points to collect payer details
- Account holder name
- Account number
- BSB
- Email address
- Page footer to let payers know about 3rd party data controllers that power your website. Text to read ‘Payments by GoCardless. Read the GoCardless privacy notice.’
Recommended:
Include a checkbox to enable DDR set up on multi-signatory accounts, where authorisation from more than one person is required. Not including this checkbox may mean DDRs attached to multi-signatory accounts are not accepted by payers' banks.
Text to read “If more than one person is required to authorise Direct Debits Requests on this account you should obtain the authorisation of all required parties before completing this form. By clicking 'Set up Direct Debit Request' you are confirming you have obtained this authorisation.”
Why is the footer a requirement?
This upfront notice ensures compliance with data protection law. GoCardless, our merchants, and our partners could be in violation of this law if the notice is not included. You can read more here.
What if I can’t include the footer?
If the suggested footer isn’t technically possible, at a minimum you must include the following reference to GoCardless in your website privacy notice:
We use GoCardless to process your Direct Debit payments. More information on how GoCardless processes your personal data and your data protection rights, including your right to object, is available at gocardless.com/legal/privacy/
What if I’m a partner?
If you’re a partner, you must include the above ‘Payments by’ notice on your payment pages, or at a minimum, enable the merchant to provide a link to their privacy notice at the information entry page.
3. Summary and confirmation page
This page is to allow payers to view and verify their details before submitting them.
There are 7 compulsory elements and 1 recommended element.
Compulsory:
- Page heading that is identifiable to payers. Title it ‘Direct Debit Request’.
- Date of the DDR set up
- Payer details as collected in the information entry page
- Payer bank name, which can be retrieved via the bank details lookup endpoint here
- DDR consent and electronic signature wording:
- “By signing and/or providing us with a valid instruction in respect to your Direct Debit Request, you have understood and agreed to the terms and conditions governing the debit arrangements between you and Merchant Name as set out in this Request and in your Direct Debit Service Agreement. You agree to execute this document by electronic signature and you are aware that by electronically signing this document you are executing a legally binding document.”
- Creditor / merchant information
- Merchant name
- Direct Debit User ID. Pro or Custom merchants - your GoCardless contact will provide you with this.
- Name that will appear on payers’ bank statements
- PDF link to the DDR and the Direct Debit Service Agreement (the terms and conditions). This information can be retrieved via the mandate pdf endpoint here.
Recommended:
Include an ‘edit’ button, allowing payers to amend any incorrect information.
Why is the Service Agreement a requirement at this point in the process?
It’s a BECS AU scheme rule that payers must be shown the Service Agreement twice, to ensure they’re fully aware of the agreement they’re entering into. They must be shown once in the summary and confirmation page, and again via email notification once the DDR has been set up.
What if I'm a partner?
Partners can make a GET request to the creditors endpoint to pull the creditor/merchant information cited in points 5 and 6.
Query the API to retrieve the following:
- Merchant name - [name]
- Direct Debit authorisation code - [scheme_identifiers: reference]
- Name that will appear on payers’ bank statements - [scheme_identifiers: name]
4. Setup success page
This page is to confirm that the DDR has been set up.
It is best practice, although not a scheme requirement, to include the below:
- Page heading that is identifiable to payers, i.e., message to confirm DD setup, such as “Direct Debit set up successfully”
- Reminder of what payers will see on their bank statements
5. GoCardless approval of payment pages
Mock ups of your payment pages must be sent to GoCardless for approval prior to your go-live date. Once you have written approval from GoCardless, you may implement the payment pages.
To test your payment pages, you can sign up here for a sandbox account.
What if I’m a partner?
When creating a new partner app and going through our technical certification process, you’ll be able to submit custom payment pages for approval through our partner portal.
Summary table
The below shows a summary of the relevant information at each stage of the payment pages.
All information is required unless specified otherwise.
|
Information entry page |
Summary & confirmation page |
Setup success page |
---|---|---|---|
Page heading that is identifiable to payers |
Displayed |
Displayed |
Displayed Recommended |
Account holder name |
Captured |
Displayed |
|
Account number |
Captured |
Displayed |
|
BSB |
Captured |
Displayed |
|
Email address |
Captured |
Displayed |
|
Page footer to let payers know about 3rd party data controllers that power your website |
Displayed |
||
Multi-signatory checkbox |
Captured Recommended |
||
Date of DDR set up |
Displayed |
||
Bank name |
Displayed |
||
DDR consent and electronic signature wording |
Displayed |
||
Edit button allowing payers to amend their details |
Recommended |
||
Merchant name |
Displayed |
||
Direct Debit User ID |
Displayed |
||
Name that will appear on payers’ bank statements |
Displayed |
Displayed Recommended |
|
PDF link to DDR and DDR-SA |
Displayed |