Difference between revisions of "Stripe"

From WHMCS Documentation

m
Line 8: Line 8:
 
}}
 
}}
  
−
The WHMCS official Stripe module was introduced in WHMCS 7.1. Stripe remotely stores a client's credit card, without storing the details within WHMCS.
+
The WHMCS Official Stripe module was introduced in WHMCS 7.1.
 +
 
 +
Stripe is a tokenised gateway. As a result, customers personal credit card information is submitted to and stored remotely by Stripe. Using a tokenised gateway is recommended for security and reduced liability.
  
 
==Setup==
 
==Setup==
 
[[File:stripe.png|thumb|Stripe Module Settings]]
 
[[File:stripe.png|thumb|Stripe Module Settings]]
−
Stripe uses the API keys found here. Start by activating the module in Setup > Payments > Payment Gateways. The module is listed as Stripe.
+
# Begin by activating the '''Stripe''' module in ''Setup > Payments > Payment Gateways''
 +
# Stripe uses API keys for authentication. Upon activation, you will be asked to enter the Secret and Publishable API Keys.
 +
## These can be found inside the Stripe portal at https://dashboard.stripe.com/account/apikeys
 +
# Customise the Display Name as desired, we recommend ''Credit Card''
 +
# Click '''Save Changes''' to complete the setup
  
−
When active, enter the Secret and Publishable API Keys and click Save Changes. Stripe is now active for clients to use.
+
Stripe is now active and ready for use.
−
Ensure the "Disable Credit Card Storage" option in not enabled. Find this on the Security tab of General Settings.
 
  
−
==How does it work?==
+
<div class="docs-alert-info">'''Transaction Fees:''' Stripe returns transaction fees in the default currency of the Stripe account. If you have a different default currency in WHMCS, you must ensure you have configured the currency of the Stripe account in ''Setup > Payments > Currencies'' to allow WHMCS to successfully convert the fee to other currencies.</div>
 +
 
 +
<div class="docs-alert-warning">Stripe is a tokenised gateway. As a result, the "Disable Credit Card Storage" option found under ''General Settings > Security'' should not be enabled.</div>
 +
 
 +
==Payment Workflow==
 
[[File:stripe_checkout.png|thumb|The Stripe module on Checkout]]
 
[[File:stripe_checkout.png|thumb|The Stripe module on Checkout]]
−
# The client does not leave WHMCS.
+
# Automated recurring and on-demand billing is supported.
−
# The module uses stripe.js for payments and card updates.
+
# When making a payment, customers are able to select to use a previously stored card or enter a new one.
−
# The module uses the Stripe API for refunds and obtaining transaction information.
+
# Customers can update their credit card at any time from the client area.
−
# A customer can edit their card at any time from the client area.
+
# Admin level users with the necessary permissions can also perform card updates from the admin area.
−
# An admin with access can request a payment for a token at any point.
+
# Customers never leave your WHMCS installation during checkout or updating their card.
 +
# Personal card information is submitted directly to Stripe and is never stored in your local WHMCS installation.
 +
# The Stripe API is used for refunds and obtaining transaction information.
 +
# The stripe.js library is used for payments and card updates.
  
−
==Migration from a 3rd Party Stripe Module==
+
==Migrating to Stripe==
  
−
The WHMCS module uses the Stripe "cus_" reference to capture payments - e.g. cus_9MvIb7UlgJfJTn. Find this on the Credit Card Information screen from the Client Summary. The WHMCS module can replace any existing Stripe module that uses the same reference. Activate the WHMCS Module as above. Then, deactivate the existing Stripe module, whilst selecting the official module as a replacement.
+
To convert from another module in WHMCS to Stripe is simple and does not need intervention. The Stripe module will create a token from existing card details on payment attempt. Choose Stripe from the Gateway dropdown on a client service to have this happen. On the next invoice, WHMCS will send the card details to Stripe and replace with the generate token.
  
−
==Migration from another Credit Card Module==
+
===Migrating from a 3rd Party Stripe Module===
  
−
To convert from another module in WHMCS to Stripe is simple and does not need intervention. The Stripe module will create a token from existing card details on payment attempt. Choose Stripe from the Gateway dropdown on a client service to have this happen. On the next invoice, WHMCS will send the card details to Stripe and replace with the generate token.
+
The Official WHMCS Stripe module uses the Stripe "cus_" reference to capture payments - e.g. cus_9MvIb7UlgJfJTn. For any 3rd party module which also uses this reference, the official module can replace it.
  
−
==Special Notes for Transaction Fees==
+
To verify if your current Stripe module uses the "cus_" reference, navigate to a client you know to have an active Stripe token and click the Credit Card Information link on the Client Summary page.  Verify the token listed there has the "cus_" prefix.
  
−
Stripe provides the fee for transactions in the currency of the account. This can be different from the currencies configured in WHMCS. For the fees to be available, the currency of the Stripe account should be available in WHMCS.
+
To convert to the Official Stripe module, activate the module as described above. Then deactivate your previous Stripe module, and when prompted, select the new Stripe module to update and switch existing customers to.

Revision as of 11:06, 7 November 2016

Supported Features

Type One Time Recurring Refunds 3D Secure
Token Yes Yes Yes No
Remote Update Card Remote Delete Card AddPayMethod API
Yes Yes No

The WHMCS Official Stripe module was introduced in WHMCS 7.1.

Stripe is a tokenised gateway. As a result, customers personal credit card information is submitted to and stored remotely by Stripe. Using a tokenised gateway is recommended for security and reduced liability.

Setup

Stripe Module Settings
  1. Begin by activating the Stripe module in Setup > Payments > Payment Gateways
  2. Stripe uses API keys for authentication. Upon activation, you will be asked to enter the Secret and Publishable API Keys.
    1. These can be found inside the Stripe portal at https://dashboard.stripe.com/account/apikeys
  3. Customise the Display Name as desired, we recommend Credit Card
  4. Click Save Changes to complete the setup

Stripe is now active and ready for use.

Transaction Fees: Stripe returns transaction fees in the default currency of the Stripe account. If you have a different default currency in WHMCS, you must ensure you have configured the currency of the Stripe account in Setup > Payments > Currencies to allow WHMCS to successfully convert the fee to other currencies.
Stripe is a tokenised gateway. As a result, the "Disable Credit Card Storage" option found under General Settings > Security should not be enabled.

Payment Workflow

The Stripe module on Checkout
  1. Automated recurring and on-demand billing is supported.
  2. When making a payment, customers are able to select to use a previously stored card or enter a new one.
  3. Customers can update their credit card at any time from the client area.
  4. Admin level users with the necessary permissions can also perform card updates from the admin area.
  5. Customers never leave your WHMCS installation during checkout or updating their card.
  6. Personal card information is submitted directly to Stripe and is never stored in your local WHMCS installation.
  7. The Stripe API is used for refunds and obtaining transaction information.
  8. The stripe.js library is used for payments and card updates.

Migrating to Stripe

To convert from another module in WHMCS to Stripe is simple and does not need intervention. The Stripe module will create a token from existing card details on payment attempt. Choose Stripe from the Gateway dropdown on a client service to have this happen. On the next invoice, WHMCS will send the card details to Stripe and replace with the generate token.

Migrating from a 3rd Party Stripe Module

The Official WHMCS Stripe module uses the Stripe "cus_" reference to capture payments - e.g. cus_9MvIb7UlgJfJTn. For any 3rd party module which also uses this reference, the official module can replace it.

To verify if your current Stripe module uses the "cus_" reference, navigate to a client you know to have an active Stripe token and click the Credit Card Information link on the Client Summary page. Verify the token listed there has the "cus_" prefix.

To convert to the Official Stripe module, activate the module as described above. Then deactivate your previous Stripe module, and when prompted, select the new Stripe module to update and switch existing customers to.

Retrieved from "http://3.17.75.209/index.php?title=Stripe&oldid=20722"