api/v3/Payment.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 Contribution Payment records.
  30  *
  31  * @package CiviCRM_APIv3
  32  */
  33
  34 /**
  35  * Retrieve a set of financial transactions which are payments.
  36  *
  37  * @param array $params
  38  *  Input parameters.
  39  *
  40  * @return array
  41  *   Array of financial transactions which are payments, if error an array with an error id and error message
  42  */
  43 function civicrm_api3_payment_get($params) {
  44   $financialTrxn = [];
  45   $limit = '';
  46   if (isset($params['options']) && !empty($params['options']['limit'])) {
  47     $limit = CRM_Utils_Array::value('limit', $params['options']);
  48   }
  49   $params['options']['limit'] = 0;
  50   $eft = civicrm_api3('EntityFinancialTrxn', 'get', $params);
  51   if (!empty($eft['values'])) {
  52     $eftIds = [];
  53     foreach ($eft['values'] as $efts) {
  54       if (empty($efts['financial_trxn_id'])) {
  55         continue;
  56       }
  57       $eftIds[] = $efts['financial_trxn_id'];
  58       $map[$efts['financial_trxn_id']] = $efts['entity_id'];
  59     }
  60     if (!empty($eftIds)) {
  61       $ftParams = [
  62         'id' => ['IN' => $eftIds],
  63         'is_payment' => 1,
  64       ];
  65       if ($limit) {
  66         $ftParams['options']['limit'] = $limit;
  67       }
  68       $financialTrxn = civicrm_api3('FinancialTrxn', 'get', $ftParams);
  69       foreach ($financialTrxn['values'] as &$values) {
  70         $values['contribution_id'] = $map[$values['id']];
  71       }
  72     }
  73   }
  74   return civicrm_api3_create_success(CRM_Utils_Array::value('values', $financialTrxn, []), $params, 'Payment', 'get');
  75 }
  76
  77 /**
  78  * Delete a payment.
  79  *
  80  * @param array $params
  81  *   Input parameters.
  82  *
  83  * @throws API_Exception
  84  * @return array
  85  *   Api result array
  86  */
  87 function civicrm_api3_payment_delete($params) {
  88   return civicrm_api3('FinancialTrxn', 'delete', $params);
  89 }
  90
  91 /**
  92  * Cancel/Refund a payment for a Contribution.
  93  *
  94  * @param array $params
  95  *   Input parameters.
  96  *
  97  * @throws API_Exception
  98  * @return array
  99  *   Api result array
 100  */
 101 function civicrm_api3_payment_cancel($params) {
 102   $eftParams = [
 103     'entity_table' => 'civicrm_contribution',
 104     'financial_trxn_id' => $params['id'],
 105   ];
 106   $entity = civicrm_api3('EntityFinancialTrxn', 'getsingle', $eftParams);
 107
 108   $paymentParams = [
 109     'total_amount' => -$entity['amount'],
 110     'contribution_id' => $entity['entity_id'],
 111     'trxn_date' => CRM_Utils_Array::value('trxn_date', $params, 'now'),
 112   ];
 113
 114   foreach (['trxn_id', 'payment_instrument_id'] as $permittedParam) {
 115     if (isset($params[$permittedParam])) {
 116       $paymentParams[$permittedParam] = $params[$permittedParam];
 117     }
 118   }
 119   $result = civicrm_api3('Payment', 'create', $paymentParams);
 120   return civicrm_api3_create_success($result['values'], $params, 'Payment', 'cancel');
 121 }
 122
 123 /**
 124  * Add a payment for a Contribution.
 125  *
 126  * @param array $params
 127  *   Input parameters.
 128  *
 129  * @throws API_Exception
 130  * @return array
 131  *   Api result array
 132  */
 133 function civicrm_api3_payment_create($params) {
 134   // Check if it is an update
 135   if (!empty($params['id'])) {
 136     $amount = $params['total_amount'];
 137     civicrm_api3('Payment', 'cancel', $params);
 138     $params['total_amount'] = $amount;
 139   }
 140   $trxn = CRM_Financial_BAO_Payment::create($params);
 141
 142   $values = [];
 143   _civicrm_api3_object_to_array_unique_fields($trxn, $values[$trxn->id]);
 144   return civicrm_api3_create_success($values, $params, 'Payment', 'create', $trxn);
 145 }
 146
 147 /**
 148  * Adjust Metadata for Create action.
 149  *
 150  * The metadata is used for setting defaults, documentation & validation.
 151  *
 152  * @param array $params
 153  *   Array of parameters.
 154  */
 155 function _civicrm_api3_payment_create_spec(&$params) {
 156   $params = [
 157     'contribution_id' => [
 158       'api.required' => 1,
 159       'title' => ts('Contribution ID'),
 160       'type' => CRM_Utils_Type::T_INT,
 161     ],
 162     'total_amount' => [
 163       'api.required' => 1,
 164       'title' => ts('Total Payment Amount'),
 165       'type' => CRM_Utils_Type::T_FLOAT,
 166     ],
 167     'payment_processor_id' => [
 168       'title' => ts('Payment Processor ID'),
 169       'type' => CRM_Utils_Type::T_INT,
 170       'description' => ts('Payment processor ID - required for payment processor payments'),
 171     ],
 172     'id' => [
 173       'title' => ts('Payment ID'),
 174       'type' => CRM_Utils_Type::T_INT,
 175       'api.aliases' => ['payment_id'],
 176     ],
 177     'trxn_date' => [
 178       'title' => ts('Cancel Date'),
 179       'type' => CRM_Utils_Type::T_DATE + CRM_Utils_Type::T_TIME,
 180     ],
 181     'is_send_contribution_notification' => [
 182       'title' => ts('Send out notifications based on contribution status change?'),
 183       'description' => ts('Most commonly this equates to emails relating to the contribution, event, etcwhen a payment completes a contribution'),
 184       'type' => CRM_Utils_Type::T_BOOLEAN,
 185       'api.default' => TRUE,
 186     ],
 187   ];
 188 }
 189
 190 /**
 191  * Adjust Metadata for Get action.
 192  *
 193  * The metadata is used for setting defaults, documentation & validation.
 194  *
 195  * @param array $params
 196  *   Array of parameters determined by getfields.
 197  */
 198 function _civicrm_api3_payment_get_spec(&$params) {
 199   $params = [
 200     'contribution_id' => [
 201       'title' => 'Contribution ID',
 202       'type' => CRM_Utils_Type::T_INT,
 203     ],
 204     'entity_table' => [
 205       'title' => 'Entity Table',
 206       'api.default' => 'civicrm_contribution',
 207     ],
 208     'entity_id' => [
 209       'title' => 'Entity ID',
 210       'type' => CRM_Utils_Type::T_INT,
 211       'api.aliases' => ['contribution_id'],
 212     ],
 213   ];
 214 }
 215
 216 /**
 217  * Adjust Metadata for Delete action.
 218  *
 219  * The metadata is used for setting defaults, documentation & validation.
 220  *
 221  * @param array $params
 222  *   Array of parameters.
 223  */
 224 function _civicrm_api3_payment_delete_spec(&$params) {
 225   $params = [
 226     'id' => [
 227       'api.required' => 1,
 228       'title' => 'Payment ID',
 229       'type' => CRM_Utils_Type::T_INT,
 230       'api.aliases' => ['payment_id'],
 231     ],
 232   ];
 233 }
 234
 235 /**
 236  * Adjust Metadata for Cancel action.
 237  *
 238  * The metadata is used for setting defaults, documentation & validation.
 239  *
 240  * @param array $params
 241  *   Array of parameters.
 242  */
 243 function _civicrm_api3_payment_cancel_spec(&$params) {
 244   $params = [
 245     'id' => [
 246       'api.required' => 1,
 247       'title' => 'Payment ID',
 248       'type' => CRM_Utils_Type::T_INT,
 249       'api.aliases' => ['payment_id'],
 250     ],
 251     'trxn_date' => [
 252       'title' => 'Cancel Date',
 253       'type' => CRM_Utils_Type::T_DATE + CRM_Utils_Type::T_TIME,
 254     ],
 255   ];
 256 }
 257
 258 /**
 259  * Send a payment confirmation.
 260  *
 261  * @param array $params
 262  *   Input parameters.
 263  *
 264  * @return array
 265  * @throws Exception
 266  */
 267 function civicrm_api3_payment_sendconfirmation($params) {
 268   $allowedParams = [
 269     'receipt_from_email',
 270     'receipt_from_name',
 271     'cc_receipt',
 272     'bcc_receipt',
 273     'receipt_text',
 274     'id',
 275   ];
 276   $input = array_intersect_key($params, array_flip($allowedParams));
 277   // use either the contribution or membership receipt, based on whether it’s a membership-related contrib or not
 278   $result = CRM_Financial_BAO_Payment::sendConfirmation($input);
 279   return civicrm_api3_create_success([
 280     $params['id'] => [
 281       'is_sent' => $result[0],
 282       'subject' => $result[1],
 283       'message_txt' => $result[2],
 284       'message_html' => $result[3],
 285     ],
 286   ]);
 287 }
 288
 289 /**
 290  * Adjust Metadata for sendconfirmation action.
 291  *
 292  * The metadata is used for setting defaults, documentation & validation.
 293  *
 294  * @param array $params
 295  *   Array of parameters determined by getfields.
 296  */
 297 function _civicrm_api3_payment_sendconfirmation_spec(&$params) {
 298   $params['id'] = [
 299     'api.required' => 1,
 300     'title' => ts('Payment ID'),
 301     'type' => CRM_Utils_Type::T_INT,
 302   ];
 303 }