How to get started with creation of new payment gateway?

  • @Naresh-webkul ,
    is this package generator compatible with the latest pull from master branch here ?

  • @otheriz
    Yes, package generator is compatible with bagisto master branch or bagisto v1.1.2 as well

  • @Naresh-webkul @Vaishali-Agarwal

    I ran the below command of the package_generator module and was able to create a folder.

    php artisan package:make-payment-method ACME/Stripe

    Unfortunately files under the newly created folder, are just some placeholder code with absolutely no explanation of the field and what needs to be done. Unfortunately this link is not much help either.

    I compared the folder/file structure of newly created folder with that of OOB Webkul/PayPal. That is also different.

    Webklu/Paypal/src [5 sub folders]

    MyApp/Razorpay/src [3 sub folders]

    Can you please help share some working example using the package_generator .

  • @Naresh-webkul @Vaishali-Agarwal Do you guys have any comments/suggestion? Or should one just give up payment integration?

    @Deepanjali @otheriz wondering whether you folks have been successful in following the documentation and achieve payment GW integration?

  • Hi @AshJi,

    1. After running this command, you will get whole directory structure,
    php artisan package:make-payment-method ACME/Stripe
    1. After running this command, you need to register you service provider in config/app.php.

    2. After then add the namespace in the composer.json file in psr-4 key.

    3. Run composer dump-autoload.

    4. Run php artisan config:cache. This thing is important because may be you are doing everything right but after cache cleared you will get success.


    Screenshot from 2020-09-08 16-45-32.png

  • Thanks @devansh-webkul for your revert. My other doubt about where I enter my app key, other secret keys which I receive from the PaymentGateway. From the UI I don't see a way to enter them. Am I missing something?

    Please clarify and guide.

  • Hi @devansh-webkul,
    Could you please elaborate on step 3 of the process, I'm not able to locate the correct composer.json file I guess

  • @Deepanjali composer.json file is in the Bagisto home directory.


  • This post is deleted!

  • The PayU payment has multiple options, while following the steps mentioned by @devansh-webkul makes it look like a single method:
    How can I show the underlying methods and not the name of the gateway?

  • @AshJi

    Hi, for that you need to create one more array key in file packages/ACME/Stripe/src/Config/system.php.

    Right now you only have 3 keys in that file. You need to create one more key in that file,

    For Example,

    return [
            'key'    => 'sales.paymentmethods.stripe',
            'name'   => 'Stripe',
            'sort'   => 1,
            'fields' => [
                        'name'          => 'active',
                        'title'         => 'Secret Key', // added hard coded for transaltion you need to add key
                        'type'          => 'text',
                        'validation'    => 'required',
                        'channel_based' => false,
                        'locale_based'  => true,

    And then rest is your development.

  • @devansh-webkul Added a new entry to the file


    But I don't still understand the whole flow how this new Payment Gateway integration is supported. Where are we telling Bagisto which PG URL to hit to connect to the payment gateway?

     1 <?php
      3 return [
      4     [
      5         'key'    => 'sales.paymentmethods.razorpay',
      6         'name'   => 'Razorpay',
      7         'sort'   => 1,
      8         'fields' => [
      9             [
     10                 'name'          => 'title',
     11                 'title'         => 'admin::app.admin.system.title',
     12                 'type'          => 'text',
     13                 'validation'    => 'required',
     14                 'channel_based' => false,
     15                 'locale_based'  => true,
     16             ], [
     17                 'name'          => 'description',
     18                 'title'         => 'admin::app.admin.system.description',
     19                 'type'          => 'textarea',
     20                 'channel_based' => false,
     21                 'locale_based'  => true,
     22             ], [
     23                 'name'          => 'active',
     24                 'title'         => 'admin::app.admin.system.status',
     25                 'type'          => 'boolean',
     26                 'validation'    => 'required',
     27                 'channel_based' => false,
     28                 'locale_based'  => true,
     29             ], [
     30                 'name'          => 'active',
     31                 'title'         => 'Secret Key',
     32                 'type'          => 'text',
     33                 'validation'    => 'required',
     34                 'channel_based' => false,
     35                 'locale_based'  => true,
     36             ]
     37         ]
     38     ]
     39 ];

  • Hi @AshJi

    This is just the boiler plate. For that you need to setup your code. You can take refrence of the Paypal payment gateway as well.

  • @devansh-webkul that was my initial query - why are folder structure of Paypal and one generated by your package different.

    If one generated by package is not complete then why should one use this package.

    I am confused now - does one use the package-generator module or clone Paypal folder.

  • Hi @devansh-webkul ,
    Is there some documentation to integrate PayU or Razorpay gateway with out site,
    somewhere one can get to enter the redirection url and secret keys?

  • @AshJi,

    In initial phase, Paypal is also the same as you see the fresh package. So as per the requirement changes are done like registering routes, controller, etc.

    If you are creating packages and modules than you need to go deeper as well.


    Same here if you want to integrate PayU money you can take reference from the Paypal module.

  • @devansh-webkul Not sure whether I follow you want to say. Feature requirements I assume are internal to Bagisto. As end user, I would be interested in knowing what I can achieve with the 'package-installer' module? If one decides not to go "deeper", what purpose does this module serves? Just having a new payment option show up in UI cannot be the goal.

    Unfortunately its neither clear in the docs not your replies. If the module in current form does not support full integration then it's fine. But in that case instructions at this link needs to be updated as they are not in sync with the module.

    Hope you understand from end user's perspective.

  • Hi @AshJi,

    Yeah, I understand that.

    We have developed the package generator to simplify and reduce your time to manually creating the folder structures and templates. Any e-commerce doesn't provide you the one execution of payment method, if you're building a custom payment package then you have to do some part of customization yourself.

    It's an opensource system so you can contribute here if you assume something is wrong. Surely we would love to have a contribution from your side as well.

  • @devansh-webkul I would be more than happy to contribute to the open source. But unfortunately there is not enough useful doc available to understand the whole flow. Probably this is the reason almost 90-95% folks contributing are from the core team. Rest 5% folks have mostly done a few bug fixes here and there.

    Coming to integration with PG there are just 2-3 use cases. And all accept REST call to post a transaction (pre defined inputs) and it returns transaction status - success or failure. There cud be a few more secondary APIs. It cannot be more complicated than that.

    If someone from Bagisto team can work with me then I can help make a generic module and make it available to all your users. I seem posts so many folks struggling with same few problem.

  • @devansh-webkul I am new to payment gateways (I mentioned it in the opening of the topic) so I don't have much idea about the routes and controllers required and also don't have much idea about the flow of this framework which makes it difficult to explore deeper,
    therefore I was asking for a guide to integrate a payment gateway to have a better clarity of What and How?

    I suppose someone from the team at least must given payment integration a test run, who could guide us through this.

Log in to reply