NakoPay for WordPress
NakoPay plugin for wordpress
by NakoPay · github.com/nakopayhq/plugin-wordpress · website
Install
The author publishes release zips, so WP-CLI can install straight from GitHub:
wp plugin install https://github.com/nakopayhq/plugin-wordpress/releases/download/v0.1.0/nakopay.zipAccept Bitcoin and other crypto in WordPress with a one-flat-fee, non-custodial checkout. Wallet-to-wallet - NakoPay never holds your funds.
Use this plugin for non-WooCommerce WordPress sites that need pay buttons, donation forms, tip jars, or payment links. If you run a store with cart and checkout flows, install NakoPay for WooCommerce instead.
Requirements
- WordPress 6.0+
- PHP 8.0+
- A NakoPay account (free) and at least one API key from https://nakopay.com/dashboard/api-keys
Download
| # | Source | When to use |
|---|---|---|
| 1 | GitHub Releases zip - https://github.com/NakoPayHQ/plugin-wordpress/releases/latest/download/nakopay.zip | Available today. Download nakopay.zip. |
| 2 | WordPress.org Plugin Directory - search "NakoPay" in your WP admin (Plugins -> Add New) |
Use after the listing is approved. |
| 3 | Build from source | See bottom of this file. |
Install
You only need one of the methods below.
Method A - Upload via WordPress admin (recommended)
- Download
nakopay.zip(do not unzip). - WordPress admin -> Plugins -> Add New -> Upload Plugin.
- Choose the zip, click Install Now, then Activate Plugin.
Method B - WP-CLI
Once approved on wp.org:
wp plugin install nakopay --activate
Or from the zip:
wp plugin install /path/to/nakopay.zip --activate
Method C - SFTP / cPanel File Manager
- Unzip on your computer - you get a folder called
nakopay/. - Upload it to
wp-content/plugins/so the final path iswp-content/plugins/nakopay/nakopay.php. - WordPress admin -> Plugins -> Activate.
Configure
- Get an API key: https://nakopay.com/dashboard/api-keys.
- WordPress admin -> Settings -> NakoPay.
- Paste your API key.
- Copy the Webhook URL the plugin shows you and paste it into your NakoPay dashboard at Settings -> Webhooks -> Add endpoint. Subscribe to
invoice.paid,invoice.completed,invoice.expired. - Paste the signing secret NakoPay shows back into the plugin's Webhook secret field.
- Save.
Use
The plugin adds a shortcode you can drop into any post or page:
[nakopay_button amount="10" currency="USD" label="Tip the author"]
Or render a donation form:
[nakopay_donate currency="USD" suggested="5,10,25,50"]
Full shortcode reference: https://nakopay.com/docs/wordpress.
Verify
Add the shortcode to a draft page, preview it, click the button - you should see a QR + address. Pay with sk_test_* keys to confirm webhooks reach your site.
Test mode
Use sk_test_* keys to run against the NakoPay sandbox. No real funds move. Flip to sk_live_* when ready.
Uninstall
- Plugins -> Installed Plugins -> NakoPay -> Deactivate.
- Click Delete to remove files.
Supported features
- [x] One-time checkout
- [ ] Refunds
- [ ] Subscriptions
- [x] Multi-currency display
- [x] Test mode
Build from source
git clone https://github.com/NakoPayHQ/plugin-wordpress.git
cd plugin-wordpress
zip -r nakopay.zip . -x "*.git*" "tests/*" "*.DS_Store"
Local development
See ../CONTRIBUTING.md. Run bash ../scripts/check-no-internal-urls.sh . before PRs.
Release
plugins/scripts/release.sh wordpress 0.1.0
Workflow at .github/workflows/release-wordpress.yml. Runbook in ../PUBLISHING.md.
Support
- Issues: https://github.com/NakoPayHQ/plugin-wordpress/issues
- Email: support@nakopay.com
About WordPress
WordPress - open-source content management system powering over 40% of the web. Visit their website to learn more about the platform and its features.
License
MIT - see ../LICENSE.
Releases
1 release. Each count is every asset in that release; expand a row for the breakdown.