Ticket #3169 - Integration itself.

modules/boonex/payment/classes/BxPaymentProviderPayPalApi.php

@@ -0,0 +1,725 @@
+<?php defined('BX_DOL') or die('hack attempt');
+/**
+ * Copyright (c) UNA, Inc - https://una.io
+ * MIT License - https://opensource.org/licenses/MIT
+ *
+ * @defgroup    Payment Payment
+ * @ingroup     UnaModules
+ *
+ * @{
+ */
+
+/*
+ * 1. Set up server-side SDK:
+ * https://developer.paypal.com/docs/business/checkout/server-side-api-calls/set-up-sdk/
+ * 
+ * 2. Orders API
+ * https://developer.paypal.com/docs/api/orders/v2
+ * 
+ * 2.1. Checkout SDK in GitHUB
+ * https://github.com/paypal/Checkout-PHP-SDK/
+ * 
+ * 3. Subscriptions:
+ * https://developer.paypal.com/docs/subscriptions/
+ * https://developer.paypal.com/docs/business/subscriptions/
+ * 
+ * 3.1. API
+ * https://developer.paypal.com/docs/api/subscriptions/v1
+ * https://developer.paypal.com/docs/api/catalog-products/v1
+ * 
+ * 3.2. Integration
+ * https://developer.paypal.com/docs/subscriptions/integrate/
+ * 
+ * 3.3 WebHooks
+ * https://developer.paypal.com/docs/api-basics/notifications/webhooks/rest/
+ * 
+ */
+
+require_once(BX_DIRECTORY_PATH_PLUGINS . 'paypal/autoload.php');
+
+use PayPalCheckoutSdk\Core\PayPalHttpClient;
+use PayPalCheckoutSdk\Core\SandboxEnvironment;
+use PayPalCheckoutSdk\Core\ProductionEnvironment;
+use PayPalCheckoutSdk\Orders\OrdersCreateRequest;
+use PayPalCheckoutSdk\Orders\OrdersCaptureRequest;
+
+define('PP_API_MODE_LIVE', 1);
+define('PP_API_MODE_TEST', 2);
+define('PP_API_MODE_DEFAULT', PP_API_MODE_LIVE);
+
+define('PP_API_SBS_STATUS_APPROVAL_PENDING', 'APPROVAL_PENDING');
+define('PP_API_SBS_STATUS_APPROVED', 'APPROVED');
+define('PP_API_SBS_STATUS_ACTIVE', 'ACTIVE');
+
+class BxPaymentProviderPayPalApi extends BxBaseModPaymentProvider implements iBxBaseModPaymentProvider
+{
+    protected $_oSession;
+    protected $_sSessionKeyOrder;
+    protected $_sSessionKeySubscription;
+
+    protected $_bCheckAmount;
+    protected $_iMode;
+    protected $_sEndpoint;
+    protected $_sToken;
+
+    function __construct($aConfig)
+    {
+    	$this->MODULE = 'bx_payment';
+
+        parent::__construct($aConfig);
+
+        $this->_oSession = BxDolSession::getInstance();
+        $this->_sSessionKeyOrder = $this->MODULE . '_' . $this->_sPrefix . 'order';
+        $this->_sSessionKeySubscription = $this->MODULE . '_' . $this->_sPrefix . 'subscription';
+
+        $this->_bCheckAmount = true;
+        $this->_iMode = (int)$this->getOption('mode');
+        $this->_sEndpoint = 'https://api-m.' . ($this->_iMode == PP_API_MODE_TEST ? 'sandbox' : '') . '.paypal.com/';
+    }
+
+    public function initializeCheckout($iPendingId, $aCartInfo)
+    {
+        if(empty($aCartInfo['items']) || !is_array($aCartInfo['items']))
+            return $this->_sLangsPrefix . 'err_empty_items';
+
+        $aPending = $this->_oModule->_oDb->getOrderPending(array('type' => 'id', 'id' => $iPendingId));
+        if(!empty($aPending['order']) || !empty($aPending['error_code']) || !empty($aPending['error_msg']) || (int)$aPending['processed'] != 0)
+            return $this->_sLangsPrefix . 'err_already_processed';
+
+        switch($aPending['type']) {
+            case BX_PAYMENT_TYPE_SINGLE:
+                $mixedResult = $this->_createOrder($iPendingId, $aCartInfo);
+                if($mixedResult === false)
+                    return $this->_sLangsPrefix . 'err_cannot_perform';
+
+                $this->_setSessionOrder($mixedResult['order']);
+                header("Location: " . $mixedResult['redirect']);
+                exit;
+
+            case BX_PAYMENT_TYPE_RECURRING:
+                $mixedResult = $this->_createSubscription($iPendingId, $aCartInfo);
+                if(is_string($mixedResult))
+                    return $mixedResult;
+
+                $this->_setSessionSubscription($mixedResult['subscription']);
+                return array(
+                    'code' => 0,
+                    'redirect' => $mixedResult['redirect'],
+                );
+        }
+    }
+
+    public function finalizeCheckout(&$aData)
+    {
+        $sMethod = '_finalizeCheckout' . bx_gen_method_name(!empty($aData['subscription_id']) && !empty('ba_token') ? BX_PAYMENT_TYPE_RECURRING : BX_PAYMENT_TYPE_SINGLE);
+
+        $aResult = $this->$sMethod($aData);
+        if(!isset($aResult['code']) || (int)$aResult['code'] != BX_PAYMENT_RESULT_SUCCESS) {
+            $this->log($aResult, 'Finalize Checkout Failed:');
+            $this->log($aData, 'Finalize Checkout Input:');
+        }
+
+        return $aResult;
+    }
+
+    public function notify()
+    {
+        $iResult = $this->_processEvent();
+        http_response_code($iResult);
+    }
+
+    public function getClientId()
+    {
+        return $this->getOption($this->_getMode() . '_client_id');
+    }
+
+    public function getSecret()
+    {
+        return $this->getOption($this->_getMode() . '_secret');
+    }
+
+    protected function _finalizeCheckoutSingle(&$aData)
+    {
+        $sOrder = '';
+        if(!empty($aData['token']))
+            $sOrder = bx_process_input($aData['token']);
+        if(empty($sOrder))
+            $sOrder = $this->_getSessionOrder();
+        if(empty($sOrder))
+            return array('code' => 1, 'message' => $this->_sLangsPrefix . 'err_empty_order');
+
+        $mixedResult = $this->_captureOrder($sOrder);
+        if($mixedResult === false)
+            return array('code' => 2, 'message' => $this->_sLangsPrefix . 'pp_api_err_cannot_capture');
+
+        $aResult = array(
+            'code' => BX_PAYMENT_RESULT_SUCCESS, 
+            'message' => $this->_sLangsPrefix . 'pp_api_msg_captured',
+            'pending_id' => $mixedResult['pending_id'],
+            'client_name' => _t($this->_sLangsPrefix . 'txt_buyer_name_mask', $mixedResult['client_first_name'], $mixedResult['client_last_name']),
+            'client_email' => $mixedResult['client_email'],
+            'paid' => true
+        );
+
+        //--- Update pending transaction
+        $this->_oModule->_oDb->updateOrderPending($aResult['pending_id'], array(
+            'order' => $mixedResult['order'],
+            'error_code' => $aResult['code'],
+            'error_msg' => _t($aResult['message'])
+        ));
+
+        return $aResult;
+    }
+
+    protected function _finalizeCheckoutRecurring(&$aData)
+    {
+        $sSubscription = '';
+        if(!empty($aData['subscription_id']))
+            $sSubscription = bx_process_input($aData['subscription_id']);
+        if(empty($sSubscription))
+            $sSubscription = $this->_getSessionSubscription();
+        if(empty($sSubscription))
+            return array('code' => 1, 'message' => $this->_sLangsPrefix . 'pp_api_err_no_subscription');
+
+        $aSubscription = $this->_getSubscription($sSubscription);
+        if(empty($aSubscription) || !in_array($aSubscription['status'], array(PP_API_SBS_STATUS_APPROVAL_PENDING, PP_API_SBS_STATUS_APPROVED, PP_API_SBS_STATUS_ACTIVE)))
+            return array('code' => 2, 'message' => $this->_sLangsPrefix . 'pp_api_err_no_subscription');
+
+        $aSubscriber = $this->_getClientInfo($aSubscription['subscriber']);
+
+        $aResult = array(
+            'code' => BX_PAYMENT_RESULT_SUCCESS, 
+            'message' => $this->_sLangsPrefix . 'pp_api_msg_subscribed',
+            'pending_id' => $aSubscription['custom_id'],
+            'customer_id' => $aSubscription['subscriber']['payer_id'], 
+            'subscription_id' => $sSubscription,
+            'client_name' => _t($this->_sLangsPrefix . 'txt_buyer_name_mask', $aSubscriber['client_first_name'], $aSubscriber['client_last_name']),
+            'client_email' => $aSubscriber['client_email']
+        );
+
+        if($aSubscription['status'] == PP_API_SBS_STATUS_APPROVAL_PENDING)       
+            $aResult = array_merge($aResult, array(
+                'code' => 3,
+                'message' => $this->_sLangsPrefix . 'pp_api_err_subscription_not_confirmed'
+            ));
+
+        //--- Update pending transaction
+        $this->_oModule->_oDb->updateOrderPending($aResult['pending_id'], array(
+            'order' => $sSubscription,
+            'error_code' => $aResult['code'],
+            'error_msg' => _t($aResult['message'])
+        ));
+
+        return $aResult;
+    }
+
+    /**
+     * Methods which use common HTTPS calls to process Recurring time payments.
+     */
+    protected function _createSubscription($iPendingId, $aCartInfo, $sReturnType = 'approve')
+    {
+        $aItem = array_shift($aCartInfo['items']);
+        if(empty($aItem) || !is_array($aItem))
+            return $this->_sLangsPrefix . 'pp_api_err_no_item';
+
+        $aItem['price_currency'] = $aCartInfo['vendor_currency_code'];
+
+        $aProduct = $this->_getProduct($aItem['name']);
+        if(empty($aProduct)) {
+            $aProduct = $this->_createProduct($aItem);
+            if($aProduct === false)
+                return $this->_sLangsPrefix . 'err_cannot_perform';
+        }
+
+        $aProductPlan = array();
+
+        $aPlans = $this->_getPlans($aProduct['id']);
+        if(!empty($aPlans)) 
+            foreach($aPlans as $aPlan)
+                if(strcmp($aPlan['name'], $aItem['name']) == 0) {
+                    $aProductPlan = $aPlan;
+                    break;
+                }
+        
+        if(empty($aProductPlan) || !is_array($aProductPlan)) {
+            $aProductPlan = $this->_createPlan($aProduct['id'], $aItem);
+            if($aProductPlan === false)
+                return $this->_sLangsPrefix . 'err_cannot_perform';
+        }
+
+        $mixedResult = $this->_apiCallAuthorized($this->_sEndpoint . 'v1/billing/subscriptions', array(
+            'plan_id' => $aProductPlan['id'],
+            'custom_id' => $iPendingId,
+            'application_context' => array(
+                'cancel_url' => $aItem['url'],
+                'return_url' => $this->getReturnDataUrl($aCartInfo['vendor_id'])
+            )
+        ));
+
+        if($mixedResult === false || empty($mixedResult['id']) || empty($mixedResult['links'])) {
+            $this->log($mixedResult, 'Create Subscription:');
+
+            return $this->_sLangsPrefix . 'err_cannot_perform';
+        }
+
+        $mixedLink = false;
+        foreach($mixedResult['links'] as $aLink)
+            if($aLink['rel'] == $sReturnType) {
+                $mixedLink = $aLink['href'];
+                break;
+            }
+
+        return array(
+            'subscription' => $mixedResult['id'],
+            'redirect' => $mixedLink
+        );
+    }
+
+    protected function _getSubscription($sSubscriptionId)
+    {
+        $mixedResult = $this->_apiCallAuthorized($this->_sEndpoint . 'v1/billing/subscriptions/' . $sSubscriptionId, array(), array(), 'get');
+        if($mixedResult === false || !isset($mixedResult['id'])) {
+            $this->log($mixedResult, 'Get Subscription:');
+
+            return array();
+        }
+
+        return $mixedResult;
+    }
+
+    protected function _createProduct($aItem)
+    {
+        $mixedResult = $this->_apiCallAuthorized($this->_sEndpoint . 'v1/catalogs/products', array(
+            'id' => $aItem['name'],
+            'name' => $aItem['title'],
+            'description' => $aItem['description'],
+            'type' => 'DIGITAL',
+            'home_url' => $aItem['url'],
+        ), array(
+            'PayPal-Request-Id: bx_prod_' . $aItem['name']
+        ));
+
+        if($mixedResult === false)
+            $this->log($mixedResult, 'Create Product:');
+
+        return $mixedResult;
+    }
+    
+    protected function _getProduct($sProductId)
+    {
+        $mixedResult = $this->_apiCallAuthorized($this->_sEndpoint . 'v1/catalogs/products/' . $sProductId, array(), array(), 'get');
+        if($mixedResult === false || !isset($mixedResult['id'])) {
+            $this->log($mixedResult, 'Get Product:');
+
+            return array();
+        }
+
+        return $mixedResult;
+    }
+
+    protected function _createPlan($sProductId, $aItem)
+    {
+        $aCycles = array();
+
+        $sIntervalUnit = $this->_getIntervalUnit($aItem['period_unit_recurring']);
+        if($sIntervalUnit === false)
+            return false;
+
+        $iSequence = 1;
+
+        $iTrial = $this->_oModule->_oConfig->getTrial(BX_PAYMENT_TYPE_RECURRING, $aItem);
+        if(!empty($iTrial)) 
+            $aCycles[] = array(
+                'frequency' => array(
+                    'interval_unit' => $this->_getIntervalUnit(BX_PAYMENT_SBS_PU_DAY),
+                    'interval_count' => $iTrial
+                ),
+                'tenure_type' => 'TRIAL',
+                'sequence' => $iSequence++,
+                'total_cycles' => 1,
+            );
+
+        $aCycles[] = array(
+            'frequency' => array(
+                'interval_unit' => $sIntervalUnit,
+                'interval_count' => (int)$aItem['period_recurring']
+            ),
+            'tenure_type' => 'REGULAR',
+            'sequence' => $iSequence,
+            'total_cycles' => 0,
+            'pricing_scheme' => array(
+                'fixed_price' => array(
+                    'value' => $this->_oModule->_oConfig->getPrice(BX_PAYMENT_TYPE_RECURRING, $aItem),
+                    'currency_code' => $aItem['price_currency']
+                )
+            )
+        );
+
+        $mixedResult = $this->_apiCallAuthorized($this->_sEndpoint . 'v1/billing/plans', array(
+            'product_id' => $sProductId,
+            'name' => $aItem['name'],
+            'description' => $aItem['title'],
+            'billing_cycles' => $aCycles,
+            'payment_preferences' => array(
+                'auto_bill_outstanding' => true,
+                'setup_fee' => array(
+                    'value' => 0,
+                    'currency_code' => $aItem['price_currency']
+                ),
+                'setup_fee_failure_action' => 'CONTINUE',
+                'payment_failure_threshold' => 3
+            ),
+        ), array(
+            'PayPal-Request-Id: bx_plan_' . $aItem['name']
+        ));
+
+        if($mixedResult === false)
+            $this->log($mixedResult, 'Create Plan:');
+
+        return $mixedResult;
+    }
+
+    protected function _getPlan($sPlanId)
+    {
+        $mixedResult = $this->_apiCallAuthorized($this->_sEndpoint . 'v1/billing/plans/' . $sPlanId, array(), array(), 'get');
+        if($mixedResult === false || !isset($mixedResult['id'])) {
+            $this->log($mixedResult, 'Get Plan:');
+
+            return array();
+        }
+
+        return $mixedResult;
+    }
+
+    protected function _getPlans($sProductId, $iStart = false, $iPerPage = false)
+    {
+        $aParams = array(
+            'product_id' => $sProductId,
+        );
+        
+        if($iStart !== false)
+            $aParams['page'] = (int)$iStart >= 1 && (int)$iStart <= 100000 ? $iStart : 1;
+        if($iPerPage !== false)
+            $aParams['page_size'] = (int)$iPerPage >= 1 && (int)$iPerPage <= 20 ? $iPerPage : 20;
+
+        $mixedResult = $this->_apiCallAuthorized($this->_sEndpoint . 'v1/billing/plans', $aParams, array(), 'get');
+        if(empty($mixedResult) || !is_array($mixedResult) || !isset($mixedResult['plans'])) {
+            $this->log($mixedResult, 'Get Plans:');
+
+            return array();
+        }
+
+        return $mixedResult['plans'];
+    }
+
+    protected function _getToken()
+    {
+        $mixedResult = $this->_apiCall($this->_sEndpoint . 'v1/oauth2/token', array(
+            'grant_type' => 'client_credentials'
+        ), array(), 'post', array(
+            'user' => $this->getClientId(),
+            'password' => $this->getSecret()
+        ));
+
+        if($mixedResult === false || empty($mixedResult['access_token'])) {
+            $this->log($mixedResult, 'Get Token:');
+
+            return false;
+        }
+
+        return $mixedResult['access_token'];
+    }
+
+    protected function _apiCallAuthorized($sEndpoint, $aParams = array(), $aHeaders = array(), $sMethod = 'post-json')
+    {
+        if(!$this->_sToken)
+            $this->_sToken = $this->_getToken();
+
+        $aHeaders = array_merge(array(
+            'Authorization: Bearer ' . $this->_sToken,
+            'Prefer: return=representation'
+        ), $aHeaders);
+
+        return $this->_apiCall($sEndpoint, $aParams, $aHeaders, $sMethod);
+    }
+
+    protected function _apiCall($sEndpoint, $aParams = array(), $aHeaders = array(), $sMethod = 'post-json', $aBasicAuth = array())
+    {
+        $sHttpCode = null;
+        $aHeaders = array_merge(array(
+            'Accept: application/json',
+            'Content-Type: application/json'
+        ), $aHeaders);
+
+        $sResult = bx_file_get_contents($sEndpoint, $aParams, $sMethod, $aHeaders, $sHttpCode, $aBasicAuth);
+        if(empty($sResult))
+            return false;
+
+        return json_decode($sResult, true);
+    }
+
+    protected function _getIntervalUnit($sPeriodUnit)
+    {
+        $aIntervalUnits = array(
+            BX_PAYMENT_SBS_PU_DAY => 'DAY',
+            BX_PAYMENT_SBS_PU_WEEK => 'WEEK',
+            BX_PAYMENT_SBS_PU_MONTH => 'MONTH',
+            BX_PAYMENT_SBS_PU_YEAR => 'YEAR'
+        );
+
+        return isset($aIntervalUnits[$sPeriodUnit]) ? $aIntervalUnits[$sPeriodUnit] : false;
+    }
+
+
+    /**
+     * Methods which use 'Checkout SDK' to process Single time payments.
+     */
+    protected function _getClient()
+    {
+        $sClientId = $this->getClientId();
+        $sSecret = $this->getSecret();
+
+        if($this->_iMode == PP_API_MODE_LIVE)
+            $oEnvironment = new ProductionEnvironment($sClientId, $sSecret);
+        else 
+            $oEnvironment = new SandboxEnvironment($sClientId, $sSecret);
+
+        return new PayPalHttpClient($oEnvironment);
+    }
+
+    protected function _createOrder($iPendingId, $aCartInfo, $sReturnType = 'approve')
+    {
+        $aItems = array();
+        foreach($aCartInfo['items'] as $aItem)
+            $aItems[] = array(
+                'name' => $aItem['title'],
+                'unit_amount' => array(
+                    'value' => $this->_oModule->_oConfig->getPrice(BX_PAYMENT_TYPE_SINGLE, $aItem),
+                    'currency_code' => $aCartInfo['vendor_currency_code']
+                ),
+                'quantity' => $aItem['quantity']
+            );
+
+        $oRequest = new OrdersCreateRequest();
+        $oRequest->prefer('return=representation');
+        $oRequest->body = array(
+            'intent' => 'CAPTURE',
+            'purchase_units' => array(
+                array(
+                    'reference_id' => $iPendingId,
+                    'amount' => array(
+                        'currency_code' => $aCartInfo['vendor_currency_code'],
+                        'value' => sprintf("%.2f", (float)$aCartInfo['items_price']),
+                        'breakdown' => array(
+                            'item_total' => array(
+                                'currency_code' => $aCartInfo['vendor_currency_code'],
+                                'value' => sprintf("%.2f", (float)$aCartInfo['items_price']),
+                            )
+                        )
+                    ),
+                    'items' => $aItems
+                )
+            ),
+            'application_context' => array(
+                'cancel_url' => $this->_oModule->getObjectCart()->serviceGetCartUrl($aCartInfo['vendor_id']),
+                'return_url' => $this->getReturnDataUrl($aCartInfo['vendor_id'])
+            )
+        );
+
+        try {
+            $oResponse = $this->_getClient()->execute($oRequest);
+            if($oResponse->statusCode != 201)
+                return false;
+
+            $mixedLink = false;
+            foreach($oResponse->result->links as $oLink)
+                if($oLink->rel == $sReturnType) {
+                    $mixedLink = $oLink->href;
+                    break;
+                }
+
+            return array(
+                'order' => $oResponse->result->id,
+                'redirect' => $mixedLink,
+            );
+        }
+        catch (HttpException $oException) {
+            return $this->_processException('Create Order Error: ', $oException);
+        }
+    }
+
+    protected function _captureOrder($sOrderId)
+    {
+        $oRequest = new OrdersCaptureRequest($sOrderId);
+
+        try {
+            $oResponse = $this->_getClient()->execute($oRequest);
+            if($oResponse->statusCode != 201 || strcmp(strtolower($oResponse->result->status), 'completed') != 0)
+                return false;
+
+            $oPurchase = current($oResponse->result->purchase_units);
+            $oCapture = current($oPurchase->payments->captures);
+            return array_merge(array(
+                'pending_id' => (int)$oPurchase->reference_id,
+                'order' => $oCapture->id,
+            ), $this->_getClientInfo($oResponse->result->payer));
+        }
+        catch (HttpException $oException) {
+            return $this->_processException('Capture Order Error: ', $oException);
+        }
+    }
+
+    protected function _processException($sMessage, &$oException)
+    {
+        $aError = $oException->getJsonBody();
+
+        $sDescription = $aError['error']['message'];
+        if(empty($sDescription))
+            $sDescription = $oException->getMessage();
+
+        $this->log($sMessage . $sDescription);
+        $this->log($aError);
+
+        return false;
+    }
+
+    /**
+     * Methods to process WebHooks
+     */
+    protected function _processEvent()
+    {
+        $sInput = @file_get_contents("php://input");
+        $aEvent = json_decode($sInput, true);
+        if(empty($aEvent) || !is_array($aEvent)) 
+            return 404;
+
+        $sType = $aEvent['event_type'];
+        if(!in_array($sType, array('PAYMENT.SALE.COMPLETED', 'PAYMENT.CAPTURE.REFUNDED', 'BILLING.SUBSCRIPTION.CANCELLED')))
+            return 200;
+
+        $this->log($aEvent, 'Webhooks: ' . (!empty($sType) ? $sType : ''));
+
+        $sMethod = '_processEvent' . bx_gen_method_name(strtolower($sType), array('.', '_', '-'));
+    	if(!method_exists($this, $sMethod))
+            return 200;
+
+    	return $this->$sMethod($aEvent) ? 200 : 403;
+    }
+
+    protected function _processEventPaymentSaleCompleted($aEvent)
+    {
+        $mixedResult = $this->_getEventData($aEvent);
+        if($mixedResult === false)
+            return false;
+
+        list($aPending, $aEventData) = $mixedResult;
+
+        $fChargeAmount = (float)$aEventData['amount']['total'];
+        $sChargeCurrency = strtoupper($aEventData['amount']['currency']);
+        if($this->_bCheckAmount && ((float)$aPending['amount'] != $fChargeAmount || strcasecmp($this->_oModule->_oConfig->getDefaultCurrencyCode(), $sChargeCurrency) !== 0))
+            return false;
+
+        if($aPending['type'] == BX_PAYMENT_TYPE_RECURRING)
+            $this->_oModule->getObjectSubscriptions()->prolong($aPending);
+
+        return $this->_oModule->registerPayment($aPending);
+    }
+
+    protected function _processEventPaymentCaptureRefunded($aEvent)
+    {
+        $mixedResult = $this->_getEventData($aEvent);
+        if($mixedResult === false)
+            return false;
+
+        list($aPending, $aEventData) = $mixedResult;
+        return $this->_oModule->refundPayment($aPending);
+    }
+
+    protected function _processEventBillingSubscriptionCancelled($aEvent)
+    {
+        $mixedResult = $this->_getEventData($aEvent);
+        if($mixedResult === false)
+            return false;
+
+        list($aPending, $aEventData) = $mixedResult;
+        return $this->_oModule->getObjectSubscriptions()->cancelLocal($aPending);
+    }
+
+    protected function _getEventData($aEvent)
+    {
+        if(empty($aEvent['resource']) || !is_array($aEvent['resource']))
+            return false;
+
+        $aData = $aEvent['resource'];
+        if(empty($aData['billing_agreement_id']))
+            return false;       
+
+        $aPending = $this->_oModule->_oDb->getOrderPending(array('type' => 'order', 'order' => $aData['billing_agreement_id']));
+        if(empty($aPending) || !is_array($aPending))
+            return false;
+
+        return array($aPending, $aData);
+    }
+
+    /**
+     * Common methods for internal usage.
+     */
+    protected function _getMode()
+    {
+        if(empty($this->_iMode))
+            $this->_iMode = (int)$this->getOption('mode');
+
+        $aModeI2S = array(
+            PP_API_MODE_LIVE => 'live',
+            PP_API_MODE_TEST => 'test'
+        );
+
+        return isset($aModeI2S[$this->_iMode]) ? $aModeI2S[$this->_iMode] : $aModeI2S[PP_API_MODE_DEFAULT];
+    }
+
+    protected function _getSessionOrder()
+    {
+        return $this->_oSession->getUnsetValue($this->_sSessionKeyOrder);
+    }
+
+    protected function _setSessionOrder($sValue)
+    {
+        $this->_oSession->setValue($this->_sSessionKeyOrder, $sValue);
+    }
+
+    protected function _getSessionSubscription()
+    {
+        return $this->_oSession->getUnsetValue($this->_sSessionKeySubscription);
+    }
+
+    protected function _setSessionSubscription($sValue)
+    {
+        $this->_oSession->setValue($this->_sSessionKeySubscription, $sValue);
+    }
+
+    protected function _getClientInfo($mixedClient)
+    {
+        $sName = 'name';
+        $sFirst = 'given_name';
+        $sLast = 'surname';
+        $sEmail = 'email_address';
+
+        $aResult = array();
+        if(is_object($mixedClient))
+            $aResult = array(
+                'client_first_name' => $mixedClient->$sName->$sFirst,
+                'client_last_name' => $mixedClient->$sName->$sLast,
+                'client_email' => $mixedClient->$sEmail,
+            );
+        else
+            $aResult = array(
+                'client_first_name' => $mixedClient[$sName][$sFirst],
+                'client_last_name' => $mixedClient[$sName][$sLast],
+                'client_email' => $mixedClient[$sEmail],
+            );
+
+        return $aResult;
+    }
+}
+
+/** @} */

modules/boonex/payment/install/langs/en.xml

@@ -427,6 +427,41 @@
 	<string name="_bx_payment_txt_name_paypal"><![CDATA[PayPal]]></string>
 	<string name="_bx_payment_txt_cart_paypal"><![CDATA[PayPal]]></string>
 
+        <!-- PayPal API payment provider -->
+	<string name="_bx_payment_pp_api_cpt"><![CDATA[PayPal API]]></string>
+	<string name="_bx_payment_pp_api_dsc"><![CDATA[PayPal payment provider (API based integration)]]></string>
+	<string name="_bx_payment_pp_api_active_cpt"><![CDATA[Active]]></string>
+	<string name="_bx_payment_pp_api_active_dsc"><![CDATA[Activate(Deactivate) provider]]></string>
+        <string name="_bx_payment_pp_api_hidden_cpt"><![CDATA[Hidden]]></string>
+	<string name="_bx_payment_pp_api_hidden_dsc"><![CDATA[Hide provider if you don't want to accept new payments but already have active subscriptions.]]></string>
+	<string name="_bx_payment_pp_api_mode_cpt"><![CDATA[Mode]]></string>
+	<string name="_bx_payment_pp_api_mode_dsc"><![CDATA[Mode to process payments]]></string>
+	<string name="_bx_payment_pp_api_mode_live"><![CDATA[live]]></string>
+	<string name="_bx_payment_pp_api_mode_test"><![CDATA[test]]></string>
+        <string name="_bx_payment_pp_api_live_account_cpt"><![CDATA[Account (live)]]></string>
+        <string name="_bx_payment_pp_api_live_account_dsc"><![CDATA[Email address which is used to access your PayPal account.]]></string>
+        <string name="_bx_payment_pp_api_live_client_id_cpt"><![CDATA[Client ID (live)]]></string>
+        <string name="_bx_payment_pp_api_live_client_id_dsc"><![CDATA[A part of application's credentials.]]></string>
+        <string name="_bx_payment_pp_api_live_secret_cpt"><![CDATA[Secret (live)]]></string>
+        <string name="_bx_payment_pp_api_live_secret_dsc"><![CDATA[A part of application's credentials.]]></string>
+        <string name="_bx_payment_pp_api_test_account_cpt"><![CDATA[Account (test)]]></string>
+        <string name="_bx_payment_pp_api_test_account_dsc"><![CDATA[Email address which is used to access your PayPal account.]]></string>
+        <string name="_bx_payment_pp_api_test_client_id_cpt"><![CDATA[Client ID (test)]]></string>
+        <string name="_bx_payment_pp_api_test_client_id_dsc"><![CDATA[A part of application's credentials.]]></string>
+        <string name="_bx_payment_pp_api_test_secret_cpt"><![CDATA[Secret (test)]]></string>
+        <string name="_bx_payment_pp_api_test_secret_dsc"><![CDATA[A part of application's credentials.]]></string>
+        <string name="_bx_payment_pp_api_return_data_url_cpt"><![CDATA[Data return URL]]></string>
+        <string name="_bx_payment_pp_api_notify_url_cpt"><![CDATA[Webhooks URL]]></string>
+        <string name="_bx_payment_pp_api_err_cannot_capture"><![CDATA[Can't finalize checkout.]]></string>
+        <string name="_bx_payment_pp_api_err_no_item"><![CDATA[There is nothing to subscribe.]]></string>
+        <string name="_bx_payment_pp_api_err_no_subscription"><![CDATA[The subscription data isn't available or incorrect.]]></string>
+        <string name="_bx_payment_pp_api_err_subscription_not_confirmed"><![CDATA[Subscription wasn't confirmed.]]></string>
+        <string name="_bx_payment_pp_api_msg_captured"><![CDATA[Payment was successfully processed.]]></string>
+        <string name="_bx_payment_pp_api_msg_subscribed"><![CDATA[Thank you! Subscription created. Please, check your email for further instructions.]]></string>
+        <string name="_bx_payment_txt_name_paypal_api"><![CDATA[PayPal]]></string>
+	<string name="_bx_payment_txt_cart_paypal_api"><![CDATA[PayPal]]></string>
+        <string name="_bx_payment_txt_subscribe_paypal_api"><![CDATA[PayPal]]></string>
+
 	<!-- 2Checkout payment provider -->
 	<string name="_bx_payment_2co_cpt"><![CDATA[2Checkout]]></string>
 	<string name="_bx_payment_2co_dsc"><![CDATA[2Checkout payment provider]]></string>

modules/boonex/payment/install/sql/install.sql

@@ -182,6 +182,24 @@ INSERT INTO `bx_payment_providers_options`(`provider_id`, `name`, `type`, `capti
 (@iProviderId, 'pp_sandbox', 'text', '_bx_payment_pp_sandbox_cpt', '_bx_payment_pp_sandbox_dsc', '', '', '', '', 6),
 (@iProviderId, 'pp_return_data_url', 'value', '_bx_payment_pp_return_data_url_cpt', '', '', '', '', '', 7);
 
+-- PayPal API payment provider
+INSERT INTO `bx_payment_providers`(`name`, `caption`, `description`, `option_prefix`, `for_visitor`, `for_single`, `for_recurring`, `single_seller`, `active`, `order`, `class_name`) VALUES
+('paypal_api', '_bx_payment_pp_api_cpt', '_bx_payment_pp_api_dsc', 'pp_api_', 1, 1, 1, 1, 1, 15, 'BxPaymentProviderPayPalApi');
+SET @iProviderId = LAST_INSERT_ID();
+
+INSERT INTO `bx_payment_providers_options`(`provider_id`, `name`, `type`, `caption`, `description`, `extra`, `check_type`, `check_params`, `check_error`, `order`) VALUES
+(@iProviderId, 'pp_api_active', 'checkbox', '_bx_payment_pp_api_active_cpt', '_bx_payment_pp_api_active_dsc', '', '', '', '', 1),
+(@iProviderId, 'pp_api_hidden', 'checkbox', '_bx_payment_pp_api_hidden_cpt', '_bx_payment_pp_api_hidden_dsc', '', '', '', '', 2),
+(@iProviderId, 'pp_api_mode', 'select', '_bx_payment_pp_api_mode_cpt', '_bx_payment_pp_api_mode_dsc', '1|_bx_payment_pp_api_mode_live,2|_bx_payment_pp_api_mode_test', '', '', '', 3),
+(@iProviderId, 'pp_api_live_account', 'text', '_bx_payment_pp_api_live_account_cpt', '_bx_payment_pp_api_live_account_dsc', '', '', '', '', 4),
+(@iProviderId, 'pp_api_live_client_id', 'text', '_bx_payment_pp_api_live_client_id_cpt', '_bx_payment_pp_api_live_client_id_dsc', '', '', '', '', 5),
+(@iProviderId, 'pp_api_live_secret', 'text', '_bx_payment_pp_api_live_secret_cpt', '_bx_payment_pp_api_live_secret_dsc', '', '', '', '', 6),
+(@iProviderId, 'pp_api_test_account', 'text', '_bx_payment_pp_api_test_account_cpt', '_bx_payment_pp_api_test_account_dsc', '', '', '', '', 7),
+(@iProviderId, 'pp_api_test_client_id', 'text', '_bx_payment_pp_api_test_client_id_cpt', '_bx_payment_pp_api_test_client_id_dsc', '', '', '', '', 8),
+(@iProviderId, 'pp_api_test_secret', 'text', '_bx_payment_pp_api_test_secret_cpt', '_bx_payment_pp_api_test_secret_dsc', '', '', '', '', 9),
+(@iProviderId, 'pp_api_return_data_url', 'value', '_bx_payment_pp_api_return_data_url_cpt', '', '', '', '', '', 10),
+(@iProviderId, 'pp_api_notify_url', 'value', '_bx_payment_pp_api_notify_url_cpt', '', '', '', '', '', 11);
+
 
 -- 2Checkout payment provider
 INSERT INTO `bx_payment_providers`(`name`, `caption`, `description`, `option_prefix`, `for_visitor`, `for_single`, `for_recurring`, `active`, `order`, `class_name`) VALUES

modules/boonex/russian/data/langs/bx_payment/ru.xml

@@ -423,10 +423,45 @@
 	<string name="_bx_payment_pp_err_wrong_verification_status"><![CDATA[Не получен статус верификации.]]></string>
 	<string name="_bx_payment_pp_err_wrong_amount"><![CDATA[Неправильная сумма платежа.]]></string>
 	<string name="_bx_payment_pp_err_wrong_custom_data"><![CDATA[Неправильные пользовательские данные.]]></string>
-	<string name="_bx_payment_pp_msg_verified"><![CDATA[Платеж удачно принят.]]></string>
+	<string name="_bx_payment_pp_msg_verified"><![CDATA[Платеж принят.]]></string>
 	<string name="_bx_payment_txt_name_paypal"><![CDATA[PayPal]]></string>
 	<string name="_bx_payment_txt_cart_paypal"><![CDATA[PayPal]]></string>
 
+        <!-- PayPal API payment provider -->
+	<string name="_bx_payment_pp_api_cpt"><![CDATA[PayPal API]]></string>
+	<string name="_bx_payment_pp_api_dsc"><![CDATA[Платежная система PayPal API (интеграция на основе API)]]></string>
+	<string name="_bx_payment_pp_api_active_cpt"><![CDATA[Активировать]]></string>
+	<string name="_bx_payment_pp_api_active_dsc"><![CDATA[Активировать(деактивировать) платежную систему.]]></string>
+        <string name="_bx_payment_pp_api_hidden_cpt"><![CDATA[Скрыть]]></string>
+	<string name="_bx_payment_pp_api_hidden_dsc"><![CDATA[Платежную систему можно Скрыть, если Вы не хотите принимать новые платежи, но у вас уже есть активные подписки.]]></string>
+	<string name="_bx_payment_pp_api_mode_cpt"><![CDATA[Режим]]></string>
+	<string name="_bx_payment_pp_api_mode_dsc"><![CDATA[Режим обработки платежей]]></string>
+	<string name="_bx_payment_pp_api_mode_live"><![CDATA[рабочий]]></string>
+	<string name="_bx_payment_pp_api_mode_test"><![CDATA[тестовый]]></string>
+        <string name="_bx_payment_pp_api_live_account_cpt"><![CDATA[Учётная запись (рабочая)]]></string>
+        <string name="_bx_payment_pp_api_live_account_dsc"><![CDATA[Email адрес, который используется для получения доступа к счету PayPal.]]></string>
+        <string name="_bx_payment_pp_api_live_client_id_cpt"><![CDATA[Идентификатор клиента (рабочий)]]></string>
+        <string name="_bx_payment_pp_api_live_client_id_dsc"><![CDATA[Часть учетных данных приложения.]]></string>
+        <string name="_bx_payment_pp_api_live_secret_cpt"><![CDATA[Ключ (рабочий)]]></string>
+        <string name="_bx_payment_pp_api_live_secret_dsc"><![CDATA[Часть учетных данных приложения.]]></string>
+        <string name="_bx_payment_pp_api_test_account_cpt"><![CDATA[Учётная запись (тестовая)]]></string>
+        <string name="_bx_payment_pp_api_test_account_dsc"><![CDATA[Email адрес, который используется для получения доступа к счету PayPal.]]></string>
+        <string name="_bx_payment_pp_api_test_client_id_cpt"><![CDATA[Идентификатор клиента (тестовый)]]></string>
+        <string name="_bx_payment_pp_api_test_client_id_dsc"><![CDATA[Часть учетных данных приложения.]]></string>
+        <string name="_bx_payment_pp_api_test_secret_cpt"><![CDATA[Ключ (тестовый)]]></string>
+        <string name="_bx_payment_pp_api_test_secret_dsc"><![CDATA[Часть учетных данных приложения.]]></string>
+        <string name="_bx_payment_pp_api_return_data_url_cpt"><![CDATA[URL для возврата данных]]></string>
+        <string name="_bx_payment_pp_api_notify_url_cpt"><![CDATA[URL для получения webhook-ов]]></string>
+        <string name="_bx_payment_pp_api_err_cannot_capture"><![CDATA[Не удалось завершить оплату.]]></string>
+        <string name="_bx_payment_pp_api_err_no_item"><![CDATA[Объект для создания подписки отсутствует.]]></string>
+        <string name="_bx_payment_pp_api_err_no_subscription"><![CDATA[Данные подписки недоступны или неверны.]]></string>
+        <string name="_bx_payment_pp_api_err_subscription_not_confirmed"><![CDATA[Подписка не подтверждена.]]></string>
+        <string name="_bx_payment_pp_api_msg_captured"><![CDATA[Платеж принят.]]></string>
+        <string name="_bx_payment_pp_api_msg_subscribed"><![CDATA[Спасибо! Подписка была создана. Пожалуйста, проверьте ваш емэйл для получения дальнейших инструкций.]]></string>
+        <string name="_bx_payment_txt_name_paypal_api"><![CDATA[PayPal]]></string>
+	<string name="_bx_payment_txt_cart_paypal_api"><![CDATA[PayPal]]></string>
+        <string name="_bx_payment_txt_subscribe_paypal_api"><![CDATA[PayPal]]></string>
+
 	<!-- 2Checkout payment provider -->
 	<string name="_bx_payment_2co_cpt"><![CDATA[2Checkout]]></string>
 	<string name="_bx_payment_2co_dsc"><![CDATA[Платежная система 2Checkout]]></string>