3 +--------------------------------------------------------------------+
4 | Copyright CiviCRM LLC. All rights reserved. |
6 | This work is published under the GNU AGPLv3 license with some |
7 | permitted exceptions and without any warranty. For full license |
8 | and copyright information, see https://civicrm.org/licensing |
9 +--------------------------------------------------------------------+
12 use Civi\Payment\System
;
13 use Civi\Payment\Exception\PaymentProcessorException
;
14 use Civi\Payment\PropertyBag
;
17 * Class CRM_Core_Payment.
19 * This class is the main class for the payment processor subsystem.
21 * It is the parent class for payment processors. It also holds some IPN related functions
22 * that need to be moved. In particular handlePaymentMethod should be moved to a factory class.
24 abstract class CRM_Core_Payment
{
27 * Component - ie. event or contribute.
29 * This is used for setting return urls.
33 protected $_component;
36 * How are we getting billing information.
38 * We are trying to completely deprecate these parameters.
40 * FORM - we collect it on the same page
41 * BUTTON - the processor collects it and sends it back to us via some protocol
44 BILLING_MODE_FORM
= 1,
45 BILLING_MODE_BUTTON
= 2,
46 BILLING_MODE_NOTIFY
= 4;
49 * Which payment type(s) are we using?
54 * @todo create option group - nb omnipay uses a 3rd type - transparent redirect cc
57 PAYMENT_TYPE_CREDIT_CARD
= 1,
58 PAYMENT_TYPE_DIRECT_DEBIT
= 2;
61 * Subscription / Recurring payment Status
65 RECURRING_PAYMENT_START
= 'START',
66 RECURRING_PAYMENT_END
= 'END';
71 protected $_paymentProcessor;
74 * Base url of the calling form (offsite processors).
78 protected $baseReturnUrl;
81 * Return url upon success (offsite processors).
85 protected $successUrl;
88 * Return url upon failure (offsite processors).
95 * Processor type label.
97 * (Deprecated parameter but used in some messages).
103 public $_processorName;
106 * The profile configured to show on the billing form.
108 * Currently only the pseudo-profile 'billing' is supported but hopefully in time we will take an id and
109 * load that from the DB and the processor will be able to return a set of fields that combines it's minimum
110 * requirements with the configured requirements.
112 * Currently only the pseudo-processor 'manual' or 'pay-later' uses this setting to return a 'curated' set
115 * Note this change would probably include converting 'billing' to a reserved profile.
119 protected $billingProfile;
122 * Payment instrument ID.
124 * This is normally retrieved from the payment_processor table.
128 protected $paymentInstrumentID;
131 * Is this a back office transaction.
135 protected $backOffice = FALSE;
138 * This is only needed during the transitional phase. In future you should
139 * pass your own PropertyBag into the method you're calling.
141 * New code should NOT use $this->propertyBag.
143 * @var Civi\Payment\PropertyBag
145 protected $propertyBag;
148 * Return the payment instrument ID to use.
151 * We normally SHOULD be returning the payment instrument of the payment processor.
152 * However there is an outstanding case where this needs overriding, which is
153 * when using CRM_Core_Payment_Manual which uses the pseudoprocessor (id = 0).
155 * i.e. If you're writing a Payment Processor you should NOT be using
156 * setPaymentInstrumentID() at all.
159 * Ideally this exception-to-the-rule should be handled outside of this class
160 * i.e. this class's getPaymentInstrumentID method should return it from the
161 * payment processor and CRM_Core_Payment_Manual could override it to provide 0.
165 public function getPaymentInstrumentID() {
166 return isset($this->paymentInstrumentID
)
167 ?
$this->paymentInstrumentID
168 : (int) ($this->_paymentProcessor
['payment_instrument_id'] ??
0);
172 * Getter for the id Payment Processor ID.
176 public function getID() {
177 return (int) $this->_paymentProcessor
['id'];
181 * @deprecated Set payment Instrument id - see note on getPaymentInstrumentID.
183 * By default we actually ignore the form value. The manual processor takes
186 * @param int $paymentInstrumentID
188 public function setPaymentInstrumentID($paymentInstrumentID) {
189 $this->paymentInstrumentID
= (int) $paymentInstrumentID;
190 // See note on getPaymentInstrumentID().
191 return $this->getPaymentInstrumentID();
197 public function isBackOffice() {
198 return $this->backOffice
;
202 * Set back office property.
204 * @param bool $isBackOffice
206 public function setBackOffice($isBackOffice) {
207 $this->backOffice
= $isBackOffice;
211 * Set base return path (offsite processors).
213 * This is only useful with an internal civicrm form.
216 * Internal civicrm path.
218 public function setBaseReturnUrl($url) {
219 $this->baseReturnUrl
= $url;
223 * Set success return URL (offsite processors).
225 * This overrides $baseReturnUrl
228 * Full url of site to return browser to upon success.
230 public function setSuccessUrl($url) {
231 $this->successUrl
= $url;
235 * Set cancel return URL (offsite processors).
237 * This overrides $baseReturnUrl
240 * Full url of site to return browser to upon failure.
242 public function setCancelUrl($url) {
243 $this->cancelUrl
= $url;
247 * Set the configured payment profile.
249 * @param int|string $value
251 public function setBillingProfile($value) {
252 $this->billingProfile
= $value;
256 * Opportunity for the payment processor to override the entire form build.
258 * @param CRM_Core_Form $form
261 * Should form building stop at this point?
263 public function buildForm(&$form) {
268 * Log payment notification message to forensic system log.
270 * @todo move to factory class \Civi\Payment\System (or similar)
272 * @param array $params
274 public static function logPaymentNotification($params) {
275 $message = 'payment_notification ';
276 if (!empty($params['processor_name'])) {
277 $message .= 'processor_name=' . $params['processor_name'];
279 if (!empty($params['processor_id'])) {
280 $message .= 'processor_id=' . $params['processor_id'];
283 $log = new CRM_Utils_SystemLogger();
284 // $_REQUEST doesn't handle JSON, to support providers that POST JSON we need the raw POST data.
285 $rawRequestData = file_get_contents("php://input");
286 if (CRM_Utils_JSON
::isValidJSON($rawRequestData)) {
287 $log->alert($message, json_decode($rawRequestData, TRUE));
290 $log->alert($message, $_REQUEST);
295 * Check if capability is supported.
297 * Capabilities have a one to one relationship with capability-related functions on this class.
299 * Payment processor classes should over-ride the capability-specific function rather than this one.
301 * @param string $capability
302 * E.g BackOffice, LiveMode, FutureRecurStartDate.
306 public function supports($capability) {
307 $function = 'supports' . ucfirst($capability);
308 if (method_exists($this, $function)) {
309 return $this->$function();
315 * Are back office payments supported.
317 * e.g paypal standard won't permit you to enter a credit card associated
318 * with someone else's login.
319 * The intention is to support off-site (other than paypal) & direct debit but that is not all working yet so to
320 * reach a 'stable' point we disable.
324 protected function supportsBackOffice() {
325 if ($this->_paymentProcessor
['billing_mode'] == 4 ||
$this->_paymentProcessor
['payment_type'] != 1) {
334 * Can more than one transaction be processed at once?
336 * In general processors that process payment by server to server communication support this while others do not.
338 * In future we are likely to hit an issue where this depends on whether a token already exists.
342 protected function supportsMultipleConcurrentPayments() {
343 if ($this->_paymentProcessor
['billing_mode'] == 4 ||
$this->_paymentProcessor
['payment_type'] != 1) {
352 * Are live payments supported - e.g dummy doesn't support this.
356 protected function supportsLiveMode() {
361 * Are test payments supported.
365 protected function supportsTestMode() {
370 * Does this payment processor support refund?
374 public function supportsRefund() {
379 * Should the first payment date be configurable when setting up back office recurring payments.
381 * We set this to false for historical consistency but in fact most new processors use tokens for recurring and can support this
385 protected function supportsFutureRecurStartDate() {
390 * Does this processor support cancelling recurring contributions through code.
392 * If the processor returns true it must be possible to take action from within CiviCRM
393 * that will result in no further payments being processed. In the case of token processors (e.g
394 * IATS, eWay) updating the contribution_recur table is probably sufficient.
398 protected function supportsCancelRecurring() {
399 return method_exists(CRM_Utils_System
::getClassName($this), 'cancelSubscription');
403 * Does this processor support pre-approval.
405 * This would generally look like a redirect to enter credentials which can then be used in a later payment call.
407 * Currently Paypal express supports this, with a redirect to paypal after the 'Main' form is submitted in the
408 * contribution page. This token can then be processed at the confirm phase. Although this flow 'looks' like the
409 * 'notify' flow a key difference is that in the notify flow they don't have to return but in this flow they do.
413 protected function supportsPreApproval() {
418 * Does this processor support updating billing info for recurring contributions through code.
420 * If the processor returns true then it must be possible to update billing info from within CiviCRM
421 * that will be updated at the payment processor.
425 protected function supportsUpdateSubscriptionBillingInfo() {
426 return method_exists(CRM_Utils_System
::getClassName($this), 'updateSubscriptionBillingInfo');
430 * Can recurring contributions be set against pledges.
432 * In practice all processors that use the baseIPN function to finish transactions or
433 * call the completetransaction api support this by looking up previous contributions in the
434 * series and, if there is a prior contribution against a pledge, and the pledge is not complete,
435 * adding the new payment to the pledge.
437 * However, only enabling for processors it has been tested against.
441 protected function supportsRecurContributionsForPledges() {
446 * Function to action pre-approval if supported
448 * @param array $params
449 * Parameters from the form
451 * This function returns an array which should contain
452 * - pre_approval_parameters (this will be stored on the calling form & available later)
453 * - redirect_url (if set the browser will be redirected to this.
455 public function doPreApproval(&$params) {
459 * Get any details that may be available to the payment processor due to an approval process having happened.
461 * In some cases the browser is redirected to enter details on a processor site. Some details may be available as a
464 * @param array $storedDetails
468 public function getPreApprovalDetails($storedDetails) {
473 * Default payment instrument validation.
475 * Implement the usual Luhn algorithm via a static function in the CRM_Core_Payment_Form if it's a credit card
476 * Not a static function, because I need to check for payment_type.
478 * @param array $values
479 * @param array $errors
481 public function validatePaymentInstrument($values, &$errors) {
482 CRM_Core_Form
::validateMandatoryFields($this->getMandatoryFields(), $values, $errors);
483 if ($this->_paymentProcessor
['payment_type'] == 1) {
484 CRM_Core_Payment_Form
::validateCreditCard($values, $errors, $this->_paymentProcessor
['id']);
489 * Getter for the payment processor.
491 * The payment processor array is based on the civicrm_payment_processor table entry.
494 * Payment processor array.
496 public function getPaymentProcessor() {
497 return $this->_paymentProcessor
;
501 * Setter for the payment processor.
503 * @param array $processor
505 public function setPaymentProcessor($processor) {
506 $this->_paymentProcessor
= $processor;
510 * Setter for the payment form that wants to use the processor.
514 * @param CRM_Core_Form $paymentForm
516 public function setForm(&$paymentForm) {
517 $this->_paymentForm
= $paymentForm;
521 * Getter for payment form that is using the processor.
523 * @return CRM_Core_Form
526 public function getForm() {
527 return $this->_paymentForm
;
531 * Get help text information (help, description, etc.) about this payment,
532 * to display to the user.
534 * @param string $context
535 * Context of the text.
536 * Only explicitly supported contexts are handled without error.
537 * Currently supported:
538 * - contributionPageRecurringHelp (params: is_recur_installments, is_email_receipt)
540 * @param array $params
541 * Parameters for the field, context specific.
545 public function getText($context, $params) {
546 // I have deliberately added a noisy fail here.
547 // The function is intended to be extendable, but not by changes
548 // not documented clearly above.
550 case 'contributionPageRecurringHelp':
551 // require exactly two parameters
552 if (array_keys($params) == [
553 'is_recur_installments',
556 $gotText = ts('Your recurring contribution will be processed automatically.');
557 if ($params['is_recur_installments']) {
558 $gotText .= ' ' . ts('You can specify the number of installments, or you can leave the number of installments blank if you want to make an open-ended commitment. In either case, you can choose to cancel at any time.');
560 if ($params['is_email_receipt']) {
561 $gotText .= ' ' . ts('You will receive an email receipt for each recurring contribution.');
566 case 'contributionPageContinueText':
567 if ($params['amount'] <= 0) {
568 return ts('To complete this transaction, click the <strong>Continue</strong> button below.');
570 if ($this->_paymentProcessor
['billing_mode'] == 4) {
571 return ts('Click the <strong>Continue</strong> button to go to %1, where you will select your payment method and complete the contribution.', [$this->_paymentProcessor
['payment_processor_type']]);
573 if ($params['is_payment_to_existing']) {
574 return ts('To complete this transaction, click the <strong>Make Payment</strong> button below.');
576 return ts('To complete your contribution, click the <strong>Continue</strong> button below.');
579 CRM_Core_Error
::deprecatedFunctionWarning('Calls to getText must use a supported method');
584 * Getter for accessing member vars.
586 * @todo believe this is unused
588 * @param string $name
592 public function getVar($name) {
593 return isset($this->$name) ?
$this->$name : NULL;
597 * Get name for the payment information type.
598 * @todo - use option group + name field (like Omnipay does)
601 public function getPaymentTypeName() {
602 return $this->_paymentProcessor
['payment_type'] == 1 ?
'credit_card' : 'direct_debit';
606 * Get label for the payment information type.
607 * @todo - use option group + labels (like Omnipay does)
610 public function getPaymentTypeLabel() {
611 return $this->_paymentProcessor
['payment_type'] == 1 ?
ts('Credit Card') : ts('Direct Debit');
615 * Get array of fields that should be displayed on the payment form.
618 * array('credit_card_type', 'credit_card_number', 'cvv2', 'credit_card_exp_date')
620 * array('account_holder', 'bank_account_number', 'bank_identification_number', 'bank_name')
625 * Array of payment fields appropriate to the payment processor.
627 * @throws CiviCRM_API3_Exception
629 public function getPaymentFormFields() {
630 if ($this->_paymentProcessor
['billing_mode'] == 4) {
633 return $this->_paymentProcessor
['payment_type'] == 1 ?
$this->getCreditCardFormFields() : $this->getDirectDebitFormFields();
637 * Get an array of the fields that can be edited on the recurring contribution.
639 * Some payment processors support editing the amount and other scheduling details of recurring payments, especially
640 * those which use tokens. Others are fixed. This function allows the processor to return an array of the fields that
641 * can be updated from the contribution recur edit screen.
643 * The fields are likely to be a subset of these
646 * - 'frequency_interval',
647 * - 'frequency_unit',
649 * - 'next_sched_contribution_date',
651 * - 'failure_retry_day',
653 * The form does not restrict which fields from the contribution_recur table can be added (although if the html_type
654 * metadata is not defined in the xml for the field it will cause an error.
656 * Open question - would it make sense to return membership_id in this - which is sometimes editable and is on that
657 * form (UpdateSubscription).
661 public function getEditableRecurringScheduleFields() {
662 if ($this->supports('changeSubscriptionAmount')) {
669 * Get the help text to present on the recurring update page.
671 * This should reflect what can or cannot be edited.
675 public function getRecurringScheduleUpdateHelpText() {
676 if (!in_array('amount', $this->getEditableRecurringScheduleFields())) {
677 return ts('Updates made using this form will change the recurring contribution information stored in your CiviCRM database, but will NOT be sent to the payment processor. You must enter the same changes using the payment processor web site.');
679 return ts('Use this form to change the amount or number of installments for this recurring contribution. Changes will be automatically sent to the payment processor. You can not change the contribution frequency.');
683 * Get the metadata for all required fields.
687 protected function getMandatoryFields() {
688 $mandatoryFields = [];
689 foreach ($this->getAllFields() as $field_name => $field_spec) {
690 if (!empty($field_spec['is_required'])) {
691 $mandatoryFields[$field_name] = $field_spec;
694 return $mandatoryFields;
698 * Get the metadata of all the fields configured for this processor.
702 * @throws \CiviCRM_API3_Exception
704 protected function getAllFields() {
705 $paymentFields = array_intersect_key($this->getPaymentFormFieldsMetadata(), array_flip($this->getPaymentFormFields()));
706 $billingFields = array_intersect_key($this->getBillingAddressFieldsMetadata(), array_flip($this->getBillingAddressFields()));
707 return array_merge($paymentFields, $billingFields);
711 * Get array of fields that should be displayed on the payment form for credit cards.
715 protected function getCreditCardFormFields() {
718 'credit_card_number',
720 'credit_card_exp_date',
725 * Get array of fields that should be displayed on the payment form for direct debits.
729 protected function getDirectDebitFormFields() {
732 'bank_account_number',
733 'bank_identification_number',
739 * Return an array of all the details about the fields potentially required for payment fields.
741 * Only those determined by getPaymentFormFields will actually be assigned to the form
746 public function getPaymentFormFieldsMetadata() {
747 //@todo convert credit card type into an option value
748 $creditCardType = ['' => ts('- select -')] + CRM_Contribute_PseudoConstant
::creditCard();
749 $isCVVRequired = Civi
::settings()->get('cvv_backoffice_required');
750 if (!$this->isBackOffice()) {
751 $isCVVRequired = TRUE;
754 'credit_card_number' => [
755 'htmlType' => 'text',
756 'name' => 'credit_card_number',
757 'title' => ts('Card Number'),
761 'autocomplete' => 'off',
762 'class' => 'creditcard',
764 'is_required' => TRUE,
765 // 'description' => '16 digit card number', // If you enable a description field it will be shown below the field on the form
768 'htmlType' => 'text',
770 'title' => ts('Security Code'),
774 'autocomplete' => 'off',
776 'is_required' => $isCVVRequired,
779 'rule_message' => ts('Please enter a valid value for your card security code. This is usually the last 3-4 digits on the card\'s signature panel.'),
780 'rule_name' => 'integer',
781 'rule_parameters' => NULL,
785 'credit_card_exp_date' => [
786 'htmlType' => 'date',
787 'name' => 'credit_card_exp_date',
788 'title' => ts('Expiration Date'),
789 'attributes' => CRM_Core_SelectValues
::date('creditCard'),
790 'is_required' => TRUE,
793 'rule_message' => ts('Card expiration date cannot be a past date.'),
794 'rule_name' => 'currentDate',
795 'rule_parameters' => TRUE,
798 'extra' => ['class' => 'crm-form-select'],
800 'credit_card_type' => [
801 'htmlType' => 'select',
802 'name' => 'credit_card_type',
803 'title' => ts('Card Type'),
804 'attributes' => $creditCardType,
805 'is_required' => FALSE,
807 'account_holder' => [
808 'htmlType' => 'text',
809 'name' => 'account_holder',
810 'title' => ts('Account Holder'),
814 'autocomplete' => 'on',
816 'is_required' => TRUE,
818 //e.g. IBAN can have maxlength of 34 digits
819 'bank_account_number' => [
820 'htmlType' => 'text',
821 'name' => 'bank_account_number',
822 'title' => ts('Bank Account Number'),
826 'autocomplete' => 'off',
830 'rule_message' => ts('Please enter a valid Bank Identification Number (value must not contain punctuation characters).'),
831 'rule_name' => 'nopunctuation',
832 'rule_parameters' => NULL,
835 'is_required' => TRUE,
837 //e.g. SWIFT-BIC can have maxlength of 11 digits
838 'bank_identification_number' => [
839 'htmlType' => 'text',
840 'name' => 'bank_identification_number',
841 'title' => ts('Bank Identification Number'),
845 'autocomplete' => 'off',
847 'is_required' => TRUE,
850 'rule_message' => ts('Please enter a valid Bank Identification Number (value must not contain punctuation characters).'),
851 'rule_name' => 'nopunctuation',
852 'rule_parameters' => NULL,
857 'htmlType' => 'text',
858 'name' => 'bank_name',
859 'title' => ts('Bank Name'),
863 'autocomplete' => 'off',
865 'is_required' => TRUE,
869 'htmlType' => 'text',
870 'name' => 'check_number',
871 'title' => ts('Check Number'),
872 'is_required' => FALSE,
873 'attributes' => NULL,
875 'pan_truncation' => [
876 'htmlType' => 'text',
877 'name' => 'pan_truncation',
878 'title' => ts('Last 4 digits of the card'),
879 'is_required' => FALSE,
884 'autocomplete' => 'off',
888 'rule_message' => ts('Please enter valid last 4 digit card number.'),
889 'rule_name' => 'numeric',
890 'rule_parameters' => NULL,
895 'htmlType' => 'hidden',
896 'name' => 'payment_token',
897 'title' => ts('Authorization token'),
898 'is_required' => FALSE,
901 'autocomplete' => 'off',
902 'id' => 'payment_token',
909 * Get billing fields required for this processor.
911 * We apply the existing default of returning fields only for payment processor type 1. Processors can override to
914 * @param int $billingLocationID
918 public function getBillingAddressFields($billingLocationID = NULL) {
919 if (!$billingLocationID) {
920 // Note that although the billing id is passed around the forms the idea that it would be anything other than
921 // the result of the function below doesn't seem to have eventuated.
922 // So taking this as a param is possibly something to be removed in favour of the standard default.
923 $billingLocationID = CRM_Core_BAO_LocationType
::getBilling();
925 if ($this->_paymentProcessor
['billing_mode'] != 1 && $this->_paymentProcessor
['billing_mode'] != 3) {
929 'first_name' => 'billing_first_name',
930 'middle_name' => 'billing_middle_name',
931 'last_name' => 'billing_last_name',
932 'street_address' => "billing_street_address-{$billingLocationID}",
933 'city' => "billing_city-{$billingLocationID}",
934 'country' => "billing_country_id-{$billingLocationID}",
935 'state_province' => "billing_state_province_id-{$billingLocationID}",
936 'postal_code' => "billing_postal_code-{$billingLocationID}",
941 * Get form metadata for billing address fields.
943 * @param int $billingLocationID
946 * Array of metadata for address fields.
948 public function getBillingAddressFieldsMetadata($billingLocationID = NULL) {
949 if (!$billingLocationID) {
950 // Note that although the billing id is passed around the forms the idea that it would be anything other than
951 // the result of the function below doesn't seem to have eventuated.
952 // So taking this as a param is possibly something to be removed in favour of the standard default.
953 $billingLocationID = CRM_Core_BAO_LocationType
::getBilling();
956 $metadata['billing_first_name'] = [
957 'htmlType' => 'text',
958 'name' => 'billing_first_name',
959 'title' => ts('Billing First Name'),
964 'autocomplete' => 'off',
966 'is_required' => TRUE,
969 $metadata['billing_middle_name'] = [
970 'htmlType' => 'text',
971 'name' => 'billing_middle_name',
972 'title' => ts('Billing Middle Name'),
977 'autocomplete' => 'off',
979 'is_required' => FALSE,
982 $metadata['billing_last_name'] = [
983 'htmlType' => 'text',
984 'name' => 'billing_last_name',
985 'title' => ts('Billing Last Name'),
990 'autocomplete' => 'off',
992 'is_required' => TRUE,
995 $metadata["billing_street_address-{$billingLocationID}"] = [
996 'htmlType' => 'text',
997 'name' => "billing_street_address-{$billingLocationID}",
998 'title' => ts('Street Address'),
1003 'autocomplete' => 'off',
1005 'is_required' => TRUE,
1008 $metadata["billing_city-{$billingLocationID}"] = [
1009 'htmlType' => 'text',
1010 'name' => "billing_city-{$billingLocationID}",
1011 'title' => ts('City'),
1016 'autocomplete' => 'off',
1018 'is_required' => TRUE,
1021 $metadata["billing_state_province_id-{$billingLocationID}"] = [
1022 'htmlType' => 'chainSelect',
1023 'title' => ts('State/Province'),
1024 'name' => "billing_state_province_id-{$billingLocationID}",
1026 'is_required' => TRUE,
1029 $metadata["billing_postal_code-{$billingLocationID}"] = [
1030 'htmlType' => 'text',
1031 'name' => "billing_postal_code-{$billingLocationID}",
1032 'title' => ts('Postal Code'),
1037 'autocomplete' => 'off',
1039 'is_required' => TRUE,
1042 $metadata["billing_country_id-{$billingLocationID}"] = [
1043 'htmlType' => 'select',
1044 'name' => "billing_country_id-{$billingLocationID}",
1045 'title' => ts('Country'),
1048 '' => ts('- select -'),
1049 ] + CRM_Core_PseudoConstant
::country(),
1050 'is_required' => TRUE,
1056 * Get base url dependent on component.
1058 * (or preferably set it using the setter function).
1062 protected function getBaseReturnUrl() {
1063 if ($this->baseReturnUrl
) {
1064 return $this->baseReturnUrl
;
1066 if ($this->_component
== 'event') {
1067 $baseURL = 'civicrm/event/register';
1070 $baseURL = 'civicrm/contribute/transact';
1076 * Get the currency for the transaction from the params.
1078 * Legacy wrapper. Better for a method to work on its own PropertyBag.
1080 * This code now uses PropertyBag to allow for old inputs like currencyID.
1086 protected function getCurrency($params = []) {
1087 $localPropertyBag = new PropertyBag();
1088 $localPropertyBag->mergeLegacyInputParams($params);
1089 return $localPropertyBag->getCurrency();
1093 * Legacy. Better for a method to work on its own PropertyBag,
1094 * but also, this function does not do very much.
1096 * @param array $params
1099 * @throws \CRM_Core_Exception
1101 protected function getAmount($params = []) {
1102 return CRM_Utils_Money
::format($params['amount'], NULL, NULL, TRUE);
1106 * Get url to return to after cancelled or failed transaction.
1108 * @param string $qfKey
1109 * @param int $participantID
1111 * @return string cancel url
1113 public function getCancelUrl($qfKey, $participantID) {
1114 if (isset($this->cancelUrl
)) {
1115 return $this->cancelUrl
;
1118 if ($this->_component
== 'event') {
1119 return CRM_Utils_System
::url($this->getBaseReturnUrl(), [
1122 'participantId' => $participantID,
1128 return CRM_Utils_System
::url($this->getBaseReturnUrl(), [
1129 '_qf_Main_display' => 1,
1138 * Get URL to return the browser to on success.
1144 protected function getReturnSuccessUrl($qfKey) {
1145 if (isset($this->successUrl
)) {
1146 return $this->successUrl
;
1149 return CRM_Utils_System
::url($this->getBaseReturnUrl(), [
1150 '_qf_ThankYou_display' => 1,
1158 * Get URL to return the browser to on failure.
1160 * @param string $key
1161 * @param int $participantID
1162 * @param int $eventID
1165 * URL for a failing transactor to be redirected to.
1167 protected function getReturnFailUrl($key, $participantID = NULL, $eventID = NULL) {
1168 if (isset($this->cancelUrl
)) {
1169 return $this->cancelUrl
;
1172 $test = $this->_is_test ?
'&action=preview' : '';
1173 if ($this->_component
== "event") {
1174 return CRM_Utils_System
::url('civicrm/event/register',
1175 "reset=1&cc=fail&participantId={$participantID}&id={$eventID}{$test}&qfKey={$key}",
1180 return CRM_Utils_System
::url('civicrm/contribute/transact',
1181 "_qf_Main_display=1&cancel=1&qfKey={$key}{$test}",
1188 * Get URl for when the back button is pressed.
1192 * @return string url
1194 protected function getGoBackUrl($qfKey) {
1195 return CRM_Utils_System
::url($this->getBaseReturnUrl(), [
1196 '_qf_Confirm_display' => 'true',
1204 * Get the notify (aka ipn, web hook or silent post) url.
1206 * If there is no '.' in it we assume that we are dealing with localhost or
1207 * similar and it is unreachable from the web & hence invalid.
1210 * URL to notify outcome of transaction.
1212 protected function getNotifyUrl() {
1213 $url = CRM_Utils_System
::url(
1214 'civicrm/payment/ipn/' . $this->_paymentProcessor
['id'],
1221 return (stristr($url, '.')) ?
$url : '';
1225 * Calling this from outside the payment subsystem is deprecated - use doPayment.
1227 * Does a server to server payment transaction.
1229 * @param array $params
1230 * Assoc array of input parameters for this transaction.
1233 * the result in an nice formatted array (or an error object - but throwing exceptions is preferred)
1235 protected function doDirectPayment(&$params) {
1240 * Processors may need to inspect, validate, cast and copy data that is
1241 * specific to this Payment Processor from the input array to custom fields
1242 * on the PropertyBag.
1244 * @param Civi\Payment\PropertyBag $propertyBag
1245 * @param array $params
1246 * @param string $component
1248 * @throws \Civi\Payment\Exception\PaymentProcessorException
1250 public function extractCustomPropertiesForDoPayment(PropertyBag
$propertyBag, array $params, $component = 'contribute') {
1252 // (validation and casting goes first)
1253 // $propertyBag->setCustomProperty('myprocessor_customPropertyName', $value);
1257 * Process payment - this function wraps around both doTransferCheckout and doDirectPayment.
1258 * Any processor that still implements the deprecated doTransferCheckout() or doDirectPayment() should be updated to use doPayment().
1260 * This function adds some historical defaults ie. the assumption that if a 'doDirectPayment' processors comes back it completed
1261 * the transaction & in fact doTransferCheckout would not traditionally come back.
1262 * Payment processors should throw exceptions and not return Error objects as they may have done with the old functions.
1264 * Payment processors should set payment_status_id (which is really contribution_status_id) in the returned array. The default is assumed to be Pending.
1265 * In some cases the IPN will set the payment to "Completed" some time later.
1267 * @fixme Creating a contribution record is inconsistent! We should always create a contribution BEFORE calling doPayment...
1268 * For the current status see: https://lab.civicrm.org/dev/financial/issues/53
1269 * If we DO have a contribution ID, then the payment processor can (and should) update parameters on the contribution record as necessary.
1271 * @param array|PropertyBag $params
1273 * @param string $component
1276 * Result array (containing at least the key payment_status_id)
1278 * @throws \Civi\Payment\Exception\PaymentProcessorException
1280 public function doPayment(&$params, $component = 'contribute') {
1281 $this->_component
= $component;
1282 $statuses = CRM_Contribute_BAO_Contribution
::buildOptions('contribution_status_id', 'validate');
1284 // If we have a $0 amount, skip call to processor and set payment_status to Completed.
1285 // Conceivably a processor might override this - perhaps for setting up a token - but we don't
1286 // have an example of that at the mome.
1287 if ($params['amount'] == 0) {
1288 $result['payment_status_id'] = array_search('Completed', $statuses);
1292 if ($this->_paymentProcessor
['billing_mode'] == 4) {
1293 $result = $this->doTransferCheckout($params, $component);
1294 if (is_array($result) && !isset($result['payment_status_id'])) {
1295 $result['payment_status_id'] = array_search('Pending', $statuses);
1299 $result = $this->doDirectPayment($params, $component);
1300 if (is_array($result) && !isset($result['payment_status_id'])) {
1301 if (!empty($params['is_recur'])) {
1302 // See comment block.
1303 $result['payment_status_id'] = array_search('Pending', $statuses);
1306 $result['payment_status_id'] = array_search('Completed', $statuses);
1310 if (is_a($result, 'CRM_Core_Error')) {
1311 throw new PaymentProcessorException(CRM_Core_Error
::getMessages($result));
1319 * Payment processors should set payment_status_id if it set the status to Refunded in case the transaction is successful
1321 * @param array $params
1323 * @throws \Civi\Payment\Exception\PaymentProcessorException
1325 public function doRefund(&$params) {}
1328 * Query payment processor for details about a transaction.
1330 * @param array $params
1331 * Array of parameters containing one of:
1332 * - trxn_id Id of an individual transaction.
1333 * - processor_id Id of a recurring contribution series as stored in the civicrm_contribution_recur table.
1336 * Extra parameters retrieved.
1337 * Any parameters retrievable through this should be documented in the function comments at
1338 * CRM_Core_Payment::doQuery. Currently:
1339 * - fee_amount Amount of fee paid
1341 public function doQuery($params) {
1346 * This function checks to see if we have the right config values.
1349 * the error message if any
1351 abstract protected function checkConfig();
1354 * Redirect for paypal.
1356 * @todo move to paypal class or remove
1358 * @param $paymentProcessor
1362 public static function paypalRedirect(&$paymentProcessor) {
1363 if (!$paymentProcessor) {
1367 if (isset($_GET['payment_date']) &&
1368 isset($_GET['merchant_return_link']) &&
1369 CRM_Utils_Array
::value('payment_status', $_GET) == 'Completed' &&
1370 $paymentProcessor['payment_processor_type'] == "PayPal_Standard"
1379 * Handle incoming payment notification.
1381 * IPNs, also called silent posts are notifications of payment outcomes or activity on an external site.
1383 * @todo move to0 \Civi\Payment\System factory method
1384 * Page callback for civicrm/payment/ipn
1386 public static function handleIPN() {
1388 self
::handlePaymentMethod(
1389 'PaymentNotification',
1391 'processor_name' => CRM_Utils_Request
::retrieveValue('processor_name', 'String'),
1392 'processor_id' => CRM_Utils_Request
::retrieveValue('processor_id', 'Integer'),
1393 'mode' => CRM_Utils_Request
::retrieveValue('mode', 'Alphanumeric'),
1397 catch (CRM_Core_Exception
$e) {
1398 Civi
::log()->error('ipn_payment_callback_exception', [
1400 'backtrace' => CRM_Core_Error
::formatBacktrace(debug_backtrace()),
1404 CRM_Utils_System
::civiExit();
1408 * Payment callback handler.
1410 * The processor_name or processor_id is passed in.
1411 * Note that processor_id is more reliable as one site may have more than one instance of a
1412 * processor & ideally the processor will be validating the results
1413 * Load requested payment processor and call that processor's handle<$method> method
1415 * @todo move to \Civi\Payment\System factory method
1417 * @param string $method
1418 * 'PaymentNotification' or 'PaymentCron'
1419 * @param array $params
1421 * @throws \CRM_Core_Exception
1422 * @throws \Exception
1424 public static function handlePaymentMethod($method, $params = []) {
1425 if (!isset($params['processor_id']) && !isset($params['processor_name'])) {
1426 $q = explode('/', CRM_Utils_Array
::value(CRM_Core_Config
::singleton()->userFrameworkURLVar
, $_GET, ''));
1427 $lastParam = array_pop($q);
1428 if (is_numeric($lastParam)) {
1429 $params['processor_id'] = $_GET['processor_id'] = $lastParam;
1432 self
::logPaymentNotification($params);
1433 throw new CRM_Core_Exception("Either 'processor_id' (recommended) or 'processor_name' (deprecated) is required for payment callback.");
1437 self
::logPaymentNotification($params);
1439 $sql = "SELECT ppt.class_name, ppt.name as processor_name, pp.id AS processor_id
1440 FROM civicrm_payment_processor_type ppt
1441 INNER JOIN civicrm_payment_processor pp
1442 ON pp.payment_processor_type_id = ppt.id
1445 if (isset($params['processor_id'])) {
1446 $sql .= " WHERE pp.id = %2";
1447 $args[2] = [$params['processor_id'], 'Integer'];
1448 $notFound = ts("No active instances of payment processor %1 were found.", [1 => $params['processor_id']]);
1451 // This is called when processor_name is passed - passing processor_id instead is recommended.
1452 $sql .= " WHERE ppt.name = %2 AND pp.is_test = %1";
1454 (CRM_Utils_Array
::value('mode', $params) == 'test') ?
1 : 0,
1457 $args[2] = [$params['processor_name'], 'String'];
1458 $notFound = ts("No active instances of payment processor '%1' were found.", [1 => $params['processor_name']]);
1461 $dao = CRM_Core_DAO
::executeQuery($sql, $args);
1463 // Check whether we found anything at all.
1465 throw new CRM_Core_Exception($notFound);
1468 $method = 'handle' . $method;
1469 $extension_instance_found = FALSE;
1471 // In all likelihood, we'll just end up with the one instance returned here. But it's
1472 // possible we may get more. Hence, iterate through all instances ..
1474 while ($dao->fetch()) {
1475 // Check pp is extension - is this still required - surely the singleton below handles it.
1476 $ext = CRM_Extension_System
::singleton()->getMapper();
1477 if ($ext->isExtensionKey($dao->class_name
)) {
1478 $paymentClass = $ext->keyToClass($dao->class_name
, 'payment');
1479 require_once $ext->classToPath($paymentClass);
1482 $processorInstance = System
::singleton()->getById($dao->processor_id
);
1484 // Should never be empty - we already established this processor_id exists and is active.
1485 if (empty($processorInstance)) {
1489 // Does PP implement this method, and can we call it?
1490 if (!method_exists($processorInstance, $method) ||
1491 !is_callable([$processorInstance, $method])
1493 // on the off chance there is a double implementation of this processor we should keep looking for another
1494 // note that passing processor_id is more reliable & we should work to deprecate processor_name
1498 // Everything, it seems, is ok - execute pp callback handler
1499 $processorInstance->$method();
1500 $extension_instance_found = TRUE;
1503 // Call IPN postIPNProcess hook to allow for custom processing of IPN data.
1504 $IPNParams = array_merge($_GET, $_REQUEST);
1505 CRM_Utils_Hook
::postIPNProcess($IPNParams);
1506 if (!$extension_instance_found) {
1507 $message = "No extension instances of the '%1' payment processor were found.<br />" .
1508 "%2 method is unsupported in legacy payment processors.";
1509 throw new CRM_Core_Exception(ts($message, [
1510 1 => $params['processor_name'],
1517 * Check whether a method is present ( & supported ) by the payment processor object.
1519 * @deprecated - use $paymentProcessor->supports(array('cancelRecurring');
1521 * @param string $method
1522 * Method to check for.
1526 public function isSupported($method) {
1527 return method_exists(CRM_Utils_System
::getClassName($this), $method);
1531 * Some processors replace the form submit button with their own.
1533 * Returning false here will leave the button off front end forms.
1535 * At this stage there is zero cross-over between back-office processors and processors that suppress the submit.
1537 public function isSuppressSubmitButtons() {
1542 * Checks to see if invoice_id already exists in db.
1544 * It's arguable if this belongs in the payment subsystem at all but since several processors implement it
1545 * it is better to standardise to being here.
1547 * @param int $invoiceId The ID to check.
1549 * @param null $contributionID
1550 * If a contribution exists pass in the contribution ID.
1553 * True if invoice ID otherwise exists, else false
1555 protected function checkDupe($invoiceId, $contributionID = NULL) {
1556 $contribution = new CRM_Contribute_DAO_Contribution();
1557 $contribution->invoice_id
= $invoiceId;
1558 if ($contributionID) {
1559 $contribution->whereAdd("id <> $contributionID");
1561 return $contribution->find();
1565 * Get url for users to manage this recurring contribution for this processor.
1567 * @param int $entityID
1568 * @param null $entity
1569 * @param string $action
1573 public function subscriptionURL($entityID = NULL, $entity = NULL, $action = 'cancel') {
1577 if (!$this->supports('cancelRecurring')) {
1580 $url = 'civicrm/contribute/unsubscribe';
1584 //in notify mode don't return the update billing url
1585 if (!$this->supports('updateSubscriptionBillingInfo')) {
1588 $url = 'civicrm/contribute/updatebilling';
1592 if (!$this->supports('changeSubscriptionAmount') && !$this->supports('editRecurringContribution')) {
1595 $url = 'civicrm/contribute/updaterecur';
1599 $userId = CRM_Core_Session
::singleton()->get('userID');
1601 $checksumValue = '';
1604 // Find related Contact
1608 $contactID = CRM_Core_DAO
::getFieldValue("CRM_Member_DAO_Membership", $entityID, "contact_id");
1612 case 'contribution':
1613 $contactID = CRM_Core_DAO
::getFieldValue("CRM_Contribute_DAO_Contribution", $entityID, "contact_id");
1614 $entityArg = 'coid';
1619 SELECT DISTINCT con.contact_id
1620 FROM civicrm_contribution_recur rec
1621 INNER JOIN civicrm_contribution con ON ( con.contribution_recur_id = rec.id )
1623 $contactID = CRM_Core_DAO
::singleValueQuery($sql, [
1629 $entityArg = 'crid';
1634 // Add entity arguments
1635 if ($entityArg != '') {
1636 // Add checksum argument
1637 if ($contactID != 0 && $userId != $contactID) {
1638 $checksumValue = '&cs=' . CRM_Contact_BAO_Contact_Utils
::generateChecksum($contactID, NULL, 'inf');
1640 return CRM_Utils_System
::url($url, "reset=1&{$entityArg}={$entityID}{$checksumValue}", TRUE, NULL, FALSE, TRUE);
1644 if ($this->supports('accountLoginURL')) {
1645 return $this->accountLoginURL();
1649 return isset($this->_paymentProcessor
['url_recur']) ?
$this->_paymentProcessor
['url_recur'] : '';
1653 * Get description of payment to pass to processor.
1655 * This is often what people see in the interface so we want to get
1656 * as much unique information in as possible within the field length (& presumably the early part of the field)
1658 * People seeing these can be assumed to be advanced users so quantity of information probably trumps
1659 * having field names to clarify
1661 * @param array $params
1662 * @param int $length
1666 protected function getPaymentDescription($params = [], $length = 24) {
1667 $propertyBag = PropertyBag
::cast($params);
1669 $propertyBag->getter('contactID', TRUE),
1670 $propertyBag->getter('contributionID', TRUE),
1671 $propertyBag->getter('description', TRUE) ?
: ($propertyBag->getter('isRecur', TRUE) ?
ts('Recurring payment') : NULL),
1672 $propertyBag->getter('billing_first_name', TRUE),
1673 $propertyBag->getter('billing_last_name', TRUE),
1675 return substr(implode('-', array_filter($parts)), 0, $length);
1679 * Checks if back-office recurring edit is allowed
1683 public function supportsEditRecurringContribution() {
1688 * Does this processor support changing the amount for recurring contributions through code.
1690 * If the processor returns true then it must be possible to update the amount from within CiviCRM
1691 * that will be updated at the payment processor.
1695 protected function supportsChangeSubscriptionAmount() {
1696 return method_exists(CRM_Utils_System
::getClassName($this), 'changeSubscriptionAmount');
1700 * Checks if payment processor supports recurring contributions
1704 public function supportsRecurring() {
1705 if (!empty($this->_paymentProcessor
['is_recur'])) {
1712 * Checks if payment processor supports an account login URL
1713 * TODO: This is checked by self::subscriptionURL but is only used if no entityID is found.
1714 * TODO: It is implemented by AuthorizeNET, any others?
1718 protected function supportsAccountLoginURL() {
1719 return method_exists(CRM_Utils_System
::getClassName($this), 'accountLoginURL');
1723 * Should a receipt be sent out for a pending payment.
1725 * e.g for traditional pay later & ones with a delayed settlement a pending receipt makes sense.
1727 public function isSendReceiptForPending() {