首頁 > 後端開發 > php教程 > Paypal實現循環扣款(訂閱)功能的範例程式碼分享

Paypal實現循環扣款(訂閱)功能的範例程式碼分享

黄舟
發布: 2023-03-06 21:14:01
原創
3030 人瀏覽過

本文主要介紹了Paypal實現循環扣款(訂閱)的想法與方法;並對如何使用Paypal的支付介面做下總結,具有很好的參考價值。下面跟著小編一起來看吧

起因

業務需求要整合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還是很繁瑣的,同時我們只想盡快完成業務要求而不是陷入對API的深入了解。

那麼如何開始呢,建議直接安裝官方提供的PayPal-PHP-SDK,透過其Wiki作為起點。

在完成首個範例之前,請確保你有Sandbox帳號,並且正確配置了:

  • Client ID

  • Client Secret

  • Webhook API(必須是https開頭且是443端口,本地調試建議結合ngrok反向代理生成地址)

  • #Returnurl(注意項目同上)

  • #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已經做進去,本文也不談。

    如何實現循環扣款

    #分成四個步驟:

    1. 建立昇級計劃,並啟動;

    2. 建立訂閱(創建Agreement),然後將跳到Paypal的網站等待使用者同意;

    3. ##使用者同意後,執行訂閱

    4. 取得扣款帳單

    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"
     ];
    登入後複製

    建立並啟動計畫程式碼如下:

     //上面的$param例子是个数组,我的实际应用传入的实际是个对象,用户理解下就好。
     public function createPlan($param)
     {
     $apiContext = $this->getApiContext();
     $plan = new Plan();
     // # Basic Information
     // Fill up the basic information that is required for the plan
     $plan->setName($param->name)
     ->setDescription($param->desc)
     ->setType('INFINITE');//例子总是设置为无限循环
     // # Payment definitions for this billing plan.
     $paymentDefinition = new PaymentDefinition();
     // The possible values for such setters are mentioned in the setter method documentation.
     // Just open the class file. e.g. lib/PayPal/Api/PaymentDefinition.php and look for setFrequency method.
     // You should be able to see the acceptable values in the comments.
     $paymentDefinition->setName($param->name)
     ->setType($param->type)
     ->setFrequency($param->frequency)
     ->setFrequencyInterval((string)$param->frequency_interval)
     ->setCycles((string)$param->cycles)
     ->setAmount(new Currency(array('value' => $param->amount, 'currency' => $param->currency)));
     // Charge Models
     $chargeModel = new ChargeModel();
     $chargeModel->setType('TAX')
     ->setAmount(new Currency(array('value' => 0, 'currency' => $param->currency)));
     $returnUrl = config('payment.returnurl');
     $merchantPreferences = new MerchantPreferences();
     $merchantPreferences->setReturnUrl("$returnUrl?success=true")
     ->setCancelUrl("$returnUrl?success=false")
     ->setAutoBillAmount("yes")
     ->setInitialFailAmountAction("CONTINUE")
     ->setMaxFailAttempts("0")
     ->setSetupFee(new Currency(array('value' => $param->amount, 'currency' => 'USD')));
     $plan->setPaymentDefinitions(array($paymentDefinition));
     $plan->setMerchantPreferences($merchantPreferences);
     // For Sample Purposes Only.
     $request = clone $plan;
     // ### Create Plan
     try {
     $output = $plan->create($apiContext);
     } catch (Exception $ex) {
     return false;
     }
     $patch = new Patch();
     $value = new PayPalModel('{"state":"ACTIVE"}');
     $patch->setOp('replace')
     ->setPath('/')
     ->setValue($value);
     $patchRequest = new PatchRequest();
     $patchRequest->addPatch($patch);
     $output->update($patchRequest, $apiContext);
     return $output;
     }
    登入後複製

    2.創建訂閱(創建Agreement),然後將跳到Paypal的網站等待用戶同意

    #Plan創建後,要怎麼讓用戶訂閱呢,其實就是創建Agreement,關於Agreement,有以下注意點:

    • 如前面所述,Plan物件的setSetupFee方法,設定了完成訂閱後首次扣款的費用,而Agreement物件的循環扣款方法設定的是第2次開始時的費用。

    • setStartDate方法設定的是第2次扣款時的時間,因此如果你按月循環,應該是當前時間加一個月,同時該方法要求時間格式是ISO8601格式,使用Carbon庫可輕鬆解決;

    • 在創建Agreement的時候,此時還沒有產生唯一ID,於是我碰到了一點小困難:那就是當用戶完成訂閱的時候,我怎麼知道這個訂閱是哪個用戶的?透過Agreement的getApprovalLink方法得到的URL,裡面的token是唯一的,我透過提取該token作為識別方式,在用戶完成訂閱後替換成真正的ID。

    範例參數如下:

    $param = [
     'id' => 'P-26T36113JT475352643KGIHY',//上一步创建Plan时生成的ID
     'name' => 'Standard', 
     'desc' => 'Standard Plan for one month'
    ];
    登入後複製

    程式碼如下:

     public function createPayment($param)
     {
     $apiContext = $this->getApiContext();
     $agreement = new Agreement();
     $agreement->setName($param['name'])
     ->setDescription($param['desc'])
     ->setStartDate(Carbon::now()->addMonths(1)->toIso8601String());
     // Add Plan ID
     // Please note that the plan Id should be only set in this case.
     $plan = new Plan();
     $plan->setId($param['id']);
     $agreement->setPlan($plan);
     // Add Payer
     $payer = new Payer();
     $payer->setPaymentMethod('paypal');
     $agreement->setPayer($payer);
     // For Sample Purposes Only.
     $request = clone $agreement;
     // ### Create Agreement
     try {
     // Please note that as the agreement has not yet activated, we wont be receiving the ID just yet.
     $agreement = $agreement->create($apiContext);
     // ### Get redirect url
     // The API response provides the url that you must redirect
     // the buyer to. Retrieve the url from the $agreement->getApprovalLink()
     // method
     $approvalUrl = $agreement->getApprovalLink();
     } catch (Exception $ex) {
     return "create payment failed, please retry or contact the merchant.";
     }
     return $approvalUrl;//跳转到$approvalUrl,等待用户同意
     }
    登入後複製

    函數執行後傳回$approvalUrl,記得透過redirect( $approvalUrl)跳到Paypal的網站等待用戶付款。

    用戶同意後,執行訂閱

    用戶同意後,訂閱還未完成,必須執行Agreement的execute方法才算完成真正的訂閱。這一步驟的注意點在於

    • 完成訂閱後,並不等於扣款,可能會延遲幾分鐘;

    • ##如果第一步的setSetupFee費用設定為0,則必須等到循環扣款的時間到了才會產生訂單;

    程式碼片段如下:

     public function onPay($request)
     {
     $apiContext = $this->getApiContext();
     if ($request->has('success') && $request->success == 'true') {
     $token = $request->token;
     $agreement = new \PayPal\Api\Agreement();
     try {
     $agreement->execute($token, $apiContext);
     } catch(\Exception $e) {
     return ull;
     return $agreement;
     }
     return null;
     }
    登入後複製

    • #在取得交易記錄

    • 訂閱後,可能不會立刻產生交易扣費的交易記錄,如果為空則過幾分鐘再嘗試。本步驟注意點:

    • start_date與end_date不能為空

    • #實際測試時,該函數傳回的物件不能總是傳回空的JSON對象,因此如果有需要輸出JSON,請依照AgreementTransactions的API說明,手動取出對應參數。

       /** 获取交易记录
       * @param $id subscription payment_id
       * @warning 总是获取该subscription的所有记录
       */
       public function transactions($id)
       {
       $apiContext = $this->getApiContext();
       $params = ['start_date' => date('Y-m-d', strtotime('-15 years')), 'end_date' => date('Y-m-d', strtotime('+5 days'))];
       try {
       $result = Agreement::searchTransactions($id, $params, $apiContext);
       } catch(\Exception $e) {
       Log::error("get transactions failed" . $e->getMessage());
       return null;
       }
       return $result->getAgreementTransactionList() ;
       }
      登入後複製
      最後,Paypal官方當然也有對應的教程,不過是呼叫原生介面的,跟我上面流程不一樣點在於只說了前3步### ###需要考慮的問題#########功能是實現了,但是也發現不少注意點:############國內使用Sandbox測試時連接特別慢,經常提示逾時或出錯,因此需要特別考慮執行中途用戶關閉頁面的情況;#############一定要實現webhook,否則當用戶進Paypal取消訂閱時,你的網站將得不到通知;############訂閱(Agreement)一旦產生,除非主動取消,否則將一直生效。因此如果你的網站設計了多個升級方案(例如Basic,Standard,Advanced),當使用者已經訂閱某個方案後,去切換升級方案時,開發上必須取消前一個升級方案;###### ######用戶同意訂閱-(取消舊訂閱-完成新訂閱的簽約-###修改用戶資訊###為新的訂閱),括號整個過程應該是原子操作,同時耗時又長,因此應該將其放到###隊列###中執行直到成功體驗會更好。 ##########

      以上是Paypal實現循環扣款(訂閱)功能的範例程式碼分享的詳細內容。更多資訊請關注PHP中文網其他相關文章!

    相關標籤:
    來源:php.cn
    本網站聲明
    本文內容由網友自願投稿,版權歸原作者所有。本站不承擔相應的法律責任。如發現涉嫌抄襲或侵權的內容,請聯絡admin@php.cn
    熱門教學
    更多>
    最新下載
    更多>
    網站特效
    網站源碼
    網站素材
    前端模板