Install and activate a payment app​

This article explains how the SHOPLINE platform interacts with your server in the process of merchants binding and activating payment apps, to provide high-quality services for merchants.

How the merchant discovers and activates payment apps​

Canary testing control of payment apps​

After your payment app is approved, it is invisible to all merchants by default. You need to contact the SHOPLINE review team to whitelist specific merchants for canary access. During the canary testing stage, only the stores included in the canary testing can view the app.
After sufficient testing, you may contact the SHOPLINE review team again to roll out the app in full scale. After full rollout, the payment app will be visible to all merchants.

Merchants set up payment apps​

If the payment app is visible to the current store, the merchant can configure it directly in the SHOPLINE Admin > Settings > Payments page:

• Credit card-based payment apps: Merchants select the app via the entry Payments > Credit or debit card > Add.
• Redirect-based payment apps: Merchants select the app via the entry Payments > Other payment methods > Add.

Installing and activating payment apps​

The merchant selects the specific payment app on the addition page. After clicking the desired app, the merchant will be directed to the payment app installation page. Click Install to complete the installation as prompted. The merchant can add the payment app as a payment method, which will ultimately be available for buyers to use on the checkout page.

Payment app installation and uninstallation​

Installation and activation​

1. On the payment app addition page, the merchant clicks Install (step 1 in the previous flow chart).

2. SHOPLINE redirects the merchant to the app URL (Steps 2–3 in the previous flow chart).

3. Upon receiving the request at your App's URL, the payment app must verify whether the merchant has installed and authorized the app. If the merchant has not completed authorization, guide them to finish the app authorization process (step 4 in the previous flow chart).

4. After the merchant completes app authorization, the payment app must redirect the merchant to the payment account binding page. This page, independently developed and maintained by the payment app provider, is used to collect the merchant’s payment account information and establish the association relationship between the SHOPLINE store and the payment account (steps 5–7 in the previous flow chart). An example of account binding page is as follows.
   

5. After the merchant completes account binding on the payment account binding page, the payment app must redirect the merchant back to the Payment settings details page of SHOPLINE to finalize the payment method activation (Steps 8–10 in the previous flow chart).

   • URL format of the Payment settings details page: https://{handle}.myshopline.com/admin/settings/payments/appInstall?appKey={yourAPPKey}
   • Example:
     

6. At the same time, the payment app must call the Merchant activation successful notification API to actively notify SHOPLINE of the successful binding of the payment account. After sending the notification, the merchant can complete the final payment method activation on the SHOPLINE Payment settings details page (Step 11 in the previous flow chart).

7. The merchant activates the SHOPLINE payment app. The entire installation and activation process of the payment app is now complete. Buyers can subsequently use the payment app on the checkout page (Steps 12–13 in the previous flow chart).

Uninstallation​

To uninstall the activated payment app, go to SHOPLINE Admin > Settings > Payments. Click the activated payment app to enter the Payment settings details page to uninstall the app. SHOPLINE will then notify the merchant that the App installation status changed. The payment app provider must monitor this event and maintain accurate merchant data to ensure that the merchant can properly re-initiate the app authorization process when reactivating the app.