Module Stancer DoliCloud

From Dolibarr ERP CRM Wiki
Jump to navigation Jump to search

Informations

Module name Stencer
Editor / Editeur DoliCloud - www.dolicloud.com
Download or buy page / Page achat ou téléchargement
Status / Statut / Estado Development / Développement
Prerequisites / Prérequis Dolibarr min version 20   
Last update date / Date mise à jour fiche / Fecha última actualización 2024-09-17
Note / Nota


This module is a working prototype dervied from the Module HelloAsso to check how it is easy (or not) to switch to another payment solution APIs with just changing the Api.

Note: You may also have a look at a more advanced Stancer module on page Module Stancer

Features

Add into Dolibarr a Stancer online payment page (credit/debit cards). This can be used to allow your customers to make ad-hoc payments or payments related to a specific Dolibarr object (invoice, order etc...).

Prerequisites

This module requires an instance of Dolibarr version 20 or +.

Installation

From the application

  • Download the archive file of module (.zip file)
  • Go on menu Home -> Setup -> Modules -> Deploy external module and submit the file.
  • Module is then visible into list of available modules (Home -> Setup -> Modules) and can be activated.

Manually

  • Download the archive file of module (.zip file)
  • Put the file into the root directory of Dolibarr.
  • Uncompress the archive file, for example with command
unzip modulefile.zip
  • Module is then visible into list of available modules (Home -> Setup -> Modules) and can be activated.

Setup

To use this module, you must first enable it using an administrator account, via the menu option "Home - Setup - Modules".

Choose the tab where the module is listed. Then click on "Activate".

The module is now activated.

If a cog icon appears Cog circle.svg on module thumb or at end of the line of the module, click on it to access the setup page specific to the module.


Setup of Stencer Api

Generate the API keys required to make online payment with Stencer. They can be found on your Stencer account in the menu Developers


Setup of Dolibarr module

1) Create a bank account, called for example "My Stancer account" from menu "Home - Bank - New bank account", to record any payment done using Stencer.

2) Go on the setup page of Stencer module in Dolibarr and set the created bank account as the default bank account.

Setup test mode

To Setup the test mode, the only thing to do is fill "Stancer secret test API key" field in setup page

Setup live mode

1) Enable production mode in setup page

2) Fill "Stancer secret live API key" field in setup page

Usage

The only thing to do to use the module is to use any Dolibarr default link to make an online payment. All the links provided by Dolibarr to make online payment will support payment using Stencer.

Here is an example of the payment page (URL found on an invoice):

PaymentPageStancer.png

Development and contributions

The development of this Open Source application is not included inside the standard GIT repository of Dolibarr but inside a repository dedicated to modules not supported by the Dolibarr development team but supported by https://www.dolicloud.com on GitHub:

Your Pull request for fixes or enhancements are welcome.

Troubleshooting