BTCPay

Overview

The Gravity Forms BTCPay Add-On connects a form to a BTCPay Server store so you can accept one-time Bitcoin and Litecoin payments. Use a server you host yourself or one hosted for you. The add-on creates the invoice and sends the customer to the BTCPay checkout. BTCPay handles addresses and payment confirmation, and the funds settle in the wallet configured on that store.

A payment feed sets the amount and the methods offered for that form. Choose from the methods already enabled on the store, such as Lightning, on-chain Bitcoin, LNURL, and Litecoin. You can also map buyer details and optional invoice metadata, including an order ID, a comment, and the receipt title and description shown on the BTCPay receipt.

After the customer pays, BTCPay notifies the site and the entry is updated. Statuses include Pending, Confirming, Partially Paid, Paid, Failed, and Cancelled, so the original submission and the payment stay together in Gravity Forms.

Key Benefits

• Accept one-time Bitcoin and Litecoin payments on any form with pricing
• Send customers to a BTCPay Server checkout
• Keep funds in the wallet configured on your BTCPay store
• Connect with a store-scoped API key, without sharing a seed or private key
• Offer Lightning, on-chain Bitcoin, LNURL, and Litecoin when those methods are enabled on the store
• Charge a form total or another mapped payment amount
• Map buyer name, email, phone, and address to the invoice
• Map an order ID, comment, receipt title, and receipt description
• Update the entry as the payment moves through Pending, Confirming, Partially Paid, Paid, Failed, or Cancelled
• Use conditional logic to control when the payment feed runs

How It Works

In WordPress, open Forms → Settings → BTCPay. Enter your BTCPay Server URL and choose Connect with BTCPay Server. Approve the API key for the store you want to use. The add-on registers a webhook and shows the server, store, API connection, and webhook status.

Turn on the payment methods this site should offer. Only methods enabled on the BTCPay store can be selected here.

Edit a form that has a product and a total, then add a BTCPay feed. Under Payment Settings, set the payment amount and choose which methods this feed accepts. Optionally map billing information and invoice metadata. Order ID defaults to the entry ID when left unmapped.

When the form is submitted, the add-on creates a BTCPay invoice and redirects the customer to checkout. BTCPay sends the result back to the site, and the entry payment status is updated to match.