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 /**
  98  * Set default getlist parameters.
  99  *
 100  * @see _civicrm_api3_generic_getlist_defaults
 101  *
 102  * @param array $request
 103  *
 104  * @return array
 105  */
 106 function _civicrm_api3_payment_processor_getlist_defaults(&$request) {
 107   return [
 108     'description_field' => [
 109       'payment_processor_type_id',
 110       'description',
 111     ],
 112     'params' => [
 113       'is_test' => 0,
 114       'is_active' => 1,
 115     ],
 116   ];
 117 }
 118
 119 /**
 120  * Action refund.
 121  *
 122  * @param array $params
 123  *
 124  * @return array
 125  *   API result array.
 126  * @throws CiviCRM_API3_Exception
 127  */
 128 function civicrm_api3_payment_processor_refund($params) {
 129   $processor = Civi\Payment\System::singleton()->getById($params['payment_processor_id']);
 130   $processor->setPaymentProcessor(civicrm_api3('PaymentProcessor', 'getsingle', array('id' => $params['payment_processor_id'])));
 131   if (!$processor->supportsRefund()) {
 132     throw API_Exception('Payment Processor does not support refund');
 133   }
 134   $result = $processor->doRefund($params);
 135   return civicrm_api3_create_success(array($result), $params);
 136 }
 137
 138 /**
 139  * Action Refund.
 140  *
 141  * @param array $params
 142  *
 143  */
 144 function _civicrm_api3_payment_processor_refund_spec(&$params) {
 145   $params['payment_processor_id'] = [
 146     'api.required' => 1,
 147     'title' => ts('Payment processor'),
 148     'type' => CRM_Utils_Type::T_INT,
 149   ];
 150   $params['amount'] = [
 151     'api.required' => TRUE,
 152     'title' => ts('Amount to refund'),
 153     'type' => CRM_Utils_Type::T_MONEY,
 154   ];
 155 }