Last update: 2022/03/18

This guide walks you step-by-step through the integration of COINQVEST with Shopify and explains how to create a custom app and configure the payment settings.

Key Features of the COINQVEST integration with Shopify

• Accepts Bitcoin (BTC), Ethereum (ETH), Ripple (XRP), Stellar Lumens (XLM) and Litecoin (LTC) payments from customers
• Instantly settles in your preferred national currency (USD, EUR, NGN, BRL)
• Integrates seamlessly into Shopify - Upon order confirmation, sends an email to the user containing a link to pay the order securely via the COINQVEST checkout page
• Automatically updates paid orders to paid
• Sets the product price in your national currency
• Eliminates chargebacks and gives you control over refunds
• Eliminates currency volatility risks due to instant conversions and settlement
• Ensures tax compliance
• Automatically generates invoices

Screenshot of the Shopify checkout page with COINQVEST payment method selected:

Required Steps:

1. Create a custom app
2. Create a webhook
3. Create the COINQVEST payment option
4. Customize the checkout order page
5. Enter Shopify API credentials into your COINQVEST account

Step 1: Create a custom app

A custom app that is created in the Shopify admin and installed on a single Shopify store. Shopify Plus service partners can install the same custom app on multiple Plus stores for a single Shopify Plus merchant. Find more details here.

1. Enable custom app development from the Shopify admin (if you haven't done it yet)

Before you can create a custom app for your store, you need to enable custom app development. Only the store owner can enable custom app development.

• From your Shopify admin, go to Apps
• Click Develop apps
• Click Allow custom app development
• Read the warning and information provided, and then click Allow custom app development

2. Create the COINQVEST custom app

• From your Shopify admin, go to Apps
• Click Develop apps
• Click Create a custom app
• In the modal window, enter the App name (COINQVEST) and select an App developer. The app developer can be the store owner, or any staff or collaborator account with the Develop apps permission
• Click Create app

3. Select API Scopes

• Click Button Configure Admin API scopes
• Scroll down to section Orders and activate write_orders and read_orders
• At the bottom of the page, in section Webhook subscriptions, choose Latest from the dropdown menu
• Click Save
• Click Install app

4. Collect API access token

• In tab API credentials, click on Reveal token once and save it in a secure place

Step 2: Create a webhook

• In your Shopify account, go to Settings -> Notifications
• Scroll to bottom of page and find section Webhooks
• Click Create webhook
• Choose the following parameters in the popup window:
  • Event: Order creation
  • Format: JSON
  • URL: https://www.coinqvest.com/api/v1/shopify-order
  • Webhook API version: Choose 'Latest'
• Click Save webhook

Step 3: Create the COINQVEST payment method

• In your Shopify account, go to Settings -> Payments
• Scroll down in the list of payment providers to section Manual payment methods
• Click on dropdown menu Manual payment methods and choose Create custom payment method
• Enter the fields in the popup window as follows:
  • Custom payment method name:
    Enter COINQVEST or Bitcoin via COINQVEST.
    (Important!: You can customize the name to your liking, but it must include COINQVEST otherwise we will not be able to capture payments). Also, Bitcoin via COINQVEST will be easier to understand for your clients than just COINQVEST.
  • Additional details: Enter a short description for COINQVEST payment method, for example:
    Pay with Bitcoin and other digital currencies (ETH, LTC, XLM, XRP) via COINQVEST
  • Payment instructions: These instructions appear on the order confirmation page and should inform shoppers that they will receive an email to make the payment and finalize the order. Example:
    Check your email inbox now, you will receive instructions to pay this order securely via the COINQVEST checkout page.
• Click Activate

Step 4: Customize the checkout order page

• In your Shopify account, go to Settings -> Checkout
• Scroll to bottom of page and find section Order status page scripts
• Copy the following Liquid snippet into the textarea:

  <script>
    {% assign gateway = checkout.transactions[0].gateway | downcase %}
    {% if gateway contains 'coinqvest' %}
    Shopify.Checkout.OrderStatus.addContentBox(`
      <div class="text-container">
          <h2 style="font-weight:bold;color:red">Payment Instructions</h2>
          <p>Check your email inbox now, you will receive instructions from <strong>COINQVEST // Service</strong> how to pay this order securely with cryptocurrencies.</p>
          <p>Powered by <img src="https://www.coinqvest.com/images/logo-140-17-white-bg@2x.png" width="100px"></p>
      </div>`)
    {% endif %}
  </script>

• Click Save

Step 5: Enter Shopify API credentials into your COINQVEST merchant account

• Log into your COINQVEST merchant account and navigate to the Shopify API settings page
• Enter the fields as follows (see screenshot above):
  • Shopify Store URL: Enter your store URL, must be in format https://{your-store-name}.myshopify.com
  • Access Token: Enter the API access token you retrieved in step 1 of this guide
  • Webhook Signing Key: Go to Settings -> Notifications and scroll down to the bottom of the page. In the Webhook section you will find the key, highlighted in yellow (see bottom left screenshot in the image above).
• Settlement Currency: The currency that the crypto payments get converted to. Choose ORIGIN if you want to be credited in the crypto currency your customer paid with.
• Checkout Page Display Currency: Only required if you choose ORIGIN as settlement currency.
• Checkout Page Language: The language that the checkout page where your customer pays gets displayed in. Choose "auto" to automatically detect the users language.
• Click Submit

That's it! Now make a test purchase to verify that everything is set up properly.

The Merchant Account on COINQVEST

Manage all payments and customers in your merchant account. You are notified by email about every new transaction.

We Love to Help!

If you have questions, feedback, or improvement suggestions, please feel free to contact us directly anytime.