Skip to content

Payment gateways

Last updated View as Markdown (opens in a new tab)

Take customer payments through your own Stripe or GoCardless account, and choose which payment methods your customers can use.

As a white-label partner, your customers pay you through your own payment gateways. The partner portal supports Stripe, SecurePay, GoCardless, PayPal and Monoova (PayID, PayTo and bank deposits in Australia). This guide covers Stripe (credit cards) and GoCardless (direct debit).

Channel partners don’t have these settings: their customers pay through the provider’s gateways.

How payment gateway settings work

Section titled “How payment gateway settings work”

Go to Settings › Payments. The Payment Gateways Settings list on the left has a group for each area, and the Configuration List on the right shows the settings in the selected group:

Group What it holds
fraud protection Credit card fraud limits, such as Fraud: Maximum daily payments limit and Maximum number of new credit cards in one day.
gateways availability Which payment methods are turned on: Accepting AMEX, Disable credit card functionality, Disable GoCardless functionality, Disable PayPal functionality, Disable Monoova direct bank deposits, Disable PayID and PayTo functionality.
general Default credit cards payment gateway, Credit card failures threshold, Credit card failures disable, Minimum invoice amount, Cancel pending transactions after days, Maximum number of auto top-ups per day.
gocardless GoCardless settings.
Monoova PayID, PayTo and credit cards in Australia through Monoova, and the bank details for direct deposits.
paypal PayPal settings.
securepay SecurePay XML API and DirectOne configuration.
stripe Stripe settings.
surcharges Surcharge system status, Credit card surcharge configuration (by country and card network) and the PayPal surcharge.

After you enter a gateway’s details, choose it in general and turn it on in gateways availability.

You can also limit how each customer pays: select the customer in Customers and use the Payments section of the Details tab (for example Payment limits, Daily limit and Disable surcharges).

For SecurePay or PayPal set-up, contact the support team through a support ticket.

Set up Stripe

Section titled “Set up Stripe”

Before you start

Section titled “Before you start”
  • A Stripe account. See Stripe’s website for sign-up and documentation.
  • Your Stripe API Publishable key and Secret key, from your Stripe dashboard.

Steps

Section titled “Steps”
  1. Go to Settings › Payments and select stripe.
  2. Enter your keys in Publishable key and Secret key.
  3. Select general and set Default credit cards payment gateway to Stripe.
  4. Select gateways availability and set Disable credit card functionality to No.

To change a setting, double-click its row in the Configuration List, change the Value and click Update. Default credit cards payment gateway offers Stripe or SecurePay, and the Disable switches offer Yes or No.

Once Stripe is turned on, the system creates the webhook in your Stripe account and fills in Webhook endpoint ID and Webhook secret. The webhook listens for successful, failed and cancelled payments.

Check it works

Section titled “Check it works”
  1. Add a card to a test customer account in the payments section.
  2. The system sends a verification email to the customer’s email address to authorise the payment.
  3. Once the email is authorised, the customer’s balance is topped up by the verified amount.

If a Stripe payment fails

Section titled “If a Stripe payment fails”
  • The card was charged but the balance didn’t go up: in your Stripe dashboard, check the webhook events for failed attempts, especially the payment_intent.succeeded event.
  • Other failures: check the Stripe logs for the error from the bank, such as the bank not honouring the transaction. The cardholder may need to contact their bank.

Set up GoCardless (direct debit)

Section titled “Set up GoCardless (direct debit)”

Before you start

Section titled “Before you start”
  • A GoCardless account.
  • Your partner ID. It’s the number at the end of the Default signup URL in Settings › Customer Portal.
  • Your own Direct Debit application (mandate) form and Direct Debit cancellation form, each at its own web address. As a white-label partner, you create these yourself.

Steps

Section titled “Steps”

  1. In GoCardless, open Developers in the left menu and create a new webhook endpoint. Its URL ends in /api/payment/status/ followed by your partner ID (the number only). To get the full URL for your region, raise a support ticket.

  2. GoCardless shows the endpoint’s ID, secret and URL. Copy the webhook Secret.

  3. In Developers, create or copy an access token.

  4. In the partner portal, go to Settings › Payments and select gocardless.

  5. Enter the token in GoCardless access token and the secret in GoCardless webhook secret.

  6. Enter the addresses of your forms in URL for Direct debit mandate form and URL for Direct debit cancellation form.

  7. Select gateways availability and set Disable GoCardless functionality to No.

Add direct debit to a customer

Section titled “Add direct debit to a customer”

The customer must already be on postpaid billing. See Prepaid and postpaid.

  1. Go to Customers and select the customer.
  2. Open the Payment Accounts tab and click Add direct debit.
  3. In the GoCardless window, enter the customer’s details from their signed mandate form.

Check it works

Section titled “Check it works”

The direct debit shows on the customer’s Payment Accounts tab, and the mandate appears in your GoCardless dashboard.

Next steps

Section titled “Next steps”