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   ];
 182 }
 183
 184 /**
 185  * Adjust Metadata for Get action.
 186  *
 187  * The metadata is used for setting defaults, documentation & validation.
 188  *
 189  * @param array $params
 190  *   Array of parameters determined by getfields.
 191  */
 192 function _civicrm_api3_payment_get_spec(&$params) {
 193   $params = [
 194     'contribution_id' => [
 195       'title' => 'Contribution ID',
 196       'type' => CRM_Utils_Type::T_INT,
 197     ],
 198     'entity_table' => [
 199       'title' => 'Entity Table',
 200       'api.default' => 'civicrm_contribution',
 201     ],
 202     'entity_id' => [
 203       'title' => 'Entity ID',
 204       'type' => CRM_Utils_Type::T_INT,
 205       'api.aliases' => ['contribution_id'],
 206     ],
 207   ];
 208 }
 209
 210 /**
 211  * Adjust Metadata for Delete action.
 212  *
 213  * The metadata is used for setting defaults, documentation & validation.
 214  *
 215  * @param array $params
 216  *   Array of parameters.
 217  */
 218 function _civicrm_api3_payment_delete_spec(&$params) {
 219   $params = [
 220     'id' => [
 221       'api.required' => 1,
 222       'title' => 'Payment ID',
 223       'type' => CRM_Utils_Type::T_INT,
 224       'api.aliases' => ['payment_id'],
 225     ],
 226   ];
 227 }
 228
 229 /**
 230  * Adjust Metadata for Cancel action.
 231  *
 232  * The metadata is used for setting defaults, documentation & validation.
 233  *
 234  * @param array $params
 235  *   Array of parameters.
 236  */
 237 function _civicrm_api3_payment_cancel_spec(&$params) {
 238   $params = [
 239     'id' => [
 240       'api.required' => 1,
 241       'title' => 'Payment ID',
 242       'type' => CRM_Utils_Type::T_INT,
 243       'api.aliases' => ['payment_id'],
 244     ],
 245     'trxn_date' => [
 246       'title' => 'Cancel Date',
 247       'type' => CRM_Utils_Type::T_DATE + CRM_Utils_Type::T_TIME,
 248     ],
 249   ];
 250 }
 251
 252 /**
 253  * Send a payment confirmation.
 254  *
 255  * @param array $params
 256  *   Input parameters.
 257  *
 258  * @return array
 259  * @throws Exception
 260  */
 261 function civicrm_api3_payment_sendconfirmation($params) {
 262   $allowedParams = [
 263     'receipt_from_email',
 264     'receipt_from_name',
 265     'cc_receipt',
 266     'bcc_receipt',
 267     'receipt_text',
 268     'id',
 269   ];
 270   $input = array_intersect_key($params, array_flip($allowedParams));
 271   // use either the contribution or membership receipt, based on whether it’s a membership-related contrib or not
 272   $result = CRM_Financial_BAO_Payment::sendConfirmation($input);
 273   return civicrm_api3_create_success([
 274     $params['id'] => [
 275       'is_sent' => $result[0],
 276       'subject' => $result[1],
 277       'message_txt' => $result[2],
 278       'message_html' => $result[3],
 279     ],
 280   ]);
 281 }
 282
 283 /**
 284  * Adjust Metadata for sendconfirmation action.
 285  *
 286  * The metadata is used for setting defaults, documentation & validation.
 287  *
 288  * @param array $params
 289  *   Array of parameters determined by getfields.
 290  */
 291 function _civicrm_api3_payment_sendconfirmation_spec(&$params) {
 292   $params['id'] = [
 293     'api.required' => 1,
 294     'title' => ts('Payment ID'),
 295     'type' => CRM_Utils_Type::T_INT,
 296   ];
 297 }