Skip to content

Shopify

Offer your platform in Shopify checkouts: set up your Shopify payments apps once, then let merchants install them.

Merchants on Shopify connect to your platform with a Shopify payments app in your brand. The app is an offsite payment method: at checkout, Shopify sends the customer to your platform to pay, and back to the shop when the payment is done. Ginger runs the app for your platform; you publish it in Shopify under your own Shopify Partner account.

This page shows how you set up the apps of your platform once, and how a merchant installs one.

How it works

Your platform's main app, offsite, shows as one payment option in the Shopify checkout, with the payment methods you choose for it. With one payment method, the customer goes straight to the payment page of that method. With more than one, the customer chooses on the hosted payment page.

To show a payment method as its own option in the checkout, you can publish an extra app for it. Ask your Ginger contact which payment methods can have their own app.

  • Capture: when the shop authorises payments, the merchant captures from Shopify, once per order.
  • Void: the merchant voids the whole authorisation, before any capture.
  • Refund: the merchant refunds from Shopify, in full or in parts, after the payment is completed.

Set up your platform

You do this once, with Shopify and your Ginger contact.

Become a Shopify Payments Partner

Only approved Payments Partners can publish payments apps in Shopify. Create a Shopify Partner account for your company and apply as a Payments Partner. Shopify reviews you and your apps before you can publish them, which takes several weeks. See Payments apps, the requirements and the review process in Shopify's docs.

Ask Ginger to run the app for your platform

Ask your Ginger contact to set up the Shopify app for your platform. Ginger runs it under your domain, and gives you the URLs to enter in Shopify. Ginger also switches on Plugins in your Admin portal.

Create the apps in Shopify

In the Shopify Partner Dashboard, create an app for each payment option you offer, such as one for cards and one for Swish. Give each app the access scopes write_payment_gateways and write_payment_sessions, and enter the URLs from Ginger. Note the client ID and the client secret of each app.

Configure the apps in the Admin portal

  1. In the Admin portal, go to Platform › Plugins and open the Shopify tab.
  2. Click Add Plugin and choose the app, such as offsite.
  3. Set the Status to enabled, and choose the payment methods of the app.
  4. Under Secrets, enter the client ID and the client secret of the Shopify app, and save.

Changes take up to 5 minutes. When you disable an app, its payments stop, and merchants can't install it.

Connect a merchant

  1. The merchant installs your app in its Shopify store, from the link you share or from Shopify's list of payment providers.
  2. After the installation, the app asks for the merchant's Merchant ID and the API key of its project on your platform. The merchant enters them and saves.
  3. Shopify opens the payment settings of the store, where the merchant activates your app.

Give the merchant the API key of its test project first. When the test payments work, the merchant replaces it with the API key of the live project. The app doesn't check the key when the merchant saves it: a wrong key shows up at the first payment.

Test

Test with a Shopify development store and the API key of a test project (status active-testing). Place an order in the store, pay with a test card on your platform's payment page, and check that Shopify marks the order paid. Then test a refund from Shopify.

Next steps

  • Plugins: the other plugins, and how you support merchants who use them.