api/v3/PaymentProcessor.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 5                                                  |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2019                                |
   7  +--------------------------------------------------------------------+
   8  | This file is a part of CiviCRM.                                    |
   9  |                                                                    |
  10  | CiviCRM is free software; you can copy, modify, and distribute it  |
  11  | under the terms of the GNU Affero General Public License           |
  12  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  13  |                                                                    |
  14  | CiviCRM is distributed in the hope that it will be useful, but     |
  15  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  16  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  17  | See the GNU Affero General Public License for more details.        |
  18  |                                                                    |
  19  | You should have received a copy of the GNU Affero General Public   |
  20  | License and the CiviCRM Licensing Exception along                  |
  21  | with this program; if not, contact CiviCRM LLC                     |
  22  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  23  | GNU Affero General Public License or the licensing of CiviCRM,     |
  24  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  25  +--------------------------------------------------------------------+
  26  */
  27
  28 /**
  29  * This api exposes CiviCRM PaymentProcessor.
  30  *
  31  * @package CiviCRM_APIv3
  32  */
  33
  34 /**
  35  * Add/Update a PaymentProcessor.
  36  *
  37  * @param array $params
  38  *
  39  * @return array
  40  *   API result array
  41  */
  42 function civicrm_api3_payment_processor_create($params) {
  43   if (empty($params['id']) && empty($params['payment_instrument_id'])) {
  44     $params['payment_instrument_id'] = civicrm_api3('PaymentProcessorType', 'getvalue', [
  45       'id' => $params['payment_processor_type_id'],
  46       'return' => 'payment_instrument_id',
  47     ]);
  48   }
  49   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params, 'PaymentProcessor');
  50 }
  51
  52 /**
  53  * Adjust Metadata for Create action.
  54  *
  55  * The metadata is used for setting defaults, documentation & validation.
  56  *
  57  * @param array $params
  58  *   Array of parameters determined by getfields.
  59  */
  60 function _civicrm_api3_payment_processor_create_spec(&$params) {
  61   $params['payment_processor_type_id']['api.required'] = 1;
  62   $params['is_default']['api.default'] = 0;
  63   $params['is_test']['api.default'] = 0;
  64   $params['is_active']['api.default'] = TRUE;
  65   $params['domain_id']['api.default'] = CRM_Core_Config::domainID();
  66   $params['financial_account_id']['api.default'] = CRM_Financial_BAO_PaymentProcessor::getDefaultFinancialAccountID();
  67   $params['financial_account_id']['api.required'] = TRUE;
  68   $params['financial_account_id']['title'] = ts('Financial Account for Processor');
  69 }
  70
  71 /**
  72  * Deletes an existing PaymentProcessor.
  73  *
  74  * @param array $params
  75  *
  76  * @return array
  77  *   API result array
  78  */
  79 function civicrm_api3_payment_processor_delete($params) {
  80   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  81 }
  82
  83 /**
  84  * Retrieve one or more PaymentProcessor.
  85  *
  86  * @param array $params
  87  *   Array of name/value pairs.
  88  *
  89  * @return array
  90  *   API result array
  91  */
  92 function civicrm_api3_payment_processor_get($params) {
  93   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  94 }
  95
  96 /**
  97  * Set default getlist parameters.
  98  *
  99  * @see _civicrm_api3_generic_getlist_defaults
 100  *
 101  * @param array $request
 102  *
 103  * @return array
 104  */
 105 function _civicrm_api3_payment_processor_getlist_defaults(&$request) {
 106   return [
 107     'description_field' => [
 108       'payment_processor_type_id',
 109       'description',
 110     ],
 111     'params' => [
 112       'is_test' => 0,
 113       'is_active' => 1,
 114     ],
 115   ];
 116 }
 117
 118 /**
 119  * Action payment.
 120  *
 121  * @param array $params
 122  *
 123  * @return array
 124  *   API result array.
 125  *
 126  * @throws \API_Exception
 127  * @throws \CiviCRM_API3_Exception
 128  */
 129 function civicrm_api3_payment_processor_pay($params) {
 130   /* @var CRM_Core_Payment $processor */
 131   $processor = Civi\Payment\System::singleton()->getById($params['payment_processor_id']);
 132   $processor->setPaymentProcessor(civicrm_api3('PaymentProcessor', 'getsingle', ['id' => $params['payment_processor_id']]));
 133   try {
 134     $processor->setContributionID($params['contribution_id']);
 135     $processor->setInvoiceID($params['invoice_id'] ?? '');
 136     if (!empty($params['contact_id'])) {
 137       $processor->setContactID((int) $params['contact_id']);
 138     }
 139     if (!empty($params['contribution_recur_id'])) {
 140       $processor->setContributionRecurID((int) $params['contribution_recur_id']);
 141     }
 142
 143     $result = $processor->doPayment($params);
 144   }
 145   catch (\Civi\Payment\Exception\PaymentProcessorException $e) {
 146     $code = $e->getErrorCode();
 147     $errorData = $e->getErrorData();
 148     if (empty($code)) {
 149       $code = 'EXTERNAL_FAILURE';
 150     }
 151     throw new API_Exception('Payment failed', $code, $errorData, $e);
 152   }
 153   return civicrm_api3_create_success([$result], $params);
 154 }
 155
 156 /**
 157  * Action payment.
 158  *
 159  * @param array $params
 160  */
 161 function _civicrm_api3_payment_processor_pay_spec(&$params) {
 162   $params['payment_processor_id'] = [
 163     'api.required' => TRUE,
 164     'title' => ts('Payment processor'),
 165     'type' => CRM_Utils_Type::T_INT,
 166   ];
 167   $params['amount'] = [
 168     'api.required' => TRUE,
 169     'title' => ts('Amount to pay'),
 170     'type' => CRM_Utils_Type::T_MONEY,
 171   ];
 172   $params['contribution_id'] = [
 173     'api.required' => TRUE,
 174     'title' => ts('Contribution ID'),
 175     'type' => CRM_Utils_Type::T_INT,
 176     'api.aliases' => ['order_id'],
 177   ];
 178   $params['contact_id'] = [
 179     'title' => ts('Contact ID'),
 180     'type' => CRM_Utils_Type::T_INT,
 181   ];
 182   $params['contribution_recur_id'] = [
 183     'title' => ts('Contribution Recur ID'),
 184     'type' => CRM_Utils_Type::T_INT,
 185   ];
 186   $params['invoice_id'] = [
 187     'title' => ts('Invoice ID'),
 188     'type' => CRM_Utils_Type::T_STRING,
 189   ];
 190 }
 191
 192 /**
 193  * Action refund.
 194  *
 195  * @param array $params
 196  *
 197  * @return array
 198  *   API result array.
 199  *
 200  * @throws \API_Exception
 201  * @throws \CiviCRM_API3_Exception
 202  * @throws \Civi\Payment\Exception\PaymentProcessorException
 203  */
 204 function civicrm_api3_payment_processor_refund($params) {
 205   /** @var \CRM_Core_Payment $processor */
 206   $processor = Civi\Payment\System::singleton()->getById($params['payment_processor_id']);
 207   $processor->setPaymentProcessor(civicrm_api3('PaymentProcessor', 'getsingle', ['id' => $params['payment_processor_id']]));
 208   if (!$processor->supportsRefund()) {
 209     throw new API_Exception('Payment Processor does not support refund');
 210   }
 211   $result = $processor->doRefund($params);
 212   return civicrm_api3_create_success([$result], $params);
 213 }
 214
 215 /**
 216  * Action Refund.
 217  *
 218  * @param array $params
 219  *
 220  */
 221 function _civicrm_api3_payment_processor_refund_spec(&$params) {
 222   $params['payment_processor_id'] = [
 223     'api.required' => TRUE,
 224     'title' => ts('Payment processor'),
 225     'type' => CRM_Utils_Type::T_INT,
 226   ];
 227   $params['amount'] = [
 228     'api.required' => TRUE,
 229     'title' => ts('Amount to refund'),
 230     'type' => CRM_Utils_Type::T_MONEY,
 231   ];
 232 }