3 +--------------------------------------------------------------------+
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2020 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
10 | CiviCRM is free software; you can copy, modify, and distribute it |
11 | under the terms of the GNU Affero General Public License |
12 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
14 | CiviCRM is distributed in the hope that it will be useful, but |
15 | WITHOUT ANY WARRANTY; without even the implied warranty of |
16 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
17 | See the GNU Affero General Public License for more details. |
19 | You should have received a copy of the GNU Affero General Public |
20 | License and the CiviCRM Licensing Exception along |
21 | with this program; if not, contact CiviCRM LLC |
22 | at info[AT]civicrm[DOT]org. If you have questions about the |
23 | GNU Affero General Public License or the licensing of CiviCRM, |
24 | see the CiviCRM license FAQ at http://civicrm.org/licensing |
25 +--------------------------------------------------------------------+
28 use Civi\Payment\Exception\PaymentProcessorException
;
33 * @copyright CiviCRM LLC (c) 2004-2020
37 * Class CRM_Core_Payment_PayPalImpl for paypal pro, paypal standard & paypal express.
39 class CRM_Core_Payment_PayPalImpl
extends CRM_Core_Payment
{
40 const CHARSET
= 'iso-8859-1';
42 const PAYPAL_PRO
= 'PayPal';
43 const PAYPAL_STANDARD
= 'PayPal_Standard';
44 const PAYPAL_EXPRESS
= 'PayPal_Express';
46 protected $_mode = NULL;
52 * The mode of operation: live or test.
54 * @param CRM_Core_Payment $paymentProcessor
56 * @return \CRM_Core_Payment_PayPalImpl
57 * @throws \Civi\Payment\Exception\PaymentProcessorException
59 public function __construct($mode, &$paymentProcessor) {
61 $this->_paymentProcessor
= $paymentProcessor;
63 if ($this->isPayPalType($this::PAYPAL_STANDARD
)) {
64 $this->_processorName
= ts('PayPal Standard');
66 elseif ($this->isPayPalType($this::PAYPAL_EXPRESS
)) {
67 $this->_processorName
= ts('PayPal Express');
69 elseif ($this->isPayPalType($this::PAYPAL_PRO
)) {
70 $this->_processorName
= ts('PayPal Pro');
73 throw new PaymentProcessorException('CRM_Core_Payment_PayPalImpl: Payment processor type is not defined!');
78 * Helper function to check which payment processor type is being used.
83 * @throws \Civi\Payment\Exception\PaymentProcessorException
85 public function isPayPalType($typeName) {
86 // Historically payment_processor_type may have been set to the name of the processor but newer versions of CiviCRM use the id set in payment_processor_type_id
87 if (empty($this->_paymentProcessor
['payment_processor_type_id']) && empty($this->_paymentProcessor
['payment_processor_type'])) {
88 // We need one of them to be set!
89 throw new PaymentProcessorException('CRM_Core_Payment_PayPalImpl: Payment processor type is not defined!');
91 if (empty($this->_paymentProcessor
['payment_processor_type_id']) && !empty($this->_paymentProcessor
['payment_processor_type'])) {
92 // Handle legacy case where payment_processor_type was set, but payment_processor_type_id was not.
93 $this->_paymentProcessor
['payment_processor_type_id']
94 = CRM_Core_PseudoConstant
::getKey('CRM_Financial_BAO_PaymentProcessor', 'payment_processor_type_id', $this->_paymentProcessor
['payment_processor_type']);
96 if ((int) $this->_paymentProcessor
['payment_processor_type_id'] ===
97 CRM_Core_PseudoConstant
::getKey('CRM_Financial_BAO_PaymentProcessor', 'payment_processor_type_id', $typeName)) {
104 * Are back office payments supported.
106 * E.g paypal standard won't permit you to enter a credit card associated
107 * with someone else's login.
110 * @throws \Civi\Payment\Exception\PaymentProcessorException
112 protected function supportsBackOffice() {
113 if ($this->isPayPalType($this::PAYPAL_PRO
)) {
120 * Does this processor support pre-approval.
122 * This would generally look like a redirect to enter credentials which can then be used in a later payment call.
124 * Currently Paypal express supports this, with a redirect to paypal after the 'Main' form is submitted in the
125 * contribution page. This token can then be processed at the confirm phase. Although this flow 'looks' like the
126 * 'notify' flow a key difference is that in the notify flow they don't have to return but in this flow they do.
129 * @throws \Civi\Payment\Exception\PaymentProcessorException
131 protected function supportsPreApproval() {
132 if ($this->isPayPalType($this::PAYPAL_EXPRESS
) ||
$this->isPayPalType($this::PAYPAL_PRO
)) {
139 * Opportunity for the payment processor to override the entire form build.
141 * @param CRM_Core_Form $form
144 * Should form building stop at this point?
145 * @throws \Civi\Payment\Exception\PaymentProcessorException
147 public function buildForm(&$form) {
148 if ($this->supportsPreApproval()) {
149 $this->addPaypalExpressCode($form);
150 if ($this->isPayPalType($this::PAYPAL_EXPRESS
)) {
151 CRM_Core_Region
::instance('billing-block-post')->add([
152 'template' => 'CRM/Financial/Form/PaypalExpress.tpl',
153 'name' => 'paypal_express',
156 if ($this->isPayPalType($this::PAYPAL_PRO
)) {
157 CRM_Core_Region
::instance('billing-block-pre')->add([
158 'template' => 'CRM/Financial/Form/PaypalPro.tpl',
166 * Billing mode button is basically synonymous with paypal express.
168 * This is probably a good example of 'odds & sods' code we
169 * need to find a way for the payment processor to assign.
171 * A tricky aspect is that the payment processor may need to set the order
173 * @param CRM_Core_Form $form
175 protected function addPaypalExpressCode(&$form) {
176 // @todo use $this->isBackOffice() instead, test.
177 if (empty($form->isBackOffice
)) {
180 * if payment method selected using ajax call then form object is of 'CRM_Financial_Form_Payment',
181 * instead of 'CRM_Contribute_Form_Contribution_Main' so it generate wrong button name
182 * and then clicking on express button it redirect to confirm screen rather than PayPal Express form
185 if ('CRM_Financial_Form_Payment' == get_class($form) && $form->_formName
) {
186 $form->_expressButtonName
= '_qf_' . $form->_formName
. '_upload_express';
189 $form->_expressButtonName
= $form->getButtonName('upload', 'express');
191 $form->assign('expressButtonName', $form->_expressButtonName
);
194 $form->_expressButtonName
,
195 $this->_paymentProcessor
['url_button'],
196 ['class' => 'crm-form-submit']
202 * Can recurring contributions be set against pledges.
204 * In practice all processors that use the baseIPN function to finish transactions or
205 * call the completetransaction api support this by looking up previous contributions in the
206 * series and, if there is a prior contribution against a pledge, and the pledge is not complete,
207 * adding the new payment to the pledge.
209 * However, only enabling for processors it has been tested against.
213 protected function supportsRecurContributionsForPledges() {
218 * Default payment instrument validation.
220 * Implement the usual Luhn algorithm via a static function in the CRM_Core_Payment_Form if it's a credit card
221 * Not a static function, because I need to check for payment_type.
223 * @param array $values
224 * @param array $errors
226 * @throws \Civi\Payment\Exception\PaymentProcessorException
228 public function validatePaymentInstrument($values, &$errors) {
229 if ($this->isPayPalType($this::PAYPAL_PRO
) && !$this->isPaypalExpress($values)) {
230 CRM_Core_Payment_Form
::validateCreditCard($values, $errors, $this->_paymentProcessor
['id']);
231 CRM_Core_Form
::validateMandatoryFields($this->getMandatoryFields(), $values, $errors);
236 * Express checkout code.
238 * Check PayPal documentation for more information
240 * @param array $params
241 * Assoc array of input parameters for this transaction.
244 * the result in an nice formatted array (or an error object)
245 * @throws \Civi\Payment\Exception\PaymentProcessorException
247 protected function setExpressCheckOut(&$params) {
250 $this->initialize($args, 'SetExpressCheckout');
252 $args['paymentAction'] = 'Sale';
253 $args['amt'] = $params['amount'];
254 $args['currencyCode'] = $params['currencyID'];
255 $args['desc'] = CRM_Utils_Array
::value('description', $params);
256 $args['invnum'] = $params['invoiceID'];
257 $args['returnURL'] = $this->getReturnSuccessUrl($params['qfKey']);
258 $args['cancelURL'] = $this->getCancelUrl($params['qfKey'], NULL);
259 $args['version'] = '56.0';
261 //LCD if recurring, collect additional data and set some values
262 if (!empty($params['is_recur'])) {
263 $args['L_BILLINGTYPE0'] = 'RecurringPayments';
264 //$args['L_BILLINGAGREEMENTDESCRIPTION0'] = 'Recurring Contribution';
265 $args['L_BILLINGAGREEMENTDESCRIPTION0'] = $params['amount'] . " Per " . $params['frequency_interval'] . " " . $params['frequency_unit'];
266 $args['L_PAYMENTTYPE0'] = 'Any';
269 // Allow further manipulation of the arguments via custom hooks ..
270 CRM_Utils_Hook
::alterPaymentProcessorParams($this, $params, $args);
272 $result = $this->invokeAPI($args);
274 if (is_a($result, 'CRM_Core_Error')) {
275 throw new PaymentProcessorException($result->message
);
280 return $result['token'];
284 * Get any details that may be available to the payment processor due to an approval process having happened.
286 * In some cases the browser is redirected to enter details on a processor site. Some details may be available as a
289 * @param array $storedDetails
292 * @throws \Civi\Payment\Exception\PaymentProcessorException
294 public function getPreApprovalDetails($storedDetails) {
295 return empty($storedDetails['token']) ?
[] : $this->getExpressCheckoutDetails($storedDetails['token']);
299 * Get details from paypal.
301 * Check PayPal documentation for more information
303 * @param string $token
304 * The key associated with this transaction.
307 * the result in an nice formatted array (or an error object)
308 * @throws \Civi\Payment\Exception\PaymentProcessorException
310 public function getExpressCheckoutDetails($token) {
313 $this->initialize($args, 'GetExpressCheckoutDetails');
314 $args['token'] = $token;
316 $args['method'] = 'GetExpressCheckoutDetails';
318 $result = $this->invokeAPI($args);
320 if (is_a($result, 'CRM_Core_Error')) {
321 throw new PaymentProcessorException(CRM_Core_Error
::getMessages($result));
327 'payer_status' => 'payerstatus',
328 'payer_id' => 'payerid',
329 'first_name' => 'firstname',
330 'middle_name' => 'middlename',
331 'last_name' => 'lastname',
332 'street_address' => 'shiptostreet',
333 'supplemental_address_1' => 'shiptostreet2',
334 'city' => 'shiptocity',
335 'postal_code' => 'shiptozip',
336 'state_province' => 'shiptostate',
337 'country' => 'shiptocountrycode',
339 return $this->mapPaypalParamsToCivicrmParams($fieldMap, $result);
343 * Do the express checkout at paypal.
345 * Check PayPal documentation for more information
347 * @param array $params
350 * The result in an nice formatted array.
352 * @throws \Civi\Payment\Exception\PaymentProcessorException
354 public function doExpressCheckout(&$params) {
355 if (!empty($params['is_recur'])) {
356 return $this->createRecurringPayments($params);
360 $this->initialize($args, 'DoExpressCheckoutPayment');
361 $args['token'] = $params['token'];
362 $args['paymentAction'] = 'Sale';
363 $args['amt'] = $params['amount'];
364 $args['currencyCode'] = $params['currencyID'];
365 $args['payerID'] = $params['payer_id'];
366 $args['invnum'] = $params['invoiceID'];
367 $args['returnURL'] = $this->getReturnSuccessUrl($params['qfKey']);
368 $args['cancelURL'] = $this->getCancelUrl($params['qfKey'], NULL);
369 $args['desc'] = $params['description'];
371 // add CiviCRM BN code
372 $args['BUTTONSOURCE'] = 'CiviCRM_SP';
374 $result = $this->invokeAPI($args);
376 if (is_a($result, 'CRM_Core_Error')) {
377 throw new PaymentProcessorException(CRM_Core_Error
::getMessages($result));
381 $params['trxn_id'] = $result['transactionid'];
382 $params['gross_amount'] = $result['amt'];
383 $params['fee_amount'] = $result['feeamt'];
384 $params['net_amount'] = CRM_Utils_Array
::value('settleamt', $result);
385 if ($params['net_amount'] == 0 && $params['fee_amount'] != 0) {
386 $params['net_amount'] = number_format(($params['gross_amount'] - $params['fee_amount']), 2);
388 $params['payment_status'] = $result['paymentstatus'];
389 $params['pending_reason'] = $result['pendingreason'];
390 if (!empty($params['is_recur'])) {
391 // See comment block.
392 $params['payment_status_id'] = CRM_Core_PseudoConstant
::getKey('CRM_Contribute_BAO_Contribution', 'contribution_status_id', 'Pending');
395 $params['payment_status_id'] = CRM_Core_PseudoConstant
::getKey('CRM_Contribute_BAO_Contribution', 'contribution_status_id', 'Completed');
401 * Create recurring payments.
403 * Use a pre-authorisation token to activate a recurring payment profile
404 * https://developer.paypal.com/docs/classic/api/merchant/CreateRecurringPaymentsProfile_API_Operation_NVP/
406 * @param array $params
411 public function createRecurringPayments(&$params) {
413 $this->initialize($args, 'CreateRecurringPaymentsProfile');
415 $start_time = strtotime(date('m/d/Y'));
416 $start_date = date('Y-m-d\T00:00:00\Z', $start_time);
418 $args['token'] = $params['token'];
419 $args['paymentAction'] = 'Sale';
420 $args['amt'] = $params['amount'];
421 $args['currencyCode'] = $params['currencyID'];
422 $args['payerID'] = $params['payer_id'];
423 $args['invnum'] = $params['invoiceID'];
424 $args['profilestartdate'] = $start_date;
425 $args['method'] = 'CreateRecurringPaymentsProfile';
426 $args['billingfrequency'] = $params['frequency_interval'];
427 $args['billingperiod'] = ucwords($params['frequency_unit']);
428 $args['desc'] = $params['amount'] . " Per " . $params['frequency_interval'] . " " . $params['frequency_unit'];
429 $args['totalbillingcycles'] = CRM_Utils_Array
::value('installments', $params);
430 $args['version'] = '56.0';
431 $args['profilereference'] = "i={$params['invoiceID']}" .
433 "&c={$params['contactID']}" .
434 "&r={$params['contributionRecurID']}" .
435 "&b={$params['contributionID']}" .
436 "&p={$params['contributionPageID']}";
438 // add CiviCRM BN code
439 $args['BUTTONSOURCE'] = 'CiviCRM_SP';
441 $result = $this->invokeAPI($args);
443 if (is_a($result, 'CRM_Core_Error')) {
447 /* Success - result looks like"
449 * 'profileid' => 'I-CP1U0PLG91R2',
450 * 'profilestatus' => 'ActiveProfile',
451 * 'timestamp' => '2018-05-07T03:55:52Z',
452 * 'correlationid' => 'e717999e9bf62',
453 * 'ack' => 'Success',
454 * 'version' => '56.0',
455 * 'build' => '39949200',)
457 $params['trxn_id'] = $result['profileid'];
458 $params['payment_status_id'] = CRM_Core_PseudoConstant
::getKey('CRM_Contribute_BAO_Contribution', 'contribution_status_id', 'Pending');
469 public function initialize(&$args, $method) {
470 $args['user'] = $this->_paymentProcessor
['user_name'];
471 $args['pwd'] = $this->_paymentProcessor
['password'];
472 $args['version'] = 3.0;
473 $args['signature'] = $this->_paymentProcessor
['signature'];
474 $args['subject'] = CRM_Utils_Array
::value('subject', $this->_paymentProcessor
);
475 $args['method'] = $method;
479 * Process payment - this function wraps around both doTransferCheckout and doDirectPayment.
481 * The function ensures an exception is thrown & moves some of this logic out of the form layer and makes the forms
484 * Payment processors should set payment_status_id. This function adds some historical defaults ie. the
485 * assumption that if a 'doDirectPayment' processors comes back it completed the transaction & in fact
486 * doTransferCheckout would not traditionally come back.
488 * doDirectPayment does not do an immediate payment for Authorize.net or Paypal so the default is assumed
491 * Once this function is fully rolled out then it will be preferred for processors to throw exceptions than to
492 * return Error objects
494 * @param array $params
496 * @param string $component
501 * @throws \Civi\Payment\Exception\PaymentProcessorException
503 public function doPayment(&$params, $component = 'contribute') {
504 if ($this->isPayPalType($this::PAYPAL_EXPRESS
) ||
($this->isPayPalType($this::PAYPAL_PRO
) && !empty($params['token']))) {
505 $this->_component
= $component;
506 return $this->doExpressCheckout($params);
509 return parent
::doPayment($params, $component);
513 * This function collects all the information from a web/api form and invokes
514 * the relevant payment processor specific functions to perform the transaction
516 * @param array $params
517 * Assoc array of input parameters for this transaction.
519 * @param string $component
521 * the result in an nice formatted array (or an error object)
522 * @throws \Civi\Payment\Exception\PaymentProcessorException
524 public function doDirectPayment(&$params, $component = 'contribute') {
527 $this->initialize($args, 'DoDirectPayment');
529 $args['paymentAction'] = 'Sale';
530 $args['amt'] = $this->getAmount($params);
531 $args['currencyCode'] = $this->getCurrency($params);
532 $args['invnum'] = $params['invoiceID'];
533 $args['ipaddress'] = $params['ip_address'];
534 $args['creditCardType'] = $params['credit_card_type'];
535 $args['acct'] = $params['credit_card_number'];
536 $args['expDate'] = sprintf('%02d', $params['month']) . $params['year'];
537 $args['cvv2'] = $params['cvv2'];
538 $args['firstName'] = $params['first_name'];
539 $args['lastName'] = $params['last_name'];
540 $args['email'] = CRM_Utils_Array
::value('email', $params);
541 $args['street'] = $params['street_address'];
542 $args['city'] = $params['city'];
543 $args['state'] = $params['state_province'];
544 $args['countryCode'] = $params['country'];
545 $args['zip'] = $params['postal_code'];
546 $args['desc'] = substr(CRM_Utils_Array
::value('description', $params), 0, 127);
547 $args['custom'] = CRM_Utils_Array
::value('accountingCode', $params);
549 // add CiviCRM BN code
550 $args['BUTTONSOURCE'] = 'CiviCRM_SP';
552 if (CRM_Utils_Array
::value('is_recur', $params) == 1) {
553 $start_time = strtotime(date('m/d/Y'));
554 $start_date = date('Y-m-d\T00:00:00\Z', $start_time);
556 $args['PaymentAction'] = 'Sale';
557 $args['billingperiod'] = ucwords($params['frequency_unit']);
558 $args['billingfrequency'] = $params['frequency_interval'];
559 $args['method'] = "CreateRecurringPaymentsProfile";
560 $args['profilestartdate'] = $start_date;
562 $params['description'] . ": " .
563 $params['amount'] . " Per " .
564 $params['frequency_interval'] . " " .
565 $params['frequency_unit'];
566 $args['amt'] = $this->getAmount($params);
567 $args['totalbillingcycles'] = CRM_Utils_Array
::value('installments', $params);
568 $args['version'] = 56.0;
569 $args['PROFILEREFERENCE'] = "" .
570 "i=" . $params['invoiceID'] . "&m=" . $component .
571 "&c=" . $params['contactID'] . "&r=" . $params['contributionRecurID'] .
572 "&b=" . $params['contributionID'] . "&p=" . $params['contributionPageID'];
575 // Allow further manipulation of the arguments via custom hooks ..
576 CRM_Utils_Hook
::alterPaymentProcessorParams($this, $params, $args);
578 $result = $this->invokeAPI($args);
581 if (is_a($result, 'CRM_Core_Error')) {
585 $params['recurr_profile_id'] = NULL;
587 if (CRM_Utils_Array
::value('is_recur', $params) == 1) {
588 $params['recurr_profile_id'] = $result['profileid'];
593 $params['trxn_id'] = CRM_Utils_Array
::value('transactionid', $result);
594 $params['gross_amount'] = CRM_Utils_Array
::value('amt', $result);
595 $params = array_merge($params, $this->doQuery($params));
600 * Query payment processor for details about a transaction.
602 * For paypal see : https://developer.paypal.com/webapps/developer/docs/classic/api/merchant/GetTransactionDetails_API_Operation_NVP/
604 * @param array $params
605 * Array of parameters containing one of:
606 * - trxn_id Id of an individual transaction.
607 * - processor_id Id of a recurring contribution series as stored in the civicrm_contribution_recur table.
610 * Extra parameters retrieved.
611 * Any parameters retrievable through this should be documented in the function comments at
612 * CRM_Core_Payment::doQuery. Currently
613 * - fee_amount Amount of fee paid
615 * @throws \Civi\Payment\Exception\PaymentProcessorException
617 public function doQuery($params) {
618 //CRM-18140 - trxn_id not returned for recurring paypal transaction
619 if (!empty($params['is_recur'])) {
622 elseif (empty($params['trxn_id'])) {
623 throw new \Civi\Payment\Exception\
PaymentProcessorException('transaction id not set');
626 'TRANSACTIONID' => $params['trxn_id'],
628 $this->initialize($args, 'GetTransactionDetails');
629 $result = $this->invokeAPI($args);
631 'fee_amount' => $result['feeamt'],
632 'net_amount' => $params['gross_amount'] - $result['feeamt'],
637 * This function checks to see if we have the right config values.
639 * @return null|string
640 * the error message if any
641 * @throws \Civi\Payment\Exception\PaymentProcessorException
643 public function checkConfig() {
646 if (!$this->isPayPalType($this::PAYPAL_STANDARD
)) {
647 if (empty($this->_paymentProcessor
['signature'])) {
648 $error[] = ts('Signature is not set in the Administer » System Settings » Payment Processors.');
651 if (empty($this->_paymentProcessor
['password'])) {
652 $error[] = ts('Password is not set in the Administer » System Settings » Payment Processors.');
655 if (empty($this->_paymentProcessor
['user_name'])) {
656 $error[] = ts('User Name is not set in the Administer » System Settings » Payment Processors.');
659 if (!empty($error)) {
660 return implode('<p>', $error);
668 * @return null|string
669 * @throws \Civi\Payment\Exception\PaymentProcessorException
671 public function cancelSubscriptionURL() {
672 if ($this->isPayPalType($this::PAYPAL_STANDARD
)) {
673 return "{$this->_paymentProcessor['url_site']}cgi-bin/webscr?cmd=_subscr-find&alias=" . urlencode($this->_paymentProcessor
['user_name']);
681 * Check whether a method is present ( & supported ) by the payment processor object.
683 * @param string $method
684 * Method to check for.
687 * @throws \Civi\Payment\Exception\PaymentProcessorException
689 public function isSupported($method) {
690 if (!$this->isPayPalType($this::PAYPAL_PRO
)) {
691 // since subscription methods like cancelSubscription or updateBilling is not yet implemented / supported
692 // by standard or express.
695 return parent
::isSupported($method);
699 * Paypal express replaces the submit button with it's own.
702 * Should the form button by suppressed?
703 * @throws \Civi\Payment\Exception\PaymentProcessorException
705 public function isSuppressSubmitButtons() {
706 if ($this->isPayPalType($this::PAYPAL_EXPRESS
)) {
713 * @param string $message
714 * @param array $params
716 * @return array|bool|object
717 * @throws \Civi\Payment\Exception\PaymentProcessorException
719 public function cancelSubscription(&$message = '', $params = []) {
720 if ($this->isPayPalType($this::PAYPAL_PRO
) ||
$this->isPayPalType($this::PAYPAL_EXPRESS
)) {
722 $this->initialize($args, 'ManageRecurringPaymentsProfileStatus');
724 $args['PROFILEID'] = CRM_Utils_Array
::value('subscriptionId', $params);
725 $args['ACTION'] = 'Cancel';
726 $args['NOTE'] = CRM_Utils_Array
::value('reason', $params);
728 $result = $this->invokeAPI($args);
729 if (is_a($result, 'CRM_Core_Error')) {
732 $message = "{$result['ack']}: profileid={$result['profileid']}";
739 * Process incoming notification.
741 * @throws \CRM_Core_Exception
742 * @throws \CiviCRM_API3_Exception
744 public static function handlePaymentNotification() {
745 $params = array_merge($_GET, $_REQUEST);
746 $q = explode('/', CRM_Utils_Array
::value('q', $params, ''));
747 $lastParam = array_pop($q);
748 if (is_numeric($lastParam)) {
749 $params['processor_id'] = $lastParam;
751 $result = civicrm_api3('PaymentProcessor', 'get', [
753 'id' => $params['processor_id'],
754 'api.PaymentProcessorType.getvalue' => ['return' => "name"],
756 if (!$result['count']) {
757 throw new CRM_Core_Exception("Could not find a processor with the given processor_id value '{$params['processor_id']}'.");
760 $paymentProcessorType = CRM_Utils_Array
::value('api.PaymentProcessorType.getvalue', $result['values'][0]);
761 switch ($paymentProcessorType) {
763 // "PayPal - Website Payments Pro"
764 $paypalIPN = new CRM_Core_Payment_PayPalProIPN($params);
767 case 'PayPal_Standard':
768 // "PayPal - Website Payments Standard"
769 $paypalIPN = new CRM_Core_Payment_PayPalIPN($params);
773 // If we don't have PayPal Standard or PayPal Pro, something's wrong.
774 // Log an error and exit.
775 throw new CRM_Core_Exception("The processor_id value '{$params['processor_id']}' is for a processor of type '{$paymentProcessorType}', which is invalid in this context.");
782 * @param string $message
783 * @param array $params
785 * @return array|bool|object
786 * @throws \Civi\Payment\Exception\PaymentProcessorException
788 public function updateSubscriptionBillingInfo(&$message = '', $params = []) {
789 if ($this->isPayPalType($this::PAYPAL_PRO
)) {
790 $config = CRM_Core_Config
::singleton();
792 $this->initialize($args, 'UpdateRecurringPaymentsProfile');
794 $args['PROFILEID'] = $params['subscriptionId'];
795 $args['AMT'] = $this->getAmount($params);
796 $args['CURRENCYCODE'] = $config->defaultCurrency
;
797 $args['CREDITCARDTYPE'] = $params['credit_card_type'];
798 $args['ACCT'] = $params['credit_card_number'];
799 $args['EXPDATE'] = sprintf('%02d', $params['month']) . $params['year'];
800 $args['CVV2'] = $params['cvv2'];
802 $args['FIRSTNAME'] = $params['first_name'];
803 $args['LASTNAME'] = $params['last_name'];
804 $args['STREET'] = $params['street_address'];
805 $args['CITY'] = $params['city'];
806 $args['STATE'] = $params['state_province'];
807 $args['COUNTRYCODE'] = $params['postal_code'];
808 $args['ZIP'] = $params['country'];
810 $result = $this->invokeAPI($args);
811 if (is_a($result, 'CRM_Core_Error')) {
814 $message = "{$result['ack']}: profileid={$result['profileid']}";
821 * @param string $message
822 * @param array $params
824 * @return array|bool|object
825 * @throws \Civi\Payment\Exception\PaymentProcessorException
827 public function changeSubscriptionAmount(&$message = '', $params = []) {
828 if ($this->isPayPalType($this::PAYPAL_PRO
)) {
829 $config = CRM_Core_Config
::singleton();
831 $this->initialize($args, 'UpdateRecurringPaymentsProfile');
833 $args['PROFILEID'] = $params['subscriptionId'];
834 $args['AMT'] = $this->getAmount($params);
835 $args['CURRENCYCODE'] = $config->defaultCurrency
;
836 $args['BILLINGFREQUENCY'] = $params['installments'];
838 $result = $this->invokeAPI($args);
839 CRM_Core_Error
::debug_var('$result', $result);
840 if (is_a($result, 'CRM_Core_Error')) {
843 $message = "{$result['ack']}: profileid={$result['profileid']}";
850 * Function to action pre-approval if supported
852 * @param array $params
853 * Parameters from the form
856 * - pre_approval_parameters (this will be stored on the calling form & available later)
857 * - redirect_url (if set the browser will be redirected to this.
858 * @throws \Civi\Payment\Exception\PaymentProcessorException
860 public function doPreApproval(&$params) {
861 if (!$this->isPaypalExpress($params)) {
864 $this->_component
= $params['component'];
865 $token = $this->setExpressCheckOut($params);
867 'pre_approval_parameters' => ['token' => $token],
868 'redirect_url' => $this->_paymentProcessor
['url_site'] . "/cgi-bin/webscr?cmd=_express-checkout&token=$token",
873 * @param array $params
874 * @param string $component
878 public function doTransferCheckout(&$params, $component = 'contribute') {
880 $notifyParameters = ['module' => $component];
881 $notifyParameterMap = [
882 'contactID' => 'contactID',
883 'contributionID' => 'contributionID',
884 'eventID' => 'eventID',
885 'participantID' => 'participantID',
886 'membershipID' => 'membershipID',
887 'related_contact' => 'relatedContactID',
888 'onbehalf_dupe_alert' => 'onBehalfDupeAlert',
889 'accountingCode' => 'accountingCode',
890 'contributionRecurID' => 'contributionRecurID',
891 'contributionPageID' => 'contributionPageID',
893 foreach ($notifyParameterMap as $paramsName => $notifyName) {
894 if (!empty($params[$paramsName])) {
895 $notifyParameters[$notifyName] = $params[$paramsName];
898 $notifyURL = $this->getNotifyUrl();
900 $config = CRM_Core_Config
::singleton();
901 $url = ($component == 'event') ?
'civicrm/event/register' : 'civicrm/contribute/transact';
902 $cancel = ($component == 'event') ?
'_qf_Register_display' : '_qf_Main_display';
904 $cancelUrlString = "$cancel=1&cancel=1&qfKey={$params['qfKey']}";
905 if (!empty($params['is_recur'])) {
906 $cancelUrlString .= "&isRecur=1&recurId={$params['contributionRecurID']}&contribId={$params['contributionID']}";
909 $cancelURL = CRM_Utils_System
::url(
916 'business' => $this->_paymentProcessor
['user_name'],
917 'notify_url' => $notifyURL,
918 'item_name' => $this->getPaymentDescription($params, 127),
920 'undefined_quantity' => 0,
921 'cancel_return' => $cancelURL,
924 'return' => $this->getReturnSuccessUrl($params['qfKey']),
926 'currency_code' => $params['currencyID'],
927 'invoice' => $params['invoiceID'],
928 'lc' => substr($config->lcMessages
, -2),
929 'charset' => function_exists('mb_internal_encoding') ?
mb_internal_encoding() : 'UTF-8',
930 'custom' => json_encode($notifyParameters),
931 'bn' => 'CiviCRM_SP',
934 // add name and address if available, CRM-3130
936 'first_name' => 'first_name',
937 'last_name' => 'last_name',
938 'street_address' => 'address1',
939 'country' => 'country',
940 'preferred_language' => 'lc',
942 'state_province' => 'state',
943 'postal_code' => 'zip',
947 foreach (array_keys($params) as $p) {
948 // get the base name without the location type suffixed to it
949 $parts = explode('-', $p);
950 $name = count($parts) > 1 ?
$parts[0] : $p;
951 if (isset($otherVars[$name])) {
952 $value = $params[$p];
954 if ($name == 'state_province') {
955 $stateName = CRM_Core_PseudoConstant
::stateProvinceAbbreviation($value);
958 if ($name == 'country') {
959 $countryName = CRM_Core_PseudoConstant
::countryIsoCode($value);
960 $value = $countryName;
962 // ensure value is not an array
964 if (!is_array($value)) {
965 $paypalParams[$otherVars[$name]] = $value;
971 // if recurring donations, add a few more items
972 if (!empty($params['is_recur'])) {
973 if (!$params['contributionRecurID']) {
974 CRM_Core_Error
::fatal(ts('Recurring contribution, but no database id'));
978 'cmd' => '_xclick-subscriptions',
979 'a3' => $this->getAmount($params),
980 'p3' => $params['frequency_interval'],
981 't3' => ucfirst(substr($params['frequency_unit'], 0, 1)),
984 'srt' => CRM_Utils_Array
::value('installments', $params),
992 'amount' => $params['amount'],
996 // Allow further manipulation of the arguments via custom hooks ..
997 CRM_Utils_Hook
::alterPaymentProcessorParams($this, $params, $paypalParams);
1000 foreach ($paypalParams as $key => $value) {
1001 if ($value === NULL) {
1005 $value = urlencode($value);
1006 if ($key == 'return' ||
1007 $key == 'cancel_return' ||
1008 $key == 'notify_url'
1010 $value = str_replace('%2F', '/', $value);
1012 $uri .= "&{$key}={$value}";
1015 $uri = substr($uri, 1);
1016 $url = $this->_paymentProcessor
['url_site'];
1017 $sub = empty($params['is_recur']) ?
'cgi-bin/webscr' : 'subscriptions';
1018 $paypalURL = "{$url}{$sub}?$uri";
1020 CRM_Utils_System
::redirect($paypalURL);
1024 * Hash_call: Function to perform the API call to PayPal using API signature.
1026 * @methodName is name of API method.
1027 * @nvpStr is nvp string.
1028 * returns an associative array containing the response from the server.
1030 * @param array $args
1033 * @return array|object
1034 * @throws \Exception
1036 public function invokeAPI($args, $url = NULL) {
1038 if ($url === NULL) {
1039 if (empty($this->_paymentProcessor
['url_api'])) {
1040 CRM_Core_Error
::fatal(ts('Please set the API URL. Please refer to the documentation for more details'));
1043 $url = $this->_paymentProcessor
['url_api'] . 'nvp';
1047 foreach ($args as $n => $v) {
1048 $p[] = "$n=" . urlencode($v);
1051 //NVPRequest for submitting to server
1052 $nvpreq = implode('&', $p);
1054 if (!function_exists('curl_init')) {
1055 CRM_Core_Error
::fatal("curl functions NOT available.");
1058 //setting the curl parameters.
1060 curl_setopt($ch, CURLOPT_URL
, $url);
1061 curl_setopt($ch, CURLOPT_VERBOSE
, 0);
1063 //turning off the server and peer verification(TrustManager Concept).
1064 curl_setopt($ch, CURLOPT_SSL_VERIFYPEER
, Civi
::settings()->get('verifySSL'));
1065 curl_setopt($ch, CURLOPT_SSL_VERIFYHOST
, Civi
::settings()->get('verifySSL') ?
2 : 0);
1067 curl_setopt($ch, CURLOPT_RETURNTRANSFER
, 1);
1068 curl_setopt($ch, CURLOPT_POST
, 1);
1070 //setting the nvpreq as POST FIELD to curl
1071 curl_setopt($ch, CURLOPT_POSTFIELDS
, $nvpreq);
1073 //getting response from server
1074 $response = curl_exec($ch);
1076 //converting NVPResponse to an Associative Array
1077 $result = self
::deformat($response);
1079 if (curl_errno($ch)) {
1080 $e = CRM_Core_Error
::singleton();
1081 $e->push(curl_errno($ch),
1091 $outcome = strtolower(CRM_Utils_Array
::value('ack', $result));
1093 if ($outcome != 'success' && $outcome != 'successwithwarning') {
1094 throw new PaymentProcessorException("{$result['l_shortmessage0']} {$result['l_longmessage0']}");
1101 * This function will take NVPString and convert it to an Associative Array.
1103 * It will decode the response. It is useful to search for a particular key and displaying arrays.
1105 * @param string $str
1109 public static function deformat($str) {
1112 while (strlen($str)) {
1114 $keyPos = strpos($str, '=');
1116 // position of value
1117 $valPos = strpos($str, '&') ?
strpos($str, '&') : strlen($str);
1119 /*getting the Key and Value values and storing in a Associative Array*/
1121 $key = substr($str, 0, $keyPos);
1122 $val = substr($str, $keyPos +
1, $valPos - $keyPos - 1);
1124 //decoding the respose
1125 $result[strtolower(urldecode($key))] = urldecode($val);
1126 $str = substr($str, $valPos +
1, strlen($str));
1133 * Get array of fields that should be displayed on the payment form.
1136 * @throws \Civi\Payment\Exception\PaymentProcessorException
1138 public function getPaymentFormFields() {
1139 if ($this->isPayPalType($this::PAYPAL_PRO
)) {
1140 return $this->getCreditCardFormFields();
1148 * Map the paypal params to CiviCRM params using a field map.
1150 * @param array $fieldMap
1151 * @param array $paypalParams
1155 protected function mapPaypalParamsToCivicrmParams($fieldMap, $paypalParams) {
1157 foreach ($fieldMap as $civicrmField => $paypalField) {
1158 $params[$civicrmField] = isset($paypalParams[$paypalField]) ?
$paypalParams[$paypalField] : NULL;
1164 * Is this being processed by payment express.
1166 * Either because it is payment express or because is pro with paypal express in use.
1168 * @param array $params
1171 * @throws \Civi\Payment\Exception\PaymentProcessorException
1173 protected function isPaypalExpress($params) {
1174 if ($this->isPayPalType($this::PAYPAL_EXPRESS
)) {
1178 // This would occur postProcess.
1179 if (!empty($params['token'])) {
1182 if (isset($params['button']) && stristr($params['button'], 'express')) {
1186 // The contribution form passes a 'button' but the event form might still set one of these fields.
1187 // @todo more standardisation & get paypal fully out of the form layer.
1188 $possibleExpressFields = [
1189 '_qf_Register_upload_express_x',
1190 '_qf_Payment_upload_express_x',
1192 if (array_intersect_key($params, array_fill_keys($possibleExpressFields, 1))) {