Install the XPay Shopify custom app

Create a custom Shopify app through the Shopify Dev Dashboard, connect it to the merchant's XPay configuration, and verify that Shopify orders map to XPay.

Before you begin#

You need:

• Access to the Shopify Dev Dashboard.
• The merchant's myshopify.com store URL.
• Permission to configure Shopify app distribution.
• Access to the merchant's Shopify app details in the XPay Merchant Portal.

Create the app#

1. Sign in to the Shopify Partner or Dev Dashboard.
2. Open Apps.
3. Select Create app.
4. Enter an app name and create the app.

Configure the app#

Set the app configuration to:

Save the configuration, create an app version, and release it.

Configure custom distribution#

1. Open Distribution.
2. Select Custom app distribution.
3. Add the merchant's Shopify store URL, such as merchant-store.myshopify.com.
4. Save the distribution settings.

Add the credentials to XPay#

1. In the Shopify app, open App home → Settings → Credentials.
2. Copy the client ID and client secret.
3. In the XPay Merchant Portal, open Settings → Store Info → Shopify App Details.
4. Select Dev Dashboard as the custom-app credential type.
5. Enter the client ID and client secret.
6. Submit the configuration.

⚠️ The Shopify client secret grants access to the custom app. Store it securely and never place it in storefront code, screenshots, or public repositories.

Install and verify#

Add the client ID and secret to XPay before installing the custom app on the merchant store. After installation:

1. Place a test Shopify order.
2. Open the corresponding record in XPay.
3. Confirm that the Shopify order ID is mapped correctly.
4. Verify the payment state before enabling the integration for customers.

Next steps#

• Rename the credit-card payment method.
• Use the existing XPay Go-Live Guide for production readiness.