Module Stancer: Difference between revisions

Stancer 2.0.28
m (Eldy moved page Stancer to Module Stancer)
(Stancer 2.0.28)
 
(4 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{TemplateDocDevFr}}{{TemplateDocUtil}}
[[fr:Module_Stancer_FR]]
[[Category:Complementary modules]]
[[Category:Complementary modules]]
[[Category:Stancer]]
[[Category:Stancer]]
[[Category:caprel]]
[[Category:CAP-REL]]
 
{{TemplateDocDevEn}}
=Informations=
{{TemplateDocUser}}
=Information=
{{TemplateModuleInfo
{{TemplateModuleInfo
|modulename=Stancer
|modulename=Stancer
|editor=CAP-REL
|editor=CAP-REL
|web=[https://cap-rel.fr cap-rel.fr]
|web=[https://www.cap-rel.fr www.cap-rel.fr]
|webbuy={{LinkToPluginDownloadDoliStore|keyword=stancer}}
|webbuy={{LinkToPluginDownloadDoliStore|keyword=stancer}}
|status=stable
|status=stable
|prerequisites=
|prerequisites=Bank and Direct debit modules; a Stancer account
|minversion=11.0.0
|minversion=15.0.0
|note= Utilisez Stancer comme prestataire de paiement
|note=Card and SEPA direct debit payments from Dolibarr invoices, orders and quotes, through the French low-cost payment platform Stancer.
}}
}}


=Features=
[https://www.stancer.com/en/?mtm_campaign=Dolibarr&mtm_source=Dolibarr Stancer] is the French low-cost payment platform. This module connects it to Dolibarr: your customers pay by card or by SEPA direct debit from their invoices, orders and quotes, and Dolibarr records the payment, classifies the invoice and books the bank entries without retyping anything.
==At a glance==
* '''Who it is for''': companies and associations that bill their customers or members in Dolibarr and want to get paid online, by card or by direct debit.
* '''What it does''': it sends payment links, collects card payments and SEPA direct debits through Stancer, then updates invoices, bank accounts and customers in Dolibarr.
* '''What it does not do''': it does not replace your Stancer account (fees and contract are with Stancer), and it never debits a customer without a SEPA mandate.
==Feature list==
* '''Card payment''' - online payment link sent by email from an invoice, an order or a quote, secure 3-D Secure payment page, payment button on documents, card saved for the next payments, new attempt offered after a refused card.
* '''Quotes and orders''' - payment of a quote or an order with automatic invoice creation, partial payment and down payment invoice.
* '''SEPA direct debit''' - public page where the customer enters their own IBAN, SEPA mandate generated as a PDF, IBAN check through SEPAMail (France and Italy), automatic debit of due invoices after the customer notice period.
* '''Electronic signature of the mandate''' - with the UptoSign add-on module; once the mandate is signed, the customer's template invoices can switch to direct debit automatically.
* '''SEPA rejections''' - invoice reopened, customer and administrator notified with the reason, rejection fee invoiced if you wish.
* '''Tracking''' - dashboard, lists of payments, payouts, refunds and disputes synchronised with Stancer, Stancer tab on every thirdparty card.
* '''Automation''' - scheduled jobs for synchronisation, direct debits, invoices sent on validation and reminders; ready-to-use emails for every situation.
* '''Accounting''' - Stancer fees recorded on the bank account, payouts recorded as internal transfers to your main bank, detection and regularisation of discrepancies.
* '''Associations''' - online payment of membership fees and donations.
* '''Six languages''' - English, French, German, Spanish, Italian and Dutch.
==Screenshots==
<gallery widths="300px" heights="200px">
File:Stancer tableau-de-bord.png|Stancer dashboard with the payment indicators of the current month
File:Stancer bouton-paiement-facture.png|Stancer payment button on a validated invoice
File:Stancer configuration-generalites.png|General setup: API keys, bank accounts and synchronisation
File:Stancer configuration-cb.png|Card payment setup
File:Stancer configuration-sepa.png|SEPA mandate setup
File:Stancer taches-planifiees.png|Stancer scheduled jobs
</gallery>
=Links=
* [https://doc.cap-rel.fr/stancer/?lang=en Module documentation]
* [https://doc.cap-rel.fr/stancer/nouveautes-2-0#version-2-0-28 What's new in version 2.0.28]
* [https://dolinews.com/en/projets/stancer Get update notifications]
* [https://cap-rel.fr/sav-module-dolibarr/ Support form]
* [https://dolitry.fr/stancer/ Online demo]: a Dolibarr created for you in less than 20 seconds; enter your own Stancer test keys in the module setup to go through the whole payment flow
=Requirements=
{| class="wikitable"
! Item !! Version or condition
|-
| Dolibarr || 15.0 or higher
|-
| PHP || 7.4 or higher
|-
| Dolibarr modules || Bank and Direct debit enabled
|-
| Stancer || an account and its API keys, sign up on [https://www.stancer.com/en/?mtm_campaign=Dolibarr&mtm_source=Dolibarr stancer.com]
|-
| Rights || an administrator account to install, enable and set up the module
|}
=Installation=
{{InstallModuleDoliStoreEn|keyword=stancer}}
On enabling, the module creates its tables, a '''STANCER''' bank account used as a transit account for the payments received, and the security token of the public payment pages.
==Upgrade==
# Back up your database.
# Install the new version through '''Home > Setup > Modules/Applications > Deploy/install external app/module'''.
# Disable then enable the module again: enabling applies the database upgrades and registers the new hooks and permissions.
==Uninstall==
Disable the module from '''Home > Setup > Modules/Applications'''. The data stays in the database: the STANCER bank account and its entries are not deleted.
=Setup=
{{ActivationModuleEn}}
The setup is in '''Home > Setup > Modules > Stancer'''. The '''General''' tab holds the essential settings:
{| class="wikitable"
! Setting !! Purpose
|-
| API keys || test keys (<code>ptest_</code>, <code>stest_</code>) and production keys (<code>pprod_</code>, <code>sprod_</code>), found in your Stancer dashboard
|-
| Production mode || No: test payments, nothing is collected; Yes: real payments
|-
| Bank account for collections || transit account where payments are recorded, STANCER by default
|-
| Main bank account || account receiving the Stancer payouts, recorded as a transfer from the STANCER account
|-
| Fee recording || none, per payout or per payment
|-
| User for automated actions || Dolibarr account used to classify invoices, record bank entries and send emails
|-
| Number of days to synchronise || depth of the history fetched from Stancer, 31 days by default
|}
The other tabs set up card payment, SEPA direct debit (creditor identifier, notice period, rejection fees), emails, accounting and associations. Every setting is described in the [https://doc.cap-rel.fr/stancer/configuration?lang=en setup guide].
=Permissions=
{| class="wikitable"
! Permission !! Access
|-
| Read Stancer data || lists of payments, payouts, refunds and disputes
|-
| Create/modify Stancer data || refresh, refund, SEPA mandate management
|}
An administrator grants them from '''Home > Users & Groups''', '''Permissions''' tab.
=Usage=
==Getting paid by card==
Validate an invoice, an order or a quote: a Stancer payment button appears on the document, and the payment link can be sent by email. The customer pays on the Stancer page, comes back to Dolibarr, and the invoice is classified as paid once Stancer confirms.
==Setting up a SEPA direct debit==
From the '''Stancer''' tab of the thirdparty, send the customer the link of the public IBAN page. The customer enters their IBAN, the mandate is generated as a PDF and can be signed electronically with UptoSign. Due invoices whose payment method is direct debit are then debited automatically, after the notice period.
==Tracking==
The '''Bank > Stancer''' menu gives the dashboard and the lists of payments, payouts, refunds and disputes. Synchronisation runs through the scheduled jobs, or on demand with the '''Refresh''' button of each list.
Each feature is described in the [https://doc.cap-rel.fr/stancer/utilisation?lang=en user guide].
=FAQ=
'''The module displays "API authentication error".'''<br>
Stancer refused your keys. Check that public and private keys are not swapped, and that the mode (test or production) matches the keys entered.
'''Payouts do not appear in the list.'''<br>
Stancer does not provide payouts in test mode. In production mode, click '''Refresh''' on the list.
'''A payment is recorded but the invoice is not classified as paid.'''<br>
The payment may be partial, the option that classifies the invoice as paid after a card payment may be off, or the user for automated actions may lack rights on invoices.
'''The SEPA direct debit does not start.'''<br>
Check that the '''StancerCheckTakePayments''' scheduled job is enabled and the Dolibarr cron runs, that the customer has an active mandate, that the notice period has passed and that the invoice uses the direct debit payment method.
'''How do I test without real payments?'''<br>
Leave production mode off, enter your test keys and use the test cards provided by Stancer. When you switch to production, the '''Clean test data''' button removes the test payments.


=Qu'est-ce que le module Stancer pour Dolibarr ?=
All questions: [https://doc.cap-rel.fr/stancer/faq?lang=en documentation FAQ].


Le module Stancer vous permet d'utiliser ce prestataire comme plate-forme de paiement CB / SEPA.
=Development=


Plus de documentation sur le site de l'éditeur : https://doc.cap-rel.fr/projet_stancer/accueil
Developments and improvements can be suggested to the project maintainer by email (see the headers of the source files) or through the [https://cap-rel.fr/sav-module-dolibarr/ support form].
447

edits