Shopify (WestpayAPI)

Last updated: October 30, 2026

Overview

Boost your Shopify store’s payment capabilities with our payment plugin, delivering secure and seamless transaction processing.

Our Shopify payment extension helps you launch or expand your business rapidly. If you are launching your business first time on Shopify, we can help you to quickly roll out through our configuration capabilities. If you are already on Shopify and thinking of expansion, we offer a wide variety of secure local and global payment options.

Our Shopify extension which is built on Payments Orchestration Platform delivers a competitive advantage over payment gateways including payment processing optimization and advanced analytics through a single integration. We help you manage payments across multiple P2Ps, acquirers and banks across all channels — online or mobile  — using a strategic, streamlined approach.

Looking for the step-by-step journey (prepare, install, configure, test, go live)? See the Shopify (WestpayAPI) overview on the Shop Plugins page. This page contains the detailed reference.

↑ Back to top

Compatibility

Our plugin supports the following versions:

  • Node 18
  • Remix 2.7.1
  • React 18.2
  • Prisma 5.12

↑ Back to top

Configure

You need the Entity ID, API key and webhook decryption key from the Onboard section.

Open the plugin settings

Access the app:

  1. After installation, you will be redirected to the app dashboard.
  2. You can also access the app through the Apps tab on the left-side navigation of the Shopify admin.
  3. Click the app name to access the App Dashboard.

Figure 1: Open the plugin settings

Shopify (WestpayAPI): Open the plugin settings

Field reference

General Setting

Field Name in Shopify Configuration Mandatory/Optional/ConditionalPossible ValuesComments
EnabledMandatoryEnabled or DisabledConfigure this to enable or disable the payment plugin
EnvironmentMandatoryTest or Live

Test - For test environment Configuration

Live - for Live environment Configuration

Entity ID (Test)MandatoryEntity ID of you Channel or Merchant from Open Payment PlatformRefer to onboarding configuration.
API Key (Test)MandatoryAPI of you Channel or Merchant from Open Payment PlatformRefer to onboarding configuration.
Entity ID (Live)MandatoryEntity ID of you Channel or Merchant from Open Payment PlatformRefer to onboarding configuration.
API Key (Live)MandatoryAPI of you Channel or Merchant from Open Payment PlatformRefer to onboarding configuration.
Test ModeMandatoryINTERNAL or EXTERNAL 

Connector test mode 

  • EXTERNAL causes test transactions to be forwarded to the processor's test system for 'end-to-end' testing
  • INTERNAL causes transactions to be sent to our simulators.
Webhook URLMandatory
The value will be auto-populated to configure the webhook URL in Open Payment Platform
JavascriptConditional

use this option to customize  payment widget

Additional information - Advanced Options


Merchant NameMandatory

Name of the Merchant on the Payment page

CSSOptional
CSS helps to customize default checkout payment page experience, 
Webhook Decryption KeyMandatory
Fill in the Secret for the encryption value generated during webhook endpoint creation in the Open Payment Platform.

Figure 2: General Setting

Shopify (WestpayAPI): General Setting

Customize Payment Page

Field Name in Shopify Configuration Mandatory/Optional/ConditionalPossible ValuesComments
Terms and Conditions URL:Mandatory
The URL for the terms and conditions page
Privacy Policy URLMandatory

The URL for the privacy policy page.

WPWL Customization OptionsConditional

Use JavaScript based on the instruction given in the documentation Advanced Options, 

Additional information - Advanced Options


Layout LogoMandatory
Image URL for a logo to display on the payment layout.
Logo WidthMandatory

Set the width for the logo. Logo Height: Set the height for the logo.

default value is 150px

Logi HeightMandatory

Set the heightfor the logo. Logo Height: Set the height for the logo.

default value is 100px

Background ImageMandatory
Image URL for a background image for the payment layout.
Merchant Name ColorMandatory
Set the color for the merchant’s name text.
Amount ColorMandatory
Set the color for the amount of text.
Pay Button ColorMandatory
Choose a color for the pay button.
Pay Button Text ColorMandatory
Set the color for the text on the pay button.

Figure 3: Customize Payment Page

Shopify (WestpayAPI): Customize Payment Page

After the Customization payment page can look like below, you can customize further with possible options.

Figure 4: Customize Payment Page (continued)

Shopify (WestpayAPI): Customize Payment Page (continued)

Sample Configuration

Figure 5: Sample Configuration

Shopify (WestpayAPI): Sample Configuration

Figure 6: Sample Configuration (continued)

Shopify (WestpayAPI): Sample Configuration (continued)

Please refer to below, the detailed configuration/user guide below. 

Shopify Installation and Configuration Guide

↑ Back to top

Onboard

After plugin installation, please follow the instructions to configure the extension in Shopify and in the Open Payment Platform using the configuration details.

You will need to configure merchant accounts and brands in Open Payment Platform, which needs to work with checkout using plugins.

Credentials from the Open Payment Platform

As part of the Shopify plugin setup, you must also request to enable the Pay by Link configuration, because the Shopify checkout redirection is based on our Pay by Link.

Follow the Pay by Link configuration and configure Allow PAYBYLINK, Activate Brand Management and Brands. Without this configuration, the Shopify checkout will not work.

To start processing with plugins, plugin configuration in the Open Payment Platform needs to be enabled for your PSP or merchant. Without this configuration, you won’t be able to send transaction requests from the plugin platform to the payment platform for processing.

Please contact H24 Support or your account manager to enable plugin usage from the Open Payment Platform.

You will need the following information from the Open Payment Platform to configure and onboard with the payment plugin:

Field Name in Shopify Configuration Open Payment Platform Field NameMandatory/OptionalComments
Entity IDEntityIdMandatory

From Merchant or Channel level, according to Open Payment Platform configuration setting of Merchant accounts

In Open Payment Platform - Administration→ Account data

API KeyAccess TokenMandatory

From Open Payment Platform at the Merchant or Channel level, according to Open Payment Platform configuration setting of Merchant accounts

In Open Payment Platform - Administration→ Account data → Merchant Info/Channel Info

Figure 7: Credentials from the Open Payment Platform

Shopify (WestpayAPI): Credentials from the Open Payment Platform

Webhook configuration

The webhooks are HTTP-based callbacks that notify your plugin platform of all the events you subscribed for on an entity. Instead of constantly polling for updates, a webhook is set up once and only sends data when a specific event occurs. The events can be about tokens, payments, payment schedules, risks or any transaction state updates related to payments or transactions connected to a payment, it is necessary to configure webhooks for seamless communication and transaction updates. 

Merchant/PSP to configure webhooks and generate the webhook decryption key in the Open Payment Platform for
webhook handling.

Steps:

  1. Login to merchant dashboard (Open Payment Platform)
  2. Select your division (here OPP_Division)
  3. Go to Administration - Webhooks
  4. Click on “Add New Webhook” button

Figure 8: Webhook configuration

Shopify (WestpayAPI): Webhook configuration

Follow further steps below to configure Webhook

  1. URL: https://<domain-name>/acipayment/process/notification
  2. Notification types: Select the notification types as required by the merchant
  3. Fields to include: Select the option as required by the merchant
  4. Secret for encryption: (Copy the value and add in the “Webhook Decryption Key” field under general settings in  Shopify  check Sample Configuration)
  5. Wrapper for encrypted notification: JSON
  6. Emails: Enter email IDs to receive a notification alert
  7. Save

Figure 9: Webhook configuration (continued)

Shopify (WestpayAPI): Webhook configuration (continued)

↑ Back to top

Features

Payment types

Payment TypeSupportedComments 
Authorization (PA)✔
Debit (DB)✔
Credit (CD)–

Capture (CP)

Full✔
Partial

✔


Multiple✔

Refund (RF)

Full✔
Partial✔
Multiple✔

Reversal (RV)

Full✔
Partial–
Multiple–
Receipt (RC)–
Rebill (RB)–

Note - Some functionalities available in the plugin might not be supported by the connector in use. Please refer to the respective connector integration sheet for details.

Features

We have standard plugin integration with Shopify using our Open Payment Platform Integration option, which gives you access to all the features and uses the WestpayAPI to present payment options to your shoppers 

FeatureSupportedComments
Supported Brands✔

ALL*

*Note -

VISA, Mastercard, Amex, are the brands certified internally. Plugin integration can adopt other card and APM brands, for any additional field support specific to APM or card please contact your account manager. 

Not Allowed brands - Apple Pay, Google Pay and Ali Pay due to Shopify restrictions. 

Note - some payment brands might not work due to Shopify not sending the required mandatory parameters for the payment brand. 

Supported Payment Methods✔

Credit Card, Virtual Account

Countries✔ALL (if Shopify is in countries)
Authorization Currencies✔ALL
Late Notification✔

Payment Facilitator

–Can be supported if the connector has its own configuration for PayFac
Recurring/Subscription –
Reference ID✔
Timeout Autoreversal✔
TLS 1.2✔
Internal Tokenization
–
Omni Tokenization–
External Tokenization–
Zero Authorization/ Account Verification–
Digital Wallet–Apple Pay/Google Pay
3D Secure ✔Using our MPI
Airline Data–
Settlement Reporting–

Settlement reporting as per the specific brand connector in use. 

WestpayAPI OneClick Checkout (Save Card)–
WestpayAPI widget or full-page redirect✔
Customization through standard WestpayAPI JS✔using wpwlOptions
Customization through standard WestpayAPI CSS✔using wpwlOptions
PayByLink–PayByLink configuration is needed in the Open Payment Platform to configure the Shopify Plugin, and it is not supported as a standalone checkout option or to generate and distribute the link
Manage Saved Card in User Profile–
Download Audit Log✔Enable this through Shopify Support
Guest Checkout ✔
Transaction identifier ✔merchantTransactionID
Fast Checkout–
Fraud with Payment✔
Standalone Fraud–
PCI DSS 4✔

↑ Back to top

Supported fields

As part of the integration with the plugin platform we have integrated the below fields, Please note this is only informational, you don't need to worry about how to send these fields or integrate them. Plugin extension takes care of it. 

Note - the below fields are supported as standard, if any specific fields need to be supported for APM for Card brand, please get in touch with your account manager. 

  • entityId
  • testMode
  • amount
  • currency
  • merchantTransactionId
  • merchant.name
  • paymentType
  • customer.givenName
  • customer.surname
  • customer.email
  • billing.city
  • billing.country
  • billing.postcode
  • billing.state
  • billing.street1

↑ Back to top

Resources

↑ Back to top

See also