Reading list Switch to dark mode

    MangoPay Payment Gateway For Magento 2

    Updated 1 November 2023

    MangoPay Payment Gateway For Magento 2 is an ideal end-to-end payment solution for your Magento 2 eCommerce stores.

    Also, it enables the platform to accept multiple payment methods online, including cards and direct debit.

    You can also check the Magento 2 SquareUp Payment Gateway extension which allows customers to pay using their credit/debit cards.


    1. The base currency of the store is used as the admin’s wallet currency.
    2. Mangopay offers many currencies for setting a base currency. (EUR, USD, AUD, CAD, HKD, JPY, AED, ZAR)
    3. To check how multi-currency works with MangoPay Payment gateway tap here.


    • Enable/disable payment method from the admin panel.
    • Allow buyers to make payment using cards Carte Bleue (CB), Visa, Mastercard, Maestro.  Moreover Diners(currency allow as per Mangopay) and Direct Debit.
    • Also, the admin can transfer payment from his wallet to the bank account.
    • Even, the admin can make a full or partial refund online for any placed order.

    Module Installation

    Customers will get a zip folder and they have to extract the contents of this zip folder on their system.

    Searching for an experienced
    Magento 2 Company ?
    Find out More

    The extracted folder has an src folder, inside the src folder you have the app folder.

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

    Installation Of MangoPay Payment Gateway For Magento2

    After the successful installation, you have to run these commands in the Magento2 root directory:

    The first command – Therefore, for Getting Mangopay API – Run the below command :

    composer require mangopay/php-sdk-v2:^2.3

    Second Command –

    php bin/magento setup:upgrade

    Third Command –

    php bin/magento setup:di:compile

    Fourth Command –

    php bin/magento setup:static-content:deploy

    Now, move to the app folder and flush the cache from the Magento admin panel. And navigate through System->Cache management. Moreover, check the given image for more details:

    Installation Of MangoPay Payment Gateway For Magento2

    How Multi-Currency Works in Mangopay?

    While generating the admin wallet details in the configuration, the base currency present at the configuration is taken as the currency for the admin’s wallet.

    And as Mangopay does not support multiple currencies, the currency at the configuration should not be changed. Now, the wallet of the customer is created according to the base currency set in the configuration.

    If the admin needs to use any different currency, the admin would have to reset admin details in configurations, set the desired Mangopay supported currency, and then create the admin wallet.

    Thus, the new admin wallet would now be supporting the new currency that is set up.

    Module Configuration – Settings

    After the successful installation of the Magento 2 MangoPay payment gateway, the admin can find the configuration panel.

    Under Stores ->Cofiguration ->Sales ->Payment Methods ->Webkul MangoPay Payment Gateway as shown below in the screenshot.

    MangoPay Payment Gateway - admin configuration

    Enabled – The Admin can enable/ disable Magento2 MangoPay Payment Gateway.

    Sandbox Active –By this option admin can enable or disable the Testing(sandbox) mode.

    Title – Then admin can set the title which will display on front-end.

    Client Id – For which MangoPay user is registered.

    Passphrase – Given by MangoPay after registration.

    Generate MangoPay User and Wallet Id – Now, Generate a MangoPay Escrow Account’s User and Wallet Id.

    Minimum Order Total – Further, Admin can set the minimum order total that is required for a transaction

    Maximum Order Total – Admin can set the maximum order total 

    Set no. of days after which admin can release hold amount – The main usage of this field is for the online refund process.

    That is if the customer wants to go for an online refund, then he has only the set no of days (for example 10 days) to go for the refund.  After that, he can not go for the online refund request. validation time can be set as per your requirement.

    Sort Order – Now the admin can set the sort order value.

    How To Get The ClientId and Passphrase Key?

    For getting MangoPay ClientId and Passphrase, you need to have your MangoPay account first.

    You can create a MangoPay account with the Registered Company.

    For creation of the Sandbox Account the user need to click here-

    Then the company registration needs to take place. For company registration, the store owner needs to click on Need To Register. This will open up a Sign Up Form to register the company as below.

    MangoPay Payment Gateway - Sign_up

    This will allow the generation of a mail from the Mangopay side. This mail will contain the Company Reference.

    Mail - MangoPay Payment Gateway

    This company reference is needed to be filled in the Sandbox Account Page.

    MangoPay Payment Gateway - sandbox account page

    Here along with the company reference, the client can enter other details like- Company Name, Email, Platform Type, Country, and a Client ID.

    Then the store owner can click on Create Your Sandbox. Thus, allowing the generation of a mail that will assure the completion of registration.


    Now, to create access to the Sandbox Dashboard, we need to follow the link- Sandbox Environment.

    Then we need to click on ‘First Time Login‘ as we are accessing the account for the first time.

    MangoPay Payment Gateway - first login

    Here, the login details as- Clientid, First and last name and email id is entered by the account holder. This completes the registration process henceforth the account holder will enter the Sign-in details.

    Thus, allowing the user to redirect to the account Dashboard which will have the account details.


    Hold In Escrow

    The admin will follow the path Webkul MangoPay payment -> Hold in Escrow and click on the “Release Amount” button to release the payment.

    The admin can see the transactions with a “Release Amount” option button and a “Wait For Validation Period” option label.

    For the transactions that have crossed the set validation period (For example- 10 days as set above).

    It will have a “Release Amount” button option displayed. And transactions that have not yet crossed validation period will have the “Wait For Validation Period” option displayed in front of them.

    MangoPay Payment Gateway

    When the buyer places an order, the placed amount gets on hold for a specific validation time period set by the admin in the e-wallet for the customer.

    Now as soon as the validation period for the transaction expires set by the admin. Then the admin can easily release the amount to their specific bank account with just a single click.

    Meanwhile within this validation period if the customer goes for an online refund. Then the order amount will get temporarily stored in customer e-wallet.

    However, after the successful refund order generation at the admin end. The amount will get transferred directly to the card used in the payment process.Configuration Of Magento2 MangoPay

    Payment Process Workflow

    Now, please view the below diagram of how the MangoPay payment process works.


    The customer can provide KYC (know your customer) documents to get some extra privileges ( transaction limits ). Also, KYC provides secure purchasing to customers.


    Module Workflow

    After getting client Id and passphrase admin will set these values to Webkul MangoPay Payment Gateway Configuration settings.  And generate MangoPay User Id and Wallet Id to accept payment from the buyers.

    If Magento 2 MangoPay Payment Gateway method is enabled from the admin panel. Then the buyer can see this payment method under the “Payment Information”. As shown below in the given screenshot.

    MangoPay Payment Gateway

    After clicking on the “Place Order” button, it will redirect to the Mangopay payment gateway.  Where the user will input his card details to make the payment. Check the given image for more details.

    After a successful checkout, amount payouts to MangoPay Escrow’s buyer wallet.

    If any error occurs during a transaction then the order will get created with order status “Pending Payment”.  Otherwise status will show “Processing”.

    Admin Management

    Admin can see the order details from the back end Sales ->Orders. Here the admin can see the “MangoPay Payment Method” being used for the placed order.

    MangoPay Payment Gateway - Orders

    Admin can see all the transaction details of the MangoPay transfer for the placed order. Furthermore, check the below-given image for complete details:
    Admin Management Of Magento2 MangoPay

    After clicking on the transaction, the admin can see the complete transaction details for the placed order.  As shown below in the screenshot.

    MangoPay Payment Gateway - Transsaction-details

    Transaction Details


    Create New Customer Account

    If a new customer registers or creates an account with the store, it generates a wallet ID for the customer which is different for every customer.

    It is a mandate requirement for the customers to add the address while filling in the details.

    Even, in order to create a new account, the customer must click on the “Create an Account” option on the frontend.

    Thereafter, the customer needs to fill in the required details in the form as shown in the image below. 


    Refund Process

    The refund process can be initiated by the admin by following the below steps –

    1.) Now, go to the Invoice page of the placed order for which you want to do the refund as shown below.
    Refund Process In Magento2 MangoPay

    2.) Now click the credit memo button to open another page.

    MangoPay Payment Gateway - Refund

    3.) Later, on the new page that opens after clicking the “Credit Memo” button, you will find a refund button.


    Then click it to refund the amount back to the buyer. Further, the money escrowed in the buyer’s wallet will get returned to the buyer’s bank account.


    When the refund is completed, transaction details for a refund will get saved.  Furthermore, admin can see this refund transaction details inside the “Transaction” tab of the order as shown below.

    Refund Process In Magento2 MangoPay

    MangoPay Money Transfer Process from Administrator’s(Escrow) Wallet to Bank

    For transferring money from wallet to bank, the admin needs to set correct bank details of the administrator as shown in the below screenshot.
    MangoPay Money Transfer Process from Administrator’s(Escrow) Wallet to Bank

    If the admin has some money in his wallet then he can transfer this money from his wallet to his bank account by clicking the “Transfer to bank” button. Admin can also see all his transactions in the form of a grid as shown below in the screenshot.
    MangoPay Money Transfer Process from Administrator’s(Escrow) Wallet to Bank

    That’s all for MangoPay Payment Gateway For Magento 2  module.

    Still, have any issue feel free to add a ticket.

    Moreover, let us know your views to make the module better at our HelpDesk System.

    Current Product Version - 5.0.1

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

    . . .

    Leave a Comment

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

    Be the first to comment.

    Back to Top

    Message Sent!

    If you have more details or questions, you can reply to the received confirmation email.

    Back to Home

    Table of Content