3 +----------------------------------------------------------------------------+
4 | PayflowPro Core Payment Module for CiviCRM version 4.7 |
5 +----------------------------------------------------------------------------+
6 | Licensed to CiviCRM under the Academic Free License version 3.0 |
8 | Written & Contributed by Eileen McNaughton - 2009 |
9 +---------------------------------------------------------------------------+
13 * Class CRM_Core_Payment_PayflowPro
15 class CRM_Core_Payment_PayflowPro
extends CRM_Core_Payment
{
16 // (not used, implicit in the API, might need to convert?)
21 * We only need one instance of this object. So we use the singleton
22 * pattern and cache the instance in this variable
26 static private $_singleton = NULL;
32 * The mode of operation: live or test.
38 * @param $paymentProcessor
40 public function __construct($mode, &$paymentProcessor) {
43 $this->_paymentProcessor
= $paymentProcessor;
44 $this->_processorName
= ts('Payflow Pro');
48 * This function sends request and receives response from
49 * the processor. It is the main function for processing on-server
50 * credit card transactions
53 * This function collects all the information from a web/api form and invokes
54 * the relevant payment processor specific functions to perform the transaction
56 * @param array $params
57 * Assoc array of input parameters for this transaction.
60 * the result in an nice formatted array (or an error object)
63 public function doDirectPayment(&$params) {
64 if (!defined('CURLOPT_SSLCERT')) {
65 CRM_Core_Error
::fatal(ts('PayFlowPro requires curl with SSL support'));
69 * define variables for connecting with the gateway
72 // Are you using the Payflow Fraud Protection Service?
73 // Default is YES, change to NO or blank if not.
74 //This has not been investigated as part of writing this payment processor
76 //if you have not set up a separate user account the vendor name is used as the username
77 if (!$this->_paymentProcessor
['subject']) {
78 $user = $this->_paymentProcessor
['user_name'];
81 $user = $this->_paymentProcessor
['subject'];
84 // ideally this id would be passed through into this class as
85 // part of the paymentProcessor
86 //object with the other variables. It seems inefficient to re-query to get it.
87 //$params['processor_id'] = CRM_Core_DAO::getFieldValue(
88 // 'CRM_Contribute_DAO_ContributionP
89 //age',$params['contributionPageID'], 'payment_processor_id' );
92 *Create the array of variables to be sent to the processor from the $params array
93 * passed into this function
97 $payflow_query_array = array(
99 'VENDOR' => $this->_paymentProcessor
['user_name'],
100 'PARTNER' => $this->_paymentProcessor
['signature'],
101 'PWD' => $this->_paymentProcessor
['password'],
102 // C - Direct Payment using credit card
104 // A - Authorization, S - Sale
106 'ACCT' => urlencode($params['credit_card_number']),
107 'CVV2' => $params['cvv2'],
108 'EXPDATE' => urlencode(sprintf('%02d', (int) $params['month']) . substr($params['year'], 2, 2)),
109 'ACCTTYPE' => urlencode($params['credit_card_type']),
110 'AMT' => urlencode($params['amount']),
111 'CURRENCY' => urlencode($params['currency']),
112 'FIRSTNAME' => $params['billing_first_name'],
114 'LASTNAME' => $params['billing_last_name'],
116 'STREET' => $params['street_address'],
117 'CITY' => urlencode($params['city']),
118 'STATE' => urlencode($params['state_province']),
119 'ZIP' => urlencode($params['postal_code']),
120 'COUNTRY' => urlencode($params['country']),
121 'EMAIL' => $params['email'],
122 'CUSTIP' => urlencode($params['ip_address']),
123 'COMMENT1' => urlencode($params['contributionType_accounting_code']),
125 'INVNUM' => urlencode($params['invoiceID']),
126 'ORDERDESC' => urlencode($params['description']),
127 'VERBOSITY' => 'MEDIUM',
128 'BILLTOCOUNTRY' => urlencode($params['country']),
131 if ($params['installments'] == 1) {
132 $params['is_recur'] == FALSE;
135 if ($params['is_recur'] == TRUE) {
137 $payflow_query_array['TRXTYPE'] = 'R';
138 $payflow_query_array['OPTIONALTRX'] = 'S';
139 $payflow_query_array['OPTIONALTRXAMT'] = $params['amount'];
140 //Amount of the initial Transaction. Required
141 $payflow_query_array['ACTION'] = 'A';
142 //A for add recurring (M-modify,C-cancel,R-reactivate,I-inquiry,P-payment
143 $payflow_query_array['PROFILENAME'] = urlencode('RegularContribution');
144 //A for add recurring (M-modify,C-cancel,R-reactivate,I-inquiry,P-payment
145 if ($params['installments'] > 0) {
146 $payflow_query_array['TERM'] = $params['installments'] - 1;
147 //ie. in addition to the one happening with this transaction
149 // $payflow_query_array['COMPANYNAME']
150 // $payflow_query_array['DESC'] = not set yet Optional
151 // description of the goods or
152 //services being purchased.
153 //This parameter applies only for ACH_CCD accounts.
155 // $payflow_query_array['MAXFAILPAYMENTS'] = 0;
156 // number of payment periods (as s
157 //pecified by PAYPERIOD) for which the transaction is allowed
158 //to fail before PayPal cancels a profile. the default
159 // value of 0 (zero) specifies no
161 //attempts occur until the term is complete.
162 // $payflow_query_array['RETRYNUMDAYS'] = (not set as can't assume business rule
164 switch ($params['frequency_unit']) {
166 $params['next_sched_contribution_date'] = mktime(0, 0, 0, date("m"), date("d") +
7,
169 $params['end_date'] = mktime(0, 0, 0, date("m"), date("d") +
(7 * $payflow_query_array['TERM']),
172 $payflow_query_array['START'] = date('mdY', $params['next_sched_contribution_date']);
173 $payflow_query_array['PAYPERIOD'] = "WEEK";
174 $params['frequency_unit'] = "week";
175 $params['frequency_interval'] = 1;
179 $params['next_sched_contribution_date'] = mktime(0, 0, 0, date("m"), date("d") +
14, date("Y"));
180 $params['end_date'] = mktime(0, 0, 0, date("m"), date("d") +
(14 * $payflow_query_array['TERM']), date("Y ")
182 $payflow_query_array['START'] = date('mdY', $params['next_sched_contribution_date']);
183 $payflow_query_array['PAYPERIOD'] = "BIWK";
184 $params['frequency_unit'] = "week";
185 $params['frequency_interval'] = 2;
189 $params['next_sched_contribution_date'] = mktime(0, 0, 0, date("m"), date("d") +
28, date("Y")
191 $params['end_date'] = mktime(0, 0, 0, date("m"), date("d") +
(28 * $payflow_query_array['TERM']), date("Y")
193 $payflow_query_array['START'] = date('mdY', $params['next_sched_contribution_date']);
194 $payflow_query_array['PAYPERIOD'] = "FRWK";
195 $params['frequency_unit'] = "week";
196 $params['frequency_interval'] = 4;
200 $params['next_sched_contribution_date'] = mktime(0, 0, 0, date("m") +
1,
203 $params['end_date'] = mktime(0, 0, 0, date("m") +
204 (1 * $payflow_query_array['TERM']),
207 $payflow_query_array['START'] = date('mdY', $params['next_sched_contribution_date']);
208 $payflow_query_array['PAYPERIOD'] = "MONT";
209 $params['frequency_unit'] = "month";
210 $params['frequency_interval'] = 1;
214 $params['next_sched_contribution_date'] = mktime(0, 0, 0, date("m") +
3, date("d"), date("Y")
216 $params['end_date'] = mktime(0, 0, 0, date("m") +
217 (3 * $payflow_query_array['TERM']),
220 $payflow_query_array['START'] = date('mdY', $params['next_sched_contribution_date']);
221 $payflow_query_array['PAYPERIOD'] = "QTER";
222 $params['frequency_unit'] = "month";
223 $params['frequency_interval'] = 3;
227 $params['next_sched_contribution_date'] = mktime(0, 0, 0, date("m") +
6, date("d"),
230 $params['end_date'] = mktime(0, 0, 0, date("m") +
231 (6 * $payflow_query_array['TERM']),
234 $payflow_query_array['START'] = date('mdY', $params['next_sched_contribution_date']
236 $payflow_query_array['PAYPERIOD'] = "SMYR";
237 $params['frequency_unit'] = "month";
238 $params['frequency_interval'] = 6;
242 $params['next_sched_contribution_date'] = mktime(0, 0, 0, date("m"), date("d"),
245 $params['end_date'] = mktime(0, 0, 0, date("m"), date("d"),
247 (1 * $payflow_query_array['TEM'])
249 $payflow_query_array['START'] = date('mdY', $params['next_sched_contribution_date']);
250 $payflow_query_array['PAYPERIOD'] = "YEAR";
251 $params['frequency_unit'] = "year";
252 $params['frequency_interval'] = 1;
257 CRM_Utils_Hook
::alterPaymentProcessorParams($this, $params, $payflow_query_array);
258 $payflow_query = $this->convert_to_nvp($payflow_query_array);
261 * Check to see if we have a duplicate before we send
263 if ($this->checkDupe($params['invoiceID'], CRM_Utils_Array
::value('contributionID', $params))) {
264 return self
::errorExit(9003, 'It appears that this transaction is a duplicate. Have you already submitted the form once? If so there may have been a connection problem. Check your email for a receipt. If you do not receive a receipt within 2 hours you can try your transaction again. If you continue to have problems please contact the site administrator.');
267 // ie. url at payment processor to submit to.
268 $submiturl = $this->_paymentProcessor
['url_site'];
270 $responseData = self
::submit_transaction($submiturl, $payflow_query);
273 * Payment successfully sent to gateway - process the response now
275 $result = strstr($responseData, "RESULT");
277 while (strlen($result)) {
279 $keypos = strpos($result, '=');
280 $keyval = substr($result, 0, $keypos);
282 $valuepos = strpos($result, '&') ?
strpos($result, '&') : strlen($result);
283 $valval = substr($result, $keypos +
1, $valuepos - $keypos - 1);
284 // decoding the respose
285 $nvpArray[$keyval] = $valval;
286 $result = substr($result, $valuepos +
1, strlen($result));
288 // get the result code to validate.
289 $result_code = $nvpArray['RESULT'];
291 echo "<p>Params array</p><br>";
294 echo "<p>Values to Payment Processor</p><br>";
295 print_r($payflow_query_array);
297 echo "<p>Results from Payment Processor</p><br>";
302 switch ($result_code) {
305 /*******************************************************
307 * This is a successful transaction. PayFlow Pro does return further information
308 * about transactions to help you identify fraud including whether they pass
309 * the cvv check, the avs check. This is stored in
310 * CiviCRM as part of the transact
311 * but not further processing is done. Business rules would need to be defined
312 *******************************************************/
313 $params['trxn_id'] = $nvpArray['PNREF'] . $nvpArray['TRXPNREF'];
314 //'trxn_id' is varchar(255) field. returned value is length 12
315 $params['trxn_result_code'] = $nvpArray['AUTHCODE'] . "-Cvv2:" . $nvpArray['CVV2MATCH'] . "-avs:" . $nvpArray['AVSADDR'];
317 if ($params['is_recur'] == TRUE) {
318 $params['recur_trxn_id'] = $nvpArray['PROFILEID'];
319 //'trxn_id' is varchar(255) field. returned value is length 12
324 return self
::errorExit(9008, "There is a payment processor configuration problem. This is usually due to invalid account information or ip restrictions on the account. You can verify ip restriction by logging // into Manager. See Service Settings >> Allowed IP Addresses. ");
327 // Hard decline from bank.
328 return self
::errorExit(9009, "Your transaction was declined ");
331 // Voice authorization required.
332 return self
::errorExit(9010, "Your Transaction is pending. Contact Customer Service to complete your order.");
335 // Issue with credit card number or expiration date.
336 return self
::errorExit(9011, "Invalid credit card information. Please re-enter.");
339 return self
::errorExit(9012, "You have not configured your payment processor with the correct credentials. Make sure you have provided both the <vendor> and the <user> variables ");
342 return self
::errorExit(9013, "Error - from payment processor: [" . $result_code . " " . $nvpArray['RESPMSG'] . "] ");
345 return self
::errorExit(9014, "Check the code - all transactions should have been headed off before they got here. Something slipped through the net");
349 * Produces error message and returns from class
352 * @param null $errorCode
353 * @param null $errorMessage
357 public function &errorExit($errorCode = NULL, $errorMessage = NULL) {
358 $e = CRM_Core_Error
::singleton();
360 $e->push($errorCode, 0, NULL, $errorMessage);
363 $e->push(9000, 0, NULL, 'Unknown System Error.');
370 * NOTE: 'doTransferCheckout' not implemented
373 * @param array $params
378 public function doTransferCheckout(&$params, $component) {
379 CRM_Core_Error
::fatal(ts('This function is not implemented'));
383 * This public function checks to see if we have the right processor config values set
385 * NOTE: Called by Events and Contribute to check config params are set prior to trying
386 * register any credit card details
388 * @param string $mode
389 * The mode we are operating in (live or test) - not used.
391 * returns string $errorMsg if any errors found - null if OK
394 // function checkConfig( $mode ) // CiviCRM V1.9 Declaration
397 * CiviCRM V2.0 Declaration
398 * This function checks to see if we have the right config values
400 * @internal param string $mode the mode we are operating in (live or test)
403 * the error message if any
405 public function checkConfig() {
407 if (empty($this->_paymentProcessor
['user_name'])) {
408 $errorMsg[] = ' ' . ts('ssl_merchant_id is not set for this payment processor');
411 if (empty($this->_paymentProcessor
['url_site'])) {
412 $errorMsg[] = ' ' . ts('URL is not set for %1', array(1 => $this->_paymentProcessor
['name']));
415 if (!empty($errorMsg)) {
416 return implode('<p>', $errorMsg);
425 * convert to a name/value pair (nvp) string
428 * @param $payflow_query_array
430 * @return array|string
432 public function convert_to_nvp($payflow_query_array) {
433 foreach ($payflow_query_array as $key => $value) {
434 $payflow_query[] = $key . '[' . strlen($value) . ']=' . $value;
436 $payflow_query = implode('&', $payflow_query);
438 return $payflow_query;
442 * Submit transaction using CuRL
443 * @submiturl string Url to direct HTTPS GET to
444 * @payflow_query value string to be posted
448 * @param $payflow_query
450 * @return mixed|object
452 public function submit_transaction($submiturl, $payflow_query) {
454 * Submit transaction using CuRL
457 // get data ready for API
458 $user_agent = $_SERVER['HTTP_USER_AGENT'];
459 // Here's your custom headers; adjust appropriately for your setup:
460 $headers[] = "Content-Type: text/namevalue";
461 //or text/xml if using XMLPay.
462 $headers[] = "Content-Length : " . strlen($data);
463 // Length of data to be passed
464 // Here the server timeout value is set to 45, but notice
465 // below in the cURL section, the timeout
466 // for cURL is 90 seconds. You want to make sure the server
467 // timeout is less, then the connection.
468 $headers[] = "X-VPS-Timeout: 45";
469 //random unique number - the transaction is retried using this transaction ID
470 // in this function but if that doesn't work and it is re- submitted
471 // it is treated as a new attempt. PayflowPro doesn't allow
472 // you to change details (e.g. card no) when you re-submit
473 // you can only try the same details
474 $headers[] = "X-VPS-Request-ID: " . rand(1, 1000000000);
475 // optional header field
476 $headers[] = "X-VPS-VIT-Integration-Product: CiviCRM";
477 // other Optional Headers. If used adjust as necessary.
479 //$headers[] = "X-VPS-VIT-OS-Name: Linux";
481 //$headers[] = "X-VPS-VIT-OS-Version: RHEL 4";
482 // What you are using
483 //$headers[] = "X-VPS-VIT-Client-Type: PHP/cURL";
485 //$headers[] = "X-VPS-VIT-Client-Version: 0.01";
487 //$headers[] = "X-VPS-VIT-Client-Architecture: x86";
488 // Application version
489 //$headers[] = "X-VPS-VIT-Integration-Version: 0.01";
491 curl_setopt($ch, CURLOPT_URL
, $submiturl);
492 curl_setopt($ch, CURLOPT_HTTPHEADER
, $headers);
493 curl_setopt($ch, CURLOPT_USERAGENT
, $user_agent);
494 curl_setopt($ch, CURLOPT_HEADER
, 1);
495 // tells curl to include headers in response
496 curl_setopt($ch, CURLOPT_RETURNTRANSFER
, 1);
497 // return into a variable
498 curl_setopt($ch, CURLOPT_TIMEOUT
, 90);
499 // times out after 90 secs
500 if (ini_get('open_basedir') == '' && ini_get('safe_mode') == 'Off') {
501 curl_setopt($ch, CURLOPT_FOLLOWLOCATION
, 0);
503 curl_setopt($ch, CURLOPT_SSL_VERIFYPEER
, CRM_Core_BAO_Setting
::getItem(CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
, 'verifySSL'));
504 // this line makes it work under https
505 curl_setopt($ch, CURLOPT_POSTFIELDS
, $payflow_query);
507 curl_setopt($ch, CURLOPT_SSL_VERIFYHOST
, CRM_Core_BAO_Setting
::getItem(CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
, 'verifySSL') ?
2 : 0);
508 //verifies ssl certificate
509 curl_setopt($ch, CURLOPT_FORBID_REUSE
, TRUE);
510 //forces closure of connection when done
511 curl_setopt($ch, CURLOPT_POST
, 1);
514 // Try to submit the transaction up to 3 times with 5 second delay. This can be used
515 // in case of network issues. The idea here is since you are posting via HTTPS there
516 // could be general network issues, so try a few times before you tell customer there
521 $responseData = curl_exec($ch);
522 $responseHeaders = curl_getinfo($ch);
523 if ($responseHeaders['http_code'] != 200) {
524 // Let's wait 5 seconds to see if its a temporary network issue.
527 elseif ($responseHeaders['http_code'] == 200) {
528 // we got a good response, drop out of loop.
534 * Transaction submitted -
535 * See if we had a curl error - if so tell 'em and bail out
537 * NOTE: curl_error does not return a logical value (see its documentation), but
538 * a string, which is empty when there was no error.
540 if ((curl_errno($ch) > 0) ||
(strlen(curl_error($ch)) > 0)) {
542 $errorNum = curl_errno($ch);
543 $errorDesc = curl_error($ch);
545 //Paranoia - in the unlikley event that 'curl' errno fails
546 if ($errorNum == 0) {
550 // Paranoia - in the unlikley event that 'curl' error fails
551 if (strlen($errorDesc) == 0) {
552 $errorDesc = "Connection to payment gateway failed";
554 if ($errorNum = 60) {
555 return self
::errorExit($errorNum, "Curl error - " . $errorDesc .
556 " Try this link for more information http://curl.haxx.se/d
561 return self
::errorExit($errorNum, "Curl error - " . $errorDesc .
562 " processor response = " . $processorResponse
567 * If null data returned - tell 'em and bail out
569 * NOTE: You will not necessarily get a string back, if the request failed for
570 * any reason, the return value will be the boolean false.
572 if (($responseData === FALSE) ||
(strlen($responseData) == 0)) {
574 return self
::errorExit(9006, "Error: Connection to payment gateway failed - no data
575 returned. Gateway url set to $submiturl");
579 * If gateway returned no data - tell 'em and bail out
581 if (empty($responseData)) {
583 return self
::errorExit(9007, "Error: No data returned from payment gateway.");
587 * Success so far - close the curl and check the data
590 return $responseData;
592 //end submit_transaction
595 * @param int $recurringProfileID
596 * @param int $processorID
600 public function getRecurringTransactionStatus($recurringProfileID, $processorID) {
601 if (!defined('CURLOPT_SSLCERT')) {
602 CRM_Core_Error
::fatal(ts('PayFlowPro requires curl with SSL support'));
606 * define variables for connecting with the gateway
609 //if you have not set up a separate user account the vendor name is used as the username
610 if (!$this->_paymentProcessor
['subject']) {
611 $user = $this->_paymentProcessor
['user_name'];
614 $user = $this->_paymentProcessor
['subject'];
616 //$recurringProfileID = "RT0000000001";
617 // c $trythis = $this->getRecurringTransactionStatus($recurringProfileID,17);
620 *Create the array of variables to be sent to the processor from the $params array
621 * passed into this function
625 $payflow_query_array = array(
627 'VENDOR' => $this->_paymentProcessor
['user_name'],
628 'PARTNER' => $this->_paymentProcessor
['signature'],
629 'PWD' => $this->_paymentProcessor
['password'],
630 // C - Direct Payment using credit card
632 // A - Authorization, S - Sale
635 //A for add recurring
636 //(M-modify,C-cancel,R-reactivate,
637 //I-inquiry,P-payment
638 'ORIGPROFILEID' => $recurringProfileID,
639 'PAYMENTHISTORY' => 'Y',
642 $payflow_query = $this->convert_to_nvp($payflow_query_array);
644 $submiturl = $this->_paymentProcessor
['url_site'];
645 //ie. url at payment processor to submit to.
646 $responseData = self
::submit_transaction($submiturl, $payflow_query);
648 * Payment successfully sent to gateway - process the response now
651 $result = strstr($responseData, "RESULT");
653 while (strlen($result)) {
655 $keypos = strpos($result, '=');
656 $keyval = substr($result, 0, $keypos);
658 $valuepos = strpos($result, '&') ?
strpos($result, '&') : strlen($result);
659 $valval = substr($result, $keypos +
1, $valuepos - $keypos - 1);
660 // decoding the respose
661 $nvpArray[$keyval] = $valval;
662 $result = substr($result, $valuepos +
1, strlen($result));
664 // get the result code to validate.
665 $result_code = $nvpArray['RESULT'];
666 print_r($responseData);
668 //RESPMSG=Invalid Profile ID: Invalid recurring profile ID