本文转自:http://docs.nopcommerce.com/display/nc/How+to+code+my+own+payment+method

Payment methods are implemented as plugins in nopCommerce. We recommend you read How to write a nopCommerce plugin before you start coding a new payment method. It will explain to you what the required steps are for creating a plugin.

So actually a payment method is an ordinary plugin which implements an IPaymentMethod interface (Nop.Services.Payments namespace). As you already guessed IPaymentMethod interface is used for creating payment method plugins. It contains some methods which are specific only for payment methods such as ProcessPayment() or GetAdditionalHandlingFee(). So add a new payment plugin project (class library) to solution and let's get started.

Controllers, views, models.

First thing you need to do is create a controller. This controller is responsible for responding to requests made against an ASP.NET MVC website.

  1. When implementing a new payment method, this controller should be derived from a special BaseNopPaymentController abstract class. Some of the payment methods ask customer for some data, such as credit card information. That's why a BasePaymentController class requires you to implement two action methods used to parse and validate customer input during checkout.

    1. ValidatePaymentForm is used in the public store to validate customer input. It returns a list of warnings (for example, a customer did not enter his credit card name). If your payment method does not ask the customer to enter additional information, then the ValidatePaymentForm should return an empty list.

              [NonAction]
      public override IList ValidatePaymentForm(FormCollection form)
              {
                   var warnings = new List();
                   return warnings;
              } 
    2. GetPaymentInfo method is used in the public store to parse customer input, such as credit card information. This method returns a ProcessPaymentRequest object with parsed customer input (for example, credit card information). If your payment method does not ask the customer to enter additional information, then GetPaymentInfo will return an empty ProcessPaymentRequest object.
              [NonAction]
      public override ProcessPaymentRequest GetPaymentInfo(FormCollection form)
      {
      var paymentInfo = new ProcessPaymentRequest();
                  return paymentInfo;
      }
       
  2. Then implement Configure action methods used for plugin configuration (by a store owner in admin area). This method and an appropriate view will define how a store owner sees configuration options in admin panel (System > Configuration > Payment methods).
  3. And the last step is to create PaymentInfo action method. This method and an appropriate view will define how your customers will see the payment information page during checkout.

Payment processing.

Now you need to create a class which implements IPaymentMethod interface. This is the class that will be doing all the actual work of communicating with your payment gateway. When someone creates an order either the ProcessPayment or PostProcessPayment methods of your class will be called. Here is how CashOnDeliveryPaymentProcessor class is defined ("Cash on delivery" payment method):

    ///      
    /// CashOnDelivery payment processor     
    ///
public class CashOnDeliveryPaymentProcessor : BasePlugin, IPaymentMethod
{...

IPaymentMethod interface has several methods and properties which are required to implement.

  • ProcessPayment. This method is always invoked right before a customer places an order. Use it when you need to process a payment before an order is stored into database. For example, capture or authorize credit card. Usually this method is used when a customer is not redirected to third-party site for completing a payment and all payments are handled on your site (for example, PayPal Direct).
  • PostProcessPayment. This method is invoked right after a customer places an order. Usually this method is used when you need to redirect a customer to a third-party site for completing a payment (for example, PayPal Standard).
  • HidePaymentMethod. You can put any logic here. For example, hide this payment method if all products in the cart are downloadable. Or hide this payment method if current customer is from certain country
  • GetAdditionalHandlingFee. You can return any additional handling fees which will be added to an order total.
  • Capture. Some payment gateways allow you to authorize payments before they're captured. It allows store owners to review order details before the payment is actually done. In this case you just authorize a payment in ProcessPayment or PostProcessPayment method (described above), and then just capture it. In this case a Capture button will be visible on the order details page in admin area. Note that an order should be already authorized and SupportCapture property should returntrue.
  • Refund. This method allows you make a refund. In this case a Refund button will be visible on the order details page in admin area. Note that an order should be paid, and SupportRefund or SupportPartiallyRefund property should return true.
  • Void. This method allows you void an authorized but not captured payment. In this case a Void button will be visible on the order details page in admin area. Note that an order should be authorized and SupportVoid property should return true.
  • ProcessRecurringPayment. Use this method to process recurring payments.
  • CancelRecurringPayment. Use this method to cancel recurring payments.
  • CanRePostProcessPayment. Usually this method is used when it redirects a customer to a third-party site for completing a payment. If the third party payment fails this option will allow customers to attempt the order again later without placing a new order. CanRePostProcessPayment should return true to enable this feature.
  • GetConfigurationRoute. As you remember we created a controller in the previous step. This method should return a route information of its Configure method. For example,
            public void GetConfigurationRoute(out string actionName,
    out string controllerName,
    out RouteValueDictionary routeValues)
    {
    actionName = "Configure";
    controllerName = "PaymentCashOnDelivery";
    routeValues = new RouteValueDictionary()
    {
    { "Namespaces", "Nop.Plugin.Payments.CashOnDelivery.Controllers" },
    { "area", null }
    };
    }
  • GetPaymentInfoRoute. This method should return a route information of appropriate PublicInfo method of the previously created controller. For example,
            public void GetPaymentInfoRoute(out string actionName,
    out string controllerName,
    out RouteValueDictionary routeValues)
    {
    actionName = "PaymentInfo";
    controllerName = "PaymentCashOnDelivery";
    routeValues = new RouteValueDictionary()
    {
    { "Namespaces", "Nop.Plugin.Payments.CashOnDelivery.Controllers" },
    { "area", null }
    };
    }
  • GetControllerType. This method should return a type of the previously created controller.
  • SupportCapture, SupportPartiallyRefund, SupportRefund, SupportVoid. These properties indicate whether appropriate methods of your payment method are supported.
  • RecurringPaymentType. This property indicates whether recurring payments are supported.
  • PaymentMethodType. This property indicates payment method type. Currently there are three types. Standard used by payment methods when a customer is not redirected to a third-party site. Redirection is used when a customer is redirected to a third-party site. And Button is similar to Redirection payment methods. The only difference is used that it's displayed as a button on shopping cart page (for example, Google Checkout).

Conclusion

Hopefully this will get you started with adding a new payment method.

[转]NopCommerce How to code my own payment method的更多相关文章

  1. Magento 0元订单 支付方式 -- Magento 0 Subtotal Payment Method

    需求 现有购物网站支持2种支付方式,但是考虑到会出现如下情况: 在一个优惠活动中,假如有一些订单的总金额为0, 那么这些订单就不必跳转到支付网关,现有支付方式无法处理此种情况. 分析 当custome ...

  2. QA:Failed to deploy artifacts from/to snapshots XX Failed to transfer file Return code is: 405, ReasonPhrase:Method Not Allowed.

    QA: Failed to deploy artifacts from/to snapshots XX Failed to transfer file Return code is: 405, Rea ...

  3. volley(2) 参数code : or_barcode, pr_ismsd:false , method:GET

    1. 来自于WHCombineBatchFragment.java /** * 当编辑框里面的内容完成的时候,自动的,同时获取服务器的批量数 */private void barcodeEnterEv ...

  4. ambari-server启动报错500 status code received on GET method for API:/api/v1/stacks/HDP/versions/2.4/recommendations Error message : Server Error解决办法(图文详解)

    问题详情 来源是,我在Ambari集群里,安装Hue. 给Ambari集群里安装可视化分析利器工具Hue步骤(图文详解 所遇到的这个问题. 然后,去ambari-server的log日志,查看,如下 ...

  5. NopCommerce功能与特点介绍

    [本文转自]http://www.cnblogs.com/nopcommerce-b2c/p/3758676.html 前两节我们主要介绍了NopCommerce下载与安装和NopCommerce中文 ...

  6. 03.NopCommerce功能与特点介绍

    前两节我们主要介绍了NopCommerce下载与安装和NopCommerce中文语言包,让大家体验一下NopCommerce.这次我们主要来介绍NopCommerce的功能与特点. NopCommer ...

  7. NopCommerce——源代码的组织,以及系统的架构

    近来使用NopCommerce进行开发,仿照源码的Demo也能做出看上去还蛮高端大气上档次的系统出来,现下准备深入学习学习.首先从官方的Documentation开始看起,先来一篇官网文章的翻译(园里 ...

  8. Code First :使用Entity. Framework编程(6) ----转发 收藏

    Chapter6 Controlling Database Location,Creation Process, and Seed Data 第6章 控制数据库位置,创建过程和种子数据 In prev ...

  9. Code First :使用Entity. Framework编程(7) ----转发 收藏

    第7章 高级概念 The Code First modeling functionality that you have seen so far should be enough to get you ...

随机推荐

  1. Play 中如何使用 Ajax

    Play在内部使用了 jQuery 这个JavaScript库,让我们能够非常方便的进行Ajax操作.同时,为了能在JavaScript中方便地生成某个action对应的Url,Play还提供了一个  ...

  2. 重新初始化 VS2010

    开始->所有程序->Microsoft Visual Stdio 2005->Visual Stdio Tools->Visual Stdio 2005 命令提示 这时会弹出一 ...

  3. go语言 rune切片

    go语言 rune切片 示例 package main import ( "fmt" ) //http://www.cnblogs.com/osfipin/ func main() ...

  4. 【javascript实例】 具有立体效果的图片浏览器

    此实例,直接粘贴代码即可运行,当然图片的路径不要忘记改了. 此实例是我一遍学习一边写出来的,希望能够帮到大家,一起学习.效果如图所示: html代码如下所示: <html xmlns=" ...

  5. js删除数组中的'NaN'

    js中的NaN不和任何值相等,包括自身. 所以可以使用x!=x来判断x是否是NaN,当且仅当x为NaN时,表达式的结果为true. NaN != NaN //true 可以依此删除数组中的'NaN'. ...

  6. atitit.userService 用户系统设计 v4 q316 .doc

    atitit.userService 用户系统设计 v4 q316 .doc 1. 新特性1 2. Admin  login1 3. 用户注册登录2 3.1. <!-- 会员注册使用 --> ...

  7. Android UX & UI 最佳实践: 设计有效的导航

    Best Practices for User Experience & UI Designing Effective Navigation 导航:帮助用户有效直观地使用你的应用. Plann ...

  8. iOS中sqlite版本号

    https://github.com/yapstudios/YapDatabase/wiki/SQLite-version-(bundled-with-OS) https://github.com/y ...

  9. AFNetwork2.0在报错1016,3840的解决方法及一些感悟

    最近在学习AFNetwork,非常好的网络框架,能节省很多时间.不过请求网络数据时报错1016,3840. 这两个错误网上解决方法很多,http://blog.csdn.net/huifeidexin ...

  10. 访客至上的Web、移动可用性设计--指导原则

    文章出自:听云博客 关于可用性设计,之前写过一个“纸上谈兵”版本的,那篇帖子主要是根据A/B test的方式来进行的. 但是最近找了本Steve krug写的Don't make me think,我 ...