GoCardlessDeveloper Docs
Create a sandbox account

Going Live with your integration#

View as Markdown

Having followed our guides and built and tested your integration, check out our best practices guide — it'll take you through everything you need to build a great integration for your users, and is perfect to review before you go live.

Go-live checklist#

Before going live, a member of our GoCardless team will need to review your integration with a demonstration video. Your demo should provide a full walkthrough of the following key elements, using an additional sandbox account as if you were one of our mutual customers:

1. OAuth

Including sign-in view, sign-up view, pre-filling capabilities, account connection, and clear verification or pending status.

  • Sign-in view
  • Sign-up view
  • Are you pre-filling merchant details?
  • Are you displaying whether the account is connected?
  • Are you displaying the GoCardless account status?
2. Mandates

Demonstrate either hosted payment pages or custom pages (which will require compliance review) and pre-filling of customer and bank details.

  • If you're using custom payment pages, submit these for compliance review.
  • Are you pre-filling the customer details in the mandate?
  • Are you pre-filling the customer bank details in the mandate?
3. Payments

Show usage of Payments, Subscriptions, and Instalments endpoints, including Open Banking and combined Open Banking/Direct Debit functionalities, and outbound payments.

4. Refunds

Exhibit implemented refund capabilities. To enable refunds in sandbox, provide the partnerships team with the email address you used to create the account.

  • Have you implemented refund capabilities?
5. Reconciliation

Display how current mandate and payment statuses are shown, and confirm that payments are marked as confirmed upon receiving the payment_confirmed event.

  • Where do you display the current mandate status?
  • Where do you display the current payment status?
  • Do you mark payments as confirmed upon receiving the payment_confirmed event?

Submit your app for review#

Once you've fully tested your integration in the sandbox and recorded the demonstration video, a member of the GoCardless team will review it before you can start connecting merchants in the live environment.

Make sure you have the following ready:

Send everything to partnerships@gocardless.com or your account manager. We'll aim to get back to you within 5 working days.

To drive usage once you're live:

  • Develop a landing page with the key benefits of your GoCardless integration.
  • Write a user guide and include GoCardless in your FAQs and support materials.
  • Point users to it in welcome emails and regular communications.

Earning money from your integration#

GoCardless offers a 10% revenue share of the transaction fees generated by your integration. For every transaction your users take through your integration, you'll receive a 10% share of the fees GoCardless collects.

For more information or to set up a revenue share, contact the partnerships team.

What's Next?#