Magento 2 Multi Vendor PayPal Commerce
Table of Content
PayPal Commerce Marketplace:
PayPal Commerce Marketplace module is for Payment. Payment methods are the most imperative aspect of any Marketplace.
The reason is that a smooth-running and secure payment method can bring your store a large number of customers.
None of your customers would want to lose their hard-earned money to cyber frauds.
While discussing payment and payment systems, we cannot get away without mentioning PayPal.
Indeed, it is one of the most secure and sought-after payment methods.
Safe, as it is, most of all, it is convenient to use. Without any hassle, a simple PayPal Checkout button can lead you to a fraud-free payment process.
PayPal Commerce Marketplace Plugin enables store admins to integrate PayPal’s payment features into their marketplace.
Initially, the admin configures the client’s secret key to use the PayPal services by logging in to the PayPal Account.
Furthermore, the admin can allow the Instant and Delayed payments feature (also known as, PayPal Commerce).
Moreover, on choosing Instant, the sellers receive the payment instantly as the customer places the order.
On choosing Delayed, the amount is kept on hold; the admin will manually transfer the amount to the seller.
Also, the sellers of the Marketplace can integrate PayPal for their customers only after authenticating with PayPal.
Furthermore, both the admin and the sellers can process the refunds for the customers in their respective panels.
PayPal has proven to be quite favorable for the customers as it does not reveal the credit card details to the sellers; the sellers receive the PayPal Account Number.
Also, the customers can pay in any currency which makes it easier for the customers to make purchases globally.
Note:
- To integrate this module, one must be using the Magento 2 Multi Vendor Module.
- For the efficient utilization of this module, it is a must to activate PayPal Commerce in the account. For more details please connect with PayPal Commerce.
- Please provide information about your business model in the PayPal Commerce Platform – Questionnaire.
To get a more clear idea of the module, kindly review the video below-
Features of PayPal Commerce Marketplace
- Initially, the admin enables the PayPal Payment Method for the customers.
- The client and the secret key are to be retrieved for configuring the payment method.
- The admin receives the commission based on the sellers.
- Also, this module supports Instant and Delayed payment Disbursement Modes, i.e. PayPal Commerce.
- To enable PayPal services, the seller must authenticate with PayPal.
- PayPal Commerce Marketplace Plugin supports Multi-Seller Purchase(MSP).
- The payment gets split between the seller and the admin.
- Both the admin and the sellers can process the online refund for the customers.
- Admin can now sell products via PayPal
- The Admin can manage seller onboarding information
- Admin can send an email notification to the seller who has not onboarded
- PayPal Unbranded Payments integrated
- Unbranded Payments are 3D Secure
Note:
- This module is not compatible with the multi checkout address feature.
-
UCC supported Countries (Branded Payments + Unbranded payments): United States, Australia, United Kingdom, France, Italy, Canada, Spain
-
Branded Payment supported Countries:
Canada, Austria, Germany, Ireland, United States, Australia, Belgium, Bulgaria, Cyprus, Czech Republic, Denmark, Estonia, Finland, France, Greece, Hungary, Italy, Latvia, Liechtenstein, Lithuania, Luxembourg, Malta, Netherlands, Norway, Poland, Portugal, Romania, Slovakia, Slovenia, Spain, Sweden, United Kingdom
Install Extension from Webkul Store of PayPal Commerce Marketplace
#1 Download Module
Firstly, you need to log in to Webkul Store, go to My Account>My Purchased Products section, verify and then download and extract the contents of this zip folder on the system.
#2 Upload Folder
Once the module zip is extracted, follow path src>app and then copy the app folder into the Magento 2 root directory on the server as shown below:
PayPal Commerce Marketplace installation
#3 Run Commands
After uploading the module folder, you need to run the following commands in the Magento 2 root directory:
1- composer require firebase/php-jwt
2- php bin/magento setup:upgrade
3- php bin/magento setup:di:compile
4- php bin/magento setup:static-content:deploy
5- php bin/magento indexer:reindex
6- php bin/magento cache:flush
Install Extension from Magento Marketplace
If you have purchased this extension from the Magento Marketplace then please follow the below process.
#1 Get Access Keys
You need to get access keys, navigate to My Profile in Magento Marketplace, then choose Access Keys in the My Products section.
Go to Magento 2 then you need to copy both the Access Keys – Public Key and Private Key. These access keys will be needed in the next steps for authentication.
If access keys are not created earlier, click Create A New Access Key, enter any name and click OK.
#2 Update composer.json File
To know the component name and version number, go to your Magento Marketplace account section, My Profile>My Purchases, then find this extension to view the details.
Note: Below is an example image, every extension will have its unique component name and version.
After that, navigate to your Magento project directory and update your composer.json file in the following format.
composer require <component-name>:<version>
For example, to install version 5.0.0 of this extension you need to run the following command:
composer require webkul/marketplace-paypal-payment-gateway:5.0.0
#3 Enter Access Keys
Now you will need to enter the Access Keys that you obtained as explained in the first step #1 Get Access Keys.
Wait for Composer to finish updating your project dependencies and make sure there aren’t any errors.
#4 Run Command
You need to run the following commands:
1- composer require firebase/PHP-jwt
2- PHP bin/Magento setup:upgrade
3- PHP bin/Magento setup:di:compile
4- PHP bin/Magento setup:static-content:deploy
5- PHP bin/Magento indexer:reindex
6- PHP bin/Magento cache:flush
Language Translation
For translating the module language, navigate through src/app/code/Webkul/MpPaypal/i18n and edit the en_US.csv file.
Thereafter, rename the CSV as “en_SA.csv” and translate all right side content after the comma in the Arabic language. After editing the CSV, save it.
Then upload it to the path src/app/code/Webkul/MpPaypal/i18n where the Magento 2 is installed on the server.
The module gets translated into the Arabic Language. It supports both RTL and LTR languages.
Retrieving the Client ID and Key
PayPal: Partners Onboarding
- As the “PayPal Commerce Platform is currently available to approved partners,” initially, to register with the PayPal Commerce Platform, the store owner will have to navigate to the PayPal Commerce Platform Partner Onboarding page.
- Thereafter, the store owner must tap on the link- PayPal Partner form. If the store owner wishes to be an approved partner of the PayPal Commerce Platform.
- It redirects to the PayPal Partner form page, where the store owner needs to fill in the necessary details as shown in the image below, and submit the same.
- Then a success message will display and a confirmation mail is sent to the store owner an account is created with PayPal.
Further, the store owner can carry on with retrieving the Client Id and Secret by following the steps below:
Generate Sandbox Client Id and Secret:
So, for retrieving the Client Id and Secret, log in here.
Then navigate to My Apps & Credentials as shown in the given image:
Create App
On clicking the Create App, it redirects to the Create New App page.
Sandbox Create New App Page
Here, enter your App Name and select the Sandbox developer account and proceed further by hitting the Create App button.
Subsequently, select the sandbox or live account for which you want to create the API credentials ie; client ID, and secret key.
Sandbox – Get Client Id and Secret
Get PayPal Live Client Id and Secret:
For the Client Id and Secret, log in to the dashboard.
Then navigate to My Apps & Credentials as shown in the given image:
Create App
On clicking the Create App, it redirects to the Create New App page.
Create New App Page
Here, enter your App Name and proceed further by hitting the Create App button.
Find the Live Client Id and Secret:
Hence, copy the client ID and secret key and configure them in the admin backend under PayPal Marketplace Payment systems configurations.
Admin Configurations of PayPal Commerce Marketplace
As soon as the installation process is complete, the admin needs to configure the settings by navigating through Stores > Configuration > Sales > Payment Methods.
On clicking the Payments tab, the admin will find the PayPal Commerce Marketplace Payment systems, under which the configurations need to be set as given below:
The admin configures the PayPal Marketplace Payment Systems as under:
PayPal Branded and Unbranded Payment Settings
Enable Branded and Unbranded Payments: The admin can Enable or Disable the payment method.
Title: A title is to be set for the Payment Method, which displays on the frontend.
Enable 3D Secure: The admin can Enable or Disable the 3D Secure. If you are based in Europe you can enable this
PayPal Branded Payment Settings
Enable Branded Payments: The admin can Enable or Disable the payment method.
Title: A title is to be set for the Payment Method, which displays on the frontend When the branded payment method is selected.
Partner Logo: Admin can upload the logo image.
Environment: The admin chooses Sandbox or Production against this tab, as need be.
PayPal Partner:
- PayPal Partner Attribution Id (bn-code): This code is provided by the PayPal when admin set up his PayPal account, But it’s a one-time sandbox code after testing admin can change It.
- Partner Merchant Id and Partner Account Email: The admin must follow the given path to gather the Merchant and the Account Email.
Step 1: Log in to PayPal Developers Account.
Path: Thereafter, navigate through- SandBox Account > Account Name > View/ Edit Account > Account Details.
In the Account Details page, the admin will find the Email ID or Account Email and the Account Id or the Merchant ID as shown below:
Client Id: The admin receives it after creating an account with PayPal.
Client Secret: The admin receives it after creating an account with PayPal.
Disbursement Mode: The admin may choose Instant or Delayed against this tab.
Enable PayPal on Checkout Page By Default: Choose Yes or No.
Payment from Applicable Countries: The admin selects All Allowed Countries or Specific countries against this tab.
Payment from Specific Countries: The admin selects countries from the given list.
Sort Order: The sort order of the payment method.
Generate Webhooks
Moreover, on saving the configuration details, the admin needs to tap on the Generate Webhooks tab as explained ahead:
Sandbox Webhooks
Live Webhooks
Add Webhook – Live
This authenticates the store owner with PayPal and the created webhooks will display on the PayPal webpage.
Note: PayPal Commerce is WebHook driven.
Seller Authentication: With PayPal
As a new seller registers with the online store, The seller can move to the seller panel or dashboard. And then the seller needs to select PayPal onboard:
Taping on PayPal Onboard a few options will open and the seller can select the country
Case 1: Branded and Unbranded payment
The customer can set up his PayPal account according to his country (Branded and Unbranded payment) or UCC
As the seller clicks on PayPal connect, it redirects to the first page of PayPal authentication as shown below.
In the first step of the authentication process, the seller needs to fill in the Email ID, location and tap on the Next tab to proceed for the next step.
In the next step, the vendor has to create the password for the PayPal account.
It redirects to the ‘What type of business is this’ page. The vendor has to choose the type of the business, i.e. Private Corporation, Non-profit or Govt Organization, etc., and hit on next button.
As the seller selects, the business type, it redirects to the ‘Tell me about your business’ page.
The seller needs to fill in the business contact information such as legal first and last name.
The remaining fields will be as Business Phone, Address, city, etc. The seller needs to agree with the terms and conditions and hit the next button. 
It redirects to the “Describe your business” page where the seller needs to answer a few questions about the business nature and sales.
Furthermore, Seller needs to provide an email or contact number for customer support and hit on the Next button.
It redirects to the ‘Tell us more about you’ page where the seller needs to fill in some legal information according to a govt-issued identity card.
Furthermore, Seller needs to fill in the permanent address as well after accepting terms and conditions hit on the next button.
Thus, it will redirect sellers to the ‘Tell us about the beneficial owner’ page. Here, the seller can provide beneficial owner information.
On completion of the authentication process, a message as shown in the image shall display.
The seller will receive the details on the email id where the seller needs to confirm and finish the authentication.
On confirming the authentication, the seller dashboard shall display a message, ‘Setup is Complete’.
When the seller onboarded successfully for branded and unbranded both payments (or seller onboard for US country) following image will display.
Case 2: Branded payments
If the Seller belongs to Branded payments supported countries, Can set up a PayPal account for branded payments only.
As the seller clicks on PayPal connect, it redirects to the first page of PayPal authentication as shown below.
In the first step of the authentication process, the seller needs to fill in the Email ID, location and tap on the Next tab to proceed for the next step.
In the next step, the vendor has to create the password for the PayPal account.
It redirects to the ‘Describe your company’ page. The vendor needs to fill in the details about the business like contact name and number.
Furthermore, Seller needs to fill the business address with zip code and also need to accept the terms and conditions and click on the further button.
It redirects to the ‘Describe your company’s page where the seller needs to choose the company’s nature.
Furthermore, once the seller has chosen the nature few options will open about the company seller needs to fill that and click on the further button.
It redirects to the seller’s basic information page once the seller will fill that the authentication for branded payments process will be complete.
The seller will receive the details on the email id where the seller needs to confirm and finish the authentication
If the seller onboarded for branded payment supported countries then this message”Please confirm your primary email address to receive the payments” will display along with the following image
On confirming the authentication, the seller dashboard shall display a message, ‘Setup is Complete’.
When the seller onboarded successfully for branded payments only the following image will display.
If the customer adds the product of the seller who does not have an active or authenticated account on PayPal and proceeds for checkout.
A message appears on the page to “remove the product from the cart” as shown in the below-given image:
Admin can send an email notification to the seller who has not onboarded. Email can be predefined templates or added by the admin.
Disbursement Mode: Instant
There are two Disbursement Modes that the admin can allow, i.e. Instant or Delayed.
In this section, we shall discuss the Instant Disbursement Mode which means the payment is instantly transferred to the seller as soon as the customer makes the payment.
The customer can choose to make a purchase and proceed to checkout in the usual way.
In the frontend, the customer will find the Webkul PayPal Payment Method option under the Review and Payments tab.
Further, the customer needs to tap on the PayPal Commerce Marketplace tab so as pay for the order using PayPal.
On choosing PayPal Checkout, it redirects the customer to the PayPal Login page as shown in the image below:
The customer needs to add the credentials or log in details and tap on the login button.
Thereafter, in the second step, the customer needs to choose the Ship-To (address) and Pay With (payment mode) and tap on Continue.
The customer can also use the Pay with debit or credit card tab to make the payment using card details only.
Thereafter, in the second step, the customer needs to choose the Ship-To (address) and Pay With (payment mode) and tap on Continue.
This confirms the order for the customer and a success notification will display as shown in the image below:
Transactions
Moving on, the admin can view the order details by navigating through the Sales > Orders > Order & Account Information page under the Information tab.
Further, on tapping the Transactions tab, the admin will find the transaction list as shown below:
Admin Transaction
Henceforth, the admin can click on the Order ID and view the details of the transaction such as intent, orderID, etc.
Also, the details of the transaction can be viewed after logging in to PayPal’s account under the Activity option, as shown in the image below:
Hence, the details of the respective transaction shall display on clicking it.
Seller Orders
Seller Transactions
The seller can navigate to the seller panel and view the list of transactions as shown in the image below:
Further, the seller can tap on the View action to view the details of the respective transaction as shown below.
Disbursement Mode: Delayed
Meanwhile, in this section, we shall discuss the Delayed Disbursement Mode.
It means the payment is kept on hold. Therefore on choosing Delayed, the admin has to manually transfer the amount to the seller.
Moreover, if funds are not disbursed within 28 days, they are automatically disbursed to the seller.
The customer will have to follow the same steps as mentioned above for the Instant Disbursement Mode. Further, choose PayPal Checkout to make payment for the order.
Subsequently, when the order is confirmed a new tab, namely, Delayed Payment shall be visible on the Order and Account Information page.
Furthermore, on clicking the Delayed Payment tab, the admin will find a Release Vendor Payment button.
On clicking the Release Vendor Payment button, a success message, “Payment released to vendors, successfully” displays.
As soon as the admin releases the payment to the seller, the admin must refresh the page.
On doing so, it redirects to the Order and Account Information page.
Seller Transactions:
In the Seller Dashboard, the transactions will not display until the admin releases the vendor amount.
As soon as the amount is released, the seller’s transaction will display in the seller panel as shown in the image below.
The seller can tap on View and choose to go through the transaction details of the respective order.
Refund Process of PayPal Commerce Marketplace
To execute a refund process, the seller must navigate to the Orders menu option in the seller dashboard.
Consequently, the sellers select the order and tap on the Order option under the View column.
It redirects to the Manage Order page, where the seller will find the Credit Memo, clicking which the refund can be processed.
As the seller clicks on the Credit Memo tab, it redirects to the New Credit Memo page.
The seller will find the Refund tab, clicking which the seller can process a refund for an order.
Furthermore, another ID is generated as soon as the seller refunds the amount.
The admin as well, in the admin panel can process a refund for the customers.
For this, the admin must navigate to Sales > Order > Invoices > View > Credit Memo > Refund.
The status of the Order will alter to Closed as soon as the admin or seller processes the refund.
Subsequently, on processing a refund, the transaction is generated on PayPal as well.
MSP – Multi-Seller Purchase
Customers can add the multi-seller product into the cart and can make payment using PayPal easily likewise other payment methods.
As explained order id will remain the same for all the sellers whose products got purchased but in the order details, they will be able to view only the item related to them.
Hence, that’s all for the PayPal Commerce Marketplace Plugin. If you face any issues, feel free to add a ticket at our HelpDesk System.
You may also browse other Magento 2 marketplace addons and our quality Magento 2 extensions.