> ## Documentation Index
> Fetch the complete documentation index at: https://docs.mangopay.com/llms.txt
> Use this file to discover all available pages before exploring further.

# WooCommerce/WC Vendors plugin

export const Buyer = ({content}) => <Tooltip tip="User making a purchase from a seller on a marketplace, who completes the transaction by making a pay-in.">
        {content}
    </Tooltip>;

export const Transfer = ({content}) => <Tooltip tip="A movement of funds from one wallet to another, within the Mangopay environment.">
        {content}
    </Tooltip>;

export const Marketplace = ({content}) => <Tooltip tip="Online platform connecting third parties in the exchange of products and services. ">
        {content}
    </Tooltip>;

export const User = ({content}) => <Tooltip tip="A private individual (natural person) or legal entity (legal person) registered with Mangopay to make payments on a platform.">
        {content}
    </Tooltip>;

export const Seller = ({content}) => <Tooltip tip="User selling a product or service on a marketplace, who must have the Owner category. To make a payout from their wallet to a bank account, they must also be verified.">
        {content}
    </Tooltip>;

export const MangopayDashboard = ({content}) => <Tooltip tip="Mangopay interface enabling platform operators to manage their payment operations and centralize their Mangopay experience.">
    {content}
  </Tooltip>;

export const Fees = ({content}) => <Tooltip tip="Funds taken by the platform on transactions and collected in the Fees Wallet for that currency.">
        {content}
    </Tooltip>;

export const Payout = ({content}) => <Tooltip tip="A movement of funds leaving the Mangopay environment to the bank account of a user.">
        {content}
    </Tooltip>;

## Official WordPress plugin

Mangopay provides an official integration for [WordPress](https://wordpress.org/) (coupled with WC Vendors, and WooCommerce), enabling you to process payments by using the Mangopay API.

Because this is an official integration maintained by Mangopay teams, you can benefit from:

* Mangopay support
* Regular updates

The Mangopay WooCommerce/WC Vendors plugin requires two other WordPress plugins:

* WooCommerce : Allows you to build an online store on a WordPress site. WooCommerce primarily manages products, orders, and transactions.
* WC Vendors : Allows you to turn a WooCommerce e-shop into a <Marketplace content="marketplace" /> with multiple vendors, or <Seller content="sellers" />. WC Vendors primarily manages sellers - their capabilities, commissions, and payouts.

The Mangopay plugin is compatible with any WordPress theme.

<Note>
  **Note - To use Mangopay’s official integration, you’ll need:**

  Both WooCommerce and WC Vendors plugins installed\
  A Mangopay API key
</Note>

### Key features

* Process payments with a compliant workflow inside your marketplace
* Accept payments with several payment methods
* Onboard sellers and stay compliant

<Note>
  **Note**

  This documentation assumes that you have basic WordPress knowledge.
</Note>

## Download and install the plugins

Before starting, you need to download:

* WordPress : latest version available [here](https://wordpress.org/).
* WooCommerce : latest version available [here](https://wordpress.org/plugins/woocommerce/) or directly from your administration panel.
* WC Vendors : latest version available [here](https://wordpress.org/plugins/wc-vendors/) or directly from your administration panel.
* Mangopay’s plugin : latest version [here](https://wordpress.org/plugins/mangopay-woocommerce/) or directly from your administration panel.

## Plugin configuration

### Configure the Mangopay plugin

Follow the steps to configure your Mangopay plugin:

<Steps>
  <Step>Activate the plugin on the WordPress plugin page: /wp-admin/plugins.php</Step>

  <Step>
    **Select Mangopay** in the left menu and set the environment:

    * Production : For live production
    * Sandbox : For testing and integration

    Your Client ID and API Key are available in the [Mangopay Dashboard](https://hub.mangopay.com/).
  </Step>

  <Step>
    Select the type of all your users (buyers, vendors, and businesses) among the following values: Individuals, Businesses, or Either. 

    If you’re unsure about which type of user to select, or if you don’t know how your marketplace will evolve, select Either.

    <Note>
      **Note - Mangopay user documentation**

      To better understand which type of user to select, see the following articles regarding <User content="users" />: \
      [Introduction and types](/guides/users/types)\
      [Categories](/guides/users/categories)
    </Note>
  </Step>
</Steps>

### Configure WC Vendors plugin

The Mangopay plugin is compatible with both the standard and the pro version of the WC Vendors plugin. Settings are similar between both versions.

<Warning>
  **Warning - Refer to the WC Vendors documentation**

  This guide only refers to WC Vendors features and setup required to use the Mangopay plugin. \
  Make sure you read the [WC Vendors documentation](https://www.wcvendors.com/knowledge-base/).
</Warning>

1. Activate the plugin on the WordPress plugin page: /wp-admin/plugins.php

**2. Set up the relevant settings** in the plugin Settings view (available by selecting WC Vendors and then Settings in the left menu).

<table>
  <thead>
    <tr>
      <th class="header">In the…</th>
      <th class="header">Relevant information </th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td class="table-content">*General* tab</td>

      <td class="table-content">
        The **Allow users to apply to become a vendeur** option is not mandatory.

        If you don’t plan on creating a custom page for the registration of sellers, users will be able to apply to become sellers on the default sign-up page.
      </td>
    </tr>

    <tr>
      <td class="table-content">*Commission* tab</td>

      <td class="table-content">
        Make sure you set the commission percentage for sellers. To allow the plugin to capture the right amount of fees, use the following field:

        * **Vendeur Commission %**
      </td>
    </tr>
  </tbody>
</table>

### Configure WooCommerce plugin

The WooCommerce plugin will allow to set up additional options necessary for processing payments with Mangopay, including the choice of payment methods to offer the buyers.

<Warning>
  **Warning - Refer to the WooCommerce documentation**

  This guide only refers to the WooCommerce features and setup required to use the Mangopay plugin.\
  Make sure you read the [WooCommerce documentation](https://woocommerce.com/documentation/woocommerce/).
</Warning>

1. Activate the plugin on the plugin page: /wp-admin/plugins.php

\*\*2. Set up the relevant settings \*\*in the plugin Settings view (accessible by selecting WooCommerce and then Settings in the left menu).

<table>
  <thead>
    <tr>
      <th class="header">In the…</th>
      <th class="header">Relevant information </th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td class="table-content">*General* tab</td>

      <td class="table-content">
        Bear in mind that Mangopay may prevent some actions due to country-specific restrictions.

        [Learn more about country restrictions](/guides/users/country-restrictions)
      </td>
    </tr>

    <tr>
      <td class="table-content">*Accounts & Privacy* tab</td>

      <td class="table-content">
        Mangopay cannot process anonymous orders, so make sure you uncheck the following option:

        * Allow customers to place orders without an account
      </td>
    </tr>

    <tr>
      <td class="table-content">*Payments* tab</td>

      <td class="table-content">
        First, activate Mangopay by switching on the “MANGOPAY” toggle.

        Once this done, click on the “Manage” button on the right-hand side of the MANGOPAY toggle to:

        * Enable payments by Mangopay

        * Select your payment method
          To activate/create a custom payment form and to enable preauthorization on a specific product, check the following option:

        * **Activate card registration**

        [Learn more about Preauthorizations](/guides/payment-methods/card/preauthorization)
      </td>
    </tr>
  </tbody>
</table>

## Seller management

<Seller content="Sellers" /> need to set up their account to successfully use Mangopay features. To fully benefit from the payment experience and collect their revenues, they should:

* Complete their profile
* Accept Mangopay T\&C
* Go through the verification process
* Create their bank account

By default, when installing the Mangopay plugin, new fields are added to the WC Vendors dashboard so that all the mandatory fields necessary to work with Mangopay are available and identified.

<Note>
  **Note - Customize the seller experience**

  You can select a specific WordPress page or even customize the vendor Dashboard.\
  It can be done by going to the WC Vendors plugin, Settings view (left menu), Display tab. From there, you’ll find the options to customize the Dashboard page and the shop settings pages.
</Note>

### How to verify a seller

To receive a payout, your seller should be verified by Mangopay. To do so, they need to upload the necessary verification documents according to the <a href="/guides/users/verification/requirements">requirements by user type</a>.

<Warning>
  **Warning – Storage of KYC documents prohibited**

  You must only use the plugin form for document management. \
  Your seller should never send you data or verification document by email or directly to your server.\
  You’re not allowed to store verification documents (in any format, even encoded) on your side.
</Warning>

Two options are available to upload verification documents.

1. Sellers can upload their verification documents by filling the corresponding form in the shop Settings page.

2. Alternatively, sellers may be able to connect to the wp-admin to upload their verification documents. All the necessary fields are available in the seller’s profile.

<Warning>
  **Warning - Mangopay T\&C acceptance**

  Your seller must accept Mangopay T\&C. This field is available below the Bank account information.
</Warning>

### How to create a bank account

In addition to being verified, sellers must provide a valid bank account in order to successfully collect their revenues. To do so, they need to go to the shop Settings page and enter their bank account information.

Mangopay supports any type of bank account.

## Refunds and payouts (Mangopay Dashboard)

Some features are not handled by the Mangopay WooCommerce/WC Vendors plugin and should be done in the [Mangopay Dashboard](https://hub.mangopay.com/).

### Refund

Doing a refund is possible through the Mangopay Dashboard.

1. Get the pay-in Id in WooCommerce

In the WooCommerce plugin, Orders menu, open the order for which a refund is to be made.

In the Custom Fields section, get the \*\*mp\_transaction\_Id \*\*value.

2. Make the refund in the Mangopay Dashboard

In the Mangopay Dashboard, search for the pay-in with your mp\_transaction\_Id value (which corresponds to the Mangopay pay-in Id), and make the refund.

### Seller payout

1. Transfer the revenues to the seller

Before payout, commissions (i.e., the seller’s revenues minus the <Fees content="fees" />) should be transferred to the seller's wallet.

There are two ways to proceed:

* Manually : In the WC Vendors plugin, Commissions menu, select any commission with the “Due” status and select the “Mangopay payout”.
* Automatically : In the WooCommerce plugin, Settings menu, Payments tab, click on the “Manage” button for the Mangopay payment method, and then activate the “Enable direct payout of vendors” option. As a result, the plugin will perform a transfer from the buyer's wallet to the seller's wallet when the status of the order turns into “completed”.

<Note>
  **Note - Commissions “payouts” are actually transfers**

  The “Mangopay payout” and “Enable direct payout of vendors” options do not refer to a <Payout content="payout" /> in the Mangopay sense of the term (i.e., wiring the funds to an external bank account). \
  It is actually a <Transfer content="transfer" /> from one wallet (the <Buyer content="buyer's" />) to another (the <Seller content="seller's" />).
</Note>

2. Make the payout to the seller’s external bank account

In order to transfer the revenues of the sellers to their external bank account, you’ll need the user’s Id and then access the Mangopay Dashboard.

In the WordPress Users menu, search for the seller for which a payout is to be made.

In the MANGOPAY section, click on “do a payout” to be redirected to the relevant view in the Mangopay Dashboard in order to make the payout.

## Get support

Mangopay’s Support team is here to help you out if you have issues regarding the Mangopay WooCommerce/WC Vendors plugin.

<Note>
  **Best Practice – Provide health check screenshot**

  For Mangopay’s Support team to efficiently answer your request, make sure you provide a screenshot of your health check.\
  It’s available by clicking on the Mangopay plugin in the WordPress left menu: /wp-admin/plugins.php?page=mangopay\_settings
</Note>

<a href="https://hub.mangopay.com/" target="_blank" class="btn normal">Contact Support from the Dashboard →</a>