Shopify (COPYandPAY)
Last updated: October 19, 2026
Overview
Boost your Shopify store’s payment capabilities with our payment plugin, delivering secure and seamless transaction processing.
Please note - Full functionality is tested in test environment (UAT) and production functional testing is pending.
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.
How it works
Compatibility
Our plugin supports the following versions:
- Node 18
- Remix 2.7.1
- React 18.2
- Prisma 5.12
Install
- Install the app from the Shopify App Store. If the app is distributed privately, use the installation link provided by your project team or account manager.
- Click Install and follow the on-screen instructions. You are then redirected to the app dashboard.
- You can open the app at any time from Apps in the left-hand navigation of the Shopify admin.
Configure
You need the Entity ID, API key and webhook decryption key from the Onboard step. The checklist below summarizes the steps; the field reference follows.
- Click the app name to open the app dashboard.
- In General Settings, enter the API key and Entity ID provided for your store.
- Enter the Webhook Decryption Key. You get it when you create the webhook in the Payments Orchestration Platform (see Onboard). The webhook delivers notifications and events for transactions to the plugin platform.
- Customize the payment page (optional).
Open the plugin settings
Access the app:
- After installation, you will be redirected to the app dashboard.
- You can also access the app through the Apps tab on the left-side navigation of the Shopify admin.
- Click the app name to access the App Dashboard.
Figure 1: Open the plugin settings
Field reference
General Setting
| Field Name in Shopify Configuration | Mandatory/Optional/Conditional | Possible Values | Comments |
|---|---|---|---|
| Enabled | Mandatory | Enabled or Disabled | Configure this to enable or disable the payment plugin |
| Environment | Mandatory | Test or Live | Test - For test environment Configuration Live - for Live environment Configuration |
| Entity ID (Test) | Mandatory | Entity ID of you Channel or Merchant from Payments Orchestration Platform | Refer to onboarding configuration. |
| API Key (Test) | Mandatory | API of you Channel or Merchant from Payments Orchestration Platform | Refer to onboarding configuration. |
| Entity ID (Live) | Mandatory | Entity ID of you Channel or Merchant from Payments Orchestration Platform | Refer to onboarding configuration. |
| API Key (Live) | Mandatory | API of you Channel or Merchant from Payments Orchestration Platform | Refer to onboarding configuration. |
| Test Mode | Mandatory | INTERNAL or EXTERNAL | Connector test mode
|
| Webhook URL | Mandatory | The value will be auto-populated to configure the webhook URL in Payments Orchestration Platform | |
| Javascript | Conditional | use this option to customize payment widget Additional information - Advanced Options | |
| Merchant Name | Mandatory | Name of the Merchant on the Payment page | |
| CSS | Optional | CSS helps to customize default checkout payment page experience, | |
| Webhook Decryption Key | Mandatory | Fill in the Secret for the encryption value generated during webhook endpoint creation in the Payments Orchestration Platform. |
Figure 2: General Setting
Customize Payment Page
| Field Name in Shopify Configuration | Mandatory/Optional/Conditional | Possible Values | Comments |
|---|---|---|---|
| Terms and Conditions URL: | Mandatory | The URL for the terms and conditions page | |
| Privacy Policy URL | Mandatory | The URL for the privacy policy page. | |
| WPWL Customization Options | Conditional | Use JavaScript based on the instruction given in the documentation Advanced Options, Additional information - Advanced Options | |
| Layout Logo | Mandatory | Image URL for a logo to display on the payment layout. | |
| Logo Width | Mandatory | Set the width for the logo. Logo Height: Set the height for the logo. default value is 150px | |
| Logi Height | Mandatory | Set the heightfor the logo. Logo Height: Set the height for the logo. default value is 100px | |
| Background Image | Mandatory | Image URL for a background image for the payment layout. | |
| Merchant Name Color | Mandatory | Set the color for the merchant’s name text. | |
| Amount Color | Mandatory | Set the color for the amount of text. | |
| Pay Button Color | Mandatory | Choose a color for the pay button. | |
| Pay Button Text Color | Mandatory | Set the color for the text on the pay button. |
Figure 3: 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)
Sample Configuration
Figure 5: Sample Configuration
Figure 6: Sample Configuration (continued)
Please refer to below, the detailed configuration/user guide below.
Shopify Installation and Configuration Guide
Onboard
After plugin installation, please follow the instructions to configure the extension in Shopify and in the Payments Orchestration Platform using the configuration details.
You will need to configure merchant accounts and brands in Payments Orchestration Platform, which needs to work with checkout using plugins.
- Enable plugins: use the Payments Orchestration Platform to enable the plugins with the assistance of your project team.
- Configure merchant accounts and brands: set up the required merchant accounts and brands in the Payments Orchestration Platform.
- Add webhooks: set up webhooks and subscribe to the relevant event types so that event updates reach the plugin platform. You obtain the decryption key here to complete the webhook configuration in the plugin platform.
- Test payments and the required functionality in your test store.
- Go live: when you are ready, complete the configuration for production and take your shop into production with the payment plugin.
Credentials from the Payments Orchestration 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 Payments Orchestration 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 Payments Orchestration Platform.
You will need the following information from the Payments Orchestration Platform to configure and onboard with the payment plugin:
| Field Name in Shopify Configuration | Payments Orchestration Platform Field Name | Mandatory/Optional | Comments |
|---|---|---|---|
| Entity ID | EntityId | Mandatory | From Merchant or Channel level, according to Payments Orchestration Platform configuration setting of Merchant accounts In Payments Orchestration Platform - Administration→ Account data |
| API Key | Access Token | Mandatory | From Payments Orchestration Platform at the Merchant or Channel level, according to Payments Orchestration Platform configuration setting of Merchant accounts In Payments Orchestration Platform - Administration→ Account data → Merchant Info/Channel Info |
Figure 7: Credentials from the Payments Orchestration 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 Payments Orchestration Platform for
webhook handling.
Steps:
- Login to merchant dashboard (Payments Orchestration Platform)
- Select your division (here OPP_Division)
- Go to Administration - Webhooks
- Click on “Add New Webhook” button
Figure 8: Webhook configuration
Follow further steps below to configure Webhook
- URL: https://<domain-name>/acipayment/process/notification
- Notification types: Select the notification types as required by the merchant
- Fields to include: Select the option as required by the merchant
- Secret for encryption: (Copy the value and add in the “Webhook Decryption Key” field under general settings in Shopify check Sample Configuration)
- Wrapper for encrypted notification: JSON
- Emails: Enter email IDs to receive a notification alert
- Save
Figure 9: Webhook configuration (continued)
Features
Payment types
| Payment Type | Supported | Comments | |
|---|---|---|---|
| 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 COPYandPAY to present payment options to your shoppers
| Feature | Supported | Comments | |
|---|---|---|---|
| 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. | |
| COPYandPAY OneClick Checkout (Save Card) | – | ||
| COPYandPAY widget or full-page redirect | ✔ | ||
| Customization through standard COPYandPAY JS | ✔ | using wpwlOptions | |
| Customization through standard COPYandPAY CSS | ✔ | using wpwlOptions | |
| PayByLink | – | PayByLink configuration is needed in the Payments Orchestration 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 | ✔ | ||
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.
entityIdtestModeamountcurrencymerchantTransactionIdmerchant.namepaymentTypecustomer.givenNamecustomer.surnamecustomer.emailbilling.citybilling.countrybilling.postcodebilling.statebilling.street1
Resources
- Installation guide (PDF): Shopify installation/user guide
- Marketplace listing: https://apps.shopify.com/aci-worldwide
- Demo storefront (test environment): https://uat-aci.myshopify.com/