Documentation for Stripe and Note Kfet

docs/billing.rst

@@ -4,22 +4,26 @@ Billing - Produits et factures
 Modèles
 -------
 
-``Product``: un produit proposé à l'achat (e.g. une adhésion ou un produit matériel)
+* ``Product``: un produit proposé à l'achat (e.g. une adhésion ou un produit matériel)
 
-``Entry``: un achat de plusieurs produits identiques
+* ``Entry``: un achat de plusieurs produits identiques
 
-``Invoice``: une collection datée de plusieurs ``Entry`` achetés en même temps
+* ``Invoice``: une collection datée de plusieurs ``Entry`` achetés en même temps
 
-``MembershipProduct``: une catégorie spéciale de ``Product`` qui représente
+* ``MembershipProduct``: une catégorie spéciale de ``Product`` qui représente
 une adhésion
 
-``MembershipPurchase``: un achat d'une adhésion enregistré pour régénération
+* ``MembershipPurchase``: un achat d'une adhésion enregistré pour régénération
 plus efficace des périodes d'adhésions (voir `Sémantique des adhésions <member.html>`_).
 Ce modèle est une table de cache.
 
-``PaymentMethod``: une méthode de payement (carte, espèces, chèque)
+* ``PaymentMethod``: une méthode de payement (carte, espèces, chèque)
 
-``ComnpayPaymentMethod``: méthode de payement particulière par carte
+* ``ComnpayPaymentMethod``: méthode de payement particulier par carte (avec ComNPay)
+
+* ``StripePaymentMethod``: méthode de payement particulier par carte (avec Stripe)
+
+* ``NoteKfetPaymentMethod``: méthode de payement particulier par Note Kfet 2020
 
 
 Création d'une nouvelle facture
@@ -67,3 +71,72 @@ sans nécessiter un parcours de toutes les factures à chaque fois.
 Puisque le test de validité de l'adhésion est fait à plusieurs reprises sur les pages de gestion
 de compte et d'achat de produits, il est important que cette opération soit efficace.
 
+
+Moyens de paiement particuliers
+-------------------------------
+
+Constellation propose des moyens de paiement particuliers, automatisant la vérification
+de factures.
+
+ComNPay
+~~~~~~~
+
+ComNPay est une plateforme de paiement en ligne. Son prix est de 2 % par transaction,
+et de 15 centimes par virement sur le compte bancaire.
+
+L'inscription peut se faire sur `<https://comnpay.com/>`_.
+
+Pour activer le support de ComNPay, il suffit de céer un compte sur ComNPay (attention
+aux CGU qui ne permettent pas la signature de contrat pour la vente de biens immatériels),
+de récupérer l'identifiant du TPE ainsi que la clé secrète, et d'ajouter dans les
+paramètres locaux les variables ``COMNPAY_ID_TPE`` et ``COMNPAY_SECRET_KEY``.
+
+En mode ``DEBUG``, la plateforme d'homologation sera utilisée afin de ne pas réellement
+faire de virement. Des cartes bancaires fictives seront proposées lors du paiement.
+
+
+Stripe
+~~~~~~
+
+Stripe est une plateforme de paiement en ligne. Son prix est de 1,4 % par transaction,
+plus 25 centimes par transaction.
+
+L'inscription peut se faire sur `<https://stripe.com/fr>`_.
+
+Récupérez vos paires de clés publique et privée, et ajoutez-les dans les paramètres
+``STRIPE_PUBLIC_KEY`` et ``STRIPE_PRIVATE_KEY``. Il suffit ensuite d'ajouter un moyen
+de paiement de type Stripe.
+
+À des fins de test, il est possible de récupérer une paire de clés de tests. Constellation
+se comportera exactement de la même manière, mais aucun argent ne sera débité.
+
+Avec une paire de clés de test, vous pouvez utiliser les numéros de carte bancaire
+présents sur cette page : `<https://stripe.com/docs/testing#cards>`_, en rentrant
+n'importe quel cryptogramme à trois chiffres et n'importe quelle date de fin de validité
+future.
+
+Note Kfet
+~~~~~~~~~
+
+Constellation permet également de payer via la Note Kfet du BDE de l'ENS Paris-Saclay.
+
+Lorsqu'un utilisateur va vouloir payer par note, l'autorisation va être demandée pour
+créer des transactions depuis son compte afin d'automatiquement faire une transaction
+sur la Note Kfet via son API et un jeton d'autorisation de l'utilisateur, puis valider
+la facture de Constellation.
+
+Pour paramétrer le lien, il faut commencer par créer une application OAuth2 sur la Note
+Kfet. Commencez par aller sur `<https://note.crans.org/o/applications/>`_, et créez une
+nouvelle application. Dans ``type de client``, choisissez ``confidential``, dans
+``type d'autorisation``, ``authorization-code`` et enfin dans ``Redirect URI`` insérez
+``https://CONSTELLATION_URL/billing/note/authorize/``. Conservez les identifiant et
+secret de l'application.
+
+Dans les paramètres de Constellation, dans le fichier ``constellation/settings_local.py``,
+vous pouvez définir les variables ``NOTE_KFET_CLIENT_ID`` et ``NOTE_KFET_CLIENT_SECRET``
+avec les champs ainsi définis. Remplissez enfin la variable ``NOTE_KFET_URL`` avec l'URL
+de la note que vous voulez utiliser, par exemple `<https://note.crans.org/>`_, ou bien
+pour des raisons de test `<https://note-dev.crans.org/>`_.
+
+Enfin, il ne vous reste plus qu'à créer le moyen de paiement par Note Kfet, et il sera
+enfin possible de payer votre adhésion par Note Kfet.