To integrate easypay with Shopify, install the plugin and follow the steps in the manual below.
Initial requirements
If you are using our old plugin, you must completely remove it to avoid conflicts with the native version.
Check your internal easypay settings. Make sure that:
- Your customer account is active
- You do not have static IP addresses configured in your easypay Backoffice (contact easypay support if needed)
- You have permissions enabled in the Teams menu of your easypay Backoffice
If you have any doubts regarding the configuration, you should confirm them with the easypay support department before installation.
1. Installation and Activation of the Native App (Required)
Step 1: Access the easypay app link
Go to https://apps.shopify.com/easypay-mbway-mb-visa and click the button “Install in your Shopify store”.
Step 2: Confirm installation in Shopify
After being redirected to your Shopify store, click the “Install” button again to confirm the installation of the app.
Step 3: easypay App Configuration
After installation, you will be redirected to the easypay e-commerce app. Here, you must enter your ID and API Key in the dedicated easypay configuration section.
If you do not know how to create API keys, please refer to the official guide on how to generate authentication keys.
Step 4: API Key Validation
After entering the API keys, click “Fix” to validate the keys.
Step 5: Complete Installation
After successful validation, click the “Finish Shopify Installation” button. You will be redirected back to your Shopify store, where you must activate the app.
Step 6: Activate Payment Methods
Finally, activate the desired payment methods and then save your store.
If you choose to enable Multibanco, you can define the payment expiration period.
Until the easypay onboarding process is completed, access will be limited to Multibanco and MB Way payment methods.
Note: selecting payment methods in the Shopify platform will only display the payment logos at the time of selection.
Payment methods are activated exclusively on the platform https://e-commerce.easypay.pt/.
2. Optional Installation (Advanced Integration)
This step is optional but enables access to native Shopify features and advanced communication between Shopify and the easypay backoffice.
Once this connection is enabled, the following features will be available (at order level):
- Orders created will be updated with payment methods (Shopify tags)
- Multibanco details will be added to the “Additional Details” section of the order (when Multibanco is used as the payment method)
- The Shopify order number (e.g. #1234) will appear in the eCommerce system
Step 1: Verify App Activation in easypay
In the easypay eCommerce platform, within the “Shopify” section, click the “Manage in Shopify” button.
Inside Shopify, make sure the app is active and click “Save”.
Step 2: Access the Apps Menu in Shopify
In your Shopify store, go to Apps and sales channels > click “Develop apps”, then select “Create an app”.
Step 3: Create New App
In the modal that appears, give the application a name and click “Create app” to complete the process.
Step 4: API Configuration
Click on the Configuration tab and, in the “Admin API integration” section, select “Configure”.
Step 5: Permission Settings
Search for “Orders” in the search bar and enable the write_orders and read_orders permissions, then click Save.
Step 6: Obtain API Credentials
Go to the API credentials tab and copy and save the following values:
- Admin API access token
- API secret key
After the keys have been generated, click the Install App button.
Step 7: Enter Credentials in easypay
Return to the easypay e-commerce page and enter the copied values in the fields “Admin API Access Token” and “API Secret Key”.
At the bottom of the page, click “Save”. If everything is correct, the message “Connection successfully completed” will be displayed.
By following all the steps in this tutorial, your Shopify store will be correctly integrated with easypay, ensuring the proper functioning of all payment features offered by easypay.