Coinsnap for GetPaid Installation Guide

These requirements must be met for Coinsnap for GetPaid to function correctly:

WordPress, Getpaid et.al.

• A self-hosted WordPress website
• GetPaid installed and activated
• at least one of these plugins installed and activated: Gravity Forms, AffiliateWP, Contact Form 7, WPForms, Ninja Forms, GeoDirectory, Sliced Invoices, Sprout Invoices, WP-Invoice or any other plugin that GetPaid can be integrated with.

Coinsnap & Payments

• An active Coinsnap account
  -> how to set up a Coinsnap account
• A connected Bitcoin Lightning wallet (self-custodial wallet or BTCPay Server)
  -> how to get a Lightning address
• The installed Coinsnap for GetPaid plugin
  -> How to install the plugin and connect it with your Coinsnap account or your BTCPay Server

Server & Access

• Ability to install and activate WordPress plugins
• HTTPS (SSL) enabled on the website

GetPaid Setup

• At least one GetPaid payment form created

All the requirements listed above are met, and you have successfully installed the plugin in your WordPress.
If not, here is a Step-by-step: How to install a Coinsnap plugin in WordPress guide to help you install the plugin.

You will soon be able to accept Bitcoin payments (on-chain and Lightning) directly with GetPaid payment forms —
without the need for a complex shop system like WooCommerce or traditional payment providers such as credit cards or PayPal.

But before you can do that, you need to configure Bitcoin payments in your GetPaid plugin.

GETPAID COINSNAP SETTINGS

After installing Coinsnap for GetPaid, you need to link the plugin to your GetPaid plugin and your Coinsnap account so that your Bitcoin sales are credited to your Lightning wallet.

Open GetPaid [1] in the left menu and click Settings [2].

Go to the Payment Gateways tab [3] and select Coinsnap [4] from the list of available payment gateways. Then click Manage [5] to configure the settings.

You will now see this:

You must now configure the following parameters for the Coinsnap payment gateway in GetPaid: Activate, Checkout Title, Checkout Description, Priority, Payment Provider, Store ID, API Key, Redirect after payment, Return URL after payment, Expired Status, Settled Status and Processing Status. 

We will show you know, step by step, how to do this.

1. Activate

This box must be checked to enable Bitcoin and Lightning payments in GetPaid.

2. Checkout Title

Here you can define the name of the Bitcoin Lightning payment method shown to customers at checkout.

3. Checkout Description

Here you can customize the short explanatory text shown below the payment method at checkout.

4. Priority

Here you can determine the position at which the Bitcoin and Lightning payment method appears among the available payment options.

5. Payment Provider

You now need to choose between two payment gateways: Coinsnap or your own BTCPay Server.

Connect your plugin to your chosen payment provider (Store ID and API Key)

After making your selection, enter the corresponding Store ID and API Key for either Coinsnap or BTCPay Server. The following steps explain how to do this.

Coinsnap

Coinsnap is the easiest option. Coinsnap handles the technical setup for you and connects your store to Bitcoin and Lightning payments with just a few clicks. It’s ideal if you want a quick, hassle-free solution without managing your own payment infrastructure.

Just enter your Coinsnap Store ID and API Key.

Learn here how to retrieve your Coinsnap Store ID and API Key:

-> Step-by-step explanation: How to connect your Coinsnap account with your plugin

BTCPay Server

BTCPay Server is a self-hosted option for merchants who want full control. You run your own Bitcoin and Lightning payment server, manage your own wallets, and don’t rely on a third party. This option offers maximum independence but requires more technical setup and maintenance.

First, enter your BTCPay Server URL. Then enter the corresponding BTCPay Server Store ID and API Key.

Learn how to retrieve your Store ID and API Key using our BTCPay Server wizard here:

-> Step-by-step explanation: How to connect your BTCPay Server with your plugin 

6. Redirect after payment / Return after payment

Here you define what happens after a successful payment. If Redirect after payment is enabled, the customer will be redirected back to the page containing the form from which the payment was made.

If you prefer to use a custom thank-you page, create the page and enter its URL in the Return URL after payment field.

7. Map the Coinsnap/GetPaid  payment statuses

GetPaid tracks the status of each payment associated with a form submission. These statuses indicate whether a payment is Pending payment, Paid, Processing, On hold, Cancelled, Refunded, Failed, Renewal Payment, Draft, orTrash, and help you understand the current state of each transaction.

The Coinsnap Bitcoin payment plugin only tracks three payment statuses — Expired, Settled, and Processing. You now need to map each of these to the corresponding status option available in GetPaid.

We strongly recommend keeping the default payment status mapping (see image below), as it provides the most reliable and consistent behavior in almost all cases; selecting an alternative option from the dropdown should only be done in very specific, exceptional circumstances.

DONE

Save these settings by clicking the button below, and your GetPaid will be ready to accept Bitcoin payments (on-chain and Lightning).

Once you have configured everything, you should perform a test transaction.

Click a payment button (from GetPaid) on your website. You will see a pop-up like this:

After selecting your price and clicking Pay now with Bitcoin, a QR code will be displayed.

Scan the QR code with your Lightning wallet and authorize the payment.

Once the payment has been completed, you will see a payment confirmation.