3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2017 |
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 payment processor types.
31 * @package CiviCRM_APIv3
35 * Create payment_processor type.
37 * @param array $params
38 * Associative array of property name/value pairs to insert in new payment_processor type.
42 function civicrm_api3_payment_processor_type_create($params) {
43 if (isset($params['id']) && !CRM_Utils_Rule
::integer($params['id'])) {
44 return civicrm_api3_create_error('Invalid value for payment_processor type ID');
47 $paymentProcessorType = CRM_Financial_BAO_PaymentProcessorType
::create($params);
51 _civicrm_api3_object_to_array($paymentProcessorType, $relType[$paymentProcessorType->id
]);
53 return civicrm_api3_create_success($relType, $params, 'PaymentProcessorType', 'create', $paymentProcessorType);
57 * Adjust Metadata for Create action.
59 * The metadata is used for setting defaults, documentation & validation.
61 * @param array $params
62 * Array of parameters determined by getfields.
64 function _civicrm_api3_payment_processor_type_create_spec(&$params) {
65 $params['billing_mode']['api.required'] = 1;
66 $params['class_name']['api.required'] = 1;
67 $params['is_active']['api.default'] = 1;
68 $params['is_recur']['api.default'] = FALSE;
69 // FIXME bool support // $params['is_recur']['api.required'] = 1;
70 $params['name']['api.required'] = 1;
71 $params['title']['api.required'] = 1;
72 $params['payment_instrument_id']['api.default'] = 'Credit Card';
76 * Get all payment_processor types.
78 * @param array $params
82 function civicrm_api3_payment_processor_type_get($params) {
83 return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__
), $params);
87 * Delete a payment_processor type delete.
89 * @param array $params
94 function civicrm_api3_payment_processor_type_delete($params) {
95 if ($params['id'] != NULL && !CRM_Utils_Rule
::integer($params['id'])) {
96 return civicrm_api3_create_error('Invalid value for payment processor type ID');
99 $payProcTypeBAO = new CRM_Financial_BAO_PaymentProcessorType();
100 $result = $payProcTypeBAO->del($params['id']);
102 return civicrm_api3_create_error('Could not delete payment processor type');
104 return civicrm_api3_create_success($result, $params, 'PaymentProcessorType', 'delete', $payProcTypeBAO);