[Drupal] How to create a payment gateway module for Drupal?
BY alfred.paul
3 years ago
comments comment

Drupal commerce is a popular e-commerce module for Drupal. It is used to build ecommerce websites and applications and leverages the outstanding features of Drupal 7 for greater flexibility. Here, we will find out how to create a payment gateway module for Drupal commerce. There are mainly two types of payment gateway integration in Drupal Commerce:

  1. On site
  2. Off site

On site payment is processed by a third party API through web services with the information gathered from our site through a checkout form (For example Credit/Debit card credentials).

Offsite payment method, on the other hand, processes data entered in the payment gateway page. Off site payment method redirects the user to the payment gateway's processing page using a checkout form. After the payment is completed, user will be redirected to payment page from where he can go forward or backward during the checkout process.

Payment gateways offer multiple types of payment services, which often provides on-site and off-site options. Each of these services is represented by a different payment method in Drupal Commerce.

A default payment method rule will be defined, when a payment method module is enabled. This could be used to configure your payment methods. During the checkout process, all the active payment method rules will be evaluated and the respective payment methods would be enabled for use on the checkout form. You can actually use one or more rules to enable any given payment method using a different set of API credentials or transaction configurations based on conditions of the order being paid for. Note that, no payment method is enabled by more than one rule.

Commerce payment module in the Drupal commerce provides API for creation of payment methods in Drupal commerce. The Payment module includes functions designed to support common types of payment services, the most common being credit card payments. The file commerce_payment.credit_card.inc includes helper functions for building and validating credit card forms and data.

Whenever a payment is done, a payment transaction should be created that references to the order for which payments were attempted and the payment status should be reflected in the transaction's status.

For reference of creating a payment gateway module, we can refer commerce_paypal as it contains both on-site and off-site payment methods.

Now, a payment method should contain the following functions.

  1. Define the payment method via hook_commerce_payment_method_info(). This hook will return a keyed array like the one below:
    $payment_methods['paypal_wps'] = array(
     'base' => 'commerce_paypal_wps',
     'title' => t('PayPal WPS'),
     'short_title' => t('PayPal'),
     'description' => t('PayPal Website Payments Standard'),
     'terminal' => FALSE,
     'offsite' => TRUE,
      'offsite_autoredirect' => TRUE,

    Each element in the array is explained in the link payment-info-hooks.

  2. Define your callback functions to add setting form to the payment method's rule. Collect the necessary information on the checkout and administrative payment forms, and accommodate the redirection process for off-site payment methods.
  3. Define menu items for additional payment transaction operations and providing the forms and API integration necessary to perform the operations.
  4. Integrate with the payment service to actually process payments, validate payment notifications, and otherwise interact with the available APIs.

On Site Payments

A simple example of on-site payment method is the Paypal WPP module in the Commerce Paypal project. Here it is important to note that you have to set off-site parameter in the payment method data to FALSE and off-site_redirect to FALSE.

The function callbacks are defined in the callbacks key in the payment method array. For on-site payments, submit_form, submit_form_validate, and submit_form_submit functions need to be defined as it shows returns form elements to collect details from the customer required to process the payment and validates.

Off Site Payments

A simple example of on-site payment method is the Paypal WPS module in the Commerce Paypal project.

You have to set off-site parameter in the payment method data to TRUE to enable redirection to payment gateway. off-site_redirect to TRUE if you are redirecting to payment gateway page, FALSE if you are using iframe to show the payment method page.

The function callbacks are defined in the callbacks key in the payment method array. For off-site payments, redirect_form, redirect_form_validate, and redirect_form_submit functions are needed.

redirect_form - This function returns form elements which should be submitted to the redirected payment service. It is because of the array merge that happens upon return and the service’s URL that should receive POST variables. The POST variables should be set in the #action property of the returned form array.

redirect_form_validate - This function returns from a redirected payment service. This callback provides an opportunity for the payment method to validate any returned data before proceeding to checkout completion; should return TRUE or FALSE indicating whether or not the customer should proceed to checkout completion or go back a step in the checkout process from the payment page

redirect_form_submit - This function returns from a redirected payment service. This callback gives an opportunity for the payment method to perform any submission functions necessary before the customer is redirected to checkout completion.

Drupal payment module development can be tricky. You may need to hire experts to get this done. We provide you a wide range of Drupal services to help you maintain and manage your Drupal websites.



on 01st January 2008 / by webmaster
We have added a few new modules to our site recently. Two of these are the StumbleThis module and the DiggThis module. Drupal already had a DiggThis module available for download but there was no StumbleThis module. StumbleUpon has been a popular source of traffic for zyxware.com and we wanted users to have an option to add any of our pages to their StumbleUpon favorites. So we created our own StumbleUpon module. Normally people use stumbleupon toolbar to stumble websites. However when the toolbar is not enabled this provides an easy way to add the URL to the stumbleupon favorites. The StumbleThis button will be shown on the left of the content inline. Positioning of the StumbleThis button can be controlled by the weight option in the admin menu. By setting a negative value you can have the button displayed on top of the post while a positive value will take it to the bottom of the post.Click here to download the StumbleThis module for Drupal. The module has been tested with Drupal 5.1. Please use the comments form below if you have any questions or suggestions. Open Source Web Development Drupal Blogging Free Software Drupalgive Leave a reply Your email address will not be published. Required fields are marker * Sean (not verified) access_time 19 Jun 2019 - 12:56 Hi there, I uploaded the files, enabled the modules to use SU, and now I see the link, but there is no icon... How can I fix this? Thanks, Sean webmaster access_time 19 Jun 2019 - 12:56 In reply to Icon doesn't show by Sean (not verified) What do you see when you view the source? Search for stumblethis_button and you should be able to see the code for the image and the URL. Then you should be able to troubleshoot from there. Juicy Couture Addict (not verified) access_time 19 Jun 2019 - 12:56 thanks for the post. would love to hear more of you. by the way, drupal's really popular nowadays as it has easy and fast features. you agree with me? thanks. Add new comment

on 16th January 2008 / by webmaster
Most webmasters do not realize this, but a lot of the content on lot of websites can be accessed from multiple URLs. A simple example would be where www.example.com and example.com leads to the same page. This is a fatal mistake in Search Engine Optimization and search engines penalize you for duplicate content. The correct configuration would be where the above two urls will lead you to the same page but example.com will redirect you to www.example.com with a 301 (Moved permanently) status which will not result in search engines penalizing the page. It is very easy to configure 301 redirects using Apache .htaccess file and the process is the same for a Drupal installation also. The article is relevant only to those webservers running Apache. There are two ways in which you can issue a 301 redirect using .htaccess on an Apache Webserver. One is using a mod_alias Redirect statement and the other is using the mod_rewrite Rewrite statements. Redirect statements take paths and assign corresponding paths to be redirected to while rewrite statements take regular expression patterns and associate paths where matched urls have to be redirected to. When you install Drupal, it will automatically insert statements in the .htaccess file that will allow you to redirect www.example.com to example.com or vice versa. The only thing you have to do normally would be to uncomment the statements corresponding to your preference of accessing your domain ie with or without the www part. # If you want the site to be accessed WITH the www. only, adapt and # uncomment the following: # RewriteCond %{HTTP_HOST} ^example\.com$ [NC] # RewriteRule .* http://www.example.com/ [L,R=301] # # If you want the site to be accessed only WITHOUT the www. prefix, adapt # and uncomment the following: # RewriteCond %{HTTP_HOST} ^www\.example\.com$ [NC] # RewriteRule .* http://example.com/ [L,R=301] There is however a problem with the above redirections in that they lose the rest of the URL. Say for example if you try to access example.com/somepath and your configuration is to use the www prefix the user will be redirected to www.example.com but the somepath part will be lost. This can easily be rectified by the following small change in the Rewrite Rule # For the first option you can use the following rewrite rule # RewriteRule (.+) http://www.example.com/$1 [L,R=301] # # whereas for the second you can use the following rewrite rule # RewriteRule (.+) http://example.com/$1 [L,R=301] These modifications will ensure that the user will be redirected to the correct page with or without the www prefix and without losing on your page ranks. So make the necessary modifications and make sure that you can access the pages to your site using only one version of the URL. The above configuration of .htaccess should be used not just for Drupal websites but for all websites. If however your problem is the reverse, ie you don't have pages corresponding to the URLs that the user typed, ie if you are getting lot of 404 errors (page not found errors) and users are thrown to the default Page not found page, you can try installing the Drupal Search404 Module to search for the keywords in the URL and show relevant results to the user. You can read more about apache mod_alias and apache mod_rewrite at the apache official documentation Apache mod_rewrite and Apache mod_alias Web Development Drupal SEO Drupal Planet Leave a reply Your email address will not be published. Required fields are marker * Anonymous (not verified) access_time 19 Jun 2019 - 12:56 Hello. I'm trying to make example.com show as www.example.com, and I'm running into difficulties. I'm on Apache 2.0 and using the following lines in my httpd.conf file: RewriteEngine on RewriteCond %{HTTP_HOST} ^xxxxxxxxxx\.com$ [NC] RewriteRule ^(.*)$ http://www.xxxxxxxxxx.com/$1 [L,R=301] When I go to http://xxxxxxxxxx.com, I get http://www.xxxxxxxxxx.com (as expected). However, when I go to http://xxxxxxxxxx.com/node/1 (it's a Drupal site), I get a 404 thrown and the URL changes to xxxxxxxxxx.com/var/www/drupal/node/1. Same thing with www.xxxxxxxxxx.com/node/1. Any suggestions? I want to run without Drupal's .htaccess file (instead incorporating these calls into my httpd.conf file). webmaster access_time 19 Jun 2019 - 12:56 In reply to Rewrite including filesystem path by Anonymous (not verified) I think the problem is with the base path which results in the redirection to /var/www/ part. The best approach I would think is to start with drupal htaccess and then strip out parts and move to httpd SNVC (not verified) access_time 19 Jun 2019 - 12:56 This is definitely a good guide. Thanks for this. wellyson access_time 19 Jun 2019 - 12:56 This is really nice and helpful. Add new comment

on 07th January 2008 / by webmaster
We have volunteered to take up the maintenance of a very useful Drupal module - Search404. As of today we are the official maintainers of this very useful Drupal module. We know that this is going to be a challenge for us, being a young company and with a young team. But we do feel that it is our responsibility to give back to the Drupal community at least some part of what it has given us. About Search404 Module Normally when a user types in an incorrect URL in a site the web server will issue a 404 error (page not found error) and correspondingly redirect you to a 404 error page. If there is no custom 404 page on the server the browser will show the 404 page not found error to the user. This could happen when either the user types in the URL himself or he clicks on a URL incorrectly typed in another page. Another case when such errors happen is when content is deleted or moved in a site and the search engine indices have not been updated to reflect the removal or change. The web crawlers of search engines on getting a 404 error will take out the URL from their indices. The normal web user will however be totally lost when he sees the 404 error page. This is especially true if the user came from a search result page and has no idea about the navigational structure of the site or the content organization of the site. Drupal however shows its own 404 error page and avoids showing the grotesque, default 404 page that would otherwise be shown by the browser to the end user. Even this 404 error page is only a bare page with just the information that the page cannot be found. The Search404 module intelligently does a search for the terms in the URL while still issuing a 404 error. This will ensure that the URL gets taken out from the search engine index at the same time making sure that the user is given some options in terms of navigating in the site. You can check out how this works by clicking on the following non-existant URL Drupal Modules from Zyxware. Even though the page does not exist you get what you wanted to get to. If you have any questions, issues or suggestions regarding this module you can either post them as comments to this page or post your issues at the Search404 Module at Drupal.org. Open Source Web Development Drupal Leave a reply Your email address will not be published. Required fields are marker * ian douglas (not verified) access_time 19 Jun 2019 - 12:56 I notice your updates on the Drupal modules page has some patch files, but they are patches for an older version of the 5.x branch of search404. Do you have any expectation on when a version for Drupal 6 will be ready? webmaster access_time 19 Jun 2019 - 12:56 In reply to when will search404 for drupal 6 be ready? by ian douglas (not verified) Hi Ian, We are currently working on moving Search404 to Drupal 6. The port has already been done and we should have a release up on drupal.org by tomorrow or worst case by monday. Cheers Anoop John Team Zyxware Dejan (not verified) access_time 19 Jun 2019 - 12:56 In reply to when will search404 for drupal 6 be ready? by ian douglas (not verified) I think that's been up for a while... did you check the download page? Add new comment
Leave a reply
Your email address will not be published. Required fields are marker *

Filtered HTML

  • Web page addresses and email addresses turn into links automatically.
  • Allowed HTML tags: <a href hreflang> <em> <strong> <cite> <blockquote cite> <code> <ul type> <ol start type='1 A I'> <li> <dl> <dt> <dd> <h2 id='jump-*'> <h3 id> <h4 id> <h5 id> <h6 id>
  • Lines and paragraphs break automatically.
The content of this field is kept private and will not be shown publicly.
CAPTCHA This question is for testing whether or not you are a human visitor and to prevent automated spam submissions.