Difference between revisions of "Stripe SEPA"

From WHMCS Documentation

(→‎Getting Started)
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__
+
 
 +
<div class="docs-alert-info">
 +
We added this module in WHMCS 7.9.
 +
</div>
 +
 
 +
The Stripe SEPA payment gateway module is available in WHMCS.
 
{{gateways
 
{{gateways
 
| type = token
 
| type = token
Line 8: Line 13:
 
| deletecc = yes
 
| deletecc = yes
 
}}
 
}}
 +
== Adding the Stripe SEPA Payment Gateway ==
 +
 +
To set up the Stripe SEPA payment gateway in WHMCS:
 +
 +
# 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'''.
 +
# Choose the '''All Payment Gateways''' tab.
 +
# Click '''Stripe SEPA'''.
 +
# Check '''Show on Order Form''' to display this payment method in the Client Area during checkout.
 +
# 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].
 +
#* Do not enter a value for the Webhook Secret Key, it will be generated automatically.
 +
#** The Stripe SEPA 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 <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.
 +
#* Do not enter a value for '''Webhook Endpoint Secret'''.
 +
# Click '''Save Changes'''.
 +
 +
=== Test Mode === 
 +
 +
This module does not support test mode.
 +
 +
== Transaction Fees ==
  
−
==Getting Started==
+
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>
  
−
To activate and configure the Stripe SEPA module for use, follow the steps below.
+
== Supported Currencies ==
  
−
# Begin by navigating 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'''.
+
Stripe SEPA '''only''' supports the EUR currency. For other currencies, the Stripe SEPA option won't appear when placing orders or paying invoices.
−
# Select the All Payment Gateways tab
 
−
# Locate '''Stripe SEPA''' and click to activate it
 
−
# Stripe SEPA uses API keys for authentication. Upon activation, you will be asked to enter the Secret and Publishable API Keys provided to you by Stripe. If you '''currently''' have the [[Stripe]] gateway configured you can check the box for "Use Stripe Configuration" to use the same API keys as the existing [[Stripe]] gateway without needing to enter them again. These can be found inside the Stripe portal at https://dashboard.stripe.com/account/apikeys [[File:Stripe sepa gateway.png|thumb|Stripe SEPA Configuration in WHMCS]]
 
−
# Do not enter a value for the Webhook Endpoint Secret, it will be generated automatically.
 
−
# Customise the Display Name for the payment gateway as desired
 
−
# Customise the Statement Descriptor if desired (maximum of 22 characters)
 
−
# Click '''Save Changes''' to complete the setup process.
 
  
−
Stripe SEPA is now activated 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===
+
SEPA Direct Debit is a pull-based, reusable, and asynchronous payment method. This means that it can take up to 14 business days to confirm the success or failure of a payment after you initiate a debit from the customer’s account, though the average is five business days.. The invoice will be placed in Payment Pending until the payment has cleared.
  
−
The Stripe SEPA 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 SEPA module configuration.
+
The Stripe API is used for refunds and obtaining transaction information.
  
−
==Supported Currencies==
+
==Troubleshooting==
−
Please note that only the EUR currency is supported by Stripe SEPA. For other currencies, the Stripe SEPA option won't appear when placing orders or paying invoices.
 
  
−
==Payment Workflow==
+
''N/A''
  
−
# Automated recurring and on-demand billing is supported.
+
{{modules}}
−
# SEPA Direct Debit is a pull-based, reusable, and asynchronous payment method. This means that it can take up to 14 business days to confirm the success or failure of a payment after you initiate a debit from the customer’s account, though the average is five business days.. 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 and is never stored in your local WHMCS installation.
 
−
# The Stripe API is used for refunds and obtaining transaction information.
 

Revision as of 19:40, 1 April 2022

About this Module

We added this module in WHMCS 7.9.

The Stripe SEPA payment gateway module is available in WHMCS.

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

Adding the Stripe SEPA Payment Gateway

To set up the Stripe SEPA payment gateway in WHMCS:

  1. Go to Configuration () > System Settings > Payment Gateways or, prior to WHMCS 8.0, Setup > Products/Services > Payment Gateways.
  2. Choose the All Payment Gateways tab.
  3. Click Stripe SEPA.
  4. Check Show on Order Form to display this payment method in the Client Area during checkout.
  5. 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.
    • Do not enter a value for the Webhook Secret Key, it will be generated automatically.
      • The Stripe SEPA 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.
    • Do not enter a value for Webhook Endpoint Secret.
  6. 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>

Supported Currencies

Stripe SEPA only supports the EUR currency. For other currencies, the Stripe SEPA option won't appear when placing orders or paying invoices.

Payment Workflow

This module supports automated recurring and on-demand billing.

SEPA Direct Debit is a pull-based, reusable, and asynchronous payment method. This means that it can take up to 14 business days to confirm the success or failure of a payment after you initiate a debit from the customer’s account, though the average is five business days.. 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

N/A

Server Modules
cPanel/WHM - DirectAdmin - Plesk - Helm 3 - Helm 4 - Ensim - InterWorx - WebsitePanel - Cloudmin
Lxadmin - Virtualmin Pro - XPanel - HyperVM - SolusVM - Cloudmin - WHMSonic - VPS.Net
CentovaCast - SCPanel - MediaCP - GameCP - TCAdmin - Reseller Central - Auto Release - Heart Internet

Registrar Modules
Enom - ResellerClub - Nominet - OpenSRS - ResellOne - OnlineNIC - PlanetDomain - Affordable Domains
TPP Wholesale - TPPInternet - Stargate - Namecheap - NetEarthOne - Bizcn - InternetBS - GMO Internet
12Register - Registercom - DotDNS - WebNIC - Dot.TK - HexoNet - Realtime Register - Registereu
RRPProxy - ResellerCamp - TransIP - Heart Internet - IPMirror - NetRegistry - OVH - VentraIP Wholesale
Email - 101Domain

Fraud Modules
MaxMind - VariLogiX FraudCall - Telesign

Gateway Modules
2CheckOut - AsiaPay - Auth.net Echeck - Authorize.net - Authorize.net CIM - Bank Transfer - BidPay
BluePay - BluePay Echeck - BluePay Remote - Boleto - CashU - CC Avenue - ChronoPay - Direct Debit
EMatters - E-Path - eProcessingNetwork - eWAY Tokens - F2B - Finansbank - GarantiBank - Gate2Shop
Inpay - InternetSecure - IP.Pay - Kuveytturk - Modulo Moip - Mail In Payment - Merchant Partners
Merchant Warrior - IDEALMollie - Moneris - Moneris Vault - Skrill 1-Tap - NaviGate - NETbilling
Netregistry Pay - NoChex - Offline Credit Card - Optimal Payments - PagSeguro - Payflow Pro - Pay Junction
Paymate AU and NZ - Payment Express - PayPal - PayPal Card Payments - PayPal Express Checkout
PayPal Payments - PayPal Payments Pro - PayPoint.net (SecPay) - Payson - Planet Authorize - ProtX VSP Form
PSIGate - Quantum Gateway - Quantum Vault - SagePay - SagePay Tokens v2 - SecurePay
SecurePay AU - Secure Trading - TrustCommerce - USA ePay - WorldPay - WorldPay Invisible


Retrieved from "http://3.17.75.209/index.php?title=Stripe_SEPA&oldid=31838"