Documentation

WooPay Merchant Documentation

WooPay is a new express checkout solution by WooCommerce. With WooPay, customers can save payment methods for use across any WooCommerce store that uses WooPay. When a customer with a WooPay account visits your store, they can use WooPay to check out securely with just a few clicks, making your checkout experience easier.

NOTE: This document is for merchants who want to offer WooPay as a payment option on their site. If you’re a customer of a site that uses WooPay, please see our customer documentation or contact support by logging into your WooPay account. From there, click the question mark icon in the header and then select Contact Support.

Requirements

↑ Back to top

WooPay is currently in public beta for U.S. merchants only. To enable it on your store, your site will need to meet the following requirements:

PHP 7.0+
WordPress 5.9+
WooCommerce 7.4+
WooPayments 5.8.1+

Enabling WooPay

↑ Back to top

To enable WooPay if you are eligible:

Go to Payments > Settings in your site’s admin dashboard.
Scroll down to to the Express checkouts section.
Check the box to enable WooPay.
Click the Save changes button at the bottom of the page.

NOTE: WooPay and Link by Stripe are currently incompatible. You cannot have both express checkout methods enabled at the same time.

Disabling WooPay

↑ Back to top

To disable WooPay, simply go back to the Payments > Settings page, uncheck the WooPay box, and click Save Changes at the bottom of the page.

Customizing

↑ Back to top

To customize WooPay and change the settings:

Go to Payments > Settings in your site’s admin dashboard.
Scroll down to to the Express checkouts section.
Click the Customize link inside the WooPay box.

At the top of that page, you choose whether to enable or disable WooPay, as well as customize where the WooPay express checkout button is shown.

Checkout appearance

↑ Back to top

In the Checkout appearance section, you can add a store logo and some custom text, which will be shown during WooPay checkout. If you do not provide a logo, we will use the one you have picked under Appearance > Customize > Site Identity.

These will display like so during WooPay checkout:

In the Policies and custom text field, you can use the following shortcodes to automatically insert certain links:

[privacy_policy_link] will insert a link to your site’s privacy policy page, if you have one. This is configured under Settings > Privacy.
[terms_of_service_link] will insert a link to your site’s terms of service page, if you have one set under WooCommerce > Settings > Advanced.

If one or both of those pages are not set, the shortcode will simply return the words “Privacy Policy” or “Terms of Service”, respectively.

Settings

↑ Back to top

In the Settings section, you can configure the display options of the WooPay buttons.

The Call to action option determines what text is shown in the WooPay button itself: icon only, “Buy with WooPay”, “Donate with WooPay”, or “Book with WooPay”. You can change this as needed to suit the types of products you sell.
The Button Size option determines how large the WooPay button will be. Note that larger sizes are more suitable for mobile use.
The Theme option can be used to adjust the foreground and background colors of the WooPay button. If your site’s background is white or light-colored, use the Dark theme. Conversely, if your site’s background is darker, use the Light theme.

Keep in mind that, as noted at the top of this section, changing these settings will also change the same settings for your Apple Pay and Google Pay buttons, if you are also using those. This is done to maintain visual consistency between the various buttons.

Testing

↑ Back to top

You can test the WooPay customer experience using WooPayMerchantDemo.com along with the customer-facing documentation. Note that the demo site is in test mode of course, so you must use a test card, and no real charges will be placed.

If you want to test WooPay on your own site, you can do so by following these steps:

Enable test mode in the WooPayments settings.
Open your site in a private / “incognito” browser window.
Add a product to your cart and go to the checkout page.
Enter a test email address that has not been used for WooPay before.
- You can make a test email address easily with most mail providers. For example, if you use Gmail, you can simply add a + sign and any text after that, so your test email address might be myname+woopaytest@gmail.com. Mail to that address will still be delivered to myname@gmail.com, but WooPay will treat it as a new account.
Fill out the checkout form using test card information, being sure to sign up for WooPay using a phone number you can receive text messages with.
After checking out, a WooPay account will be created for you with your test email.
Close your private / “incognito” browser window.
Open a new private / “incognito” window to test purchasing with an existing account.
Add a product to your cart and go to the checkout page.
Entering the same test email will trigger WooPay to send you a verification code.
You will be taken to the WooPay site to check out as shown in the customer doc. There will be a banner at the top indicating that it’s in test mode.

Completing the checkout will result in the test order being placed on your site.

Compatibility

↑ Back to top

After testing with various WooCommerce settings, as well as the most popular extensions we offer on WooCommerce.com, we’ve created the following compatibility lists. As new extensions are tested and more extensions become compatible, they’ll be added here.

Any extensions that are not listed here remain untested at the current time. We encourage merchants to test their favorite extensions for compatibility and let us know using the question mark icon at the top of this page.

Incompatible settings

↑ Back to top

The WooPay button will not be shown when:

The order contains WooCommerce Subscriptions products.
The “Allow customers to place orders without an account” setting is enabled.

Compatible extensions

↑ Back to top

Incompatible extensions

↑ Back to top

Our list of incompatible extensions includes:

Affiliate For WooCommerce
AutomateWoo – Refer A Friend add-on
Checkout Field Editor
Donation For WooCommerce
Dynamic Pricing
EU VAT Number
Gifting for WooCommerce Subscriptions
Gravity Forms Product Add-ons
Local Pickup Plus
Mix and Match Products
Order Delivery for WooCommerce
PDF Product Vouchers
Product Bundles
Shipping Multiple Addresses
Smart Coupons
Table Rate Shipping
Teams for WooCommerce Memberships
WooCommerce Bookings
WooCommerce Checkout Add-Ons
WooCommerce Multi-Currency

If WooPayments detects that you have an incompatible extension active, we will flag this for your under Payments > Settings.

Frequently asked questions

↑ Back to top

I don’t see the option to enable WooPay

↑ Back to top

WooPay is currently only available for U.S. merchants.

Is WooPayments required to use WooPay?

↑ Back to top

WooPay is currently only available as an express payment method as part of WooPayments. Thus, you will need to have WooPayments installed and running on your site in order to offer WooPay to your customers.

Is Jetpack required to use WooPay?

↑ Back to top

You do not need to have the Jetpack plugin installed to use WooPay.

What’s the difference between this and WooPayments?

↑ Back to top

WooPayments is a WooCommerce payment gateway, which allows you to accept credit and debit cards as well as access a dashboard for managing transactions.

WooPay is a new feature of the WooPayments gateway. Specifically, it is an express checkout method available to merchants who opt in to enabling it. You can set up WooPay in your WooPayments settings.

Will my customers be required to use WooPay?

↑ Back to top

No. Customers will have the choice to check out using WooPay or using your store’s standard checkout process.

What information is available to me about customers?

↑ Back to top

Details about the customer and the customer’s order are still available through the order details page under WooCommerce > Orders. Information such as the customer’s name, billing and shipping address, contact information, and order details are all still available.

How do I get paid when a customer uses WooPay?

↑ Back to top

WooPay is part of the WooPayments gateway, so you will be paid according to the WooPayments deposit schedule.

How does WooPay handle subscription products?

↑ Back to top

If you use WooPay to purchase a subscription product, WooPay is only involved in the initial order. After that, all renewal orders are handled by the merchant’s website, not by WooPay.

If you wish to cancel your subscription, change your payment method, or perform an early renewal, you will need to do so on the merchant’s site. Deleting the subscription payment method from WooPay will not cancel the subscription.

How do I opt out or disable WooPay?

↑ Back to top

To disable WooPay, simply go back to the Payments > Settings page, uncheck the WooPay box, and click Save Changes at the bottom of the page.

If a customer has trouble with WooPay, where can they get help?

↑ Back to top

If a customer of yours is experiencing a problem paying with WooPay on your site, please refer them to our customer documentation.

30-day money-back guarantee

Support teams across the world

Safe and secure online payment