Skip to main content

Getting Started

Overviewโ€‹

The GoCardless Payment Gateway module for Perfex CRM integrates GoCardless into your Perfex CRM installation, enabling you to accept direct debit payments from your clients. The module supports both sandbox (test) mode and live mode, allowing you to verify the payment flow before accepting real transactions.

info

Themesic is not affiliated with GoCardless and does not have access to any user data processed through the gateway.

Requirementsโ€‹

Before installing the module, ensure you have the following:

  • A working installation of Perfex CRM
  • Administrator access to the Perfex CRM backend
  • The downloaded module archive from Themesic
  • A GoCardless account (sandbox for testing, live for production)

Installationโ€‹

Follow these steps to install the GoCardless module:

  1. Extract the downloaded archive to a location on your computer.
  2. Inside the extracted folder, locate the file named upload.zip.
  3. Log in to your Perfex CRM Admin panel.
  4. Navigate to SETUP โ†’ Modules.
  5. Click the Upload Module button and select the upload.zip file.
  6. Press Install โ€” the module will now appear in your modules list.

Test Modeโ€‹

Before going live, it is recommended to test the integration using the GoCardless sandbox environment.

  1. Sign up for a GoCardless Sandbox account at developer.gocardless.com.
  2. Once registered, obtain your sandbox API key from the GoCardless developer dashboard.
  3. In your Perfex CRM backend, navigate to the GoCardless module Settings.
  4. Paste the sandbox API key into the API key field.
  5. Ensure the Test Mode toggle is enabled.
  6. Press Save.

Testing a Paymentโ€‹

To verify the integration is working:

  1. Generate an invoice in Perfex CRM.

  2. At checkout, select GoCardless as the payment method.

  3. Use the following test bank details:

    FieldValue
    Sort Code200000
    Account Number55779911

  4. Complete the payment and confirm the transaction appears in both Perfex CRM and the GoCardless sandbox dashboard.

tip

The test bank details above are provided by GoCardless specifically for sandbox testing and will not process any real funds.

Live Modeโ€‹

When you are satisfied with your test results, follow these steps to switch to production:

  1. Log in to your live GoCardless account at gocardless.com.
  2. Obtain your live API key from the account dashboard.
  3. In your Perfex CRM module Settings, replace the sandbox API key with the live API key.
  4. Disable the Test Mode toggle.
  5. Press Save.

Your Perfex CRM installation is now ready to accept real direct debit payments through GoCardless.

info

For GoCardless-specific support (account issues, payment disputes, etc.), contact GoCardless directly at [email protected] (available 9amโ€“6pm, Mondayโ€“Friday).

Currency Configurationโ€‹

By default, the GoCardless module processes payments in GBP (British Pounds). If you need to change the currency, follow these steps:

  1. Navigate to the following file in your Perfex CRM installation:

    modules/gocardless_gateway/libraries/Gocardless_gateway.php

  2. Locate line 156, which contains the currency code setting.

  3. Change the currency code to your desired value (e.g., EUR, SEK, AUD).

  4. Save the file.

warning

Make sure to use a currency code that is supported by GoCardless. Using an unsupported currency will cause payment failures. If you encounter any issues, please contact support at https://themesic.com/support.