Reading list Switch to dark mode

    Magento 2 Marketplace Paytabs Payment Documentation

    Updated 30 October 2023

    Magento 2 Marketplace Paytabs Payment module provides the option to complete the payment through the Paytabs payment gateway. Paytabs is a payment gateway widely used in Saudi Arabia.

    The admin can enable this method into their store and users can take advantage of the services. The Paytabs provide services in multiple currencies and various card options.

    Note: This payment gateway is an add-on to the Adobe Commerce Marketplace Module. To use this module you must have installed the first Magento 2 Multi Vendor Module.

    Features of Magento 2 Marketplace Paytabs Payment

    • Enable/disable payment method from the admin panel.
    • Provide split payment to sellers for your Marketplace store.
    • It supports various cards like Visa, MasterCard, Electron, and Maestro.
    • Accept all the cards that Paytabs supports.
    • Allow sellers to register themselves using Paytabs.
    • Sellers and admin both can refund the invoiced amount.
    • Buyers can do payments via the Paytabs payment method.
    • Set the payment method title.
    • The module supports multiple languages including RTL Arabic.

    Installation of Magento 2 Marketplace Paytabs Payment

    Paytabs Payment Gateway installation is super easy. First, you have to unzip the module and then you will get an src folder.

    Click on the src folder and then you will get the app folder. You need to move the app folder in Magento 2 root directory as per the screenshot.

    Start your headless eCommerce
    now.
    Find out More
    installation-1

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

    First Command – php bin/magento setup:upgrade

    command2

    Second Command – php bin/magento setup:di:compile

    command3

    Third Command – php bin/magento setup:static-content:deploy

    command4

    Forth Command – php bin/magento indexer:reindex

    After running the commands, you have to log into the admin panel and you have to clear the Cache. You can refer to the below screenshot.

    Cache Management

    Magento 2 Marketplace Paytabs Payment Documentation

    Multi-Lingual Support

    For multilingual support, the admin will navigate through Store->Configuration->General ->Locale Options and select the locale as German (the language into which the admin wants to translate his store content).

    Magento 2 Marketplace Paytabs Payment documentation

    Language Translation

    If a user wants to translate their module from English to German then they need to follow the path app/code/Webkul/paytabs/i18n in their unzipped Magento Marketplace folder and will get a CSV file with the name “en_US.csv”.

    Now they will rename that CSV as “de_DE.csv” and translate all right side content after the comma in the German language.

    After editing the CSV, save it and then upload it to the path app/code/Webkul/Paytabs/i18n where they have installed Magento2 on their server.

    screenshot_from_2023_07_24_13_29_29

    The module will get translated into your desired Language. It also supports RTL and LTR languages. The user can edit the CSV like the image below.

    Magento 2 Marketplace Paytabs Payment

    Configuration- Magento 2 Marketplace Paytabs Payment

    After the successful installation of the extension, you can see the configuration panel under Stores > Configuration > Sales > Payment Method > Marketplace Paytabs Adaptive Payment as per the below snapshot:

    Magento 2 Marketplace Paytabs Payment

    To complete the configuration admin needs to enter Paytabs details.

    Enable this solution – Enable the permission so the customer can find the payment method at the time of checkout.

    Sandbox Mode – Enable the sandbox for testing the module.

    Title – Enter the Paytabs payment title to be displayed on the checkout page.

    Merchant Email – Enter the merchant email id which is registered with Paytabs.

    Paytab Credentials – Enter Paytab credentials like secret key, client key, merchant id, and profile id.

    How to get Paytab credentials?

    The seller or admin needs to create an account on Paytabs to create the merchant credentials and manage the payments.

    merchant.paytabs.sa_merchant_registerwebkul-store

    Once the admin enters the details and clicks on the register button the merchant account will create for them, username and password will be created.

    Note: Whatever the country is chosen here only that country’s currency will work to complete the payment.

    Magento 2 Marketplace Paytabs Payment

    Once you add the details it will redirect you to the Paytabs dashboard.

    merchant-global.paytabs.com_merchant_homewebkul-store-1

    Here, the admin can check the latest transaction and other details. To get the Paytab credentials to move into the profile section where you will get the profile id and merchant id.

    Magento 2 Marketplace Paytabs Payment

    To get the secret keys, move to the developer’s tab and there you will find the API keys.

    Screenshot-3-3

    Click on the API keys and you will get the server key and client key.

    Magento 2 Marketplace Paytabs Payment

    These keys will use on Magento 2 store for Paytabs integration.

    Customer End Flow

    The customer will open the Magento 2 store and log in. Customers can add admin and seller to both’s products and proceed further.

    magento234.webkul.com_m2462_bag1.htmlwebkul-store

    Customers can check the cart and proceed further.

    magento234.webkul.com_m2462_checkout_cart_webkul-store

    Once the product is added to the cart choose shipping details and proceed to the next step.

    magento234.webkul.com_m2462_checkout_webkul-store-1-1

    When the customer proceeds to check out it will show the payment option of Paytabs Adaptive payment method.

    magento234.webkul.com_m2462_checkout_webkul-store-2

    Once the user chooses the payment option it will redirect them to the Paytabs payment page.

    Magento 2 Marketplace Paytabs Payment

    Once the payment is completed it will redirect the user again to the Magento 2 store page with the order placed message.

    Magento 2 Marketplace Paytabs Payment

    Seller End Workflow

    The seller can add their Paytabs merchant Id and member Id into their panel by navigating My account > Paytab details.

    Magento 2 Marketplace Paytabs payment gateway

    Once the account is added users can use the Paytabs payment method for the seller’s product as well.

    Magento 2 Marketplace Paytabs Payment

    When a product is added to the cart and proceeds with checkout user will find the Paytabs option on the checkout page.

    Magento 2 Marketplace Paytabs Payment

    When click on the continue checkout page it will redirect to the Paytabs website to complete the payment.

    Magento 2 Marketplace Paytabs Payment

    Here, the user needs to fill in their billing and shipping info as well.

    Seller Order List

    Sellers can check the placed orders in their order section.

    magento234.webkul.com_m2467_pub_sales_order_history_webkul-store

    Furthermore, the seller can check the order details by viewing it.

    magento234.webkul.com_m2467_pub_sales_order_view_order_id_83_webkul-store

    Admin End Workflow – Magento 2 Marketplace Paytabs Payment

    The admin can check the placed order in their order section.

    magento2 marketplace paytabs payment

    Moreover, the admin can check the order details by viewing it.

    Magento 2 Multi Vendor PayTabs Payment

    Once the admin creates the credit memo of the respective order. It can be refunded as well.

    magento234.webkul.com_m2467_pub_admin_sales_order_creditmemo_new_key_6aed617e71907bc9f5221fb0fc727458f234e1f3e1bb82fffbec88590251f840_order_id_81_invoice_id_56_webkul-store

    Paytabs Order History

    Admin can check the order history on the Paytabs account in the transaction section as well.

    Magento 2 Marketplace Paytabs payment

    Also, initiate the refund from Paytabs after viewing the order.

    Magento 2 Marketplace Paytabs payment

    Note

    • The refund amount will be credited to the customers base account
    • Paytabs payment method will work only when the Magento 2 store’s default country and the currency is the same as per the below image.
    Magento 2 Marketplace Paytabs payment

    For example, if the chosen country is India then the base currency should be the Indian rupee. Only after this setting the module will work.

    Magento 2 Marketplace Paytabs payment

    Support

    Thus, that’s all for Magento 2 Marketplace Paytabs Payment. Still, have any issues feel free to add a ticket and let us know your views to make the module better webkul.uvdesk.com.

    You may also browse other Adobe Commerce marketplace add-ons and our quality  Adobe Commerce Cloud extensions.

    Current Product Version - 5.0.1

    Supported Framework Version - 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