api/v3/Contribution.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | Copyright CiviCRM LLC. All rights reserved.                        |
   5  |                                                                    |
   6  | This work is published under the GNU AGPLv3 license with some      |
   7  | permitted exceptions and without any warranty. For full license    |
   8  | and copyright information, see https://civicrm.org/licensing       |
   9  +--------------------------------------------------------------------+
  10  */
  11
  12 /**
  13  * This api exposes CiviCRM Contribution records.
  14  *
  15  * @package CiviCRM_APIv3
  16  */
  17
  18 /**
  19  * Add or update a Contribution.
  20  *
  21  * @param array $params
  22  *   Input parameters.
  23  *
  24  * @throws API_Exception
  25  * @return array
  26  *   Api result array
  27  */
  28 function civicrm_api3_contribution_create($params) {
  29   $values = [];
  30   _civicrm_api3_custom_format_params($params, $values, 'Contribution');
  31   $params = array_merge($params, $values);
  32   // The BAO should not clean money - it should be done in the form layer & api wrapper
  33   // (although arguably the api should expect pre-cleaned it seems to do some cleaning.)
  34   if (empty($params['skipCleanMoney'])) {
  35     foreach (['total_amount', 'net_amount', 'fee_amount'] as $field) {
  36       if (isset($params[$field])) {
  37         $params[$field] = CRM_Utils_Rule::cleanMoney($params[$field]);
  38       }
  39     }
  40   }
  41   $params['skipCleanMoney'] = TRUE;
  42
  43   if (!empty($params['check_permissions']) && CRM_Financial_BAO_FinancialType::isACLFinancialTypeStatus()) {
  44     if (empty($params['id'])) {
  45       $op = CRM_Core_Action::ADD;
  46     }
  47     else {
  48       if (empty($params['financial_type_id'])) {
  49         $params['financial_type_id'] = CRM_Core_DAO::getFieldValue('CRM_Contribute_DAO_Contribution', $params['id'], 'financial_type_id');
  50       }
  51       $op = CRM_Core_Action::UPDATE;
  52     }
  53     CRM_Financial_BAO_FinancialType::getAvailableFinancialTypes($types, $op);
  54     if (!in_array($params['financial_type_id'], array_keys($types))) {
  55       throw new API_Exception('You do not have permission to create this contribution');
  56     }
  57   }
  58   if (!empty($params['id']) && !empty($params['contribution_status_id'])) {
  59     $error = [];
  60     //throw error for invalid status change such as setting completed back to pending
  61     //@todo this sort of validation belongs in the BAO not the API - if it is not an OK
  62     // action it needs to be blocked there. If it is Ok through a form it needs to be OK through the api
  63     CRM_Contribute_BAO_Contribution::checkStatusValidation(NULL, $params, $error);
  64     if (array_key_exists('contribution_status_id', $error)) {
  65       throw new API_Exception($error['contribution_status_id']);
  66     }
  67   }
  68   if (!empty($params['id']) && !empty($params['financial_type_id'])) {
  69     $error = [];
  70     CRM_Contribute_BAO_Contribution::checkFinancialTypeChange($params['financial_type_id'], $params['id'], $error);
  71     if (array_key_exists('financial_type_id', $error)) {
  72       throw new API_Exception($error['financial_type_id']);
  73     }
  74   }
  75   _civicrm_api3_contribution_create_legacy_support_45($params);
  76
  77   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params, 'Contribution');
  78 }
  79
  80 /**
  81  * Adjust Metadata for Create action.
  82  *
  83  * The metadata is used for setting defaults, documentation & validation.
  84  *
  85  * @param array $params
  86  *   Array of parameters determined by getfields.
  87  */
  88 function _civicrm_api3_contribution_create_spec(&$params) {
  89   $params['contact_id']['api.required'] = 1;
  90   $params['total_amount']['api.required'] = 1;
  91   $params['payment_instrument_id']['api.aliases'] = ['payment_instrument'];
  92   $params['receive_date']['api.default'] = 'now';
  93   $params['receive_date']['api.required'] = TRUE;
  94   $params['payment_processor'] = [
  95     'name' => 'payment_processor',
  96     'title' => 'Payment Processor ID',
  97     'description' => 'ID of payment processor used for this contribution',
  98     // field is called payment processor - not payment processor id but can only be one id so
  99     // it seems likely someone will fix it up one day to be more consistent - lets alias it from the start
 100     'api.aliases' => ['payment_processor_id'],
 101     'type' => CRM_Utils_Type::T_INT,
 102   ];
 103   $params['financial_type_id']['api.aliases'] = ['contribution_type_id', 'contribution_type'];
 104   $params['financial_type_id']['api.required'] = 1;
 105   $params['note'] = [
 106     'name' => 'note',
 107     'uniqueName' => 'contribution_note',
 108     'title' => 'note',
 109     'type' => 2,
 110     'description' => 'Associated Note in the notes table',
 111   ];
 112   $params['soft_credit_to'] = [
 113     'name' => 'soft_credit_to',
 114     'title' => 'Soft Credit contact ID (legacy)',
 115     'type' => CRM_Utils_Type::T_INT,
 116     'description' => 'ID of Contact to be Soft credited to (deprecated - use contribution_soft api)',
 117     'FKClassName' => 'CRM_Contact_DAO_Contact',
 118   ];
 119   $params['honor_contact_id'] = [
 120     'name' => 'honor_contact_id',
 121     'title' => 'Honoree contact ID (legacy)',
 122     'type' => CRM_Utils_Type::T_INT,
 123     'description' => 'ID of honoree contact (deprecated - use contribution_soft api)',
 124     'FKClassName' => 'CRM_Contact_DAO_Contact',
 125   ];
 126   $params['honor_type_id'] = [
 127     'name' => 'honor_type_id',
 128     'title' => 'Honoree Type (legacy)',
 129     'type' => CRM_Utils_Type::T_INT,
 130     'description' => 'Type of honoree contact (deprecated - use contribution_soft api)',
 131     'pseudoconstant' => TRUE,
 132   ];
 133   // note this is a recommended option but not adding as a default to avoid
 134   // creating unnecessary changes for the dev
 135   $params['skipRecentView'] = [
 136     'name' => 'skipRecentView',
 137     'title' => 'Skip adding to recent view',
 138     'type' => CRM_Utils_Type::T_BOOLEAN,
 139     'description' => 'Do not add to recent view (setting this improves performance)',
 140   ];
 141   $params['skipLineItem'] = [
 142     'name' => 'skipLineItem',
 143     'title' => 'Skip adding line items',
 144     'type' => CRM_Utils_Type::T_BOOLEAN,
 145     'api.default' => 0,
 146     'description' => 'Do not add line items by default (if you wish to add your own)',
 147   ];
 148   $params['batch_id'] = [
 149     'title' => 'Batch',
 150     'type' => CRM_Utils_Type::T_INT,
 151     'description' => 'Batch which relevant transactions should be added to',
 152   ];
 153   $params['refund_trxn_id'] = [
 154     'title' => 'Refund Transaction ID',
 155     'type' => CRM_Utils_Type::T_STRING,
 156     'description' => 'Transaction ID specific to the refund taking place',
 157   ];
 158   $params['card_type_id'] = [
 159     'title' => 'Card Type ID',
 160     'description' => 'Providing Credit Card Type ID',
 161     'type' => CRM_Utils_Type::T_INT,
 162     'pseudoconstant' => [
 163       'optionGroupName' => 'accept_creditcard',
 164     ],
 165   ];
 166 }
 167
 168 /**
 169  * Support for schema changes made in 4.5.
 170  *
 171  * The main purpose of the API is to provide integrators a level of stability not provided by
 172  * the core code or schema - this means we have to provide support for api calls (where possible)
 173  * across schema changes.
 174  *
 175  * @param array $params
 176  */
 177 function _civicrm_api3_contribution_create_legacy_support_45(&$params) {
 178   //legacy soft credit handling - recommended approach is chaining
 179   if (!empty($params['soft_credit_to'])) {
 180     $params['soft_credit'][] = [
 181       'contact_id'          => $params['soft_credit_to'],
 182       'amount'              => $params['total_amount'],
 183       'soft_credit_type_id' => CRM_Core_OptionGroup::getDefaultValue("soft_credit_type"),
 184     ];
 185   }
 186   if (!empty($params['honor_contact_id'])) {
 187     $params['soft_credit'][] = [
 188       'contact_id'          => $params['honor_contact_id'],
 189       'amount'              => $params['total_amount'],
 190       'soft_credit_type_id' => CRM_Utils_Array::value('honor_type_id', $params, CRM_Core_PseudoConstant::getKey('CRM_Contribute_BAO_ContributionSoft', 'soft_credit_type_id', 'in_honor_of')),
 191     ];
 192   }
 193 }
 194
 195 /**
 196  * Delete a Contribution.
 197  *
 198  * @param array $params
 199  *   Input parameters.
 200  *
 201  * @return array
 202  * @throws \API_Exception
 203  */
 204 function civicrm_api3_contribution_delete($params) {
 205
 206   $contributionID = !empty($params['contribution_id']) ? $params['contribution_id'] : $params['id'];
 207   // First check contribution financial type
 208   $financialType = CRM_Core_DAO::getFieldValue('CRM_Contribute_DAO_Contribution', $contributionID, 'financial_type_id');
 209   // Now check permissioned lineitems & permissioned contribution
 210   if (!empty($params['check_permissions']) && CRM_Financial_BAO_FinancialType::isACLFinancialTypeStatus() &&
 211     (
 212       !CRM_Core_Permission::check('delete contributions of type ' . CRM_Contribute_PseudoConstant::financialType($financialType))
 213       || !CRM_Financial_BAO_FinancialType::checkPermissionedLineItems($contributionID, 'delete', FALSE)
 214     )
 215   ) {
 216     throw new API_Exception('You do not have permission to delete this contribution');
 217   }
 218   if (CRM_Contribute_BAO_Contribution::deleteContribution($contributionID)) {
 219     return civicrm_api3_create_success([$contributionID => 1]);
 220   }
 221   else {
 222     throw new API_Exception('Could not delete contribution');
 223   }
 224 }
 225
 226 /**
 227  * Modify metadata for delete action.
 228  *
 229  * Legacy support for contribution_id.
 230  *
 231  * @param array $params
 232  */
 233 function _civicrm_api3_contribution_delete_spec(&$params) {
 234   $params['id']['api.aliases'] = ['contribution_id'];
 235 }
 236
 237 /**
 238  * Retrieve a set of contributions.
 239  *
 240  * @param array $params
 241  *  Input parameters.
 242  *
 243  * @return array
 244  *   Array of contributions, if error an array with an error id and error message
 245  */
 246 function civicrm_api3_contribution_get($params) {
 247
 248   $mode = CRM_Contact_BAO_Query::MODE_CONTRIBUTE;
 249   $additionalOptions = _civicrm_api3_contribution_get_support_nonunique_returns($params);
 250   $returnProperties = CRM_Contribute_BAO_Query::defaultReturnProperties($mode);
 251
 252   // Get the contributions based on parameters passed in
 253   $contributions = _civicrm_api3_get_using_query_object('Contribution', $params, $additionalOptions, NULL, $mode, $returnProperties);
 254   if (!empty($contributions)) {
 255     $softContributions = CRM_Contribute_BAO_ContributionSoft::getSoftCreditContributionFields(array_keys($contributions), TRUE);
 256     foreach ($contributions as $id => $contribution) {
 257       $contributions[$id] = isset($softContributions[$id]) ? array_merge($contribution, $softContributions[$id]) : $contribution;
 258       // format soft credit for backward compatibility
 259       _civicrm_api3_format_soft_credit($contributions[$id]);
 260       _civicrm_api3_contribution_add_supported_fields($contributions[$id]);
 261     }
 262   }
 263   return civicrm_api3_create_success($contributions, $params, 'Contribution', 'get');
 264 }
 265
 266 /**
 267  * Fix the return values to reflect cases where the schema has been changed.
 268  *
 269  * At the query object level using uniquenames dismbiguates between tables.
 270  *
 271  * However, adding uniquename can change inputs accepted by the api, so we need
 272  * to ensure we are asking for the unique name return fields.
 273  *
 274  * @param array $params
 275  *
 276  * @return array
 277  * @throws \API_Exception
 278  */
 279 function _civicrm_api3_contribution_get_support_nonunique_returns($params) {
 280   $additionalOptions = [];
 281   $options = _civicrm_api3_get_options_from_params($params, TRUE);
 282   foreach (['check_number', 'address_id', 'cancel_date'] as $changedVariable) {
 283     if (isset($options['return']) && !empty($options['return'][$changedVariable])) {
 284       $additionalOptions['return']['contribution_' . $changedVariable] = 1;
 285     }
 286   }
 287   return $additionalOptions;
 288 }
 289
 290 /**
 291  * Support for supported output variables.
 292  *
 293  * @param $contribution
 294  */
 295 function _civicrm_api3_contribution_add_supported_fields(&$contribution) {
 296   // These are output fields that are supported in our test contract.
 297   // Arguably we should also do the same with 'campaign_id' &
 298   // 'source' - which are also fields being rendered with unique names.
 299   // That seems more consistent with other api where we output the actual field names.
 300   $outputAliases = [
 301     'contribution_check_number' => 'check_number',
 302     'contribution_address_id' => 'address_id',
 303     'payment_instrument_id' => 'instrument_id',
 304     'contribution_cancel_date' => 'cancel_date',
 305   ];
 306   foreach ($outputAliases as $returnName => $copyTo) {
 307     if (array_key_exists($returnName, $contribution)) {
 308       $contribution[$copyTo] = $contribution[$returnName];
 309     }
 310   }
 311
 312 }
 313
 314 /**
 315  * Get number of contacts matching the supplied criteria.
 316  *
 317  * @param array $params
 318  *
 319  * @return int
 320  */
 321 function civicrm_api3_contribution_getcount($params) {
 322   $count = _civicrm_api3_get_using_query_object('Contribution', $params, [], TRUE, CRM_Contact_BAO_Query::MODE_CONTRIBUTE);
 323   return (int) $count;
 324 }
 325
 326 /**
 327  * This function is used to format the soft credit for backward compatibility.
 328  *
 329  * As of v4.4 we support multiple soft credit, so now contribution returns array with 'soft_credit' as key
 330  * but we still return first soft credit as a part of contribution array
 331  *
 332  * @param $contribution
 333  */
 334 function _civicrm_api3_format_soft_credit(&$contribution) {
 335   if (!empty($contribution['soft_credit'])) {
 336     $contribution['soft_credit_to'] = $contribution['soft_credit'][1]['contact_id'];
 337     $contribution['soft_credit_id'] = $contribution['soft_credit'][1]['soft_credit_id'];
 338   }
 339 }
 340
 341 /**
 342  * Adjust Metadata for Get action.
 343  *
 344  * The metadata is used for setting defaults, documentation & validation.
 345  *
 346  * @param array $params
 347  *   Array of parameters determined by getfields.
 348  */
 349 function _civicrm_api3_contribution_get_spec(&$params) {
 350   $params['contribution_test'] = [
 351     'api.default' => 0,
 352     'type' => CRM_Utils_Type::T_BOOLEAN,
 353     'title' => 'Get Test Contributions?',
 354     'api.aliases' => ['is_test'],
 355   ];
 356
 357   $params['financial_type_id']['api.aliases'] = ['contribution_type_id'];
 358   $params['payment_instrument_id']['api.aliases'] = ['contribution_payment_instrument', 'payment_instrument'];
 359   $params['contact_id'] = CRM_Utils_Array::value('contribution_contact_id', $params);
 360   $params['contact_id']['api.aliases'] = ['contribution_contact_id'];
 361   $params['is_template']['api.default'] = 0;
 362   unset($params['contribution_contact_id']);
 363 }
 364
 365 /**
 366  * Legacy handling for contribution parameters.
 367  *
 368  * Take the input parameter list as specified in the data model and
 369  * convert it into the same format that we use in QF and BAO object.
 370  *
 371  * @param array $params
 372  *   property name/value  pairs to insert in new contact.
 373  * @param array $values
 374  *   The reformatted properties that we can use internally.
 375  *
 376  * @return array
 377  */
 378 function _civicrm_api3_contribute_format_params($params, &$values) {
 379   //legacy way of formatting from v2 api - v3 way is to define metadata & do it in the api layer
 380   _civicrm_api3_filter_fields_for_bao('Contribution', $params, $values);
 381   return [];
 382 }
 383
 384 /**
 385  * Send a contribution confirmation (receipt or invoice).
 386  *
 387  * The appropriate online template will be used (the existence of related objects
 388  * (e.g. memberships ) will affect this selection
 389  *
 390  * @param array $params
 391  *   Input parameters.
 392  *
 393  * @throws Exception
 394  */
 395 function civicrm_api3_contribution_sendconfirmation($params) {
 396   $ids = $values = [];
 397   $allowedParams = [
 398     'receipt_from_email',
 399     'receipt_from_name',
 400     'receipt_update',
 401     'cc_receipt',
 402     'bcc_receipt',
 403     'receipt_text',
 404     'payment_processor_id',
 405   ];
 406   $input = array_intersect_key($params, array_flip($allowedParams));
 407   $input['is_email_receipt'] = TRUE;
 408   CRM_Contribute_BAO_Contribution::sendMail($input, $ids, $params['id'], $values);
 409 }
 410
 411 /**
 412  * Adjust Metadata for sendconfirmation action.
 413  *
 414  * The metadata is used for setting defaults, documentation & validation.
 415  *
 416  * @param array $params
 417  *   Array of parameters determined by getfields.
 418  */
 419 function _civicrm_api3_contribution_sendconfirmation_spec(&$params) {
 420   $params['id'] = [
 421     'api.required' => 1,
 422     'title' => ts('Contribution ID'),
 423     'type' => CRM_Utils_Type::T_INT,
 424   ];
 425   $params['receipt_from_email'] = [
 426     'title' => ts('From Email address (string)'),
 427     'type' => CRM_Utils_Type::T_STRING,
 428   ];
 429   $params['receipt_from_name'] = [
 430     'title' => ts('From Name (string)'),
 431     'type' => CRM_Utils_Type::T_STRING,
 432   ];
 433   $params['cc_receipt'] = [
 434     'title' => ts('CC Email address (string)'),
 435     'type' => CRM_Utils_Type::T_STRING,
 436   ];
 437   $params['bcc_receipt'] = [
 438     'title' => ts('BCC Email address (string)'),
 439     'type' => CRM_Utils_Type::T_STRING,
 440   ];
 441   $params['receipt_text'] = [
 442     'title' => ts('Message (string)'),
 443     'type' => CRM_Utils_Type::T_STRING,
 444   ];
 445   $params['receipt_update'] = [
 446     'title' => ts('Update the Receipt Date'),
 447     'type' => CRM_Utils_Type::T_BOOLEAN,
 448     'api.default' => TRUE,
 449   ];
 450   $params['payment_processor_id'] = [
 451     'title' => ts('Payment processor Id (avoids mis-guesses)'),
 452     'type' => CRM_Utils_Type::T_INT,
 453   ];
 454 }
 455
 456 /**
 457  * Complete an existing (pending) transaction.
 458  *
 459  * This will update related entities (participant, membership, pledge etc)
 460  * and take any complete actions from the contribution page (e.g. send receipt).
 461  *
 462  * @todo - most of this should live in the BAO layer but as we want it to be an addition
 463  * to 4.3 which is already stable we should add it to the api layer & re-factor into the BAO layer later
 464  *
 465  * @param array $params
 466  *   Input parameters.
 467  *
 468  * @return array
 469  *   API result array
 470  * @throws \API_Exception
 471  * @throws \CRM_Core_Exception
 472  * @throws \Exception
 473  */
 474 function civicrm_api3_contribution_completetransaction($params) {
 475   $input = $ids = [];
 476   if (isset($params['payment_processor_id'])) {
 477     $input['payment_processor_id'] = $params['payment_processor_id'];
 478   }
 479   $contribution = new CRM_Contribute_BAO_Contribution();
 480   $contribution->id = $params['id'];
 481   if (!$contribution->find(TRUE)) {
 482     throw new API_Exception('A valid contribution ID is required', 'invalid_data');
 483   }
 484
 485   if (!$contribution->loadRelatedObjects($input, $ids, TRUE)) {
 486     throw new API_Exception('failed to load related objects');
 487   }
 488   elseif ($contribution->contribution_status_id == CRM_Core_PseudoConstant::getKey('CRM_Contribute_BAO_Contribution', 'contribution_status_id', 'Completed')) {
 489     throw new API_Exception(ts('Contribution already completed'), 'contribution_completed');
 490   }
 491   $input['trxn_id'] = !empty($params['trxn_id']) ? $params['trxn_id'] : $contribution->trxn_id;
 492   if (!empty($params['fee_amount'])) {
 493     $input['fee_amount'] = $params['fee_amount'];
 494   }
 495   return _ipn_process_transaction($params, $contribution, $input, $ids);
 496
 497 }
 498
 499 /**
 500  * Provide function metadata.
 501  *
 502  * @param array $params
 503  */
 504 function _civicrm_api3_contribution_completetransaction_spec(&$params) {
 505   $params['id'] = [
 506     'title' => 'Contribution ID',
 507     'type' => CRM_Utils_Type::T_INT,
 508     'api.required' => TRUE,
 509   ];
 510   $params['trxn_id'] = [
 511     'title' => 'Transaction ID',
 512     'type' => CRM_Utils_Type::T_STRING,
 513   ];
 514   $params['is_email_receipt'] = [
 515     'title' => 'Send email Receipt?',
 516     'type' => CRM_Utils_Type::T_BOOLEAN,
 517   ];
 518   $params['receipt_from_email'] = [
 519     'title' => 'Email to send receipt from.',
 520     'description' => 'If not provided this will default to being based on domain mail or contribution page',
 521     'type' => CRM_Utils_Type::T_EMAIL,
 522   ];
 523   $params['receipt_from_name'] = [
 524     'title' => 'Name to send receipt from',
 525     'description' => '. If not provided this will default to domain mail or contribution page',
 526     'type' => CRM_Utils_Type::T_STRING,
 527   ];
 528   $params['payment_processor_id'] = [
 529     'title' => 'Payment processor ID',
 530     'description' => 'Providing this is strongly recommended, as not possible to calculate it accurately always',
 531     'type' => CRM_Utils_Type::T_INT,
 532   ];
 533   $params['fee_amount'] = [
 534     'title' => 'Fee charged on transaction',
 535     'description' => 'If a fee has been charged then the amount',
 536     'type' => CRM_Utils_Type::T_FLOAT,
 537   ];
 538   $params['trxn_date'] = [
 539     'title' => 'Transaction Date',
 540     'description' => 'Date this transaction occurred',
 541     'type' => CRM_Utils_Type::T_DATE + CRM_Utils_Type::T_TIME,
 542   ];
 543   $params['card_type_id'] = [
 544     'title' => 'Card Type ID',
 545     'description' => 'Providing Credit Card Type ID',
 546     'type' => CRM_Utils_Type::T_INT,
 547     'pseudoconstant' => [
 548       'optionGroupName' => 'accept_creditcard',
 549     ],
 550   ];
 551   // At some point we will deprecate this api in favour of calling payment create which will in turn call this
 552   // api if appropriate to transition related entities and send receipts - ie. financial responsibility should
 553   // not exist in completetransaction. For now we just need to allow payment.create to force a bypass on the
 554   // things it does itself.
 555   $params['is_post_payment_create'] = [
 556     'title' => 'Is this being called from payment create?',
 557     'type' => CRM_Utils_Type::T_BOOLEAN,
 558     'description' => 'The \'correct\' flow is to call payment.create for the financial side & for that to call completecontribution for the entity & receipt management. However, we need to still support completetransaction directly for legacy reasons',
 559   ];
 560 }
 561
 562 /**
 563  * Complete an existing (pending) transaction.
 564  *
 565  * This will update related entities (participant, membership, pledge etc)
 566  * and take any complete actions from the contribution page (e.g. send receipt).
 567  *
 568  * @todo - most of this should live in the BAO layer but as we want it to be an addition
 569  * to 4.3 which is already stable we should add it to the api layer & re-factor into the BAO layer later
 570  *
 571  * @param array $params
 572  *   Input parameters.
 573  *
 574  * @return array
 575  *   Api result array.
 576  * @throws API_Exception
 577  */
 578 function civicrm_api3_contribution_repeattransaction($params) {
 579   $input = $ids = [];
 580   civicrm_api3_verify_one_mandatory($params, NULL, ['contribution_recur_id', 'original_contribution_id']);
 581   if (empty($params['original_contribution_id'])) {
 582     //  CRM-19873 call with test mode.
 583     $params['original_contribution_id'] = civicrm_api3('contribution', 'getvalue', [
 584       'return' => 'id',
 585       'contribution_status_id' => ['IN' => ['Completed']],
 586       'contribution_recur_id' => $params['contribution_recur_id'],
 587       'contribution_test' => CRM_Core_DAO::getFieldValue('CRM_Contribute_DAO_ContributionRecur', $params['contribution_recur_id'], 'is_test'),
 588       'options' => ['limit' => 1, 'sort' => 'id DESC'],
 589     ]);
 590   }
 591   $contribution = new CRM_Contribute_BAO_Contribution();
 592   $contribution->id = $params['original_contribution_id'];
 593   if (!$contribution->find(TRUE)) {
 594     throw new API_Exception(
 595       'A valid original contribution ID is required', 'invalid_data');
 596   }
 597   $original_contribution = clone $contribution;
 598   $input['payment_processor_id'] = civicrm_api3('contributionRecur', 'getvalue', [
 599     'return' => 'payment_processor_id',
 600     'id' => $contribution->contribution_recur_id,
 601   ]);
 602   try {
 603     if (!$contribution->loadRelatedObjects($input, $ids, TRUE)) {
 604       throw new API_Exception('failed to load related objects');
 605     }
 606
 607     unset($contribution->id, $contribution->receive_date, $contribution->invoice_id);
 608     $contribution->receive_date = $params['receive_date'];
 609
 610     $passThroughParams = [
 611       'trxn_id',
 612       'total_amount',
 613       'campaign_id',
 614       'fee_amount',
 615       'financial_type_id',
 616       'contribution_status_id',
 617       'membership_id',
 618     ];
 619     $input = array_intersect_key($params, array_fill_keys($passThroughParams, NULL));
 620
 621     return _ipn_process_transaction($params, $contribution, $input, $ids, $original_contribution);
 622   }
 623   catch (Exception $e) {
 624     throw new API_Exception('failed to load related objects' . $e->getMessage() . "\n" . $e->getTraceAsString());
 625   }
 626 }
 627
 628 /**
 629  * Calls IPN complete transaction for completing or repeating a transaction.
 630  *
 631  * The IPN function is overloaded with two purposes - this is simply a wrapper for that
 632  * when separating them in the api layer.
 633  *
 634  * @param array $params
 635  * @param CRM_Contribute_BAO_Contribution $contribution
 636  * @param array $input
 637  *
 638  * @param array $ids
 639  *
 640  * @param CRM_Contribute_BAO_Contribution $firstContribution
 641  *
 642  * @return mixed
 643  * @throws \CRM_Core_Exception
 644  * @throws \CiviCRM_API3_Exception
 645  */
 646 function _ipn_process_transaction(&$params, $contribution, $input, $ids, $firstContribution = NULL) {
 647   $objects = $contribution->_relatedObjects;
 648   $objects['contribution'] = &$contribution;
 649
 650   if ($firstContribution) {
 651     $objects['first_contribution'] = $firstContribution;
 652   }
 653   $input['component'] = $contribution->_component;
 654   $input['is_test'] = $contribution->is_test;
 655   $input['amount'] = empty($input['total_amount']) ? $contribution->total_amount : $input['total_amount'];
 656
 657   if (isset($params['is_email_receipt'])) {
 658     $input['is_email_receipt'] = $params['is_email_receipt'];
 659   }
 660   if (!empty($params['trxn_date'])) {
 661     $input['trxn_date'] = $params['trxn_date'];
 662   }
 663   if (!empty($params['receive_date'])) {
 664     $input['receive_date'] = $params['receive_date'];
 665   }
 666   if (empty($contribution->contribution_page_id)) {
 667     static $domainFromName;
 668     static $domainFromEmail;
 669     if (empty($domainFromEmail) && (empty($params['receipt_from_name']) || empty($params['receipt_from_email']))) {
 670       list($domainFromName, $domainFromEmail) = CRM_Core_BAO_Domain::getNameAndEmail(TRUE);
 671     }
 672     $input['receipt_from_name'] = CRM_Utils_Array::value('receipt_from_name', $params, $domainFromName);
 673     $input['receipt_from_email'] = CRM_Utils_Array::value('receipt_from_email', $params, $domainFromEmail);
 674   }
 675   $input['card_type_id'] = CRM_Utils_Array::value('card_type_id', $params);
 676   $input['pan_truncation'] = CRM_Utils_Array::value('pan_truncation', $params);
 677   $transaction = new CRM_Core_Transaction();
 678   return CRM_Contribute_BAO_Contribution::completeOrder($input, $ids, $objects, $transaction,
 679      $contribution, CRM_Utils_Array::value('is_post_payment_create', $params));
 680 }
 681
 682 /**
 683  * Provide function metadata.
 684  *
 685  * @param array $params
 686  */
 687 function _civicrm_api3_contribution_repeattransaction_spec(&$params) {
 688   $params['original_contribution_id'] = [
 689     'title' => 'Original Contribution ID',
 690     'description' => 'Contribution ID to copy (will be calculated from recurring contribution if not provided)',
 691     'type' => CRM_Utils_Type::T_INT,
 692   ];
 693   $params['contribution_recur_id'] = [
 694     'title' => 'Recurring contribution ID',
 695     'type' => CRM_Utils_Type::T_INT,
 696   ];
 697   $params['trxn_id'] = [
 698     'title' => 'Transaction ID',
 699     'type' => CRM_Utils_Type::T_STRING,
 700   ];
 701   $params['is_email_receipt'] = [
 702     'title' => 'Send email Receipt?',
 703     'type' => CRM_Utils_Type::T_BOOLEAN,
 704   ];
 705   $params['contribution_status_id'] = [
 706     'title' => 'Contribution Status ID',
 707     'name' => 'contribution_status_id',
 708     'type' => CRM_Utils_Type::T_INT,
 709     'pseudoconstant' => [
 710       'optionGroupName' => 'contribution_status',
 711     ],
 712     'api.required' => TRUE,
 713   ];
 714   $params['receive_date'] = [
 715     'title' => 'Contribution Receive Date',
 716     'name' => 'receive_date',
 717     'type' => CRM_Utils_Type::T_DATE + CRM_Utils_Type::T_TIME,
 718     'api.default' => 'now',
 719   ];
 720   $params['trxn_id'] = [
 721     'title' => 'Transaction ID',
 722     'name' => 'trxn_id',
 723     'type' => CRM_Utils_Type::T_STRING,
 724   ];
 725   $params['campaign_id'] = [
 726     'title' => 'Campaign ID',
 727     'name' => 'campaign_id',
 728     'type' => CRM_Utils_Type::T_INT,
 729     'pseudoconstant' => [
 730       'table' => 'civicrm_campaign',
 731       'keyColumn' => 'id',
 732       'labelColumn' => 'title',
 733     ],
 734   ];
 735   $params['financial_type_id'] = [
 736     'title' => 'Financial ID (ignored if more than one line item)',
 737     'name' => 'financial_type_id',
 738     'type' => CRM_Utils_Type::T_INT,
 739     'pseudoconstant' => [
 740       'table' => 'civicrm_financial_type',
 741       'keyColumn' => 'id',
 742       'labelColumn' => 'name',
 743     ],
 744   ];
 745   $params['payment_processor_id'] = [
 746     'description' => ts('Payment processor ID, will be loaded from contribution_recur if not provided'),
 747     'title' => 'Payment processor ID',
 748     'name' => 'payment_processor_id',
 749     'type' => CRM_Utils_Type::T_INT,
 750   ];
 751 }
 752
 753 /**
 754  * Declare deprecated functions.
 755  *
 756  * @return array
 757  *   Array of deprecated actions
 758  */
 759 function _civicrm_api3_contribution_deprecation() {
 760   return ['transact' => 'Contribute.transact is ureliable & unsupported - see https://docs.civicrm.org/dev/en/latest/financial/OrderAPI/  for how to move on'];
 761 }