• Requirements
  • Add your gateway to your Partner account
  • Helpful tips for your logo file

Add a payment gateway to your partners account

Deprecated

Starting April 30, 2022, new users can no longer install your legacy Hosted Payment SDK (HPSDK) integrations. Your new payments app should be launched by this time to ensure that there's no disruption with new user onboarding. Existing users will have until July 31, 2022 to switch to your payments app.

In early May 2022, Shopify will contact impacted users who haven't migrated to the new platform to help them adopt an alternative payments app and avoid payment processing disruptions. After July 31, 2022, all HPSDK integrations will be deprecated.

To learn more about the HPSDK deprecation, and how to migrate to Payments Platform, refer to Hosted Payment SDK overview.

Learn more about the new payments platform.

Adding a gateway to your Shopify Partner's account will prepare you for publishing your gateway integration. Before you can add a gateway to a shop, make sure that the gateway meets the requirements.

Requirements

Anchor link to section titled "Requirements"
  • You've become a Shopify Partner and create a development store
  • You've developed your payment gateway.

Add your gateway to your Partner account

Anchor link to section titled "Add your gateway to your Partner account"

After you have completed the development of your gateway, you can add it to your development store:

  1. Log in to the Partner Dashboard.

  2. Click Gateways:

    Gateways option in the Partner Dashboard sidebar

  3. Click Create gateway.

  4. Fill out the following fields with your gateway's info:

    • Gateway Name - This will appear in the merchant payment settings and on customer checkout pages as a payment option.

- Gateway Website - This URL will be provided to the merchant within the payment settings and will also be used to review your service.

- Gateway Logo - This will appear at checkout at a height of 24 pixels and a maximum width of 220 pixels. Learn more ›

- Gateway Category - This is the category that your gateway will display under within payment settings.

- Redirect URL - The customer will be redirected to this address at checkout. This URL must properly handle the request values that will be sent.

- Login Label - The naming convention used to describe the login credential types for your gateway, such as Username or Account Number.

- Password Label - The naming convention used to describe passwords for this gateway, such as Password or Secret Key.

- Sandbox URL (Optional): - You can send test transactions to this URL.

- Payment Types - These will appear next to your gateway logo at checkout.

- Countries Served - Supported countries in which merchant accounts are available.

Helpful tips for your logo file

Anchor link to section titled "Helpful tips for your logo file"

Your gateway logo will appear at checkout as a payment option:

Example gateway logo in a store checkout

To make sure it looks the as nice as possible, upload a logo that:

  • has a max height of 24 pixels, and max width of 220 pixels

  • is a high-resolution raster (PNG) file format

  • has a transparent background

  • does not rely on small text that is difficult to read at a height of 24 pixels.

Suggested dimensions for a gateway logo

If you have already developed your gateway, you can now bring your gateway live privately or publicly.

On this page

  • Requirements
  • Add your gateway to your Partner account
  • Helpful tips for your logo file