Difference between revisions of "Stripe ACH"

From WHMCS Documentation

m (DOCS-6953)
(→‎Getting Started)
Line 14: Line 14:
  
 
<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>
 
<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>
 +
<div class="docs-alert-warning">
 +
<span class="title">Activate ACH at Stripe</span><br />
 +
Before payments can be processed via Stripe ACH, it is necessary to activate ACH capabilities on your Stripe account. This guide demonstrates the process: https://plaid.com/docs/stripe/#step1
 +
</div>
  
−
# Begin by navigating to ''Setup > Payments > Payment Gateways''
+
# Begin by logging into the [https://dashboard.plaid.com/team/integrations Plaid control panel] and navigate to ''Team Settings > Integrations''
 +
# Click ''Enable'' next to the Stripe integration and follow-up the on-screen instructions through to completion
 +
# Once Plaid and Stripe are successfully linked, login to your WHMCS Administration Area
 +
# Navigate to ''Setup > Payments > Payment Gateways''
 
# Select the All Payment Gateways tab
 
# Select the All Payment Gateways tab
 
# Locate '''Stripe ACH''' and click to activate it
 
# Locate '''Stripe ACH''' and click to activate it
Line 36: Line 43:
  
 
Should the Secret Key for the Webhook be modified at Stripe, this must be updated within the WHMCS Stripe SEPA module configuration.
 
Should the Secret Key for the Webhook be modified at Stripe, this must be updated within the WHMCS Stripe SEPA module configuration.
 +
 +
==Troubleshooting==
 +
===error===
 +
A simple message '''error''' when attempting to make payment indicates invalid credentials or incomplete Plaid configuration. To resolve it, please check the following points:
 +
 +
1. The Plaid Client Id, Public Key and Secret combination is being rejected.
 +
 +
Ensure the API Keys have been correctly copied from your [https://dashboard.plaid.com/account/keys|Plaid account] across into the WHMCS ''Setup > Payments > Payment Gateways > Manage Existing Gateways tab''
 +
 +
Please review the [[#Getting Started]] steps above to ensure all the configuration has been fully completed.
 +
 +
2. 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 entered correctly corresponds to the Plaid Environment setting.
 +
 +
To use Plaid in production mode to process real payments:
 +
* Login to your [https://dashboard.plaid.com/account/keys Plaid account], navigate to ''Team Settings > Keys''
 +
* Copy the Production Secret
 +
* In the WHMCS Admin, navigate to ''Setup > Payments > Payment Gateways > Manage Existing Gateways tab''
 +
* Use the ''Plaid Environment'' dropdown to select the '''Production''' option
 +
* Paste it into the Plaid Secret field
 +
* Click Save Changes
 +
Please review the [[#Getting Started]] steps above to ensure all the configuration has been fully completed.
 +
 +
3. The Stripe integration is not enabled in your Plaid account.
 +
To use Stripe ACH, Plaid must be linked to your Stripe account.
 +
 +
Follow these steps to activate the Stripe integration with your Plaid account: https://plaid.com/docs/stripe/#step1
 +
Please review the [[#Getting Started]] steps above to ensure all the configuration has been fully completed.
  
 
==Payment Workflow==
 
==Payment Workflow==

Revision as of 17:13, 7 January 2020

This page describes a Payment Gateway Module in version 7.9 and above.

Supported Features

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

Getting Started

To activate and configure the Stripe ACH module for use, follow the steps below.

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

Activate ACH at Stripe
Before payments can be processed via Stripe ACH, it is necessary to activate ACH capabilities on your Stripe account. This guide demonstrates the process: https://plaid.com/docs/stripe/#step1

  1. Begin by logging into the Plaid control panel and navigate to Team Settings > Integrations
  2. Click Enable next to the Stripe integration and follow-up the on-screen instructions through to completion
  3. Once Plaid and Stripe are successfully linked, login to your WHMCS Administration Area
  4. Navigate to Setup > Payments > Payment Gateways
  5. Select the All Payment Gateways tab
  6. Locate Stripe ACH and click to activate it
  7. Stripe ACH uses API keys for authentication. Upon activation, you will be asked to enter the Secret and Publishable API Keys.
  8. Do not enter a value for the Webhook Secret Key, it will be generated automatically.
  9. Stripe ACH uses Plaid to validate bank information entered by clients. You will need to enter your Plaid Client ID, Public Key and Secret
  10. Customise the Display Name as desired
  11. Customise the Statement Descriptor if desired (maximum of 22 characters)
  12. Click Save Changes to complete the setup process.

Stripe ACH 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 your Stripe account in Setup > Payments > Currencies along with a valid exchange rate to allow WHMCS to be able to convert the fee into your other currencies.

Webhook Secret Key

The Stripe SEPA module requires a valid Webhook and Secret Key in order for payments to be recognised and automatically applied to invoices.

Should the Secret Key for the Webhook be modified at Stripe, this must be updated within the WHMCS Stripe SEPA module configuration.

Troubleshooting

error

A simple message error when attempting to make payment indicates invalid credentials or incomplete Plaid configuration. To resolve it, please check the following points:

1. The Plaid Client Id, Public Key and Secret combination is being rejected.

Ensure the API Keys have been correctly copied from your account across into the WHMCS Setup > Payments > Payment Gateways > Manage Existing Gateways tab

Please review the #Getting Started steps above to ensure all the configuration has been fully completed.

2. 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 entered correctly corresponds to the Plaid Environment setting.

To use Plaid in production mode to process real payments:

  • Login to your Plaid account, navigate to Team Settings > Keys
  • Copy the Production Secret
  • In the WHMCS Admin, navigate to Setup > Payments > Payment Gateways > Manage Existing Gateways tab
  • Use the Plaid Environment dropdown to select the Production option
  • Paste it into the Plaid Secret field
  • Click Save Changes

Please review the #Getting Started steps above to ensure all the configuration has been fully completed.

3. The Stripe integration is not enabled in your Plaid account. To use Stripe ACH, Plaid must be linked to your Stripe account.

Follow these steps to activate the Stripe integration with your Plaid account: https://plaid.com/docs/stripe/#step1 Please review the #Getting Started steps above to ensure all the configuration has been fully completed.

Payment Workflow

  1. Automated recurring and on-demand billing is supported.
  2. ACH Payments can take up to 5 days to process. The invoice will be placed in Payment Pending until the payment has cleared.
  3. When making a payment, customers are able to select to use a previously stored bank account or enter a new one.
  4. Customers never leave your WHMCS installation during checkout or adding/removing a new bank account.
  5. Personal bank information is submitted directly to Stripe/Plaid and is never stored in your local WHMCS installation.
  6. The Stripe API is used for refunds and obtaining transaction information.
Retrieved from "http://3.17.75.209/index.php?title=Stripe_ACH&oldid=27945"