Stripe

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.