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 unused parameter).
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() {
357 return empty($this->_paymentProcessor
['is_test']);
361 * Are test payments supported.
365 protected function supportsTestMode() {
366 return !empty($this->_paymentProcessor
['is_test']);
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 the processor support the user having a choice as to whether to cancel the recurring with the processor?
405 * If this returns TRUE then there will be an option to send a cancellation request in the cancellation form.
407 * This would normally be false for processors where CiviCRM maintains the schedule.
411 protected function supportsCancelRecurringNotifyOptional() {
412 return $this->supportsCancelRecurring();
416 * Does this processor support pre-approval.
418 * This would generally look like a redirect to enter credentials which can then be used in a later payment call.
420 * Currently Paypal express supports this, with a redirect to paypal after the 'Main' form is submitted in the
421 * contribution page. This token can then be processed at the confirm phase. Although this flow 'looks' like the
422 * 'notify' flow a key difference is that in the notify flow they don't have to return but in this flow they do.
426 protected function supportsPreApproval() {
431 * Does this processor support updating billing info for recurring contributions through code.
433 * If the processor returns true then it must be possible to update billing info from within CiviCRM
434 * that will be updated at the payment processor.
438 protected function supportsUpdateSubscriptionBillingInfo() {
439 return method_exists(CRM_Utils_System
::getClassName($this), 'updateSubscriptionBillingInfo');
443 * Can recurring contributions be set against pledges.
445 * In practice all processors that use the baseIPN function to finish transactions or
446 * call the completetransaction api support this by looking up previous contributions in the
447 * series and, if there is a prior contribution against a pledge, and the pledge is not complete,
448 * adding the new payment to the pledge.
450 * However, only enabling for processors it has been tested against.
454 protected function supportsRecurContributionsForPledges() {
459 * Does the processor work without an email address?
461 * The historic assumption is that all processors require an email address. This capability
462 * allows a processor to state it does not need to be provided with an email address.
463 * NB: when this was added (Feb 2020), the Manual processor class overrides this but
464 * the only use of the capability is in the webform_civicrm module. It is not currently
465 * used in core but may be in future.
469 protected function supportsNoEmailProvided() {
474 * Function to action pre-approval if supported
476 * @param array $params
477 * Parameters from the form
479 * This function returns an array which should contain
480 * - pre_approval_parameters (this will be stored on the calling form & available later)
481 * - redirect_url (if set the browser will be redirected to this.
483 public function doPreApproval(&$params) {
487 * Get any details that may be available to the payment processor due to an approval process having happened.
489 * In some cases the browser is redirected to enter details on a processor site. Some details may be available as a
492 * @param array $storedDetails
496 public function getPreApprovalDetails($storedDetails) {
501 * Default payment instrument validation.
503 * Implement the usual Luhn algorithm via a static function in the CRM_Core_Payment_Form if it's a credit card
504 * Not a static function, because I need to check for payment_type.
506 * @param array $values
507 * @param array $errors
509 public function validatePaymentInstrument($values, &$errors) {
510 CRM_Core_Form
::validateMandatoryFields($this->getMandatoryFields(), $values, $errors);
511 if ($this->_paymentProcessor
['payment_type'] == 1) {
512 CRM_Core_Payment_Form
::validateCreditCard($values, $errors, $this->_paymentProcessor
['id']);
517 * Getter for the payment processor.
519 * The payment processor array is based on the civicrm_payment_processor table entry.
522 * Payment processor array.
524 public function getPaymentProcessor() {
525 return $this->_paymentProcessor
;
529 * Setter for the payment processor.
531 * @param array $processor
533 public function setPaymentProcessor($processor) {
534 $this->_paymentProcessor
= $processor;
538 * Setter for the payment form that wants to use the processor.
542 * @param CRM_Core_Form $paymentForm
544 public function setForm(&$paymentForm) {
545 $this->_paymentForm
= $paymentForm;
549 * Getter for payment form that is using the processor.
551 * @return CRM_Core_Form
554 public function getForm() {
555 return $this->_paymentForm
;
559 * Get help text information (help, description, etc.) about this payment,
560 * to display to the user.
562 * @param string $context
563 * Context of the text.
564 * Only explicitly supported contexts are handled without error.
565 * Currently supported:
566 * - contributionPageRecurringHelp (params: is_recur_installments, is_email_receipt)
567 * - contributionPageContinueText (params: amount, is_payment_to_existing)
568 * - cancelRecurDetailText:
570 * mode, amount, currency, frequency_interval, frequency_unit,
571 * installments, {membershipType|only if mode=auto_renew},
572 * selfService (bool) - TRUE if user doesn't have "edit contributions" permission.
573 * ie. they are accessing via a "self-service" link from an email receipt or similar.
574 * - cancelRecurNotSupportedText
576 * @param array $params
577 * Parameters for the field, context specific.
581 public function getText($context, $params) {
582 // I have deliberately added a noisy fail here.
583 // The function is intended to be extendable, but not by changes
584 // not documented clearly above.
586 case 'contributionPageRecurringHelp':
587 // require exactly two parameters
588 if (array_keys($params) == [
589 'is_recur_installments',
592 $gotText = ts('Your recurring contribution will be processed automatically.');
593 if ($params['is_recur_installments']) {
594 $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.');
596 if ($params['is_email_receipt']) {
597 $gotText .= ' ' . ts('You will receive an email receipt for each recurring contribution.');
602 case 'contributionPageContinueText':
603 return ts('Click the <strong>Continue</strong> button to proceed with the payment.');
605 case 'cancelRecurDetailText':
606 if ($params['mode'] === 'auto_renew') {
607 return ts('Click the button below if you want to cancel the auto-renewal option for your %1 membership. This will not cancel your membership. However you will need to arrange payment for renewal when your membership expires.',
608 [1 => $params['membershipType']]
612 $text = ts('Recurring Contribution Details: %1 every %2 %3', [
613 1 => CRM_Utils_Money
::format($params['amount'], $params['currency']),
614 2 => $params['frequency_interval'],
615 3 => $params['frequency_unit'],
617 if (!empty($params['installments'])) {
618 $text .= ' ' . ts('for %1 installments', [1 => $params['installments']]) . '.';
620 $text = "<strong>{$text}</strong><div class='content'>";
621 $text .= ts('Click the button below to cancel this commitment and stop future transactions. This does not affect contributions which have already been completed.');
626 case 'cancelRecurNotSupportedText':
627 if (!$this->supportsCancelRecurring()) {
628 return ts('Automatic cancellation is not supported for this payment processor. You or the contributor will need to manually cancel this recurring contribution using the payment processor website.');
633 CRM_Core_Error
::deprecatedFunctionWarning('Calls to getText must use a supported method');
638 * Get the title of the payment processor to display to the user
642 public function getTitle() {
643 return $this->getPaymentProcessor()['title'] ??
$this->getPaymentProcessor()['name'];
647 * Getter for accessing member vars.
649 * @todo believe this is unused
651 * @param string $name
655 public function getVar($name) {
656 return $this->$name ??
NULL;
660 * Get name for the payment information type.
661 * @todo - use option group + name field (like Omnipay does)
664 public function getPaymentTypeName() {
665 return $this->_paymentProcessor
['payment_type'] == 1 ?
'credit_card' : 'direct_debit';
669 * Get label for the payment information type.
670 * @todo - use option group + labels (like Omnipay does)
673 public function getPaymentTypeLabel() {
674 return $this->_paymentProcessor
['payment_type'] == 1 ?
ts('Credit Card') : ts('Direct Debit');
678 * Get array of fields that should be displayed on the payment form.
681 * array('credit_card_type', 'credit_card_number', 'cvv2', 'credit_card_exp_date')
683 * array('account_holder', 'bank_account_number', 'bank_identification_number', 'bank_name')
688 * Array of payment fields appropriate to the payment processor.
690 * @throws CiviCRM_API3_Exception
692 public function getPaymentFormFields() {
693 if ($this->_paymentProcessor
['billing_mode'] == 4) {
696 return $this->_paymentProcessor
['payment_type'] == 1 ?
$this->getCreditCardFormFields() : $this->getDirectDebitFormFields();
700 * Get an array of the fields that can be edited on the recurring contribution.
702 * Some payment processors support editing the amount and other scheduling details of recurring payments, especially
703 * those which use tokens. Others are fixed. This function allows the processor to return an array of the fields that
704 * can be updated from the contribution recur edit screen.
706 * The fields are likely to be a subset of these
709 * - 'frequency_interval',
710 * - 'frequency_unit',
712 * - 'next_sched_contribution_date',
714 * - 'failure_retry_day',
716 * The form does not restrict which fields from the contribution_recur table can be added (although if the html_type
717 * metadata is not defined in the xml for the field it will cause an error.
719 * Open question - would it make sense to return membership_id in this - which is sometimes editable and is on that
720 * form (UpdateSubscription).
724 public function getEditableRecurringScheduleFields() {
725 if ($this->supports('changeSubscriptionAmount')) {
732 * Get the help text to present on the recurring update page.
734 * This should reflect what can or cannot be edited.
738 public function getRecurringScheduleUpdateHelpText() {
739 if (!in_array('amount', $this->getEditableRecurringScheduleFields())) {
740 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.');
742 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.');
746 * Get the metadata for all required fields.
750 protected function getMandatoryFields() {
751 $mandatoryFields = [];
752 foreach ($this->getAllFields() as $field_name => $field_spec) {
753 if (!empty($field_spec['is_required'])) {
754 $mandatoryFields[$field_name] = $field_spec;
757 return $mandatoryFields;
761 * Get the metadata of all the fields configured for this processor.
765 * @throws \CiviCRM_API3_Exception
767 protected function getAllFields() {
768 $paymentFields = array_intersect_key($this->getPaymentFormFieldsMetadata(), array_flip($this->getPaymentFormFields()));
769 $billingFields = array_intersect_key($this->getBillingAddressFieldsMetadata(), array_flip($this->getBillingAddressFields()));
770 return array_merge($paymentFields, $billingFields);
774 * Get array of fields that should be displayed on the payment form for credit cards.
778 protected function getCreditCardFormFields() {
781 'credit_card_number',
783 'credit_card_exp_date',
788 * Get array of fields that should be displayed on the payment form for direct debits.
792 protected function getDirectDebitFormFields() {
795 'bank_account_number',
796 'bank_identification_number',
802 * Return an array of all the details about the fields potentially required for payment fields.
804 * Only those determined by getPaymentFormFields will actually be assigned to the form
809 public function getPaymentFormFieldsMetadata() {
810 //@todo convert credit card type into an option value
811 $creditCardType = ['' => ts('- select -')] + CRM_Contribute_PseudoConstant
::creditCard();
812 $isCVVRequired = Civi
::settings()->get('cvv_backoffice_required');
813 if (!$this->isBackOffice()) {
814 $isCVVRequired = TRUE;
817 'credit_card_number' => [
818 'htmlType' => 'text',
819 'name' => 'credit_card_number',
820 'title' => ts('Card Number'),
824 'autocomplete' => 'off',
825 'class' => 'creditcard required',
827 'is_required' => TRUE,
828 // 'description' => '16 digit card number', // If you enable a description field it will be shown below the field on the form
831 'htmlType' => 'text',
833 'title' => ts('Security Code'),
837 'autocomplete' => 'off',
838 'class' => ($isCVVRequired ?
'required' : ''),
840 'is_required' => $isCVVRequired,
843 '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.'),
844 'rule_name' => 'integer',
845 'rule_parameters' => NULL,
849 'credit_card_exp_date' => [
850 'htmlType' => 'date',
851 'name' => 'credit_card_exp_date',
852 'title' => ts('Expiration Date'),
853 'attributes' => CRM_Core_SelectValues
::date('creditCard'),
854 'is_required' => TRUE,
857 'rule_message' => ts('Card expiration date cannot be a past date.'),
858 'rule_name' => 'currentDate',
859 'rule_parameters' => TRUE,
862 'extra' => ['class' => 'crm-form-select required'],
864 'credit_card_type' => [
865 'htmlType' => 'select',
866 'name' => 'credit_card_type',
867 'title' => ts('Card Type'),
868 'attributes' => $creditCardType,
869 'is_required' => FALSE,
871 'account_holder' => [
872 'htmlType' => 'text',
873 'name' => 'account_holder',
874 'title' => ts('Account Holder'),
878 'autocomplete' => 'on',
879 'class' => 'required',
881 'is_required' => TRUE,
883 //e.g. IBAN can have maxlength of 34 digits
884 'bank_account_number' => [
885 'htmlType' => 'text',
886 'name' => 'bank_account_number',
887 'title' => ts('Bank Account Number'),
891 'autocomplete' => 'off',
892 'class' => 'required',
896 'rule_message' => ts('Please enter a valid Bank Identification Number (value must not contain punctuation characters).'),
897 'rule_name' => 'nopunctuation',
898 'rule_parameters' => NULL,
901 'is_required' => TRUE,
903 //e.g. SWIFT-BIC can have maxlength of 11 digits
904 'bank_identification_number' => [
905 'htmlType' => 'text',
906 'name' => 'bank_identification_number',
907 'title' => ts('Bank Identification Number'),
911 'autocomplete' => 'off',
912 'class' => 'required',
914 'is_required' => TRUE,
917 'rule_message' => ts('Please enter a valid Bank Identification Number (value must not contain punctuation characters).'),
918 'rule_name' => 'nopunctuation',
919 'rule_parameters' => NULL,
924 'htmlType' => 'text',
925 'name' => 'bank_name',
926 'title' => ts('Bank Name'),
930 'autocomplete' => 'off',
931 'class' => 'required',
933 'is_required' => TRUE,
937 'htmlType' => 'text',
938 'name' => 'check_number',
939 'title' => ts('Check Number'),
940 'is_required' => FALSE,
941 'attributes' => NULL,
943 'pan_truncation' => [
944 'htmlType' => 'text',
945 'name' => 'pan_truncation',
946 'title' => ts('Last 4 digits of the card'),
947 'is_required' => FALSE,
952 'autocomplete' => 'off',
956 'rule_message' => ts('Please enter valid last 4 digit card number.'),
957 'rule_name' => 'numeric',
958 'rule_parameters' => NULL,
963 'htmlType' => 'hidden',
964 'name' => 'payment_token',
965 'title' => ts('Authorization token'),
966 'is_required' => FALSE,
969 'autocomplete' => 'off',
970 'id' => 'payment_token',
977 * Get billing fields required for this processor.
979 * We apply the existing default of returning fields only for payment processor type 1. Processors can override to
982 * @param int $billingLocationID
986 public function getBillingAddressFields($billingLocationID = NULL) {
987 if (!$billingLocationID) {
988 // Note that although the billing id is passed around the forms the idea that it would be anything other than
989 // the result of the function below doesn't seem to have eventuated.
990 // So taking this as a param is possibly something to be removed in favour of the standard default.
991 $billingLocationID = CRM_Core_BAO_LocationType
::getBilling();
993 if ($this->_paymentProcessor
['billing_mode'] != 1 && $this->_paymentProcessor
['billing_mode'] != 3) {
997 'first_name' => 'billing_first_name',
998 'middle_name' => 'billing_middle_name',
999 'last_name' => 'billing_last_name',
1000 'street_address' => "billing_street_address-{$billingLocationID}",
1001 'city' => "billing_city-{$billingLocationID}",
1002 'country' => "billing_country_id-{$billingLocationID}",
1003 'state_province' => "billing_state_province_id-{$billingLocationID}",
1004 'postal_code' => "billing_postal_code-{$billingLocationID}",
1009 * Get form metadata for billing address fields.
1011 * @param int $billingLocationID
1014 * Array of metadata for address fields.
1016 public function getBillingAddressFieldsMetadata($billingLocationID = NULL) {
1017 if (!$billingLocationID) {
1018 // Note that although the billing id is passed around the forms the idea that it would be anything other than
1019 // the result of the function below doesn't seem to have eventuated.
1020 // So taking this as a param is possibly something to be removed in favour of the standard default.
1021 $billingLocationID = CRM_Core_BAO_LocationType
::getBilling();
1024 $metadata['billing_first_name'] = [
1025 'htmlType' => 'text',
1026 'name' => 'billing_first_name',
1027 'title' => ts('Billing First Name'),
1032 'autocomplete' => 'off',
1033 'class' => 'required',
1035 'is_required' => TRUE,
1038 $metadata['billing_middle_name'] = [
1039 'htmlType' => 'text',
1040 'name' => 'billing_middle_name',
1041 'title' => ts('Billing Middle Name'),
1046 'autocomplete' => 'off',
1048 'is_required' => FALSE,
1051 $metadata['billing_last_name'] = [
1052 'htmlType' => 'text',
1053 'name' => 'billing_last_name',
1054 'title' => ts('Billing Last Name'),
1059 'autocomplete' => 'off',
1060 'class' => 'required',
1062 'is_required' => TRUE,
1065 $metadata["billing_street_address-{$billingLocationID}"] = [
1066 'htmlType' => 'text',
1067 'name' => "billing_street_address-{$billingLocationID}",
1068 'title' => ts('Street Address'),
1073 'autocomplete' => 'off',
1074 'class' => 'required',
1076 'is_required' => TRUE,
1079 $metadata["billing_city-{$billingLocationID}"] = [
1080 'htmlType' => 'text',
1081 'name' => "billing_city-{$billingLocationID}",
1082 'title' => ts('City'),
1087 'autocomplete' => 'off',
1088 'class' => 'required',
1090 'is_required' => TRUE,
1093 $metadata["billing_state_province_id-{$billingLocationID}"] = [
1094 'htmlType' => 'chainSelect',
1095 'title' => ts('State/Province'),
1096 'name' => "billing_state_province_id-{$billingLocationID}",
1098 'is_required' => TRUE,
1099 'extra' => ['class' => 'required'],
1102 $metadata["billing_postal_code-{$billingLocationID}"] = [
1103 'htmlType' => 'text',
1104 'name' => "billing_postal_code-{$billingLocationID}",
1105 'title' => ts('Postal Code'),
1110 'autocomplete' => 'off',
1111 'class' => 'required',
1113 'is_required' => TRUE,
1116 $metadata["billing_country_id-{$billingLocationID}"] = [
1117 'htmlType' => 'select',
1118 'name' => "billing_country_id-{$billingLocationID}",
1119 'title' => ts('Country'),
1122 '' => ts('- select -'),
1123 ] + CRM_Core_PseudoConstant
::country(),
1124 'is_required' => TRUE,
1125 'extra' => ['class' => 'required crm-form-select2 crm-select2'],
1131 * Get base url dependent on component.
1133 * (or preferably set it using the setter function).
1137 protected function getBaseReturnUrl() {
1138 if ($this->baseReturnUrl
) {
1139 return $this->baseReturnUrl
;
1141 if ($this->_component
== 'event') {
1142 $baseURL = 'civicrm/event/register';
1145 $baseURL = 'civicrm/contribute/transact';
1151 * Get the currency for the transaction from the params.
1153 * Legacy wrapper. Better for a method to work on its own PropertyBag.
1155 * This code now uses PropertyBag to allow for old inputs like currencyID.
1161 protected function getCurrency($params = []) {
1162 $localPropertyBag = new PropertyBag();
1163 $localPropertyBag->mergeLegacyInputParams($params);
1164 return $localPropertyBag->getCurrency();
1168 * Legacy. Better for a method to work on its own PropertyBag,
1169 * but also, this function does not do very much.
1171 * @param array $params
1174 * @throws \CRM_Core_Exception
1176 protected function getAmount($params = []) {
1177 return CRM_Utils_Money
::format($params['amount'], NULL, NULL, TRUE);
1181 * Get url to return to after cancelled or failed transaction.
1183 * @param string $qfKey
1184 * @param int $participantID
1186 * @return string cancel url
1188 public function getCancelUrl($qfKey, $participantID) {
1189 if (isset($this->cancelUrl
)) {
1190 return $this->cancelUrl
;
1193 if ($this->_component
== 'event') {
1194 return CRM_Utils_System
::url($this->getBaseReturnUrl(), [
1197 'participantId' => $participantID,
1203 return CRM_Utils_System
::url($this->getBaseReturnUrl(), [
1204 '_qf_Main_display' => 1,
1213 * Get URL to return the browser to on success.
1215 * @param string $qfKey
1219 protected function getReturnSuccessUrl($qfKey) {
1220 if (isset($this->successUrl
)) {
1221 return $this->successUrl
;
1224 return CRM_Utils_System
::url($this->getBaseReturnUrl(), [
1225 '_qf_ThankYou_display' => 1,
1233 * Get URL to return the browser to on failure.
1235 * @param string $key
1236 * @param int $participantID
1237 * @param int $eventID
1240 * URL for a failing transactor to be redirected to.
1242 protected function getReturnFailUrl($key, $participantID = NULL, $eventID = NULL) {
1243 if (isset($this->cancelUrl
)) {
1244 return $this->cancelUrl
;
1247 $test = $this->_is_test ?
'&action=preview' : '';
1248 if ($this->_component
== "event") {
1249 return CRM_Utils_System
::url('civicrm/event/register',
1250 "reset=1&cc=fail&participantId={$participantID}&id={$eventID}{$test}&qfKey={$key}",
1255 return CRM_Utils_System
::url('civicrm/contribute/transact',
1256 "_qf_Main_display=1&cancel=1&qfKey={$key}{$test}",
1263 * Get URl for when the back button is pressed.
1267 * @return string url
1269 protected function getGoBackUrl($qfKey) {
1270 return CRM_Utils_System
::url($this->getBaseReturnUrl(), [
1271 '_qf_Confirm_display' => 'true',
1279 * Get the notify (aka ipn, web hook or silent post) url.
1281 * If there is no '.' in it we assume that we are dealing with localhost or
1282 * similar and it is unreachable from the web & hence invalid.
1285 * URL to notify outcome of transaction.
1287 protected function getNotifyUrl() {
1288 $url = CRM_Utils_System
::url(
1289 'civicrm/payment/ipn/' . $this->_paymentProcessor
['id'],
1296 return (stristr($url, '.')) ?
$url : '';
1300 * Calling this from outside the payment subsystem is deprecated - use doPayment.
1302 * Does a server to server payment transaction.
1304 * @param array $params
1305 * Assoc array of input parameters for this transaction.
1308 * the result in an nice formatted array (or an error object - but throwing exceptions is preferred)
1310 protected function doDirectPayment(&$params) {
1315 * Processors may need to inspect, validate, cast and copy data that is
1316 * specific to this Payment Processor from the input array to custom fields
1317 * on the PropertyBag.
1319 * @param Civi\Payment\PropertyBag $propertyBag
1320 * @param array $params
1321 * @param string $component
1323 * @throws \Civi\Payment\Exception\PaymentProcessorException
1325 public function extractCustomPropertiesForDoPayment(PropertyBag
$propertyBag, array $params, $component = 'contribute') {
1327 // (validation and casting goes first)
1328 // $propertyBag->setCustomProperty('myprocessor_customPropertyName', $value);
1332 * Process payment - this function wraps around both doTransferCheckout and doDirectPayment.
1333 * Any processor that still implements the deprecated doTransferCheckout() or doDirectPayment() should be updated to use doPayment().
1335 * This function adds some historical defaults ie. the assumption that if a 'doDirectPayment' processors comes back it completed
1336 * the transaction & in fact doTransferCheckout would not traditionally come back.
1337 * Payment processors should throw exceptions and not return Error objects as they may have done with the old functions.
1339 * Payment processors should set payment_status_id (which is really contribution_status_id) in the returned array. The default is assumed to be Pending.
1340 * In some cases the IPN will set the payment to "Completed" some time later.
1342 * @fixme Creating a contribution record is inconsistent! We should always create a contribution BEFORE calling doPayment...
1343 * For the current status see: https://lab.civicrm.org/dev/financial/issues/53
1344 * If we DO have a contribution ID, then the payment processor can (and should) update parameters on the contribution record as necessary.
1346 * @param array|PropertyBag $params
1348 * @param string $component
1351 * Result array (containing at least the key payment_status_id)
1353 * @throws \Civi\Payment\Exception\PaymentProcessorException
1355 public function doPayment(&$params, $component = 'contribute') {
1356 $this->_component
= $component;
1357 $statuses = CRM_Contribute_BAO_Contribution
::buildOptions('contribution_status_id', 'validate');
1359 // If we have a $0 amount, skip call to processor and set payment_status to Completed.
1360 // Conceivably a processor might override this - perhaps for setting up a token - but we don't
1361 // have an example of that at the mome.
1362 if ($params['amount'] == 0) {
1363 $result['payment_status_id'] = array_search('Completed', $statuses);
1367 if ($this->_paymentProcessor
['billing_mode'] == 4) {
1368 $result = $this->doTransferCheckout($params, $component);
1369 if (is_array($result) && !isset($result['payment_status_id'])) {
1370 $result['payment_status_id'] = array_search('Pending', $statuses);
1374 $result = $this->doDirectPayment($params, $component);
1375 if (is_array($result) && !isset($result['payment_status_id'])) {
1376 if (!empty($params['is_recur'])) {
1377 // See comment block.
1378 $result['payment_status_id'] = array_search('Pending', $statuses);
1381 $result['payment_status_id'] = array_search('Completed', $statuses);
1385 if (is_a($result, 'CRM_Core_Error')) {
1386 CRM_Core_Error
::deprecatedFunctionWarning('payment processors should throw exceptions rather than return errors');
1387 throw new PaymentProcessorException(CRM_Core_Error
::getMessages($result));
1393 * Cancel a recurring subscription.
1395 * Payment processor classes should override this rather than implementing cancelSubscription.
1397 * A PaymentProcessorException should be thrown if the update of the contribution_recur
1398 * record should not proceed (in many cases this function does nothing
1399 * as the payment processor does not need to take any action & this should silently
1400 * proceed. Note the form layer will only call this after calling
1401 * $processor->supports('cancelRecurring');
1403 * A payment processor can control whether to notify the actual payment provider or just
1404 * cancel in CiviCRM by setting the `isNotifyProcessorOnCancelRecur` property on PropertyBag.
1405 * If supportsCancelRecurringNotifyOptional() is TRUE this will be automatically set based on
1406 * the user selection on the form. If FALSE you need to set it yourself.
1408 * @param \Civi\Payment\PropertyBag $propertyBag
1412 * @throws \Civi\Payment\Exception\PaymentProcessorException
1414 public function doCancelRecurring(PropertyBag
$propertyBag) {
1415 if (method_exists($this, 'cancelSubscription')
1416 && ($propertyBag->has('isNotifyProcessorOnCancelRecur') && $propertyBag->getIsNotifyProcessorOnCancelRecur())) {
1418 if ($this->cancelSubscription($message, $propertyBag)) {
1419 return ['message' => $message];
1421 throw new PaymentProcessorException($message);
1423 return ['message' => ts('Recurring contribution cancelled')];
1429 * Payment processors should set payment_status_id if it set the status to Refunded in case the transaction is successful
1431 * @param array $params
1433 * @throws \Civi\Payment\Exception\PaymentProcessorException
1435 public function doRefund(&$params) {}
1438 * Query payment processor for details about a transaction.
1440 * @param array $params
1441 * Array of parameters containing one of:
1442 * - trxn_id Id of an individual transaction.
1443 * - processor_id Id of a recurring contribution series as stored in the civicrm_contribution_recur table.
1446 * Extra parameters retrieved.
1447 * Any parameters retrievable through this should be documented in the function comments at
1448 * CRM_Core_Payment::doQuery. Currently:
1449 * - fee_amount Amount of fee paid
1451 public function doQuery($params) {
1456 * This function checks to see if we have the right config values.
1459 * the error message if any
1461 abstract protected function checkConfig();
1464 * Redirect for paypal.
1466 * @todo move to paypal class or remove
1468 * @param $paymentProcessor
1472 public static function paypalRedirect(&$paymentProcessor) {
1473 if (!$paymentProcessor) {
1477 if (isset($_GET['payment_date']) &&
1478 isset($_GET['merchant_return_link']) &&
1479 CRM_Utils_Array
::value('payment_status', $_GET) == 'Completed' &&
1480 $paymentProcessor['payment_processor_type'] == "PayPal_Standard"
1489 * Handle incoming payment notification.
1491 * IPNs, also called silent posts are notifications of payment outcomes or activity on an external site.
1493 * @todo move to0 \Civi\Payment\System factory method
1494 * Page callback for civicrm/payment/ipn
1496 public static function handleIPN() {
1498 self
::handlePaymentMethod(
1499 'PaymentNotification',
1501 'processor_name' => CRM_Utils_Request
::retrieveValue('processor_name', 'String'),
1502 'processor_id' => CRM_Utils_Request
::retrieveValue('processor_id', 'Integer'),
1503 'mode' => CRM_Utils_Request
::retrieveValue('mode', 'Alphanumeric'),
1507 catch (CRM_Core_Exception
$e) {
1508 Civi
::log()->error('ipn_payment_callback_exception', [
1510 'backtrace' => $e->getTraceAsString(),
1511 'message' => $e->getMessage(),
1515 CRM_Utils_System
::civiExit();
1519 * Payment callback handler.
1521 * The processor_name or processor_id is passed in.
1522 * Note that processor_id is more reliable as one site may have more than one instance of a
1523 * processor & ideally the processor will be validating the results
1524 * Load requested payment processor and call that processor's handle<$method> method
1526 * @todo move to \Civi\Payment\System factory method
1528 * @param string $method
1529 * 'PaymentNotification' or 'PaymentCron'
1530 * @param array $params
1532 * @throws \CRM_Core_Exception
1533 * @throws \Exception
1535 public static function handlePaymentMethod($method, $params = []) {
1536 if (!isset($params['processor_id']) && !isset($params['processor_name'])) {
1537 $q = explode('/', CRM_Utils_System
::currentPath());
1538 $lastParam = array_pop($q);
1539 if (is_numeric($lastParam)) {
1540 $params['processor_id'] = $_GET['processor_id'] = $lastParam;
1543 self
::logPaymentNotification($params);
1544 throw new CRM_Core_Exception("Either 'processor_id' (recommended) or 'processor_name' (deprecated) is required for payment callback.");
1548 self
::logPaymentNotification($params);
1550 $sql = "SELECT ppt.class_name, ppt.name as processor_name, pp.id AS processor_id
1551 FROM civicrm_payment_processor_type ppt
1552 INNER JOIN civicrm_payment_processor pp
1553 ON pp.payment_processor_type_id = ppt.id
1556 if (isset($params['processor_id'])) {
1557 $sql .= " WHERE pp.id = %2";
1558 $args[2] = [$params['processor_id'], 'Integer'];
1559 $notFound = ts("No active instances of payment processor %1 were found.", [1 => $params['processor_id']]);
1562 // This is called when processor_name is passed - passing processor_id instead is recommended.
1563 $sql .= " WHERE ppt.name = %2 AND pp.is_test = %1";
1565 (CRM_Utils_Array
::value('mode', $params) == 'test') ?
1 : 0,
1568 $args[2] = [$params['processor_name'], 'String'];
1569 $notFound = ts("No active instances of payment processor '%1' were found.", [1 => $params['processor_name']]);
1572 $dao = CRM_Core_DAO
::executeQuery($sql, $args);
1574 // Check whether we found anything at all.
1576 throw new CRM_Core_Exception($notFound);
1579 $method = 'handle' . $method;
1580 $extension_instance_found = FALSE;
1582 // In all likelihood, we'll just end up with the one instance returned here. But it's
1583 // possible we may get more. Hence, iterate through all instances ..
1585 while ($dao->fetch()) {
1586 // Check pp is extension - is this still required - surely the singleton below handles it.
1587 $ext = CRM_Extension_System
::singleton()->getMapper();
1588 if ($ext->isExtensionKey($dao->class_name
)) {
1589 $paymentClass = $ext->keyToClass($dao->class_name
, 'payment');
1590 require_once $ext->classToPath($paymentClass);
1593 $processorInstance = System
::singleton()->getById($dao->processor_id
);
1595 // Should never be empty - we already established this processor_id exists and is active.
1596 if (empty($processorInstance)) {
1600 // Does PP implement this method, and can we call it?
1601 if (!method_exists($processorInstance, $method) ||
1602 !is_callable([$processorInstance, $method])
1604 // on the off chance there is a double implementation of this processor we should keep looking for another
1605 // note that passing processor_id is more reliable & we should work to deprecate processor_name
1609 // Everything, it seems, is ok - execute pp callback handler
1610 $processorInstance->$method();
1611 $extension_instance_found = TRUE;
1614 // Call IPN postIPNProcess hook to allow for custom processing of IPN data.
1615 $IPNParams = array_merge($_GET, $_REQUEST);
1616 CRM_Utils_Hook
::postIPNProcess($IPNParams);
1617 if (!$extension_instance_found) {
1618 $message = "No extension instances of the '%1' payment processor were found.<br />" .
1619 "%2 method is unsupported in legacy payment processors.";
1620 throw new CRM_Core_Exception(ts($message, [
1621 1 => $params['processor_name'],
1628 * Check whether a method is present ( & supported ) by the payment processor object.
1630 * @deprecated - use $paymentProcessor->supports(array('cancelRecurring');
1632 * @param string $method
1633 * Method to check for.
1637 public function isSupported($method) {
1638 return method_exists(CRM_Utils_System
::getClassName($this), $method);
1642 * Some processors replace the form submit button with their own.
1644 * Returning false here will leave the button off front end forms.
1646 * At this stage there is zero cross-over between back-office processors and processors that suppress the submit.
1648 public function isSuppressSubmitButtons() {
1653 * Checks to see if invoice_id already exists in db.
1655 * It's arguable if this belongs in the payment subsystem at all but since several processors implement it
1656 * it is better to standardise to being here.
1658 * @param int $invoiceId The ID to check.
1660 * @param null $contributionID
1661 * If a contribution exists pass in the contribution ID.
1664 * True if invoice ID otherwise exists, else false
1666 protected function checkDupe($invoiceId, $contributionID = NULL) {
1667 $contribution = new CRM_Contribute_DAO_Contribution();
1668 $contribution->invoice_id
= $invoiceId;
1669 if ($contributionID) {
1670 $contribution->whereAdd("id <> $contributionID");
1672 return $contribution->find();
1676 * Get url for users to manage this recurring contribution for this processor.
1678 * @param int $entityID
1679 * @param null $entity
1680 * @param string $action
1682 * @return string|null
1683 * @throws \CRM_Core_Exception
1685 public function subscriptionURL($entityID = NULL, $entity = NULL, $action = 'cancel') {
1689 if (!$this->supports('cancelRecurring')) {
1692 $url = 'civicrm/contribute/unsubscribe';
1696 //in notify mode don't return the update billing url
1697 if (!$this->supports('updateSubscriptionBillingInfo')) {
1700 $url = 'civicrm/contribute/updatebilling';
1704 if (!$this->supports('changeSubscriptionAmount') && !$this->supports('editRecurringContribution')) {
1707 $url = 'civicrm/contribute/updaterecur';
1711 $userId = CRM_Core_Session
::singleton()->get('userID');
1713 $checksumValue = '';
1716 // Find related Contact
1720 $contactID = CRM_Core_DAO
::getFieldValue("CRM_Member_DAO_Membership", $entityID, "contact_id");
1724 case 'contribution':
1725 $contactID = CRM_Core_DAO
::getFieldValue("CRM_Contribute_DAO_Contribution", $entityID, "contact_id");
1726 $entityArg = 'coid';
1731 SELECT DISTINCT con.contact_id
1732 FROM civicrm_contribution_recur rec
1733 INNER JOIN civicrm_contribution con ON ( con.contribution_recur_id = rec.id )
1735 $contactID = CRM_Core_DAO
::singleValueQuery($sql, [
1741 $entityArg = 'crid';
1746 // Add entity arguments
1747 if ($entityArg != '') {
1748 // Add checksum argument
1749 if ($contactID != 0 && $userId != $contactID) {
1750 $checksumValue = '&cs=' . CRM_Contact_BAO_Contact_Utils
::generateChecksum($contactID, NULL, 'inf');
1752 return CRM_Utils_System
::url($url, "reset=1&{$entityArg}={$entityID}{$checksumValue}", TRUE, NULL, FALSE, TRUE);
1756 if ($this->supports('accountLoginURL')) {
1757 return $this->accountLoginURL();
1761 return $this->_paymentProcessor
['url_recur'] ??
'';
1765 * Get description of payment to pass to processor.
1767 * This is often what people see in the interface so we want to get
1768 * as much unique information in as possible within the field length (& presumably the early part of the field)
1770 * People seeing these can be assumed to be advanced users so quantity of information probably trumps
1771 * having field names to clarify
1773 * @param array $params
1774 * @param int $length
1778 protected function getPaymentDescription($params = [], $length = 24) {
1779 $propertyBag = PropertyBag
::cast($params);
1781 $propertyBag->getter('contactID', TRUE),
1782 $propertyBag->getter('contributionID', TRUE),
1783 $propertyBag->getter('description', TRUE) ?
: ($propertyBag->getter('isRecur', TRUE) ?
ts('Recurring payment') : NULL),
1784 $propertyBag->getter('billing_first_name', TRUE),
1785 $propertyBag->getter('billing_last_name', TRUE),
1787 return substr(implode('-', array_filter($parts)), 0, $length);
1791 * Checks if back-office recurring edit is allowed
1795 public function supportsEditRecurringContribution() {
1800 * Does this processor support changing the amount for recurring contributions through code.
1802 * If the processor returns true then it must be possible to update the amount from within CiviCRM
1803 * that will be updated at the payment processor.
1807 protected function supportsChangeSubscriptionAmount() {
1808 return method_exists(CRM_Utils_System
::getClassName($this), 'changeSubscriptionAmount');
1812 * Checks if payment processor supports recurring contributions
1816 public function supportsRecurring() {
1817 if (!empty($this->_paymentProcessor
['is_recur'])) {
1824 * Checks if payment processor supports an account login URL
1825 * TODO: This is checked by self::subscriptionURL but is only used if no entityID is found.
1826 * TODO: It is implemented by AuthorizeNET, any others?
1830 protected function supportsAccountLoginURL() {
1831 return method_exists(CRM_Utils_System
::getClassName($this), 'accountLoginURL');
1835 * Should a receipt be sent out for a pending payment.
1837 * e.g for traditional pay later & ones with a delayed settlement a pending receipt makes sense.
1839 public function isSendReceiptForPending() {