Stripe - Setup Documentation

This page describes how to setup the add-on payment gateway, available here.

Connecting your Stripe account

In order to use the Stripe payment gateway extension, you must first have a account. It's free to create a Stripe account, and testing it is also free. Once you have purchased the Stripe Payment Gateway, install it just like any other WordPress plugin. After it is installed and activated, go to Downloads → Settings → Payment Gateways, and enable the gateway:

Next, scroll down to where it says "Stripe Settings". Connect your account using the Connect with Stripe button.

This will take you to the Stripe website where you can log into your existing account if you have one, or create a new account if you do not.

Have questions about connecting with Stripe? See the documentation.

Webhook configuration

The Stripe payment gateway can automatically detect refunded purchases in your Stripe account. When a refund is detected, the corresponding purchase in EDD is also marked as refunded.

To enable automatic refund processing, you must add a new Webhook URL for your site in your Stripe Dashboard → API → Webhooks. The URL should be set to:

Recurring Payments Integration

This payment gateway has complete support for the   Recurring Payments extension. See the Recurring Payments Stripe set up documentation for configuration instructions.

Additional Settings

There are additional settings to configure below.

Billing Address Display

This drop down field will allow you to select which billing details are collected. There are three options:

  • Full address - This will result in a complete address form with street, city, country, state / province, and zip / postal code being displayed.
  • Zip / Postal Code and Country only - This will result in a simplified address form being displayed that asks only for zip / postal code and country.
  • No address fields - This will result in no address fields being displayed.

Taxes note: if you have taxes enabled, only the full address option may be used as those fields are required for accurately calculating taxation amounts.

Fraud note: collecting a full billing address can help reduce fraudulent charges. It is recommended that minimum zip / postal code and country be collected.

Preapprove Only?
Check this if you would like to preapprove payments but not charge until the payment status gets set to "Complete". If you choose this option, Stripe will not charge the customer right away after checkout, and the payment status will be set to "preapproved" in Easy Digital Downloads. You (as the admin) can then manually change the status to "Complete" by going to Dashboard → Downloads → Payment History → Find the payment in question and view it → C hange the status to "Complete" on the side of the screen under "Status". Once you change it to "Complete" the customer will be charged. Note that most typical stores will not need this option.

Stripe Checkout modal deprecation:
If you used Stripe prior to version 2.7, you might have noticed Stripe Checkout is no longer available. Stripe has removed the ability to use the Stripe Checkout modal in this version of their API. In the future we are looking into a solution to reintroduce a ‘checkout-like’ feature that will give you the ability to use a modal once again. See this blog post for more information.

System Requirements

In order for Stripe to work you must have the Multibyte String PHP extension installed on your server.