Direct Debit is a widely used payment method across the globe. Different territories operate different schemes such as Bacs in the UK, SEPA across the Eurozone and BECS in Australia.
GoCardless provides a single point of access to a number of these Direct Debit schemes. The list can be found here.
By default, a GoCardless account will have access to the scheme associated with the country where you're signing up from e.g. if you're based in France, you're account will have SEPA enabled. If you wish to request access to another scheme supported by GoCardless, please send an email to firstname.lastname@example.org.
Implementing a new scheme
As an integrator, it’s important to be aware of the fields that need to be addressed when adding another scheme to your integration.
The two most important fields to adjust are scheme and currency (please see the endpoint documentation for where parameters are required):
|Parameter values by Scheme|
|Creditors (scheme identifiers)|
|Customer Bank Accounts|
Creating a customer using the Redirect Flow
So for example when creating a customer based in a SEPA covered country via the Redirect Flow, you would simply change the scheme value:
Please note that the scheme value isn't a required field. If it isn't sent, the value will default to the scheme associated with the customer's bank account.
The language of the payment page will default to that of the customer's browser. However, you can also manually set the language of the payment page using the country_code and language parameters e.g.
Creating a customer using Custom Payment Pages
For integrators using custom payment pages on our Pro package, you would do something similar to the following to add a new SEPA customer:
Note that again the scheme isn't required when creating the mandate, as this will automatically be detected from the customer’s bank account.
Creating a payment
To then create a payment after the customer is created, you’d do the following:
Additional information for partners
Checking the schemes a merchant has access to
As a partner using custom payment pages or the Redirect Flow, it’s important to know which schemes a merchant has access to before attempting to create a customer for a specific scheme. This can be found by using the Creditors endpoint to list the creditors on a GoCardless account (there should only be one creditor). You can then check the scheme_identifiers array, within which each instance will have a scheme field.
If a merchant doesn't have a scheme enabled on their account, they can make a request to add a new scheme by contacting email@example.com. Additionally, if you're looking to test a new scheme in the sandbox environment, please send us an email to the above address and we can add any desired schemes.
Receiving partner fee payouts
To receive revenue share or app fee payouts for a new scheme, you'll need to ensure that you've added a payout bank account in the currency of that scheme. To do this, you'll need to request the scheme be added to your account by emailing firstname.lastname@example.org. We can then add the scheme to your GoCardless account, which will then allow you to add a new bank account for that currency. For further details on how to connect the new bank account, please refer to the guide here.
Payout bank accounts
Finally, if you wish to display or allow a merchant to disable a payout bank account using the Creditor Bank Accounts endpoint, you can find the bank account IDs of a particular payout bank account using the following fields:
- Links[default_eur_payout_account] - ID of the bank account which is set up to receive payouts in EUR.
- Links[default_gbp_payout_account] - ID of the bank account which is set up to receive payouts in GBP.
- Links[default_sek_payout_account] - ID of the bank account which is set up to receive payouts in SEK.
- Links[default_aud_payout_account] - ID of the bank account which is set up to receive payouts in AUD.