Stripe ACH - Revision history

JuanR: /* The Plaid Client ID, Public Key, and Secret combination is rejected. */

2024-04-14T12:22:23Z

‎The Plaid Client ID, Public Key, and Secret combination is rejected.

JuanR: /* The Sandbox/Development Secret is being used in a live move or vice versa. */

2024-04-14T12:21:20Z

‎The Sandbox/Development Secret is being used in a live move or vice versa.

SarahK: /* About this Module */

2024-02-16T19:40:48Z

‎About this Module

SarahK at 17:29, 7 February 2024

2024-02-07T17:29:08Z

SarahK: /* Adding the Stripe ACH Payment Gateway */

2022-09-28T18:56:42Z

‎Adding the Stripe ACH Payment Gateway

SarahK: /* Adding the Stripe ACH Payment Gateway */

2022-09-07T21:03:29Z

‎Adding the Stripe ACH Payment Gateway

SarahK at 17:03, 5 May 2022

2022-05-05T17:03:15Z

SarahK at 19:40, 1 April 2022

2022-04-01T19:40:47Z

SarahK at 19:26, 1 April 2022

2022-04-01T19:26:31Z

SarahK at 21:26, 27 January 2022

2022-01-27T21:26:48Z

@@ Line 72: / Line 72: @@
 ==== The Plaid Client ID, Public Key, and Secret combination is rejected. ====
-Ensure that the API keys have copied correctly from your [https://dashboard.plaid.com/account/keys|Plaid account]  into WHMCS in the '''Manage Existing Gateways''' tab at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Payment Gateways]]''' or, prior to WHMCS 8.0, '''Setup > Payments > Payment Gateways'''.
+Ensure that the API keys have copied correctly from your [https://dashboard.plaid.com/account/keys|Plaid account] into the appropriate location for your version of WHMCS:
 See the [[#Getting Started|Getting Started]] steps above to ensure all the configuration is complete.

@@ Line 82: / Line 82: @@
 To use Plaid in production mode to process real payments:
-* Log in to your [https://dashboard.plaid.com/account/keys Plaid account] and go to '''Team Settings > Keys'''.
+# Log in to your [https://dashboard.plaid.com/account/keys Plaid account] and go to '''Team Settings > Keys'''.
-* Copy the '''Production Secret'''.
+# Copy the '''Production Secret'''.
-* In WHMCS, go to the '''Manage Existing Gateways''' tab at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Payment Gateways]]''' or, prior to WHMCS 8.0, '''Setup > Payments > Payment Gateways'''.
+# Go to the appropriate location for your version of WHMCS:
-* Select '''Production''' for '''Plaid Environment'''.
+#* For WHMCS 8.6 and later, go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Payment Gateways]]'''.
-* Paste it into '''Plaid Secret'''.
+#* For WHMCS 8.0 and later, go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Payment Gateways]]''' and choose '''Manage Existing Gateways'''.
-* Click '''Save Changes'''.
+#* For WHMCS 7.10 and earlier, go to '''Setup > Products/Services > [[Payment Gateways]]''' and choose '''Manage Existing Gateways'''.
 See the [[#Getting Started|Getting Started]] steps above to ensure all the configuration has been fully completed.

@@ Line 3: / Line 3: @@
 <div class="docs-alert-success">
 - We added this module in WHMCS 7.9.
-- In WHMCS 8.9, we updated this module to use Stripe's <tt>PaymentIntents</tt> API instead of the deprecated Stripe API. [LINK A patch is available for some previous versions of WHMCS.]
+- In WHMCS 8.9, we updated this module to use Stripe's <tt>PaymentIntents</tt> API instead of the deprecated Stripe API.
 </div>
@@ Line 14: / Line 14: @@
 | deletecc = yes
 }}
 == Adding the Stripe ACH Payment Gateway ==

@@ Line 2: / Line 2: @@
 <div class="docs-alert-success">
-We added this module in WHMCS 7.9.
+- We added this module in WHMCS 7.9.
 </div>
@@ Line 14: / Line 15: @@
 }}
 == Adding the Stripe ACH Payment Gateway ==
 To set up the Stripe ACH payment gateway in WHMCS:
-# Make certain that you have [https://plaid.com/docs/stripe/#step1 activated ACH in your Stripe account].
+# If you use WHMCS 8.8 or earlier, activate Plaid support:
-# If you have not already, [https://dashboard.plaid.com/signup create a Plaid account].
+## Make certain that you have [https://plaid.com/docs/stripe/#step1 activated ACH in your Stripe account].
-# Log in to the [https://dashboard.plaid.com/team/integrations Plaid control panel].
+## If you have not already, [https://dashboard.plaid.com/signup create a Plaid account].
-# Go to '''Team Settings > Integrations'''.
+## Log in to the [https://dashboard.plaid.com/team/integrations Plaid control panel].
-# Click '''Enable''' next to the Stripe integration and follow the on-screen instructions.
+## Go to '''Team Settings > Integrations'''.
 # Log in to the WHMCS Admin Area.
 # Go to the appropriate location for your version of WHMCS:
@@ Line 30: / Line 36: @@
 # Enter your Stripe credentials.
 #* If you currently also use the [[Stripe]] payment gateway, you can check '''Use Stripe Configuration''' to use your existing API keys.
-#* You can find your credentials in [https://dashboard.stripe.com/account/apikeys the Stripe portal]. [[File:Stripe ach gateway.png|thumb|Stripe ACH Configuration in WHMCS]]
+#* You can find your credentials in [https://dashboard.stripe.com/account/apikeys the Stripe portal]. [[File:stripe-ach-configuration.png|thumb|Stripe ACH Configuration in WHMCS 8.9 and later.]]
-#* Do not enter a value for the Webhook Secret Key, it will be generated automatically.
+#* Do not enter a value for the '''Webhook Secret Key'''. The system generates this automatically.
-#** The Stripe ACH module requires a valid Webhook and Secret Key in order for payments to be recognised and automatically applied to invoices.
+#** The Stripe ACH module requires a valid webhook and secret key in order for payments to be recognized and automatically applied to invoices.
 #** If you modify the secret key for the webhook at Stripe, you must also update it in WHMCS.
-#*Newer Plaid accounts provide <tt>link_tokens</tt> values instead of <tt>public_key</tt> values. If you use WHMCS 8.0 or earlier, contact Plaid support and ask them to enable <tt>public_key</tt> on your Plaid account.
+#* If you use WHMCS 8.0 or earlier, contact Plaid support and ask them to enable <tt>public_key</tt> on your Plaid account.
 # Click '''Save Changes'''.
@@ Line 86: / Line 92: @@
 ==== The Stripe integration is not enabled in your Plaid account. ====
-To use Stripe ACH, you must link Plaid to your Stripe account.
+To use Stripe ACH in WHMCS 8.8 or earlier, you must link Plaid to your Stripe account.
 For steps to activate the Stripe integration with your Plaid account, see [https://plaid.com/docs/stripe/#step1 Stripe's documentation]].

@@ Line 24: / Line 24: @@
 # Log in to the WHMCS Admin Area.
 # Go to the appropriate location for your version of WHMCS:
-#* For WHMCS 8.6 and later, go to '''Addons > [[Apps and Integrations|Apps & Integrations]]''' or '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > Apps & Integrations'''.
+#* For WHMCS 8.0 and later, go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > Apps & Integrations''' or '''Addons > [[Apps and Integrations|Apps & Integrations]]'''.
-#* For WHMCS 8.0 to 8.6, go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Payment Gateways]]''' and choose '''All Payment Gateways'''.
+#* For WHMCS 7.10 and earlier, go to '''Setup > Products/Services > [[Payment Gateways]]''' and choose '''All Payment Gateways'''.
 # Click '''Stripe ACH'''.
 # Check '''Show on Order Form''' to display this payment method in the Client Area during checkout.

@@ Line 23: / Line 23: @@
 # Click '''Enable''' next to the Stripe integration and follow the on-screen instructions.
 # Log in to the WHMCS Admin Area.
-# Go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Payment Gateways]]''' or, prior to WHMCS 8.0, '''Setup > Products/Services > Payment Gateways'''.
+# Go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Payment Gateways]]''' or, prior to WHMCS 8.0, '''Setup > Payments > Payment Gateways'''.
 # Choose the '''All Payment Gateways''' tab.
 # Click '''Stripe ACH'''.
@@ Line 42: / Line 42: @@
 == 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 your Stripe account in '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Currencies''' or, prior to WHMCS 8.0, ''Setup > Payments > Currencies'' along with a valid exchange rate to allow WHMCS to be able to convert the fee into your other currencies.</div>
+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 your Stripe account in '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Currencies]]''' or, prior to WHMCS 8.0, ''Setup > Payments > Currencies'' along with a valid exchange rate to allow WHMCS to be able to convert the fee into your other currencies.</div>
 ==Payment Workflow==
@@ Line 48: / Line 48: @@
 This module supports automated recurring and on-demand billing.
-ACH Payments can take up to 5 days to process. The invoice will be placed in Payment Pending until the payment has cleared.
+ACH payments can take up to 5 days to process. The invoice will be placed in '''Payment Pending''' until the payment has cleared.
-When making a payment, customers are able to select to use a previously stored bank account or enter a new one. Customers never leave your WHMCS installation during checkout or adding/removing a new bank account. Personal bank information is submitted directly to Stripe/Plaid and is never stored in your local WHMCS installation.
+When making a payment, customers are able to select to use a previously stored bank account or enter a new one. Customers never leave your WHMCS installation during checkout or adding or removing a new bank account. Personal bank information is submitted directly and the system never stores it in your local WHMCS installation.
-The Stripe API is used for refunds and obtaining transaction information.
+The system uses the Stripe API for refunds and obtaining transaction information.
 ==Troubleshooting==
 ===error===
-. The Plaid Client Id, Public Key and Secret combination is being rejected.
+A simple message '''error''' when attempting to make payment indicates invalid credentials or incomplete Plaid configuration.
-Ensure the API Keys have been correctly copied from your [https://dashboard.plaid.com/account/keys|Plaid account]  into WHMCS in the '''Manage Existing Gateways''' tab at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Payment Gateways''' or, prior to WHMCS 8.0, '''Setup > Payments > Payment Gateways'''.
+See the [[#Getting Started|Getting Started]] steps above to ensure all the configuration is complete.
-Please review the [[#Getting Started]] steps above to ensure all the configuration has been fully completed.
+==== The Sandbox/Development Secret is being used in a live move or vice versa. ====
-. The Sandbox/Development Secret is being used in a live move or vice versa.
+Plaid issues individual Secrets for use with the Sandbox, Developer, and Live environments. Ensure that the Plaid Secret you entered correctly corresponds to the Plaid Environment setting.
 To use Plaid in production mode to process real payments:
-. The Stripe integration is not enabled in your Plaid account.
+* Log in to your [https://dashboard.plaid.com/account/keys Plaid account] and go to '''Team Settings > Keys'''.
-To use Stripe ACH, Plaid must be linked to your Stripe account.
+* Copy the '''Production Secret'''.
-Follow these steps to activate the Stripe integration with your Plaid account: https://plaid.com/docs/stripe/#step1
+See the [[#Getting Started|Getting Started]] steps above to ensure all the configuration has been fully completed.
 ===Invalid Remote Token For Gateway: ===
-A '''Invalid Remote Token For Gateway''' error at '''Billing > Gateway Log''' indicates that the invoice's associated client does not currently have a valid Stripe ACH pay method available.
+A '''Invalid Remote Token For Gateway''' error at '''Billing > [[Gateway Log]]''' indicates that the invoice's associated client does not currently have a valid Stripe ACH pay method available.
 You cannot use local bank account pay methods to make a capture attempt. Instead, Stripe ACH requires storing the bank details in their system and then WHMCS stores a remote token for them. This has the added benefit of reducing your liabilities because you do not need to store a client's full bank account details.
@@ Line 90: / Line 99: @@
 To resolve this error:
-# Go to the '''Summary''' tab of the client's profile.
+# Go to the '''[[Clients:Summary Tab|Summary]]''' tab of the client's profile.
 # Delete the local bank account pay method.
 # Ask the customer to log in to the Client Area and pay the invoice by clicking '''Pay Invoice'''.

← Older revision		Revision as of 19:40, 1 April 2022
Line 96:		Line 96:
	This will initiate the payment via Stripe ACH and create the necessary tokens for accepting future automated payments.		This will initiate the payment via Stripe ACH and create the necessary tokens for accepting future automated payments.

−	{{modules}}	+	{{modules}}

@@ Line 1: / Line 1: @@
-<div class="docs-alert-info"><i class="fa fa-question-circle"></i> This page describes a Payment Gateway Module in version 7.9 and above.</div>
+== About this Module ==
-__TOC__
 {{gateways
 | type = token
@@ Line 8: / Line 13: @@
 | deletecc = yes
 }}
-==Getting Started==
+# Make certain that you have [https://plaid.com/docs/stripe/#step1 activated ACH in your Stripe account].
-To activate and configure the Stripe ACH module for use, follow the steps below.
+=== Test Mode ===
-<div class="docs-alert-info">Plaid and Stripe have partnered in order to offer frictionless money transfers without the need to ever handle an account or routing number. Using Plaid allows you to instantly authenticate a customer's account and automatically generate a Stripe bank account token. The WHMCS Stripe ACH integration requires Plaid. If you do not have a Plaid account, you can sign up at https://dashboard.plaid.com/signup</div>
+This module does not support test mode.
-# Begin by logging into the [https://dashboard.plaid.com/team/integrations Plaid control panel] and navigate to ''Team Settings > Integrations''
+== Transaction Fees ==
-# Customise the Display Name as desired
+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 your Stripe account in '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Currencies''' or, prior to WHMCS 8.0, ''Setup > Payments > Currencies'' along with a valid exchange rate to allow WHMCS to be able to convert the fee into your other currencies.</div>
-Stripe ACH is now active and ready for use.
+==Payment Workflow==
-<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 your Stripe account in '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Currencies''' or, prior to WHMCS 8.0, ''Setup > Payments > Currencies'' along with a valid exchange rate to allow WHMCS to be able to convert the fee into your other currencies.</div>
+This module supports automated recurring and on-demand billing.
-===Webhook Secret Key===
+ACH Payments can take up to 5 days to process. The invoice will be placed in Payment Pending until the payment has cleared.
-The Stripe ACH module requires a valid Webhook and Secret Key in order for payments to be recognised and automatically applied to invoices.
+When making a payment, customers are able to select to use a previously stored bank account or enter a new one. Customers never leave your WHMCS installation during checkout or adding/removing a new bank account. Personal bank information is submitted directly to Stripe/Plaid and is never stored in your local WHMCS installation.
-Should the Secret Key for the Webhook be modified at Stripe, this must be updated within the WHMCS Stripe ACH module configuration:
+The Stripe API is used for refunds and obtaining transaction information.
 ==Troubleshooting==
@@ Line 108: / Line 95: @@
 This will initiate the payment via Stripe ACH and create the necessary tokens for accepting future automated payments.