Perfex CRM Payment Gateway Bundle Documentation ☰

Introduction

This documentation provides complete setup and usage instructions for the Perfex CRM Payment Gateway Bundle, which includes seamless integration for the following payment gateways:

  • Adyen
  • Klarna
  • SumUp

These add-ons are designed to plug directly into Perfex CRM, allowing you to offer multiple payment options to your clients with minimal setup. This bundle ensures fast transactions, secure data handling, and an improved payment experience for customers.

System Requirements

  • Perfex CRM v3.1.0 or higher

Adyen

Required Information :

  • API Key
  • Client Key
  • Merchant Account

Get Credentials :

  • Navigate to the following URL and log in to Adyen Dashboard : https://www.adyen.com/
  • After logging in, navigate to the sidebar where you'll find Developers. Click on it to expand the dropdown menu, then select API Credentials
  • Click on Create new credentials, Add details and submit it.
Adyen Dashboard
  • After credentials are created you will get your API Key
Adyen Dashboard
  • Scroll down to Authentication section and add origin domains.
Adyen Dashboard

Installation :

Installing the payment gateway is quick and simple, It takes just a few minutes :

  • Extract the main .zip file and locate the adyen.zip file.
  • Log in to the Perfex CRM admin panel as an administrator and go to Setup → Modules.
  • Click Choose File and select the adyen.zip
  • Click Install to complete the process.
Adyen Module Installation

Once the module is installed, it will appear in the list of available modules below. Simply click the Activate button to enable it.

Adyen Module Activation

Configuration :

Once the module is installed and activated, you'll see two options, Deactivate and Settings. Click on the Settings button to quickly access the Adyen Payment Gateway

Adyen Module Activation

Alternatively, you can navigate to Setup → Settings → Payment Gateways and click on Adyen to access its configuration options, which include :

  • API Key
  • Clint Key
  • Merchant Account
  • Default Currency
  • Default Country
  • Currencies – Comma-separated list of supported currencies. Refer to the Perfex CRM documentation for more information.

Note : Ensure that the selected currencies and countries are properly configured and enabled in your Adyen dashboard.

Adyen Module Activation

Testing :

Test Card :
American Express 
Card : 3714 4963 5398 431
Expiry: 03/30
CVV: 7373

Klarna

Required Information :

  • Username
  • Password

Get Credentials :

  • Navigate to the following URL and log in to Klarna Dashboard :
    Production / Live : Navigate to the following URL and log in to dashboard : https://portal.klarna.com/
    Sandbox / Test : Navigate to the following URL and log in to dashboard : https://portal.playground.klarna.com/
  • After logging in, navigate to the sidebar where you'll find Settings. Click on it to expand the dropdown menu, then select Klarna API Keys
  • Click on Generate new Klarna API key to receive your API credentials. Be sure to download and store them securely

Note : Credentials will only be displayed and available for download once. If lost, you’ll need to generate a new set.

Klarna Dashboard

Installation :

Installing the payment gateway is quick and simple, It takes just a few minutes :

  • Extract the main .zip file and locate the klarna.zip file.
  • Log in to the Perfex CRM admin panel as an administrator and go to Setup → Modules.
  • Click Choose File and select the klarna.zip
  • Click Install to complete the process.
Klarna Module Installation

Once the module is installed, it will appear in the list of available modules below. Simply click the Activate button to enable it.

Klarna Module Activation

Configuration :

Once the module is installed and activated, you'll see two options, Deactivate and Settings. Click on the Settings button to quickly access the Klarna Payment Gateway

Klarna Module Activation

Alternatively, you can navigate to Setup → Settings → Payment Gateways and click on Klarna to access its configuration options, which include :

  • Username
  • Password
  • Region
  • Default Currency
  • Default Country
  • Gateway Dashboard Payment Description – This text will appear in your Klarna dashboard, transaction details and on the popup modal when the customer pays
  • Currencies – Comma-separated list of supported currencies. Refer to the Perfex CRM documentation for more information.

Note : Ensure that the selected currencies, countries and region are properly configured and enabled in your Klarna dashboard.

Klarna Module Activation

Testing

Test Phone Number : 
Phone Number : +15197438620

SumUp

Required Information :

  • Client ID
  • Client Secret
  • Merchant Email

Get Credentials :

  • Navigate to the following URL and log in to dashboard : https://auth.sumup.com/
  • Once you're logged in, you'll see a dropdown menu similar to the one shown below. Select OAuth2 Apps from that menu.

Note : If you are unable to fine dropdown please head to developer login : https://developer.sumup.com/

SumUp Dashboard
  • Click on Create application
SumUp Dashboard
  • Enter details and click on Register Application
SumUp Dashboard
  • Make sure Homepage URL is proper as SumUp will only allow request from register URL.
SumUp Dashboard
  • Scroll down, Make sure in Restricted Scope, Payments scope is enabled.
  • Click on Create client secret
SumUp Dashboard
  • Select Application Type as Web
  • Make sure to add proper redirect URL, It should be : https://your.domain.com/sumup/callback
  • Copy or download, Client ID and Client Secret
SumUp Dashboard

Installation :

Installing the payment gateway is quick and simple, It takes just a few minutes :

  • Extract the main .zip file and locate the sumup.zip file.
  • Log in to the Perfex CRM admin panel as an administrator and go to Setup → Modules.
  • Click Choose File and select the sumup.zip
  • Click Install to complete the process.
SumUP Module Installation

Once the module is installed, it will appear in the list of available modules below. Simply click the Activate button to enable it.

SumUP Module Activation

Configuration :

Once the module is installed and activated, you'll see two options, Deactivate and Settings. Click on the Settings button to quickly access the SumUp Payment Gateway

SumUP Module Activation

Alternatively, you can navigate to Setup → Settings → Payment Gateways and click on SumUp to access its configuration options, which include :

  • Client ID
  • Client Secret
  • Merchant Email
  • Default Currency
  • Gateway Dashboard Payment Description – This text will appear in your SumUp dashboard and transaction details.
  • Currencies – Comma-separated list of supported currencies. Refer to the Perfex CRM documentation for more information.

Note : Ensure that the selected currencies are properly configured and enabled in your SumUp dashboard.

SumUp Module Activation

Testing

Test Card : 
Name : Test (any name)
Card : 3714 4963 5398 431
Expiry: 03/30
CVV: 7373

Usage

Once the modules are installed and configured, using them within Perfex CRM is seamless :

  • Invoice Generation
    • Create or view any invoice under Sales → Invoices
    • Ensure the invoice status is Unpaid
  • Customer Payment
    • When a customer views the invoice from their portal, they will see available payment methods (Adyen, Klarna, or SumUp).
    • Customer can choose their preferred gateway and proceed with the payment.
  • Payment Processing
    • After a successful payment, the invoice status is automatically updated to Paid
    • Payment details are logged under the Invoice → Payments tab for tracking.
  • Failure or Cancellation
    • If a transaction fails or is canceled, the client is redirected to the invoice with an appropriate status message.
    • No payment is recorded unless confirmation is received from the gateway.
  • Admin Review
    • Admin can view all successful transactions in Sales → Payments

Frequently Asked Questions (FAQ)

  • Do I need coding knowledge to use these modules?
  • No. These modules are plug-and-play. You only need to upload, activate, and configure the credentials provided by the payment gateway.
  • Can I use more than one payment gateway at the same time?
  • Yes, you can enable multiple gateways simultaneously. Customers will be able to choose their preferred payment method when paying invoices.
  • Can I use only one gateway and ignore the others?
  • Yes, you can install and activate only the gateways you need. Each module works independently.
  • Do I need to modify any core files in Perfex CRM?
  • No. All modules are plug-and-play. No core files are touched or modified.
  • What happens if a payment fails?
  • If a transaction fails, the customer will be redirected to the invoice with a failure message. No payment will be recorded unless confirmation is received from the gateway.
  • Will this bundle work with all Perfex CRM versions?
  • Yes, these modules are compatible with all versions of Perfex CRM starting from version 3.1.0 and above.
  • Can I test transactions before going live?
  • Yes, all gateways support test or sandbox transactions. Just ensure that test mode is enabled both in the gateway's dashboard and in the corresponding settings within Perfex CRM.
  • Are updates included?
  • Yes, future updates for the included modules are free and will be available via your CodeCanyon downloads section.

Support

For support, please reach out to us at codeonstring@gmail.com. We will respond as soon as possible, typically within one working day.

Update

Installing the module is quick and simple, It takes just a few minutes :

  • Extract the main .zip file and locate the module_name.zip file.
  • Log in to the Perfex CRM admin panel as an administrator and go to Setup → Modules.
  • Click Choose File and select the module_name.zip
  • Click Install to complete the process.
Module Update

Once the module is installed, it will appear in the list of available modules below. Simply click the Upgrade Database button to update it.

Module Update

Changelog

VERSION 1.0.1 – Klarna Only

  • Minor Design and Bug Fixed

VERSION 1.0.0 – Initial Release