Difference between revisions of "Stripe"
| Line 16: | Line 16: | ||
# Begin by activating the '''Stripe''' module in ''Setup > Payments > Payment Gateways'' | # 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. | # 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'' | # Customise the Display Name as desired, we recommend ''Credit Card'' | ||
# Click '''Save Changes''' to complete the setup | # Click '''Save Changes''' to complete the setup | ||
| Line 39: | Line 39: | ||
==Migrating to Stripe== | ==Migrating to Stripe== | ||
| − | + | Our Stripe module supports migrating credit card details stored locally within WHMCS to the Stripe tokenisation system. This allows for a seamless transition from another merchant gateway provider to Stripe. | |
| + | |||
| + | For an existing client with a credit card stored locally, the first time a payment capture is attempted for an invoice using Stripe, the credit card details will be submitted to Stripe and a token created and stored. Any card details stored locally for that client will be removed. | ||
| + | |||
| + | To migrate all of your credit card processing to Stripe, follow the steps below: | ||
| + | |||
| + | # Navigate to ''Setup > Payments > Payment Gateways'' | ||
| + | # Ensure the Stripe module has been activated | ||
| + | # Select the '''Deactivate''' link for your previous merchant gateway provider | ||
| + | # When prompted to choose a replacement gateway to switch users of the previous gateway module to, select Stripe | ||
| + | # Click '''OK''' to complete the process | ||
| + | |||
| + | <div class="docs-alert-info">'''Note:''' Existing credit card details stored locally will be sent to Stripe and converted to a token the first time a payment is attempted for a client using the Stripe module. Until that time, credit card details will remain stored locally within WHMCS.</div> | ||
===Migrating from a 3rd Party Stripe Module=== | ===Migrating from a 3rd Party Stripe Module=== | ||
Revision as of 12:53, 7 November 2016
Contents
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
- 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
Stripe is now active and ready for use.
Payment Workflow
- Automated recurring and on-demand billing is supported.
- When making a payment, customers are able to select to use a previously stored card or enter a new one.
- Customers can update their credit card at any time from the client area.
- Admin level users with the necessary permissions can also perform card updates from the admin area.
- 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.
Migrating to Stripe
Our Stripe module supports migrating credit card details stored locally within WHMCS to the Stripe tokenisation system. This allows for a seamless transition from another merchant gateway provider to Stripe.
For an existing client with a credit card stored locally, the first time a payment capture is attempted for an invoice using Stripe, the credit card details will be submitted to Stripe and a token created and stored. Any card details stored locally for that client will be removed.
To migrate all of your credit card processing to Stripe, follow the steps below:
- Navigate to Setup > Payments > Payment Gateways
- Ensure the Stripe module has been activated
- Select the Deactivate link for your previous merchant gateway provider
- When prompted to choose a replacement gateway to switch users of the previous gateway module to, select Stripe
- Click OK to complete the process
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.