Redeem Now
Read More
Read now
Menu Close
    Start a Project Request quote Reading list Switch to dark mode

    PayPal Commerce Marketplace Plugin

    PayPal Commerce Marketplace Plugin: Payment and payment methods are the most imperative aspect of any Marketplace. The reason being, a smooth running and a secure payment method can get your store a large number of customer traffic.

    Obviously, 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 is one such extension that allows the store admin to incorporate the PayPal Payment systems feature with their Marketplace.

    Initially, the admin configures the client and secret key so as to use the PayPal services by logging in to the PayPal Account.

    Furthermore, the admin can allow Instant and Delayed payments feature (also known as, PayPal Commerce).

    Moreover on choosing Instant, the sellers receive the payment instantly as the customer makes payment and 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.


    To get more clear idea on the module, kindly review the video below-


    • Initially, the admin enables the PayPal Payment Method for the customers. 
    • The client and the secret key is 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 into the seller and the admin. 
    • Both the admin and the sellers can process the online refund for the customers. 


    • This module is not compatible with the multi checkout address feature.
    • PayPal Commerce Platform (PCP) currently supports the following countries:


      US, 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, Canada, Austria, Germany, Ireland.


    Customers will get a zip folder. Then they have to extract the contents of this zip folder on their system. The extracted folder has an src folder, inside the src folder you have the app folder.

    You need to transfer this app folder into the Magento2 root directory on the server as shown below.

    On successfully installing the module, you have to run these commands in the Magento2 root directory.

    First command –

    Second command –

    Third Command –

    Fourth Command –

    After running the commands, you have to flush the cache from the Magento admin panel by navigating through->System->Cache management as shown below:

    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 Magento2 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, login 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, login 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.

    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

    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 Marketplace Payment systems, under which the configurations need to be set as given below:

    The admin configures the PayPal Marketplace Payment Systems as under:

    Enabled: 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. 

    Environment: The admin chooses Sandbox or Production against this tab, as need be. 

    PayPal Partner:

    • PayPal Partner Attribution Id (bn-code): It comes already and it is not recommended to change this value. 
    • 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, it redirects the seller to the seller panel or dashboard. And then the seller needs to select the country as shown in the below-given image:

    The seller will find an option, PayPal Onboard as one of the menu options, tapping which the seller will find an Enable PayPal link as shown below:

    Seller Authentication Process

    As the seller clicks on Enable PayPal, 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 and the location and tap on the Next tab to proceed in for the next step. 

    In the next step, the vendor has to choose the type of account, i.e. Primarily for personal use or Primarily for your business or organization. 

    As the seller selects, “Primarily for the business organization” it redirects to the ‘Sign up for a Business account’ page. 

    The seller is required to add the email address, password under Create a login.

    Also, the seller needs to add the business contact information such as First and Last name, Legal Business Name, Business Phone, Address, city, etc. and hit the continue button. 

    It redirects to the “Tell us about your business” page where the seller needs to choose the Business Type, Employer ID, etc, and click on the Continue tab. 

    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. 

    PayPal Merchant Onboard

    On confirming the authentication, the seller dashboard shall display a message, ‘Setup is Complete’ as shown in the image below:

    If the customer adds the product of  the seller who does not have an active or authenticated account on the PayPal and proceeds for checkout then a message appears on the page to “remove the product from the cart” as shown in the below-given image:


    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 Checkout 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

    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:


    Moving on, the admin can view the order details by navigating through 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:

    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 also 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 so as 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 in 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

    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 payment made for multi purchases at one time hence the placed order id will remain the same for the sellers whose product got purchased.

    As explained order id will remain the same for all the sellers whose product 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 issue, feel free to add a ticket at

    Current Product Version - 3.0.2

    Supported Framework Version - 2.0.x , 2.1.x , 2.2.x , 2.3.x

    . . .

    Leave a Comment

    Your email address will not be published. Required fields are marked*


  • Shubham Sharma
    Hey Gunjita, The information you’ve provided is highly useful. The explanation is in great depth, covering everything. I really appreciate you putting in the effort to provide such valuable content for your audience.
    • Subhangi (Moderator)

      Hello Shubham,

      Thanks for the appreciation.

  • Back to Top
    Hire Us!
    Brief us about your requirements and we'll get back to you.
    Woo! Hooy!
    We have just recieved your project brief and our expert will contact you shortly.
    Send Again

    Table of Content

    Hide Index