PayPal REST API for PHPによる月額課金実装まとめ

Pocket

フージー（@fuujii__）です。

PHPで組んでるサイトでPayPal REST APIで月額課金を組んだとき、情報とっちらかってるので、まとめ。

1 PayPal登録〜実装まで
2 確認
3 関連サイト

PayPal登録〜実装まで

１　ペイパルwebサイトから登録

２　デベロッパーサイトでREST APIを登録

３　テストアカウントを登録

　販売者、購買者をそれぞれ登録。各100万円程度を登録。

４　WEBHOOKを登録

　今回は解約時だけを登録すれば事足りた。

５　プロジェクトにSDKを組み込み

❌ついてるけど大丈夫なんで気にしない。。

６　Making First Call

↓このページを読んでその通りにやる。GREAT!

Making First Call

７　サンプルコード

<?php

use PayPal\Api\ChargeModel;
use PayPal\Api\Currency;
use PayPal\Api\MerchantPreferences;
use PayPal\Api\PaymentDefinition;
use PayPal\Api\Plan;

use PayPal\Api\Patch;
use PayPal\Api\PatchRequest;
use PayPal\Common\PayPalModel;

use PayPal\Api\Agreement;
use PayPal\Api\Payer;
use PayPal\Api\ShippingAddress;

〜〜〜
        // 1. Autoload the SDK Package. This will include all the files and classes to your autoloader
		//        require ('../../PayPal-PHP-SDK/autoload.php');

        // 2. Provide your Secret Key. Replace the given one with your app clientId, and Secret
        // https://developer.paypal.com/webapps/developer/applications/myapps
        $apiContext = new \PayPal\Rest\ApiContext(
        new \PayPal\Auth\OAuthTokenCredential(
            PAYPAY_CLIENT_ID,     				// ClientID
            PAYPAY_CLIENT_SECRET      	// ClientSecret
            )
        );
        
        // Step 2.1 : Between Step 2 and Step 3
        $apiContext->setConfig(
            array(
                'mode' => 'sandbox',
                //                'mode' => 'live',
                'log.LogEnabled' => true,
                'log.FileName' => 'PayPal.log',
                'log.LogLevel' => 'DEBUG',
                'http.CURLOPT_CONNECTTIMEOUT' => 30,
                'validation.level'=>"disable",
                'cache.enabled'=>true,
                'cache.FileName'=>"auth.cache"
            )
        );
        
        //create plan
        // Create a new instance of Plan object
        $plan = new Plan();
        // # Basic Information
        // Fill up the basic information that is required for the plan
        $plan->setName('月額基本プラン')
        ->setDescription('テスト月額支払い基本コース。月額¥300-（税別）初月無料')
        ->setType('fixed');
        // # Payment definitions for this billing plan.
        $paymentDefinition = new PaymentDefinition();
        $paymentDefinition->setName('Regular Payments')
        ->setType('REGULAR')
        ->setFrequency('Month')
        ->setFrequencyInterval("1")
        ->setCycles("12")
        ->setAmount(new Currency(array('value' => 300, 'currency' => 'JPY')));
        // Charge Models
        $chargeModel = new ChargeModel();
        $chargeModel->setType('SHIPPING')
        ->setAmount(new Currency(array('value' => 30, 'currency' => 'JPY')));
        $paymentDefinition->setChargeModels(array($chargeModel));
        $merchantPreferences = new MerchantPreferences();
        $merchantPreferences->setReturnUrl($okurl)
        ->setCancelUrl($cancelurl)
        ->setAutoBillAmount("yes")
        ->setInitialFailAmountAction("CONTINUE")
        ->setMaxFailAttempts("0")
        ->setSetupFee(new Currency(array('value' => 0, 'currency' => 'JPY')));
        $plan->setPaymentDefinitions(array($paymentDefinition));
        $plan->setMerchantPreferences($merchantPreferences);
        try {
            $output = $plan->create($apiContext);
        } catch (Exception $ex) {
            exit(1);
        }
 
        //3 plan to ACTIVE
        $createdPlan=$output;
        try {
            $patch = new Patch();
            $value = new PayPalModel('{
	           "state":"ACTIVE"
	        }');
            $patch->setOp('replace')
            ->setPath('/')
            ->setValue($value);
            $patchRequest = new PatchRequest();
            $patchRequest->addPatch($patch);
            $createdPlan->update($patchRequest, $apiContext);
            $plan = Plan::get($createdPlan->getId(), $apiContext);
        } catch (Exception $ex) {
            exit(1);
        }

        $createdPlan=$plan;
        //4 create agreement
        $agreement = new Agreement();
        $agreement->setName('月額基本プラン')
        ->setDescription('テスト月額支払い基本コース。月額¥300-（税別）初月無料')
        ->setStartDate($startdate);
        // Add Plan ID
        $plan = new Plan();
        $plan->setId($createdPlan->getId());
        
        $agreement->setPlan($plan);
        // Add Payer
        $payer = new Payer();
        $payer->setPaymentMethod('paypal');
        $agreement->setPayer($payer);

        try {
            $agreement = $agreement->create($apiContext);
            $approvalUrl = $agreement->getApprovalLink();
        } catch (Exception $ex) {
            exit(1);
        }
        
        // リダイレクト先のURLへ転送する
        header('Location: ' . $approvalUrl, true, 301);
        
        // すべての出力を終了
        exit;

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

<?php

use PayPal\Api\ChargeModel;

use PayPal\Api\Currency;

use PayPal\Api\MerchantPreferences;

use PayPal\Api\PaymentDefinition;

use PayPal\Api\Plan;

use PayPal\Api\Patch;

use PayPal\Api\PatchRequest;

use PayPal\Common\PayPalModel;

use PayPal\Api\Agreement;

use PayPal\Api\Payer;

use PayPal\Api\ShippingAddress;

〜〜〜

// 1. Autoload the SDK Package. This will include all the files and classes to your autoloader

// require ('../../PayPal-PHP-SDK/autoload.php');

// 2. Provide your Secret Key. Replace the given one with your app clientId, and Secret

// https://developer.paypal.com/webapps/developer/applications/myapps

$apiContext = new \PayPal\Rest\ApiContext(

new \PayPal\Auth\OAuthTokenCredential(

PAYPAY_CLIENT_ID, // ClientID

PAYPAY_CLIENT_SECRET // ClientSecret

)

);

// Step 2.1 : Between Step 2 and Step 3

$apiContext->setConfig(

array(

'mode' => 'sandbox',

// 'mode' => 'live',

'log.LogEnabled' => true,

'log.FileName' => 'PayPal.log',

'log.LogLevel' => 'DEBUG',

'http.CURLOPT_CONNECTTIMEOUT' => 30,

'validation.level'=>"disable",

'cache.enabled'=>true,

'cache.FileName'=>"auth.cache"

)

);

//create plan

// Create a new instance of Plan object

$plan = new Plan();

// # Basic Information

// Fill up the basic information that is required for the plan

$plan->setName('月額基本プラン')

->setDescription('テスト月額支払い基本コース。月額¥300-（税別）初月無料')

->setType('fixed');

// # Payment definitions for this billing plan.

$paymentDefinition = new PaymentDefinition();

$paymentDefinition->setName('Regular Payments')

->setType('REGULAR')

->setFrequency('Month')

->setFrequencyInterval("1")

->setCycles("12")

->setAmount(new Currency(array('value' => 300, 'currency' => 'JPY')));

// Charge Models

$chargeModel = new ChargeModel();

$chargeModel->setType('SHIPPING')

->setAmount(new Currency(array('value' => 30, 'currency' => 'JPY')));

$paymentDefinition->setChargeModels(array($chargeModel));

$merchantPreferences = new MerchantPreferences();

$merchantPreferences->setReturnUrl($okurl)

->setCancelUrl($cancelurl)

->setAutoBillAmount("yes")

->setInitialFailAmountAction("CONTINUE")

->setMaxFailAttempts("0")

->setSetupFee(new Currency(array('value' => 0, 'currency' => 'JPY')));

$plan->setPaymentDefinitions(array($paymentDefinition));

$plan->setMerchantPreferences($merchantPreferences);

try {

$output = $plan->create($apiContext);

} catch (Exception $ex) {

exit(1);

}

//3 plan to ACTIVE

$createdPlan=$output;

try {

$patch = new Patch();

$value = new PayPalModel('{

"state":"ACTIVE"

}');

$patch->setOp('replace')

->setPath('/')

->setValue($value);

$patchRequest = new PatchRequest();

$patchRequest->addPatch($patch);

$createdPlan->update($patchRequest, $apiContext);

$plan = Plan::get($createdPlan->getId(), $apiContext);

} catch (Exception $ex) {

exit(1);

}

$createdPlan=$plan;

//4 create agreement

$agreement = new Agreement();

$agreement->setName('月額基本プラン')

->setDescription('テスト月額支払い基本コース。月額¥300-（税別）初月無料')

->setStartDate($startdate);

// Add Plan ID

$plan = new Plan();

$plan->setId($createdPlan->getId());

$agreement->setPlan($plan);

// Add Payer

$payer = new Payer();

$payer->setPaymentMethod('paypal');

$agreement->setPayer($payer);

try {

$agreement = $agreement->create($apiContext);

$approvalUrl = $agreement->getApprovalLink();

} catch (Exception $ex) {

exit(1);

}

// リダイレクト先のURLへ転送する

header('Location: ' . $approvalUrl, true, 301);

// すべての出力を終了

exit;

確認

サンドボックスサイトで、購入者アカウントでは購入履歴が見られる。販売者アカウントでは販売履歴が見られる。

デベロッパーサイトでは下記のようにnotificationsがきていることを確認できる。

またwebhookの状態も確認できる。

webhookは保留などになっている場合は正常にスクリプトが叩かれていない。webレスポンスが200 OKであれば正常に叩かれたと表示される。

PayPal登録〜実装まで

確認

関連サイト

コメント