API Reference

Shopify

Shopify UPayments App for Non Whitelabeled API

Installing Shopify App

  1. UPayments Shopify Plugin publicly listed on Shopify's Payment Providers. You can search for us by going to Shopify Admin > Settings > Payments > Add Payment Method > Search by Provider

  2. You can find our plugin from the Shopify App link

  3. Click the 'Install' button

  4. Enter your Shopify Store link

  5. If you're not logged into your store, it will prompt you to log in to your Shopify Store Admin

  6. Add your Store link

  7. You will see a screen asking you to approve the permissions that the app requires. Review these permissions & Click “Install app” to proceed.

  1. Your UPayments app will be installed successfully
  1. Activate your plugin.

Configuring your Shopify App

Configure for Test Payments


  1. To try out test transactions, go to Shopify Admin > Settings > Payments > 'UPayments ' settings
  2. Enable 'Test mode' , toggle switch to try out test transactions on your Shopify Store

  1. Go to your Shopify store,
  2. Add a product to the cart,
  3. Proceed to Checkout
  4. Choose UPayments Payment Method
  5. Click 'Pay now'
  6. You will be redirected to UPayments Payment Page
  7. Choose the desired payment method (KNET & CC are the payment methods that are available in Test mode)
  8. Test Card details for KNET & Credit Card can be found in https://developers.upayments.com/reference/test-cards
  9. Complete payment

🚧

Important Note

  • Please contact [email protected] to enable the Shopify feature for your account.
  • This Shopify plugin works for Non whitelabeled API users only

Configure for Real Payments

  1. Once Shopify feature is enabled from UPayments, go to Shopify Admin > Settings > Payments > UPayments

  2. Click on 'More actions' dropdown > Manage

  3. Enter your Production API Key and clickSubmit


  1. Ensure the Test mode toggle is disabled
  2. In your Store, add items to cart
  3. Proceed to Checkout
  4. Choose UPayments Payment Method
  5. Click Pay now
  6. You will be redirected to UPayments Payment Page
  7. Choose the desired payment method
  8. Complete payment

Shopify Multi-vendor

Steps:

  1. Contact [email protected] to enable Shopify Multi-vendor feature
  2. Once enabled, go to Shopify Admin > Settings > Payments > UPayments
  3. Click on 'More actions' dropdown > Manage
  4. Add the Main Vendor's API key, Sub-vendor's IBAN, Main Vendors Commisions for KNET and Credit Card transactions
  5. Click Submit.