是否有 PayPal IPN 的样本

Question

我有一个 Asp.Net WEB API 2 项目，我想实现一个即时支付通知 (IPN) 侦听器控制器。

我找不到任何示例和 nuget 包。我只需要确认用户使用 Paypal 上的标准 html 按钮付款。这很简单。

所有 nuget 包都用于创建发票或自定义按钮。这不是我需要的

paypal 上的示例适用于经典的 asp.net，而不适用于 MVC 或 WEB API MVC

我确信已经有人这样做了，当我开始编码时，我有一种重新发明轮子的感觉。

有没有 IPN 监听控制器示例？

至少有一个 PaypalIPNBindingModel 来绑定 Paypal 查询。

    [Route("IPN")]
    [HttpPost]
    public IHttpActionResult IPN(PaypalIPNBindingModel model)
    {
        if (!ModelState.IsValid)
        {
            return BadRequest();
        }

        return Ok();
    }

编辑

到目前为止，我有以下代码

        [Route("IPN")]
        [HttpPost]
        public void IPN(PaypalIPNBindingModel model)
        {
            if (!ModelState.IsValid)
            {
                // if you want to use the PayPal sandbox change this from false to true
                string response = GetPayPalResponse(model, true);

                if (response == "VERIFIED")
                {

                }
            }
        }

        string GetPayPalResponse(PaypalIPNBindingModel model, bool useSandbox)
        {
            string responseState = "INVALID";

            // Parse the variables
            // Choose whether to use sandbox or live environment
            string paypalUrl = useSandbox ? "https://www.sandbox.paypal.com/"
            : "https://www.paypal.com/";

            using (var client = new HttpClient())
            {
                client.BaseAddress = new Uri(paypalUrl);
                client.DefaultRequestHeaders.Accept.Clear();
                client.DefaultRequestHeaders.Accept.Add(new MediaTypeWithQualityHeaderValue("application/x-www-form-urlencoded"));

                //STEP 2 in the paypal protocol
                //Send HTTP CODE 200
                HttpResponseMessage response = client.PostAsJsonAsync("cgi-bin/webscr", "").Result;

                if (response.IsSuccessStatusCode)
                {
                    //STEP 3
                    //Send the paypal request back with _notify-validate
                    model.cmd = "_notify-validate";
                    response = client.PostAsync("cgi-bin/webscr", THE RAW PAYPAL REQUEST in THE SAME ORDER ).Result;

                    if(response.IsSuccessStatusCode)
                    {
                        responseState = response.Content.ReadAsStringAsync().Result;
                    }
                }
            }

            return responseState;
        }

但是对于第 3 步，我尝试将我的模型发布为 json，但 paypal 返回一个 HTML 页面而不是 VALIDATED 或 INVALID。我发现我必须使用application/x-www-form-urlencoded，并且它的参数顺序相同。

如何获取请求 URL？

我会使用查询网址并将&cmd=_notify-validate 添加到其中

Answer 1

这里有一个官方的 c# 示例： https://github.com/paypal/ipn-code-samples 在路径\c#\paypal_ipn_mvc.cs

C# 示例显示了一个 ASP.NET MVC 控制器，其中包含一个响应 IPN 的操作。

Answer 2

我也在寻找类似于 OP 的原始问题 Is there any IPN listener controller example? At least a PaypalIPNBindingModel to bind the Paypal query. 的解决方案，然后我来到了这个页面。我尝试了这个线程中提到的其他解决方案，它们都有效，但我真的需要 PayPal 查询到模型的解决方案，所以我在谷歌上搜索，直到我偶然发现了 Carlos Rodriguez 的 Creating a PayPal IPN Web API Endpoint 博文。

以下是 Carlos 所做工作的概述：

1. 创建一个模型。基于您将从 PayPal 获得的 ipn 响应在模型中定义的属性。

   public class IPNBindingModel
   {
       public string PaymentStatus { get; set; }
       public string RawRequest { get; set; }
       public string CustomField { get; set; }    
   }
   

2. 创建一个 PayPal 验证器类。

   public class PayPalValidator
   {
       public bool ValidateIPN(string body)
       {
           var paypalResponse = GetPayPalResponse(true, body);
           return paypalResponse.Equals("VERIFIED");
       }
   
       private string GetPayPalResponse(bool useSandbox, string rawRequest)
       {
           string responseState = "INVALID";
           string paypalUrl = useSandbox ? "https://www.sandbox.paypal.com/"
           : "https://www.paypal.com/";
   
           ServicePointManager.SecurityProtocol = SecurityProtocolType.Tls12;
           using (var client = new HttpClient())
           {
               client.BaseAddress = new Uri(paypalUrl);
               client.DefaultRequestHeaders.Accept.Clear();
               client.DefaultRequestHeaders.Accept.Add(new MediaTypeWithQualityHeaderValue("application/x-www-form-urlencoded"));
               HttpResponseMessage response = client.PostAsJsonAsync("cgi-bin/webscr", "").Result;
               if (response.IsSuccessStatusCode)
               {
                   rawRequest += "&cmd=_notify-validate";
                   HttpContent content = new StringContent(rawRequest);
                   response = client.PostAsync("cgi-bin/webscr", content).Result;
                   if (response.IsSuccessStatusCode)
                   {
                       responseState = response.Content.ReadAsStringAsync().Result;
                   }
               }
           }
           return responseState;
       }
   }
   

3. 创建你的控制器。

   [RoutePrefix("paypal")]
   public class PayPalController : ApiController
   {
       private PayPalValidator _validator;
   
       public PayPalController()
       {
          this._validator = new PayPalValidator();
       }
   
       [HttpPost]
       [Route("ipn")]
       public void ReceiveIPN(IPNBindingModel model)
       {
           if (!_validator.ValidateIPN(model.RawRequest)) 
               throw new Exception("Error validating payment");
   
           switch (model.PaymentStatus)
           {
   
               case "Completed":
                   //Business Logic
                   break;
           }
      }
   }
   

4. 创建一个模型绑定器，它将定义 Web Api 如何为您自动创建模型。

   public class IPNModelBinder : IModelBinder
   {
       public bool BindModel(HttpActionContext actionContext, ModelBindingContext bindingContext)
       {
           if (bindingContext.ModelType != typeof(IPNBindingModel))
           {
              return false;
           }
       var postedRaw = actionContext.Request.Content.ReadAsStringAsync().Result;
   
       Dictionary postedData = ParsePaypalIPN(postedRaw);
       IPNBindingModel ipn = new IPNBindingModel
       {
           PaymentStatus = postedData["payment_status"],
           RawRequest = postedRaw,
           CustomField = postedData["custom"]
       };
   
       bindingContext.Model = ipn;
       return true;
   }
   
   private Dictionary ParsePaypalIPN(string postedRaw)
   {
       var result = new Dictionary();
       var keyValuePairs = postedRaw.Split('&');
       foreach (var kvp in keyValuePairs)
       {
           var keyvalue = kvp.Split('=');
           var key = keyvalue[0];
           var value = keyvalue[1];
           result.Add(key, value);
       }
   
       return result;
   }
   }
    }
   

5. 将您的模型绑定器注册到 WebApiConfig.cs。 config.BindParameter(typeof(IPNBindingModel), new IPNModelBinder());

希望这对其他人有所帮助。感谢 Carlos Rodriguez 的精彩代码。

Answer 3

扩展 Michal Hosala 的 answer，与 PayPal 成功握手需要两件事

首先，在向 PayPal 发出请求之前设置安全协议

ServicePointManager.SecurityProtocol = SecurityProtocolType.Tls12;

其次，避免使用字典，因为为了验证，PayPal 要求数据以相同的顺序回发，并以 cmd 变量开头。我最终这样做了

Request.InputStream.Seek(0, SeekOrigin.Begin);
string rawRequestBody = new StreamReader(Request.InputStream).ReadToEnd();
var ipnVarsWithCmd = rawRequestBody.Split('&').Select(x => new KeyValuePair<string, string>(x.Split('=')[0], x.Split('=')[1])).ToList();
ipnVarsWithCmd.Insert(0, new KeyValuePair<string, string>("cmd", "_notify-validate"));

Answer 4

这是我的代码

如有问题请随时查看

        [Route("IPN")]
        [HttpPost]
        public IHttpActionResult IPN()
        {
            // if you want to use the PayPal sandbox change this from false to true
            string response = GetPayPalResponse(true);

            if (response == "VERIFIED")
            {
                //Database stuff
            }
            else
            {
                return BadRequest();
            }

            return Ok();
        }

        string GetPayPalResponse(bool useSandbox)
        {
            string responseState = "INVALID";
            // Parse the variables
            // Choose whether to use sandbox or live environment
            string paypalUrl = useSandbox ? "https://www.sandbox.paypal.com/"
            : "https://www.paypal.com/";

            using (var client = new HttpClient())
            {
                client.BaseAddress = new Uri(paypalUrl);
                client.DefaultRequestHeaders.Accept.Clear();
                client.DefaultRequestHeaders.Accept.Add(new MediaTypeWithQualityHeaderValue("application/x-www-form-urlencoded"));

                //STEP 2 in the paypal protocol
                //Send HTTP CODE 200
                HttpResponseMessage response = client.PostAsJsonAsync("cgi-bin/webscr", "").Result;

                if (response.IsSuccessStatusCode)
                {
                    //STEP 3
                    //Send the paypal request back with _notify-validate
                    string rawRequest = response.Content.ReadAsStringAsync().Result;
                    rawRequest += "&cmd=_notify-validate";

                    HttpContent content = new StringContent(rawRequest);

                    response = client.PostAsync("cgi-bin/webscr", content).Result;

                    if(response.IsSuccessStatusCode)
                    {
                        responseState = response.Content.ReadAsStringAsync().Result;
                    }
                }
            }

            return responseState;
        }

Answer 5

根据接受的答案，我想出了以下代码，为 ASP.NET MVC 实现 IPN 侦听器。该解决方案已部署并且似乎可以正常工作。

[HttpPost]
public async Task<ActionResult> Ipn()
{
    var ipn = Request.Form.AllKeys.ToDictionary(k => k, k => Request[k]);
    ipn.Add("cmd", "_notify-validate");

    var isIpnValid = await ValidateIpnAsync(ipn);
    if (isIpnValid)
    {
        // process the IPN
    }

    return new EmptyResult();
}

private static async Task<bool> ValidateIpnAsync(IEnumerable<KeyValuePair<string, string>> ipn)
{
    using (var client = new HttpClient())
    {
        const string PayPalUrl = "https://www.paypal.com/cgi-bin/webscr";

        // This is necessary in order for PayPal to not resend the IPN.
        await client.PostAsync(PayPalUrl, new StringContent(string.Empty));

        var response = await client.PostAsync(PayPalUrl, new FormUrlEncodedContent(ipn));

        var responseString = await response.Content.ReadAsStringAsync();
        return (responseString == "VERIFIED");
    }
}

编辑：

让我分享一下我的经验 - 到目前为止，上面的代码运行良好，但突然对于它正在处理的一个 IPN 失败，即responseString == "INVALID"。

问题原来是我的帐户设置为使用charset == windows-1252，这是 PayPal 的默认设置。但是，FormUrlEncodedContent 使用 UTF-8 进行编码，因此由于“ř”等国家字符，验证失败。解决方案是将charset设置为UTF-8，可以在个人资料>我的销售工具>贝宝按钮语言编码>更多选项中完成，见this SO thread。