Paypal实现循环扣款（订阅）功能

yskl

            起因
业务需求要集成Paypal，实现循环扣款功能，然而百度和GOOGLE了一圈，除官网外，没找到相关开发教程，只好在Paypal上看，花了两天后集成成功，这里对如何使用Paypal的支付接口做下总结。
Paypal现在有多套接口：

  

通过Braintree（后面会谈Braintree)实现Express Checkout;
  

创建App，通过REST Api的接口方式（现在的主流接口方式）;
  

NVP/SOAP API apps的接口（旧接口）;

Braintree的接口
Braintree是Paypal收购的一家公司，它除了支持Paypal的支付外，还提供了升级计划，信用卡，客户信息等一系列全套的管理，使用上更方便；这些功能Paypal第二套REST接口其实也集成了大部分，但是Paypal的Dashboard不能直接管理这些信息而Braintree可以，所以我其实我更愿意用Braintree。关键是我使用的后端框架是Laravel，它的cashier解决方案默认可以支持Braintee，所以这套接口是我的首选。但是当我把它的功能都实现后发现一个蛋疼的问题：Braintree在国内不支持。。。。。。卒。。。
REST API
这是顺应时代发展的产物，如果你之前用过OAuth 2.0与REST API，那看这些接口应该不会有什么困惑。
旧接口
除非REST API接口有不能满足的，比如政策限制，否则不推荐使用。全世界都在往OAuth 2.0的认证方式和REST API的API使用方式迁移，干嘛逆势而行呢。因此在REST API能解决问题情况下，我也没对这套接口做深入比较。
REST API的介绍
官方的API参考文档https://developer.paypal.com/webapps/developer/docs/api/对于其API和使用方式有较详细的介绍，但是如果自己直接调这些API还是很繁琐的，同时我们只想尽快完成业务要求而不是陷入对API的深入了解。
那么如何开始呢，建议直接安装官方提供的PayPal-PHP-SDK，通过其Wiki作为起点。
在完成首个例子之前，请确保你有Sandbox帐号，并正确配置了：

  

Client ID
  

Client Secret
  

Webhook API(必须是https开头且是443端口，本地调试建议结合ngrok反向代理生成地址)
  

Returnurl（注意项同上）

在完成Wiki的首个例子后，理解下接口的分类有助于完成你的业务需求，下面我对接口分类做个介绍，请结合例子理解http://paypal.github.io/PayPal-PHP-SDK/sample/#payments。

  

Payments 一次性支付接口，不支持循环捐款。主要支付内容有支持Paypal支付，信用卡支付，通过已保存的信用卡支持（需要使用Vault接口，会有这样的接口主要是PCI的要求，不允许一般的网站采集信用卡的敏感信息），支持付给第三方收款人。
  

Payouts 没用到，忽略；
  

Authorization and Capture 支持直接通过Paypal的帐号登陆你的网站，并获取相关信息;
  

Sale 跟商城有关，没用到，忽略;
  

Order 跟商城有关，没用到，忽略;
  

Billing Plan & Agreements 升级计划和签约，也就是订阅功能，实现循环扣款必须使用这里的功能，这是本文的重点；
  

Vault 存储信用卡信息
  

Payment Experience 没用到，忽略;
  

Notifications 处理Webhook的信息，重要，但不是本文关注内容;
  

Invoice 票据处理；
  

Identity 认证处理，实现OAuth 2.0的登陆，获取对应token以便请求其他API，这块Paypal-PHP-SDK已经做进去，本文也不谈。

如何实现循环扣款
分四个步骤：
[ol]
  

创建升级计划，并激活；
  

创建订阅(创建Agreement)，然后将跳转到Paypal的网站等待用户同意;
  

用户同意后，执行订阅
  

获取扣款帐单
[/ol]
1.创建升级计划
升级计划对应Plan这个类。这一步有几个注意点：

  

升级计划创建后，处于CREATED状态，必须将状态修改为ACTIVE才能正常使用。
  

Plan有PaymentDefinition和MerchantPreferences两个对象，这两个对象都不能为空；
  

如果想创建TRIAL类型的计划，该计划还必须有配套的REGULAR的支付定义，否则会报错；
  

看代码有调用一个setSetupFee（非常，非常，非常重要）方法，该方法设置了完成订阅后首次扣款的费用，而Agreement对象的循环扣款方法设置的是第2次开始时的费用。

以创建一个Standard的计划为例，其参数如下：
$param = [
"name" => "standard_monthly",
"display_name" => "Standard Plan",
"desc" => "standard Plan for one month",
"type" => "REGULAR",
"frequency" => "MONTH",
"frequency_interval" => 1,
"cycles" => 0,
"amount" => 20,
"currency" => "USD"
];