# Requirements

Please ensure that you meet the following requirements before installing this plugin.

# 1. Install BTCPay for GiveWP Plugin

There are three ways to install the BTCPay for GiveWP plugin:

  1. On left sidebar click Plugins -> Add New.
  2. In Search, type "BTCPay for GiveWP".
  3. Click Install now and then Activate.
BTCPay for GiveWP: Plugin installation

# 1.2 Download and install plugin from GitHub

Alternatively, you can download the plugin from GitHub and install it manually:

  1. Download the latest BTCPay plugin (opens new window).
  2. On WordPress admin dashboard click on Plugins -> Add Plugin.
  3. Click on Upload Plugin button and select the .zip file you just downloaded.
  4. Click Install Now and then Activate.

# 2. Connecting GiveWP and BTCPay Server

BTCPay for GiveWP plugin is a bridge between your BTCPay Server (payment processor) and your donation forms. No matter if you're using a self-hosted or third-party solution, the connection process is identical.

# 2.1 Create API key

On your BTCPay Server instance (ideally on a separate browser tab):

  1. Click on [Account] -> Manage Account on the bottom left
  2. Click on "API Keys"
  3. Click [Generate Key] to select permissions.
  4. Click on the "Select specific stores" link and select the GiveWP store you want to connect - for the following permissions: View invoices, Create invoice, Modify invoices, Modify stores webhooks, View your stores, Create non-approved pull payments (used for refunds (not implemented yet)) BTCPay for GiveWP: API Keys Permissions BTCPay for GiveWP: API Keys Permissions
  5. Click on the [Generate API Key] button in the top right corner.
  6. Copy the generated API Key and Store ID to a safe place. You will need them in the next steps. BTCPay for GiveWP: API Keys Save

# 2.2 Copy Store ID

Still on your BTCPay Server instance:

  1. In the left sidebar, in the stores dropdown, select the store you want to connect to GiveWP.
  2. Still, in the left sidebar, click on [Settings].
  3. You will see the Store ID at the top of the page. BTCPay for GiveWP: Copy Store ID
  4. Copy the Store ID to a safe place. You will need it in the next steps.

# 2.3 Enter API key and store ID in GiveWP settings

Back on your WordPress site:

  1. Go to your WordPress dashboard.

  2. In the sidebar GiveWP -> Settings -> Payment Gateways.

  3. Click on the BTCPay Gateway tab.

  4. Fill in the BTCPay Server URL with your BTCPay Server instance URL (e.g., https://btcpay.example.com).

  5. Copy the store ID to your GiveWP BTCPay Settings

  6. Copy the generated API Key to your GiveWP BTCPay Settings BTCPay for GiveWP: Copy API Key

  7. Click on [Save changes] at the bottom of the page

  8. Make sure you see the notification "_BTCPay for GiveWP: BTCPay Server API credentials verified successfully." and "BTCPay for GiveWP: Webhook created successfully." at the top of the page. BTCPay for GiveWP: Save BTCPay Settings form saved

  9. Now click on the [Gateways] link/tab at the top of the page to return to the gateways overview.

  10. In the gateways overview, you should see the BTCPay Server Gateway listed as an available payment gateway.

  11. Make sure to put a checkmark in the "Enabled" column to enable the BTCPay Server Gateway. You can also make it the default gateway by checking the "Default" column.
    BTCPay for GiveWP: Gateways Overview

Congratulations, you are now ready to accept donations via BTCPay Server on your GiveWP donation forms!

# 3. Testing the donation payment

Making a small test-donation from your store will give you peace of mind. Always make sure that everything is set up correctly before going live.

BTCPay for GiveWP: Test Donation BTCPay for GiveWP: Test Donation payment page BTCPay for GiveWP: Test Donation