3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2015 |
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
41 function civicrm_api3_payment_processor_create($params) {
42 if (empty($params['id']) && empty($params['payment_instrument_id'])) {
43 $params['payment_instrument_id'] = civicrm_api3('PaymentProcessorType', 'getvalue', array(
44 'id' => $params['payment_processor_type_id'],
45 'return' => 'payment_instrument_id',
48 return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__
), $params);
52 * Adjust Metadata for Create action.
54 * The metadata is used for setting defaults, documentation & validation.
56 * @param array $params
57 * Array of parameters determined by getfields.
59 function _civicrm_api3_payment_processor_create_spec(&$params) {
60 $params['payment_processor_type_id']['api.required'] = 1;
61 $params['is_default']['api.default'] = 0;
62 $params['is_test']['api.default'] = 0;
66 * Deletes an existing PaymentProcessor.
68 * @param array $params
73 function civicrm_api3_payment_processor_delete($params) {
74 return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__
), $params);
78 * Retrieve one or more PaymentProcessor.
80 * @param array $params
81 * Array of name/value pairs.
84 * details of found PaymentProcessor
86 function civicrm_api3_payment_processor_get($params) {
87 return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__
), $params);
92 * Set default getlist parameters.
94 * @see _civicrm_api3_generic_getlist_defaults
96 * @param array $request
100 function _civicrm_api3_payment_processor_getlist_defaults(&$request) {
102 'description_field' => array(
103 'payment_processor_type_id',