Menu Close
    Start a Project Request quote Reading list Switch to dark mode

    PayPal Commerce Marketplace Plugin

    PayPal Commerce Marketplace Plugin: Payment gateways 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.

    Wherefore, when talking about payment gateways, 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 Gateway 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.

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

    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 integrate this module, one must be using the Marketplace Multi-Vendor Module for Magento 2.
    • Also, the Split Cart module is essential for the proper functioning of this module (inclusive in the package; there’s no need to purchase it separately).
    • For integrating PayPal Commerce into Magento 2 Marketplace Mobile App, the user will require paid customization work, contact sales.
    •  As of now, this module supports Single Seller Checkout only. The Multi-Seller Checkout is might release at the starting of the second quarter. Thereafter, there won’t be a need to use the Split Cart module for the checkout process.
    • For the efficient utilization of this module, it is a must to activate PayPal Commerce in the account.  For more details please connect with the PayPal Commerce via the link:


    • 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. 
    • The payment gets split into the seller and the admin. 
    • Both the admin and the sellers, can process the online refund for the customers. 


    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 “PayPal Commerce Platform is currently available to approved partners,” initially, to register with PayPal Commerce Platform, the store owner will have to navigate to PayPal Commerce Platform Partner Onboarding page.
    • Therafter, the store owner must tap on the link- PayPal Partner form if the store owner wishes to be an approved partner of 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.

    • A success message will display and a confirmation mail is sent to the store owner an account is created with PayPal.  

    Further, the store onwer can carry on with retrieving the Client Id and Secret by following the steps below. 

    For retrieving the Client Id and Secret, login here. Then navigate to My Apps & Credentials ->Create App as per the below image.

    On clicking the Create App, it redirects to the Create New App page.

    Here, enter your App Name and select Sandbox developer account and proceed further by hitting 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.

    Hence, copy the client ID and secret key and configure them in the admin backend under Paypal Marketplace Payment Gateway 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 Gateway, under which the configurations need to be set as under. 

    The admin configures the Paypal Marketplace Payment Gateway as under:

    Enabled: The admin can Enable or Disable the payment method.

    Paypal Partner:

    • Attribution Id (bn-code): Paypal sends on the mail id which the admin adds by while creating account with PayPal. 
    • Merchant Id and Account Email: The admin must follow the given path to gather the Merchant and the Account Email.

    Step 1: Login to PayPal Developers Account.

    Path: Thereafter, navigate through- SandBox Account > Account Name > View/ Edit Account > Account Details

    In 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 account with Paypal.

    Client Secret: The admin receives it after creating account with Paypal.

    Disbursement Mode: The admin may choose Instant or Delayed against this tab. 

    Payment from Applicable Countries: The admin selects All Allowed Countries or Specific countries against this tab.

    Payment from Specific Countries: The admin selects countries form the given list. 

    Title: A title is to be set for the Payment Method, which displays on th frontend. 

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

    Sort Order: The sort order of the payment method.

    On saving the configuration details, the admin needs to tap on the Generate Webhooks tab as shown in the above image. 

    This authenticates the store owner with Paypal and the created webhooks will display in the Paypal webpage as shown in the image below.

    Seller Authentication: With Paypal

    As a new seller registers with the online store, it redirects the seller to the seller panel or dashboard as shown in the image below. 

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

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

    Disbursement Mode: Instant

    There are two Disbursement Modes which 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 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 login details and tap on the Log In button. 

    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 Sales > Orders > Order & Account Information page under 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 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 and the admin manually transfers it 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 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. 

    Hence, the Delayed Payment tab will not be visible anymore. 

    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 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 selects the order and tap on the Order option under 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, transaction is generated on the PayPal as well. 

    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.0

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

    . . .


    Add Your Comment

    Be the first to comment.

    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