Revision as of 19:26, 1 April 2022

About this Module

The Stripe ACH payment gateway module is available in WHMCS.

Supported Features

Adding the Stripe ACH Payment Gateway

To set up the Stripe ACH payment gateway in WHMCS:

1. Make certain that you have activated ACH in your Stripe account.
2. If you have not already, create a Plaid account.
3. Log in to the Plaid control panel.
4. Go to Team Settings > Integrations.
5. Click Enable next to the Stripe integration and follow the on-screen instructions.
6. Log in to the WHMCS Admin Area.
7. Go to Configuration () > System Settings > Payment Gateways or, prior to WHMCS 8.0, Setup > Products/Services > Payment Gateways.
8. Choose the All Payment Gateways tab.
9. Click Stripe ACH.
10. Check Show on Order Form to display this payment method in the Client Area during checkout.
11. 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 the Stripe portal.
      

      Stripe ACH Configuration in WHMCS
    • Do not enter a value for the Webhook Secret Key, it will be generated automatically.
      • The Stripe ACH module requires a valid Webhook and Secret Key in order for payments to be recognised 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 link_tokens values instead of public_key values. If you use WHMCS 8.0 or earlier, contact Plaid support and ask them to enable public_key on your Plaid account.
12. Click Save Changes.

Test Mode

This module does not support test mode.

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 () > 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

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.

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.

The Stripe API is used for refunds and obtaining transaction information.

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 into WHMCS in the Manage Existing Gateways tab at Configuration () > System Settings > Payment Gateways or, prior to WHMCS 8.0, Setup > Payments > Payment Gateways.

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:

• Log in to your Plaid account, navigate to Team Settings > Keys
• Copy the Production Secret
• In the WHMCS Admin, navigate to the Manage Existing Gateways tab at Configuration () > System Settings > Payment Gateways or, prior to WHMCS 8.0, Setup > Payments > Payment Gateways.
• 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.

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.

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.

To resolve this error:

1. Go to the Summary tab of the client's profile.
2. Delete the local bank account pay method.
3. Ask the customer to log in to the Client Area and pay the invoice by clicking Pay Invoice.

This will initiate the payment via Stripe ACH and create the necessary tokens for accepting future automated payments.