api/v3/Contribution.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.6                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2015                                |
   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 records.
  30  *
  31  * @package CiviCRM_APIv3
  32  */
  33
  34 /**
  35  * Add or update a Contribution.
  36  *
  37  * @param array $params
  38  *   Input parameters.
  39  *
  40  * @throws API_Exception
  41  * @return array
  42  *   Api result array
  43  */
  44 function civicrm_api3_contribution_create(&$params) {
  45   $values = array();
  46   _civicrm_api3_custom_format_params($params, $values, 'Contribution');
  47   $params = array_merge($params, $values);
  48
  49   if (!empty($params['id']) && !empty($params['contribution_status_id'])) {
  50     $error = array();
  51     //throw error for invalid status change such as setting completed back to pending
  52     //@todo this sort of validation belongs in the BAO not the API - if it is not an OK
  53     // action it needs to be blocked there. If it is Ok through a form it needs to be OK through the api
  54     CRM_Contribute_BAO_Contribution::checkStatusValidation(NULL, $params, $error);
  55     if (array_key_exists('contribution_status_id', $error)) {
  56       throw new API_Exception($error['contribution_status_id']);
  57     }
  58   }
  59   if (!empty($params['id']) && !empty($params['financial_type_id'])) {
  60     $error = array();
  61     CRM_Contribute_BAO_Contribution::checkFinancialTypeChange($params['financial_type_id'], $params['id'], $error);
  62     if (array_key_exists('financial_type_id', $error)) {
  63       throw new API_Exception($error['financial_type_id']);
  64     }
  65   }
  66   _civicrm_api3_contribution_create_legacy_support_45($params);
  67
  68   // Make sure tax calculation is handled via api.
  69   $params = CRM_Contribute_BAO_Contribution::checkTaxAmount($params);
  70
  71   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params, 'Contribution');
  72 }
  73
  74 /**
  75  * Adjust Metadata for Create action.
  76  *
  77  * The metadata is used for setting defaults, documentation & validation.
  78  *
  79  * @param array $params
  80  *   Array of parameters determined by getfields.
  81  */
  82 function _civicrm_api3_contribution_create_spec(&$params) {
  83   $params['contact_id']['api.required'] = 1;
  84   $params['total_amount']['api.required'] = 1;
  85   $params['payment_instrument_id']['api.aliases'] = array('payment_instrument');
  86   $params['receive_date']['api.default'] = 'now';
  87   $params['payment_processor'] = array(
  88     'name' => 'payment_processor',
  89     'title' => 'Payment Processor ID',
  90     'description' => 'ID of payment processor used for this contribution',
  91     // field is called payment processor - not payment processor id but can only be one id so
  92     // it seems likely someone will fix it up one day to be more consistent - lets alias it from the start
  93     'api.aliases' => array('payment_processor_id'),
  94     'type' => CRM_Utils_Type::T_INT,
  95   );
  96   $params['financial_type_id']['api.aliases'] = array('contribution_type_id', 'contribution_type');
  97   $params['financial_type_id']['api.required'] = 1;
  98   $params['note'] = array(
  99     'name' => 'note',
 100     'uniqueName' => 'contribution_note',
 101     'title' => 'note',
 102     'type' => 2,
 103     'description' => 'Associated Note in the notes table',
 104   );
 105   $params['soft_credit_to'] = array(
 106     'name' => 'soft_credit_to',
 107     'title' => 'Soft Credit contact ID (legacy)',
 108     'type' => 1,
 109     'description' => 'ID of Contact to be Soft credited to (deprecated - use contribution_soft api)',
 110     'FKClassName' => 'CRM_Contact_DAO_Contact',
 111   );
 112   $params['honor_contact_id'] = array(
 113     'name' => 'honor_contact_id',
 114     'title' => 'Honoree contact ID (legacy)',
 115     'type' => 1,
 116     'description' => 'ID of honoree contact (deprecated - use contribution_soft api)',
 117     'FKClassName' => 'CRM_Contact_DAO_Contact',
 118   );
 119   $params['honor_type_id'] = array(
 120     'name' => 'honor_type_id',
 121     'title' => 'Honoree Type (legacy)',
 122     'type' => 1,
 123     'description' => 'Type of honoree contact (deprecated - use contribution_soft api)',
 124     'pseudoconstant' => TRUE,
 125   );
 126   // note this is a recommended option but not adding as a default to avoid
 127   // creating unnecessary changes for the dev
 128   $params['skipRecentView'] = array(
 129     'name' => 'skipRecentView',
 130     'title' => 'Skip adding to recent view',
 131     'type' => CRM_Utils_Type::T_BOOLEAN,
 132     'description' => 'Do not add to recent view (setting this improves performance)',
 133   );
 134   $params['skipLineItem'] = array(
 135     'name' => 'skipLineItem',
 136     'title' => 'Skip adding line items',
 137     'type' => 1,
 138     'api.default' => 0,
 139     'description' => 'Do not add line items by default (if you wish to add your own)',
 140   );
 141   $params['batch_id'] = array(
 142     'title' => 'Batch',
 143     'type' => 1,
 144     'description' => 'Batch which relevant transactions should be added to',
 145   );
 146 }
 147
 148 /**
 149  * Support for schema changes made in 4.5.
 150  *
 151  * The main purpose of the API is to provide integrators a level of stability not provided by
 152  * the core code or schema - this means we have to provide support for api calls (where possible)
 153  * across schema changes.
 154  *
 155  * @param array $params
 156  */
 157 function _civicrm_api3_contribution_create_legacy_support_45(&$params) {
 158   //legacy soft credit handling - recommended approach is chaining
 159   if (!empty($params['soft_credit_to'])) {
 160     $params['soft_credit'][] = array(
 161       'contact_id'          => $params['soft_credit_to'],
 162       'amount'              => $params['total_amount'],
 163       'soft_credit_type_id' => CRM_Core_OptionGroup::getDefaultValue("soft_credit_type"),
 164     );
 165   }
 166   if (!empty($params['honor_contact_id'])) {
 167     $params['soft_credit'][] = array(
 168       'contact_id'          => $params['honor_contact_id'],
 169       'amount'              => $params['total_amount'],
 170       'soft_credit_type_id' => CRM_Utils_Array::value('honor_type_id', $params, CRM_Core_OptionGroup::getValue('soft_credit_type', 'in_honor_of', 'name')),
 171     );
 172   }
 173 }
 174
 175 /**
 176  * Delete a Contribution.
 177  *
 178  * @param array $params
 179  *   Input parameters.
 180  *
 181  * @return array
 182  */
 183 function civicrm_api3_contribution_delete($params) {
 184
 185   $contributionID = !empty($params['contribution_id']) ? $params['contribution_id'] : $params['id'];
 186   if (CRM_Contribute_BAO_Contribution::deleteContribution($contributionID)) {
 187     return civicrm_api3_create_success(array($contributionID => 1));
 188   }
 189   else {
 190     return civicrm_api3_create_error('Could not delete contribution');
 191   }
 192 }
 193
 194 /**
 195  * Modify metadata for delete action.
 196  *
 197  * Legacy support for contribution_id.
 198  *
 199  * @param array $params
 200  */
 201 function _civicrm_api3_contribution_delete_spec(&$params) {
 202   $params['id']['api.aliases'] = array('contribution_id');
 203 }
 204
 205 /**
 206  * Retrieve a set of contributions.
 207  *
 208  * @param array $params
 209  *  Input parameters.
 210  *
 211  * @return array
 212  *   Array of contributions, if error an array with an error id and error message
 213  */
 214 function civicrm_api3_contribution_get($params) {
 215
 216   $mode = CRM_Contact_BAO_Query::MODE_CONTRIBUTE;
 217   list($dao, $query) = _civicrm_api3_get_query_object($params, $mode, 'Contribution');
 218
 219   $contribution = array();
 220   while ($dao->fetch()) {
 221     //CRM-8662
 222     $contribution_details = $query->store($dao);
 223     $softContribution = CRM_Contribute_BAO_ContributionSoft::getSoftContribution($dao->contribution_id, TRUE);
 224     $contribution[$dao->contribution_id] = array_merge($contribution_details, $softContribution);
 225     // format soft credit for backward compatibility
 226     _civicrm_api3_format_soft_credit($contribution[$dao->contribution_id]);
 227   }
 228   return civicrm_api3_create_success($contribution, $params, 'Contribution', 'get', $dao);
 229 }
 230
 231 /**
 232  * This function is used to format the soft credit for backward compatibility.
 233  *
 234  * As of v4.4 we support multiple soft credit, so now contribution returns array with 'soft_credit' as key
 235  * but we still return first soft credit as a part of contribution array
 236  *
 237  * @param $contribution
 238  */
 239 function _civicrm_api3_format_soft_credit(&$contribution) {
 240   if (!empty($contribution['soft_credit'])) {
 241     $contribution['soft_credit_to'] = $contribution['soft_credit'][1]['contact_id'];
 242     $contribution['soft_credit_id'] = $contribution['soft_credit'][1]['soft_credit_id'];
 243   }
 244 }
 245
 246 /**
 247  * Adjust Metadata for Get action.
 248  *
 249  * The metadata is used for setting defaults, documentation & validation.
 250  *
 251  * @param array $params
 252  *   Array of parameters determined by getfields.
 253  */
 254 function _civicrm_api3_contribution_get_spec(&$params) {
 255   $params['contribution_test'] = array(
 256     'api.default' => 0,
 257     'type' => CRM_Utils_Type::T_BOOLEAN,
 258     'title' => 'Get Test Contributions?',
 259   );
 260   $params['financial_type_id']['api.aliases'] = array('contribution_type_id');
 261   $params['payment_instrument_id']['api.aliases'] = array('contribution_payment_instrument', 'payment_instrument');
 262   $params['contact_id'] = $params['contribution_contact_id'];
 263   $params['contact_id']['api.aliases'] = array('contribution_contact_id');
 264   unset($params['contribution_contact_id']);
 265 }
 266
 267 /**
 268  * Legacy handling for contribution parameters.
 269  *
 270  * Take the input parameter list as specified in the data model and
 271  * convert it into the same format that we use in QF and BAO object.
 272  *
 273  * @param array $params
 274  *   property name/value  pairs to insert in new contact.
 275  * @param array $values
 276  *   The reformatted properties that we can use internally.
 277  *
 278  * @return array
 279  */
 280 function _civicrm_api3_contribute_format_params($params, &$values) {
 281   //legacy way of formatting from v2 api - v3 way is to define metadata & do it in the api layer
 282   _civicrm_api3_filter_fields_for_bao('Contribution', $params, $values);
 283   return array();
 284 }
 285
 286 /**
 287  * Adjust Metadata for Transact action.
 288  *
 289  * The metadata is used for setting defaults, documentation & validation.
 290  *
 291  * @param array $params
 292  *   Array of parameters determined by getfields.
 293  */
 294 function _civicrm_api3_contribution_transact_spec(&$params) {
 295   $fields = civicrm_api3('Contribution', 'getfields', array('action' => 'create'));
 296   $params = array_merge($params, $fields['values']);
 297   $params['receive_date']['api.default'] = 'now';
 298 }
 299
 300 /**
 301  * Process a transaction and record it against the contact.
 302  *
 303  * @param array $params
 304  *   Input parameters.
 305  *
 306  * @return array
 307  *   contribution of created or updated record (or a civicrm error)
 308  */
 309 function civicrm_api3_contribution_transact($params) {
 310   // Set some params specific to payment processing
 311   // @todo - fix this function - none of the results checked by civicrm_error would ever be an array with
 312   // 'is_error' set
 313   // also trxn_id is not saved.
 314   // but since there is no test it's not desirable to jump in & make the obvious changes.
 315   $params['payment_processor_mode'] = empty($params['is_test']) ? 'live' : 'test';
 316   $params['amount'] = $params['total_amount'];
 317   if (!isset($params['net_amount'])) {
 318     $params['net_amount'] = $params['amount'];
 319   }
 320   if (!isset($params['invoiceID']) && isset($params['invoice_id'])) {
 321     $params['invoiceID'] = $params['invoice_id'];
 322   }
 323
 324   // Some payment processors expect a unique invoice_id - generate one if not supplied
 325   $params['invoice_id'] = CRM_Utils_Array::value('invoice_id', $params, md5(uniqid(rand(), TRUE)));
 326
 327   $paymentProcessor = CRM_Financial_BAO_PaymentProcessor::getPayment($params['payment_processor'], $params['payment_processor_mode']);
 328   if (civicrm_error($paymentProcessor)) {
 329     return $paymentProcessor;
 330   }
 331
 332   $payment = CRM_Core_Payment::singleton($params['payment_processor_mode'], $paymentProcessor);
 333   if (civicrm_error($payment)) {
 334     return $payment;
 335   }
 336
 337   $transaction = $payment->doPayment($params);
 338
 339   $params['payment_instrument_id'] = CRM_Core_DAO::getFieldValue('CRM_Financial_DAO_PaymentProcessorType', $paymentProcessor['payment_processor_type_id'], 'payment_type') == 1 ? 'Credit Card' : 'Debit Card';
 340   return civicrm_api('Contribution', 'create', $params);
 341 }
 342
 343 /**
 344  * Send a contribution confirmation (receipt or invoice).
 345  *
 346  * The appropriate online template will be used (the existence of related objects
 347  * (e.g. memberships ) will affect this selection
 348  *
 349  * @param array $params
 350  *   Input parameters.
 351  *
 352  * @throws Exception
 353  */
 354 function civicrm_api3_contribution_sendconfirmation($params) {
 355   $contribution = new CRM_Contribute_BAO_Contribution();
 356   $contribution->id = $params['id'];
 357   if (!$contribution->find(TRUE)) {
 358     throw new Exception('Contribution does not exist');
 359   }
 360   $input = $ids = $cvalues = array('receipt_from_email' => $params['receipt_from_email']);
 361   $contribution->loadRelatedObjects($input, $ids, FALSE, TRUE);
 362   $contribution->composeMessageArray($input, $ids, $cvalues, FALSE, FALSE);
 363 }
 364
 365 /**
 366  * Adjust Metadata for sendconfirmation action.
 367  *
 368  * The metadata is used for setting defaults, documentation & validation.
 369  *
 370  * @param array $params
 371  *   Array of parameters determined by getfields.
 372  */
 373 function _civicrm_api3_contribution_sendconfirmation_spec(&$params) {
 374   $params['id'] = array(
 375     'api.required' => 1,
 376     'title' => 'Contribution ID',
 377     'type' => CRM_Utils_Type::T_INT,
 378   );
 379   $params['receipt_from_email'] = array(
 380     'api.required' => 1,
 381     'title' => 'From Email address (string) required until someone provides a patch :-)',
 382     'type' => CRM_Utils_Type::T_STRING,
 383   );
 384   $params['receipt_from_name'] = array(
 385     'title' => 'From Name (string)',
 386     'type' => CRM_Utils_Type::T_STRING,
 387   );
 388   $params['cc_receipt'] = array(
 389     'title' => 'CC Email address (string)',
 390     'type' => CRM_Utils_Type::T_STRING,
 391   );
 392   $params['bcc_receipt'] = array(
 393     'title' => 'BCC Email address (string)',
 394     'type' => CRM_Utils_Type::T_STRING,
 395   );
 396   $params['receipt_text'] = array(
 397     'title' => 'Message (string)',
 398     'type' => CRM_Utils_Type::T_STRING,
 399   );
 400 }
 401
 402 /**
 403  * Complete an existing (pending) transaction.
 404  *
 405  * This will update related entities (participant, membership, pledge etc)
 406  * and take any complete actions from the contribution page (e.g. send receipt).
 407  *
 408  * @todo - most of this should live in the BAO layer but as we want it to be an addition
 409  * to 4.3 which is already stable we should add it to the api layer & re-factor into the BAO layer later
 410  *
 411  * @param array $params
 412  *   Input parameters.
 413  *
 414  * @throws API_Exception
 415  *   Api result array.
 416  */
 417 function civicrm_api3_contribution_completetransaction(&$params) {
 418
 419   $input = $ids = array();
 420   $contribution = new CRM_Contribute_BAO_Contribution();
 421   $contribution->id = $params['id'];
 422   $contribution->find(TRUE);
 423   if (!$contribution->id == $params['id']) {
 424     throw new API_Exception('A valid contribution ID is required', 'invalid_data');
 425   }
 426   try {
 427     if (!$contribution->loadRelatedObjects($input, $ids, FALSE, TRUE)) {
 428       throw new API_Exception('failed to load related objects');
 429     }
 430     elseif ($contribution->contribution_status_id == CRM_Core_OptionGroup::getValue('contribution_status', 'Completed', 'name')) {
 431       throw new API_Exception(ts('Contribution already completed'));
 432     }
 433     $input['trxn_id'] = !empty($params['trxn_id']) ? $params['trxn_id'] : $contribution->trxn_id;
 434     $params = _ipn_process_transaction($params, $contribution, $input, $ids);
 435   }
 436   catch(Exception $e) {
 437     throw new API_Exception('failed to load related objects' . $e->getMessage() . "\n" . $e->getTraceAsString());
 438   }
 439 }
 440
 441 /**
 442  * Provide function metadata.
 443  *
 444  * @param array $params
 445  */
 446 function _civicrm_api3_contribution_completetransaction_spec(&$params) {
 447   $params['id'] = array(
 448     'title' => 'Contribution ID',
 449     'type' => CRM_Utils_Type::T_INT,
 450     'api.required' => TRUE,
 451   );
 452   $params['trxn_id'] = array(
 453     'title' => 'Transaction ID',
 454     'type' => CRM_Utils_Type::T_STRING,
 455   );
 456   $params['is_email_receipt'] = array(
 457     'title' => 'Send email Receipt?',
 458     'type' => CRM_Utils_Type::T_BOOLEAN,
 459   );
 460   $params['receipt_from_email'] = array(
 461     'title' => 'Email to send receipt from.',
 462     'description' => 'If not provided this will default to being based on domain mail or contribution page',
 463     'type' => CRM_Utils_Type::T_EMAIL,
 464   );
 465   $params['receipt_from_name'] = array(
 466     'title' => 'Name to send receipt from',
 467     'description' => '. If not provided this will default to domain mail or contribution page',
 468     'type' => CRM_Utils_Type::T_STRING,
 469   );
 470 }
 471
 472 /**
 473  * Complete an existing (pending) transaction.
 474  *
 475  * This will update related entities (participant, membership, pledge etc)
 476  * and take any complete actions from the contribution page (e.g. send receipt).
 477  *
 478  * @todo - most of this should live in the BAO layer but as we want it to be an addition
 479  * to 4.3 which is already stable we should add it to the api layer & re-factor into the BAO layer later
 480  *
 481  * @param array $params
 482  *   Input parameters.
 483  *
 484  * @throws API_Exception
 485  *   Api result array.
 486  */
 487 function civicrm_api3_contribution_repeattransaction(&$params) {
 488   $input = $ids = array();
 489   $contribution = new CRM_Contribute_BAO_Contribution();
 490   $contribution->id = $params['original_contribution_id'];
 491   if (!$contribution->find(TRUE)) {
 492     throw new API_Exception(
 493       'A valid original contribution ID is required', 'invalid_data');
 494   }
 495   $original_contribution = clone $contribution;
 496   try {
 497     if (!$contribution->loadRelatedObjects($input, $ids, FALSE, TRUE)) {
 498       throw new API_Exception('failed to load related objects');
 499     }
 500
 501     unset($contribution->id, $contribution->receive_date, $contribution->invoice_id);
 502     $contribution->contribution_status_id = $params['contribution_status_id'];
 503     $contribution->receive_date = $params['receive_date'];
 504
 505     $passThroughParams = array('trxn_id', 'total_amount', 'campaign_id', 'fee_amount');
 506     $input = array_intersect_key($params, array_fill_keys($passThroughParams, NULL));
 507
 508     $params = _ipn_process_transaction($params, $contribution, $input, $ids, $original_contribution);
 509   }
 510   catch(Exception $e) {
 511     throw new API_Exception('failed to load related objects' . $e->getMessage() . "\n" . $e->getTraceAsString());
 512   }
 513 }
 514
 515 /**
 516  * Calls IPN complete transaction for completing or repeating a transaction.
 517  *
 518  * The IPN function is overloaded with two purposes - this is simply a wrapper for that
 519  * when separating them in the api layer.
 520  *
 521  * @param array $params
 522  * @param CRM_Contribute_BAO_Contribution $contribution
 523  * @param array $input
 524  *
 525  * @param array $ids
 526  *
 527  * @param CRM_Contribute_BAO_Contribution $firstContribution
 528  *
 529  * @return mixed
 530  */
 531 function _ipn_process_transaction(&$params, $contribution, $input, $ids, $firstContribution = NULL) {
 532   $objects = $contribution->_relatedObjects;
 533   $objects['contribution'] = &$contribution;
 534
 535   if ($firstContribution) {
 536     $objects['first_contribution'] = $firstContribution;
 537   }
 538   $input['component'] = $contribution->_component;
 539   $input['is_test'] = $contribution->is_test;
 540   $input['amount'] = empty($input['total_amount']) ? $contribution->total_amount : $input['total_amount'];
 541
 542   if (isset($params['is_email_receipt'])) {
 543     $input['is_email_receipt'] = $params['is_email_receipt'];
 544   }
 545   if (empty($contribution->contribution_page_id)) {
 546     static $domainFromName;
 547     static $domainFromEmail;
 548     if (empty($domainFromEmail) && (empty($params['receipt_from_name']) || empty($params['receipt_from_email']))) {
 549       list($domainFromName, $domainFromEmail) = CRM_Core_BAO_Domain::getNameAndEmail(TRUE);
 550     }
 551     $input['receipt_from_name'] = CRM_Utils_Array::value('receipt_from_name', $params, $domainFromName);
 552     $input['receipt_from_email'] = CRM_Utils_Array::value('receipt_from_email', $params, $domainFromEmail);
 553   }
 554   // @todo required for base ipn but problematic as api layer handles this
 555   $transaction = new CRM_Core_Transaction();
 556   $ipn = new CRM_Core_Payment_BaseIPN();
 557   $ipn->completeTransaction($input, $ids, $objects, $transaction, !empty($contribution->contribution_recur_id));
 558   return $params;
 559 }
 560
 561 /**
 562  * Provide function metadata.
 563  *
 564  * @param array $params
 565  */
 566 function _civicrm_api3_contribution_repeattransaction_spec(&$params) {
 567   $params['original_contribution_id'] = array(
 568     'title' => 'Original Contribution ID',
 569     'type' => CRM_Utils_Type::T_INT,
 570     'api.required' => TRUE,
 571   );
 572   $params['trxn_id'] = array(
 573     'title' => 'Transaction ID',
 574     'type' => CRM_Utils_Type::T_STRING,
 575   );
 576   $params['is_email_receipt'] = array(
 577     'title' => 'Send email Receipt?',
 578     'type' => CRM_Utils_Type::T_BOOLEAN,
 579   );
 580   $params['contribution_status_id'] = array(
 581     'title' => 'Contribution Status ID',
 582     'name' => 'contribution_status_id',
 583     'type' => CRM_Utils_Type::T_INT,
 584     'pseudoconstant' => array(
 585       'optionGroupName' => 'contribution_status',
 586     ),
 587     'api.required' => TRUE,
 588   );
 589   $params['receive_date'] = array(
 590     'title' => 'Contribution Receive Date',
 591     'name' => 'receive_date',
 592     'type' => CRM_Utils_Type::T_DATE,
 593     'api.default' => 'now',
 594   );
 595   $params['trxn_id'] = array(
 596     'title' => 'Transaction ID',
 597     'name' => 'trxn_id',
 598     'type' => CRM_Utils_Type::T_STRING,
 599   );
 600   $params['payment_processor_id'] = array(
 601     'description' => ts('Payment processor ID, will be loaded from contribution_recur if not provided'),
 602     'title' => 'Payment processor ID',
 603     'name' => 'payment_processor_id',
 604     'type' => CRM_Utils_Type::T_INT,
 605   );
 606 }