You are here

Home » API reference » Commerce Stripe 8

README.txt in Commerce Stripe 8

Same filename and directory in other branches
  1. 7.3 README.txt
  2. 7 README.txt
  3. 7.2 README.txt
README file for Commerce Stripe

CONTENTS OF THIS FILE
---------------------
* Introduction
* Requirements
* Installation
* Configuration
* How It Works
* Troubleshooting
* Maintainers

INTRODUCTION
------------
This project integrates Stripe online payments into
the Drupal Commerce payment and checkout systems.
https://stripe.com/docs/quickstart
* For a full description of the module, visit the project page:
  https://www.drupal.org/project/commerce_stripe
* To submit bug reports and feature suggestions, or to track changes:
  https://www.drupal.org/project/issues/commerce_stripe


REQUIREMENTS
------------
This module requires the following:
* Submodules of Drupal Commerce package (https://drupal.org/project/commerce)
  - Commerce core
  - Commerce Payment (and its dependencies)
* Stripe PHP Library (https://github.com/stripe/stripe-php)
* Stripe Merchant account (https://dashboard.stripe.com/register)


INSTALLATION
------------
* This module needs to be installed via Composer, which will download
the required libraries.
composer require "drupal/commerce_stripe"
https://www.drupal.org/docs/8/extending-drupal-8/installing-modules-composer-dependencies

CONFIGURATION
-------------
* Create a new Stripe payment gateway.
  Administration > Commerce > Configuration > Payment gateways > Add payment gateway
  Stripe-specific settings available:
  - Secret key
  - Publishable key
  Use the API credentials provided by your Stripe merchant account. It is
  recommended to enter test credentials and then override these with live
  credentials in settings.php. This way, live credentials will not be stored in the db.


HOW IT WORKS
------------

* General considerations:
  - The store owner must have a Stripe merchant account.
    Sign up here:
    https://dashboard.stripe.com/register
  - Customers should have a valid credit card.
    - Stripe provides several dummy credit card numbers for testing:
      https://stripe.com/docs/testing

* Checkout workflow:
  It follows the Drupal Commerce Credit Card workflow.
  The customer should enter his/her credit card data
  or select one of the credit cards saved with Stripe
  from a previous order.

* Payment Terminal
  The store owner can Void, Capture and Refund the Stripe payments.


TROUBLESHOOTING
---------------
* No troubleshooting pending for now.


MAINTAINERS
-----------
Current maintainers:
* Tavi Toporjinschi (vasike) - https://www.drupal.org/u/vasike
* Scott Hooker (scotthooker) - https://www.drupal.org/u/scotthooker

This project has been developed by:
* TES Global
  TES Global is a digital education company that has been supporting educators
  for over 100 years. Our mission is to help teachers, schools and universities
  to develop and deliver the best education.
  Visit https://www.tes.com for more information.
* Commerce Guys by Actualys
  Visit https://commerceguys.fr for more information.

File

README.txt
View source 
  1. README file for Commerce Stripe

  2. 

  3. CONTENTS OF THIS FILE

  4. ---------------------

  5. * Introduction

  6. * Requirements

  7. * Installation

  8. * Configuration

  9. * How It Works

  10. * Troubleshooting

  11. * Maintainers

  12. 

  13. INTRODUCTION

  14. ------------

  15. This project integrates Stripe online payments into

  16. the Drupal Commerce payment and checkout systems.

  17. https://stripe.com/docs/quickstart

  18. * For a full description of the module, visit the project page:

  19.   https://www.drupal.org/project/commerce_stripe

  20. * To submit bug reports and feature suggestions, or to track changes:

  21.   https://www.drupal.org/project/issues/commerce_stripe

  22. 

  23. 

  24. REQUIREMENTS

  25. ------------

  26. This module requires the following:

  27. * Submodules of Drupal Commerce package (https://drupal.org/project/commerce)

  28.   - Commerce core

  29.   - Commerce Payment (and its dependencies)

  30. * Stripe PHP Library (https://github.com/stripe/stripe-php)

  31. * Stripe Merchant account (https://dashboard.stripe.com/register)

  32. 

  33. 

  34. INSTALLATION

  35. ------------

  36. * This module needs to be installed via Composer, which will download

  37. the required libraries.

  38. composer require "drupal/commerce_stripe"

  39. https://www.drupal.org/docs/8/extending-drupal-8/installing-modules-composer-dependencies

  40. 

  41. CONFIGURATION

  42. -------------

  43. * Create a new Stripe payment gateway.

  44.   Administration > Commerce > Configuration > Payment gateways > Add payment gateway

  45.   Stripe-specific settings available:

  46.   - Secret key

  47.   - Publishable key

  48.   Use the API credentials provided by your Stripe merchant account. It is

  49.   recommended to enter test credentials and then override these with live

  50.   credentials in settings.php. This way, live credentials will not be stored in the db.

  51. 

  52. 

  53. HOW IT WORKS

  54. ------------

  55. 

  56. * General considerations:

  57.   - The store owner must have a Stripe merchant account.

  58.     Sign up here:

  59.     https://dashboard.stripe.com/register

  60.   - Customers should have a valid credit card.

  61.     - Stripe provides several dummy credit card numbers for testing:

  62.       https://stripe.com/docs/testing

  63. 

  64. * Checkout workflow:

  65.   It follows the Drupal Commerce Credit Card workflow.

  66.   The customer should enter his/her credit card data

  67.   or select one of the credit cards saved with Stripe

  68.   from a previous order.

  69. 

  70. * Payment Terminal

  71.   The store owner can Void, Capture and Refund the Stripe payments.

  72. 

  73. 

  74. TROUBLESHOOTING

  75. ---------------

  76. * No troubleshooting pending for now.

  77. 

  78. 

  79. MAINTAINERS

  80. -----------

  81. Current maintainers:

  82. * Tavi Toporjinschi (vasike) - https://www.drupal.org/u/vasike

  83. * Scott Hooker (scotthooker) - https://www.drupal.org/u/scotthooker

  84. 

  85. This project has been developed by:

  86. * TES Global

  87.   TES Global is a digital education company that has been supporting educators

  88.   for over 100 years. Our mission is to help teachers, schools and universities

  89.   to develop and deliver the best education.

  90.   Visit https://www.tes.com for more information.

  91. * Commerce Guys by Actualys

  92.   Visit https://commerceguys.fr for more information.