BTCPay Server

# Accept Bitcoin in BigCommerce with BTCPay Server

Introducing BTCPay Server for BigCommerce an open-source payment gateway that enables you accept Bitcoin payments directly on your website or store from customers with no fees.

Our integration with BigCommerce (opens new window) allows you to connect your self-hosted BTCPay Server with your BigCommerce store, enabling you to accept Bitcoin payments seamlessly.

# Why Choose BTCPay for Your BigCommerce Store?

  • No Fees, No Hidden Costs: BTCPay Server empowers your business with a truly fee-free payment solution. Enjoy every cent of your transactions without any deductions
  • Direct payment: Say goodbye to intermediaries and lengthy KYC processes. Receive payments directly to your wallet with complete privacy
  • Automated Payment Processing: BTCPay Server takes care of payments and invoice management automatically.
  • Great Checkout Experience: Enhance customer experience with Bitcoin QR code displays during checkout.
  • Self-hosted infrastructure: With BTCPay Server, you own your payment instances. You also maintain complete control over your payment infrastructure.
  • Easy data exports: Easily export payment data with CSV files, making financial management a breeze.
  • Multilingual ready: Serve a global audience right out of your corner.
  • Community-driven support: Get responsive assistance from our dedicated community (Mattermost (opens new window) or Telegram (opens new window)).

# Prerequisites:

Before diving into the setup process, ensure you have the following:

# Setting up BTCPay Server with BigCommerce

# Install the plugin on BTCPay Server

  1. In your BTCPay instance, navigate to Plugins=> Add New => BigCommerce
  2. Restart BTCPay Server.
  3. If successful, you'd see Bigcommerce included in the plugin section.
image

Click on it, it would display BigCommerce configuration page for BTCPay server where you can configure your credentials and also view your callback Urls.

# Setup the BigCommerce app

  1. Now, you need to create a BigCommerce application. go to devtools.bigcommerce.com (opens new window) and click on Create an app button.
  2. After inputting the name of the application, you'd need to fill more details about the application including the callback urls, permission and scopes, etc. For the callback urls (auth, load, uninstall), you can copy it from your Bigcommerce plugin page on BTCPay Server, and prefill the inputs on your BigCommerce app.
image
  1. There are also required permissions that you will need to grant the BigCommerce application for the integration to be successful. So from the OAuth scopes list, ensure you select the following permissions and their access levels.
    • Orders => Modify
    • Order Transactions => Modify
    • Content => Modify
    • Checkout Content => Modify
    • Carts => Modify
    • Checkouts => Modify
    • Information & Settings => Read-Only
image
image
  1. Go ahead and fill out other information about the application, once completed you can save.
  2. Once your application is included in the app list, click on the "View Client Id" icon of the just created application to get the client Id and secret of the BigCommerce application.
  3. Go back to your BigCommerce plugin on BTCPay server, and update the configuration details with the client Id and secret as copied from the BigCommerce application. Please ensure they are copied properly.

P.S: It is important to note that you cannot assign a BigCommerce application credential to multiple stores on BTCPay Server.

# Install the app to your store and connect

Once you have completed the above steps, it is time to install your BigCommerce application in your store and start receiving payment using Bitcoin.

  1. Login to your BigCommerce (opens new window), Navigate to Apps => MyApps
  2. Select "My Draft Apps", there you would see a list of all your BigCommerce application that you've set up including this newly created application.
  3. Hover on your newly created application and click on "Learn more"
  4. It would take you to a page containing your application details including permissions granted to the application, with a button to install.
image
  1. Click on the install button, acknowledge that PCI-DSS compliance, and confirm the installation.
image
  1. Once the installation is successful, you should see the application listed on the Apps section of your navigation panel.

You manually need to create an offline payment method containing "Bitcoin" (e.g. Bitcoin / Lightning Network) in the BigCommerce store under Settings => Setup => Payments => Additional providers

# Verify script installation

Two more steps to go. First, we need to verify that the checkout script was updated successfully on your store.

  1. Navigate to StoreFront => Script Manager.
  2. Confirm you have a script with the name: btcpay-checkout, with date-installed corresponding to the date at which the app was installed. If you do, you are good to go.
  3. If you dont, kindly verify the permissions granted and retry the installation process.

# Create an offline payment method

Now that we have the checkout scripts uploaded to the BigCommerce application, we need to configure an offline payment method. This is the important for checkout payment.

On your BigCommerce dashboard, navigate to Settings => Setup => Payments => Additional providers

image

From the list of Offline payment method, choose "Money Order" and then click "Set up" button. It would take you to the configuration page for Money Order payment method.

image

We need to change the Display name for this guide. Let's name it "Bitcoin / Lightning Network" or "Bitcoin Payment". You can input the display name of your choice when configuring this, however the name inputted must include the word "bitcoin" so it can be detected by BTCPay Server as shown below

image
image

Once the name has been updated, go ahead and save the changes.

image

Now if you return to the Offline payment method list, we should see Money Order checked.

image

Now you are ready to receive Bitcoin payment from your BigCommerce store.

# How to receive payment:

On the checkout page, after all necessary information has been inputted, the payment screen would be similar to this:

image

From the payment providers listed, select "Bitcoin/Lightning Network".

image

Notice that the button now changes to "Pay with Bitcoin".

To complete the payment, the customer clicks on the the "Pay with Bitcoin" button. The QR code would pop on the screen with an option to pay directly through the customer's wallet.

image

Once the payment is complete and confirmed, an invoice is then successfully created on the merchant BTCPay instance as well as the payment.

# Big Commerce Uninstall

Once you uninstall the application, the client Id and the client secret is also deleted from the store and can be reused by another store, or the same store with a new application. So if you uninstalled, and you want to still use the same store, go back to your BTCPay instance and save the clientId and secret.

← Drupal →