btcpay-greenfield-for-woocommerce
Last commit date
.wordpress-org
4 years ago
assets
2 years ago
languages
2 years ago
resources
2 years ago
src
2 years ago
updates
3 years ago
vendor
2 years ago
btcpay-greenfield-for-woocommerce.php
2 years ago
changelog.txt
2 years ago
license.txt
4 years ago
readme.txt
2 years ago
readme.txt
156 lines
| 1 | === BTCPay for WooCommerce V2 === |
| 2 | Contributors: ndeet, kukks, nicolasdorier |
| 3 | Donate link: https://btcpayserver.org/donate/ |
| 4 | Tags: bitcoin, btcpay, BTCPay Server, btcpayserver, WooCommerce, payment gateway, accept bitcoin, bitcoin plugin, bitcoin payment processor, bitcoin e-commerce, Lightning Network, Litecoin, cryptocurrency |
| 5 | Requires at least: 5.2 |
| 6 | Tested up to: 6.4 |
| 7 | Requires PHP: 7.4 |
| 8 | Stable tag: 2.4.0 |
| 9 | License: MIT |
| 10 | License URI: https://github.com/btcpayserver/woocommerce-greenfield-plugin/blob/master/license.txt |
| 11 | |
| 12 | BTCPay Server is a free and open-source bitcoin payment processor which allows you to receive payments in Bitcoin and altcoins directly, with no fees, transaction cost or a middleman. |
| 13 | |
| 14 | == Description == |
| 15 | |
| 16 | = Accept Bitcoin payments in your WooCommerce powered WordPress site with BTCPay Server = |
| 17 | |
| 18 | BTCPay Server for WooCommerce is a revolutionary, self-hosted, open-source payment gateway to accept Bitcoin payments. Our** seamless integration** with WooCommerce allows you to connect your self-hosted [BTCPay Server](https://btcpayserver.org) and start accepting Bitcoin payments in **just a few simple steps**. |
| 19 | |
| 20 | = Features: = |
| 21 | |
| 22 | * **Zero fees**: Enjoy a payment gateway with no fees. Yes, really! |
| 23 | * **Fully automated system**: BTCPay takes care of payments, invoice management and refunds automatically. |
| 24 | * **Display Bitcoin QR code at checkout**: Enhance customer experience with an easy and secure payment option. |
| 25 | * **No middlemen or KYC**: |
| 26 | * Direct, P2P payments (going directly to your wallet) |
| 27 | * Say goodbye to intermediaries and tedious paperwork |
| 28 | * Transaction information is only shared between you and your customer |
| 29 | * **Self-hosted infrastructure**: Maintain full control over your payment gateway. |
| 30 | * **Direct wallet payments**: Be your own bank with a self-custodial service. |
| 31 | * **Lightning Network** integrated out of the box - instant, fast and low cost payments and payouts |
| 32 | * **Reporting and accounting** - CSV exports |
| 33 | * **Advanced invoice managemen**t and refunding integrated in the WooCommerce UI |
| 34 | * **Real-time exchange price tracking **for correct payment amounts |
| 35 | * **Versatile plugin system**: |
| 36 | * Extend functionality according to your needs |
| 37 | * Accept payments in altcoins through various plugins |
| 38 | * **Elegant checkout design**: Compatible with all Bitcoin wallets and enhanced with your store's logo and branding for a unique UX. |
| 39 | * **Point-of-sale** integration - Accept payments in your physical shops |
| 40 | * **Multilingual ready**: Serve a global audience right out of the box. |
| 41 | * **Top-notch privacy and security**: Protect your and your customers' data. |
| 42 | * **Community-driven support**: Get responsive assistance from our dedicated community ([Mattermost](http://chat.btcpayserver.org) or [Telegram](https://t.me/btcpayserver)). |
| 43 | * Extensive [documentation](https://docs.btcpayserver.org/WooCommerce) and [video](https://www.youtube.com/c/btcpayserver) tutorials |
| 44 | |
| 45 | The non-profit [BTCPay Server Foundation ](https://foundation.btcpayserver.org)is committed to keeping this powerful payment gateway free forever. Our mission is to enable anyone to accept bitcoin regardless of financial, technical, social or political barriers. |
| 46 | |
| 47 | |
| 48 | == Installation == |
| 49 | |
| 50 | This plugin requires WooCommerce. Please make sure you have WooCommerce installed. |
| 51 | |
| 52 | <img src="https://github.com/btcpayserver/btcpayserver-doc/blob/master/img/BTCPayWooCommerceInfoggraphic.png" alt="Infographic" /> |
| 53 | |
| 54 | To integrate BTCPay Server into an existing WooCommerce store, follow the steps below or check our official [installation instructions](https://docs.btcpayserver.org/WooCommerce/). |
| 55 | |
| 56 | ### 1. Deploy BTCPay Server (optional) ### |
| 57 | |
| 58 | This step is optional, if you already have a BTCPay Server instance setup you can skip to section 2. below. To launch your BTCPay server, you can self-host it, or use a third party host. |
| 59 | |
| 60 | #### 1.1 Self-hosted BTCPay #### |
| 61 | |
| 62 | There are various ways to [launch a self-hosted BTCPay](https://github.com/btcpayserver/btcpayserver-doc#deployment). If you do not have technical knowledge, use the [web-wizard method](https://launchbtcpay.lunanode.com) and follow the video below. |
| 63 | |
| 64 | https://www.youtube.com/watch?v=NjslXYvp8bk |
| 65 | |
| 66 | For the self-hosted solutions, you will have to wait for your node to sync fully before proceeding to step 3. |
| 67 | |
| 68 | #### 1.2 Third-party host #### |
| 69 | |
| 70 | Those who want to test BTCPay out, or are okay with the limitations of a third-party hosting (dependency and privacy, as well as lack of some features) can use a one of many [third-party hosts](ThirdPartyHosting.md). |
| 71 | |
| 72 | The video below shows you how to connect your store to such a host. |
| 73 | |
| 74 | https://www.youtube.com/watch?v=IT2K8It3S3o |
| 75 | |
| 76 | ### 2. Install BTCPay WooCommerce Plugin ### |
| 77 | |
| 78 | BTCPay WooCommerce plugin is a bridge between your BTCPay Server (payment processor) and your e-commerce store. No matter if you are using a self-hosted or third-party solution from step 1., the connection process is identical. |
| 79 | |
| 80 | You can find detailed installation instructions on our [WooCommerce documentation](https://docs.btcpayserver.org/WooCommerce/). |
| 81 | |
| 82 | Here is a quick walk through if you prefer a video: |
| 83 | |
| 84 | https://www.youtube.com/watch?v=ULcocDKZ1Mw |
| 85 | |
| 86 | ### 3. Connecting your wallet ### |
| 87 | |
| 88 | No matter if you're using self-hosted or server hosted by a third-party, the process of configuring your wallet is the same. |
| 89 | |
| 90 | https://www.youtube.com/watch?v=xX6LyQej0NQ |
| 91 | |
| 92 | ### 4. Testing the checkout ### |
| 93 | |
| 94 | Making a small test-purchase from your own store, will give you a piece of mind. Always make sure that everything is set up correctly before going live. The final video, guides you through the steps of setting a gap limit in your Electrum wallet and testing the checkout process. |
| 95 | |
| 96 | https://www.youtube.com/watch?v=Fi3pYpzGmmo |
| 97 | |
| 98 | Depending on your business model and store settings, you may want to fine tune [your order statuses](https://docs.btcpayserver.org/WooCommerce/#41-global-settings). |
| 99 | |
| 100 | == Frequently Asked Questions == |
| 101 | |
| 102 | You'll find extensive documentation and answers to many of your questions on [BTCPay for WooCommerce V2 docs](https://docs.btcpayserver.org/WooCommerce) and on [BTCPay for WooCommerce integrations FAQ](https://docs.btcpayserver.org/FAQ/Integrations/#woocommerce-faq). |
| 103 | |
| 104 | == Screenshots == |
| 105 | |
| 106 | 1. The BTCPay Server invoice. Your customers will see this at the checkout. They can pay from their wallet by scanning a QR or copy/pasting it manually into the wallet. |
| 107 | 2. Customizable plugin interface allows store owners to adjust store statuses according to their needs. |
| 108 | 3. Customer will see the pay with Bitcoin button at the checkout.Text can be customized. |
| 109 | 4. Example of successfully paid invoice. |
| 110 | 5. Example of an easy-embeddable HTML donation payment button. |
| 111 | 6. Example of the PoS app you can launch. |
| 112 | |
| 113 | == Upgrade Notice == |
| 114 | = 2.4.0 = |
| 115 | * New feature: Add basic support for [WooCommerce cart and checkout blocks](https://woo.com/document/cart-checkout-blocks-status/). |
| 116 | |
| 117 | == Changelog == |
| 118 | |
| 119 | = 2.4.0 :: 2023-12-12 = |
| 120 | * Fix: Avoid error on InvoiceProcessing/InvoiceSettled event in case of paidOver property is missing. |
| 121 | * New feature: Add basic support for WooCommerce cart and checkout blocks. |
| 122 | Note: Works for default configuration; future versions will make it work with modal checkout and separate payment gateways too. |
| 123 | |
| 124 | = 2.3.1 :: 2023-10-20 = |
| 125 | * Fix: Ensure refunds text does not exceed API field limit. |
| 126 | |
| 127 | = 2.3.0 :: 2023-09-06 = |
| 128 | * Support for high performance order storage (HPOS) |
| 129 | |
| 130 | Note: This is opt-in but brings performance improvements. Follow instructions [here](https://github.com/woocommerce/woocommerce/wiki/High-Performance-Order-Storage-Upgrade-Recipe-Book#how-to-enable-hpos) if you want to use it. |
| 131 | |
| 132 | = 2.2.3 :: 2023-08-22 = |
| 133 | * Automatically create webhook after redirect. |
| 134 | |
| 135 | = 2.2.2 :: 2023-08-22 = |
| 136 | * Fix edgecase JS error on payment method selection. |
| 137 | |
| 138 | = 2.2.1 :: 2023-08-17 = |
| 139 | * Add tooltip with webhook callback information |
| 140 | |
| 141 | = 2.2.0 :: 2023-08-17 = |
| 142 | * Refactor settings UI and allow manual webhook secret entry. This allows 3rd party integrators limit their API keys scope and not include the webhook permission. |
| 143 | |
| 144 | = 2.1.0 :: 2023-04-03 = |
| 145 | * New feature: Modal / Overlay checkout mode (no redirect to BTCPay Server) |
| 146 | |
| 147 | = 2.0.0 :: 2023-03-20 = |
| 148 | * New feature: Add support for refunds. |
| 149 | |
| 150 | Note: If you are upgrading from a version < 2.0 and you want to use refunds (via pull payments) you need to create a new API key with the "Create non-approved pull payments" which is available from BTCPay Server version 1.7.6. |
| 151 | See this link for more information: https://docs.btcpayserver.org/WooCommerce/#create-a-new-api-key |
| 152 | |
| 153 | If you do NOT use refunds. You do NOT need to do anything, your existing API key and setup will continue to work as before. |
| 154 | |
| 155 | Changelog of older releases can be found [here](https://github.com/btcpayserver/woocommerce-greenfield-plugin/blob/master/changelog.txt) |
| 156 |