3 +--------------------------------------------------------------------+
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2020 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
29 * This api exposes CiviCRM PaymentProcessor.
31 * @package CiviCRM_APIv3
35 * Add/Update a PaymentProcessor.
37 * @param array $params
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',
49 return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__
), $params, 'PaymentProcessor');
53 * Adjust Metadata for Create action.
55 * The metadata is used for setting defaults, documentation & validation.
57 * @param array $params
58 * Array of parameters determined by getfields.
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']['type'] = CRM_Utils_Type
::T_INT
;
69 $params['financial_account_id']['title'] = ts('Financial Account for Processor');
70 $params['financial_account_id']['pseudoconstant'] = [
71 'table' => 'civicrm_financial_account',
73 'labelColumn' => 'name',
78 * Deletes an existing PaymentProcessor.
80 * @param array $params
85 function civicrm_api3_payment_processor_delete($params) {
86 return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__
), $params);
90 * Retrieve one or more PaymentProcessor.
92 * @param array $params
93 * Array of name/value pairs.
98 function civicrm_api3_payment_processor_get($params) {
99 return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__
), $params);
103 * Set default getlist parameters.
105 * @see _civicrm_api3_generic_getlist_defaults
107 * @param array $request
111 function _civicrm_api3_payment_processor_getlist_defaults(&$request) {
113 'description_field' => [
114 'payment_processor_type_id',
127 * @param array $params
132 * @throws \API_Exception
133 * @throws \CiviCRM_API3_Exception
135 function civicrm_api3_payment_processor_pay($params) {
136 /* @var CRM_Core_Payment $processor */
137 $processor = Civi\Payment\System
::singleton()->getById($params['payment_processor_id']);
138 $processor->setPaymentProcessor(civicrm_api3('PaymentProcessor', 'getsingle', ['id' => $params['payment_processor_id']]));
140 $result = $processor->doPayment($params);
142 catch (\Civi\Payment\Exception\PaymentProcessorException
$e) {
143 $code = $e->getErrorCode();
144 $errorData = $e->getErrorData();
146 $code = 'EXTERNAL_FAILURE';
148 throw new API_Exception('Payment failed', $code, $errorData, $e);
150 return civicrm_api3_create_success(array($result), $params);
156 * @param array $params
158 function _civicrm_api3_payment_processor_pay_spec(&$params) {
159 $params['payment_processor_id'] = [
160 'api.required' => TRUE,
161 'title' => ts('Payment processor'),
162 'type' => CRM_Utils_Type
::T_INT
,
164 $params['amount'] = [
165 'api.required' => TRUE,
166 'title' => ts('Amount to pay'),
167 'type' => CRM_Utils_Type
::T_MONEY
,
169 $params['contribution_id'] = [
170 'api.required' => TRUE,
171 'title' => ts('Contribution ID'),
172 'type' => CRM_Utils_Type
::T_INT
,
173 'api.aliases' => ['order_id'],
175 $params['contact_id'] = [
176 'title' => ts('Contact ID'),
177 'type' => CRM_Utils_Type
::T_INT
,
179 $params['contribution_recur_id'] = [
180 'title' => ts('Contribution Recur ID'),
181 'type' => CRM_Utils_Type
::T_INT
,
183 $params['invoice_id'] = [
184 'title' => ts('Invoice ID'),
185 'type' => CRM_Utils_Type
::T_STRING
,
192 * @param array $params
197 * @throws \API_Exception
198 * @throws \CiviCRM_API3_Exception
199 * @throws \Civi\Payment\Exception\PaymentProcessorException
201 function civicrm_api3_payment_processor_refund($params) {
202 /** @var \CRM_Core_Payment $processor */
203 $processor = Civi\Payment\System
::singleton()->getById($params['payment_processor_id']);
204 $processor->setPaymentProcessor(civicrm_api3('PaymentProcessor', 'getsingle', ['id' => $params['payment_processor_id']]));
205 if (!$processor->supportsRefund()) {
206 throw new API_Exception('Payment Processor does not support refund');
208 $result = $processor->doRefund($params);
209 return civicrm_api3_create_success([$result], $params);
215 * @param array $params
218 function _civicrm_api3_payment_processor_refund_spec(&$params) {
219 $params['payment_processor_id'] = [
220 'api.required' => TRUE,
221 'title' => ts('Payment processor'),
222 'type' => CRM_Utils_Type
::T_INT
,
224 $params['amount'] = [
225 'api.required' => TRUE,
226 'title' => ts('Amount to refund'),
227 'type' => CRM_Utils_Type
::T_MONEY
,