Difference between revisions of "Module Stripe"

Latest revision as of 11:29, 19 January 2024

Stripe
Numéro/ID du module	50300
Doc utilisateur du module	This page
Doc développeur du module	Online Payment Module Architecture

Introduction

This Stripe module for Dolibarr ERP CRM allows

to bind your Dolibarr third parties to Stripe customers
to display the list of the Stripe mode of payment in Dolibarr
to display the list of payments and payouts in Dolibarr
to pay, using Strong Customer Authentication (SCA), for orders, invoices, lines of contracts, subscriptions or any free amount, online, using Stripe (https://www.stripe.com). See the note at bottom of this page to use the version "SCA ready" of module.

Dolibarr is an official

Installation / Upgrade

This module is included with the Dolibarr distribution, so there is no need to install it.

Also, because this is a native module, if you need to upgrade the module, you must just upgrade your Dolibarr application.

Configuration

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 on module thumb or at end of the line of the module, click on it to access the setup page specific to the module.

After clicking on the configuration icon, you will access a page to enter different information. Private and Secret key values for Test mode and Live mode provided by Stripe (to get on https://www.stripe.com) are required.

What about the Restricted API keys ?

This chapter has not been tested yet !!!!

A restricted API key allows you to specify which Stripe resources the API key has access to read and/or write. To create a restricted key, follow the steps provided by Stripe. When creating the key, the permissions needed by Dolibarr include:

Customers: write
Events: read
PaymentIntents: write
SetupIntents: write
Checkout Sessions: write

Then, you can replace the secret key with this new restricted key.

Usage

Once the mandatory identifiers are entered, you can use some URL links, provided by Dolibarr, to make or ask your customers to make online payments. These links are provided as "generic link" on the Stripe configuration page. But you will find them also as "dedicated link" on the page of each invoice, each order, each contract, or each member for the payment of memberships.

This is an exemple of the public interface your customer can use to pay you.

Variants

Stripe offers several modes of operation. The old mode is the use of Stripe's "charge" APIs. As of September 2019, these APIs are deprecated to implement the SCA on online payments and 3D Secure v2 (https://stripe.com/docs/strong-customer-authentication). The v10 is ready for this change. Dolibarr v10 offers 2 other modes of operation:

By going to Home - Setup - Other and adding the constant STRIPE_USE_INTENT_WITH_AUTOMATIC_CONFIRMATION to 1, Dolibarr will use the PaymentIntent Stripe APIs according to the workflow "Automatic Confirmation" (https://stripe.com/docs/payments/payment-intents/quickstart) , which is ready for the SCA.
By going into Home - Setup - Other and adding the STRIPE_USE_NEW_CHECKOUT constant to 1, Dolibarr will use the CheckOut Stripe APIs according to the "Server Integration" workflow (https://stripe.com/docs/payments/checkout), which is also ready for the SCA.

When using Dolibarr v11, the default mode is when STRIPE_USE_INTENT_WITH_AUTOMATIC_CONFIRMATION = 1 with no need to change or edit any configuration variable. So if you want to use another method, you must force this constant to 0.

@@ Line 1: / Line 1: @@
+<!-- BEGIN origin interlang links -->
+<!-- You can edit this section but do NOT remove these comments
+     Links below will be automatically replicated on translated pages by PolyglotBot -->
+[[fr:Module Stripe FR]]
+[[es:Módulo Stripe]]
+<!-- END interlang links -->
 [[Category:List of Modules]]
-{{TemplateDocUtilEN}}
+{{TemplateDocUser}}
 {{TemplateModEN}}
 {{BasculeDevUser|
 nom=Stripe|
 num=50300|
-devdoc=|
+devdoc=[[Online Payment Module Architecture]]|
 userdoc=This page|}}
@@ Line 15: / Line 22: @@
+=Introduction=
+This Stripe module for Dolibarr ERP CRM allows
+*to bind your Dolibarr third parties to Stripe customers
+*to display the list of the Stripe mode of payment in Dolibarr
+*to display the list of payments and payouts in Dolibarr
+*to pay, using Strong Customer Authentication (SCA), for orders, invoices, lines of contracts, subscriptions or any free amount, online, using Stripe (https://www.stripe.com). See the note at bottom of this page to use the version "SCA ready" of module.
-= Introduction =
+Dolibarr is an official [[File:L Color Solid.svg|link=https://www.stripe.com/about]]
-Ce module permet
+=Installation / Upgrade=
-* de lier vos tiers Dolibarr à des clients Stripe
+{{NoInstallModuleEn}}
-* d'afficher la liste des moyens de paiement stockés dans Stripe dans Dolibarr
-* de payer des commandes, factures ou lignes de Contrat/Abonnements en ligne en utilisant Stripe
-= Installation =
+Also, because this is a native module, if you need to upgrade the module, you must just upgrade your Dolibarr application.
-{{NoInstallModuleFr}}
-= Configuration =
+=Configuration=
-{{ActivationModuleFr}}
+{{ActivationModuleEn}}
-Après avoir cliquer sur le pictogramme de configuration, vous accéder à une page pour saisir différentes informations. Les informations obligatoires sont les identifiants des votre compte Stripe (à créer sur stripe.com).
+After clicking on the configuration icon, you will access a page to enter different information.
-Les valeurs des clés privés et secrètes pour le mode test et le mode live fournies par Stripe sont obligatoires.
+Private and Secret key values for Test mode and Live mode provided by Stripe (to get on https://www.stripe.com) are required.
 <div class="divforimgcentpercent">
@@ Line 36: / Line 48: @@
 </div>
-= Utilisation =
-Une fois les identifiants obligatoire saisies, vous bénéficiez de liens URL, fournies par Dolibarr, pour réaliser les paiements en ligne.
-Ces liens sont rappelés de manière générique sur la page de configuration du module Stripe. Mais vous les trouverez de manière complète sur la page de chaque facture, chaque commande, chaque contrat, ou chaque adhérent pour le paiement des adhésions.
+'''What about the Restricted API keys ?'''
+This chapter has not been tested yet !!!!
+A restricted API key allows you to specify which Stripe resources the API key has access to read and/or write.
+To create a restricted key, follow the [https://stripe.com/docs/keys#create-restricted-api-secret-key steps provided by Stripe]. When creating the key, the permissions needed by Dolibarr include:
+* Customers: <code>write</code>
+* Events: <code>read</code>
+* PaymentIntents: <code>write</code>
+* SetupIntents: <code>write</code>
+* Checkout Sessions: <code>write</code>
+Then, you can replace the secret key with this new restricted key.
+=Usage=
+Once the mandatory identifiers are entered, you can use some URL links, provided by Dolibarr, to make or ask your customers to make online payments.
+These links are provided as "generic link" on the Stripe configuration page. But you will find them also as "dedicated link" on the page of each invoice, each order, each contract, or each member for the payment of memberships.
+This is an exemple of the public interface your customer can use to pay you.
+<div class="divforimgcentpercent" style="max-width: 800px">
+[[File:Public interface for payment with Stripe.png]]
+</div>
+=Variants=
+Stripe offers several modes of operation. The old mode is the use of Stripe's "charge" APIs. As of September 2019, these APIs are deprecated to implement the SCA on online payments and 3D Secure v2 (https://stripe.com/docs/strong-customer-authentication).
+The v10 is ready for this change. Dolibarr v10 offers 2 other modes of operation:
-= Variantes =
+*By going to Home - Setup - Other and adding the constant STRIPE_USE_INTENT_WITH_AUTOMATIC_CONFIRMATION to 1, Dolibarr will use the PaymentIntent Stripe APIs according to the workflow "Automatic Confirmation" (https://stripe.com/docs/payments/payment-intents/quickstart) , which is ready for the SCA.
-Stripe proposent plusieurs mode de fonctionnement. Le mode actuel par défaut est l'utilisation des API "charge" de Stripe. A partir de septembre 2019, ces API sont dépréciés afin de mettre en oeuvre le SCA sur les paiements en ligne et le SecureID v2 (https://stripe.com/docs/strong-customer-authentication).
+*By going into Home - Setup - Other and adding the STRIPE_USE_NEW_CHECKOUT constant to 1, Dolibarr will use the CheckOut Stripe APIs according to the "Server Integration" workflow (https://stripe.com/docs/payments/checkout), which is also ready for the SCA.
-La v10 est prête pour ce changement. Dolibarr v10 propose 2 autres modes de fonctionnements:
-* En allant dans accueil - configuration - divers et en ajoutant la constante STRIPE_USE_INTENT_WITH_AUTOMATIC_CONFIRMATION à 1, Dolibarr utilisera les API Stripe PaymentIntent selon le workflow "Automatic Confirmation" (https://stripe.com/docs/payments/payment-intents/quickstart), lequel est prêt pour le SCA.
-* En allant dans accueil - configuration - divers et en ajoutant la constante STRIPE_USE_NEW_CHECKOUT à 1, Dolibarr utilisera les API Stripe de CheckOut selon le workflow "Server Integration" (https://stripe.com/docs/payments/checkout), lequel est également prêt pour le SCA.
-A l'échéance, une de ces 2 variantes, déjà opérationelle en v10, deviendra le mode par défaut.
+When using Dolibarr v11, the default mode is when STRIPE_USE_INTENT_WITH_AUTOMATIC_CONFIRMATION = 1 with no need to change or edit any configuration variable. So if you want to use another method, you must force this constant to 0.