API Reference

Our reference library for integrating with our API


Find answers to our most frequently asked questions

Classic Docs

Documentation for our Classic API


The payment gateway is fully integrated with Shopify. If you're already using Shopify, you can start accepting payments through our gateway by configuring a few simple settings.

Onsite or offsite options

You can accept payments through our gateway either onsite, where your customer enters their payment details on your website, or offsite, where they will be redirected to a page to do so.

The onsite option is available by default – you simply have to select it from your Shopify configuration menu.

If you want to use the offsite option, follow the instructions below.

Onsite: alternative payment methods

The onsite option does not currently support alternative payment methods.

Onsite: card payments

If you want to process card payments with the onsite option, please contact our Support team at so we can enable them on your account.

Installation instructions (offsite option)

Shopify admin

  1. Log in to your Shopify admin.
  2. After logging in, you should see an Add payment gateway message. Click Add payment gateway.
  3. Enter your public and secret API keys – you'll find these in the Hub – and select the payment methods permitted for your account (Visa, MasterCard, Amex, etc.).
  4. After completing the form, click Activate.

The Hub

  1. Log in to your Hub account.
  2. Go to SettingsChannels.
  3. Enter the relevant redirection URLs for your environment:

    Redirection success
    Redirection fail
    Redirection success
    Redirection fail
  4. Scroll down to Webhooks and click New webhook.

  5. Enter the relevant URL for your environment:

    Webhook endpoint URL
    Webhook endpoint URL
  6. Select API - v1.0.
  7. Tick Select all, then click Create webhook.

You've successfully set up the offsite option on your Shopify account! If you're having any problems or just have a question, please contact our Support team for help.

The customer experience

Onsite option

Your customers can enter their payment details on your checkout page, like so:

Offsite option

Once you've activated it, your customers should see as a payment method on the checkout page. It looks like this:

After the customer clicks Complete Order, they will be redirected to our hosted JS page:

From here, the customer can enter their payment details securely and complete their order.