3 +--------------------------------------------------------------------+
4 | Copyright CiviCRM LLC. All rights reserved. |
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 +--------------------------------------------------------------------+
13 * This api exposes CiviCRM Contribution records.
15 * @package CiviCRM_APIv3
18 use Civi\Api4\Contribution
;
21 * Add or update a Contribution.
23 * @param array $params
26 * @throws API_Exception
30 function civicrm_api3_contribution_create($params) {
32 _civicrm_api3_custom_format_params($params, $values, 'Contribution');
33 $params = array_merge($params, $values);
34 // The BAO should not clean money - it should be done in the form layer & api wrapper
35 // (although arguably the api should expect pre-cleaned it seems to do some cleaning.)
36 if (empty($params['skipCleanMoney'])) {
37 foreach (['total_amount', 'net_amount', 'fee_amount', 'non_deductible_amount'] as $field) {
38 if (isset($params[$field])) {
39 $params[$field] = CRM_Utils_Rule
::cleanMoney($params[$field]);
43 $params['skipCleanMoney'] = TRUE;
45 if (!empty($params['check_permissions'])) {
46 // Check acls on this entity. Note that we pass in financial type id, if we have it
47 // since we know this is checked by acls. In v4 we do something more generic.
48 if (!Contribution
::checkAccess()
49 ->setAction(empty($params['id']) ?
'create' : 'update')
50 ->addValue('id', $params['id'] ??
NULL)
51 ->addValue('financial_type_id', $params['financial_type_id'] ??
NULL)
52 ->execute()->first()['access']) {
53 throw new API_Exception('You do not have permission to create this contribution');
56 if (!empty($params['id']) && !empty($params['contribution_status_id'])) {
58 //throw error for invalid status change such as setting completed back to pending
59 //@todo this sort of validation belongs in the BAO not the API - if it is not an OK
60 // action it needs to be blocked there. If it is Ok through a form it needs to be OK through the api
61 CRM_Contribute_BAO_Contribution
::checkStatusValidation(NULL, $params, $error);
62 if (array_key_exists('contribution_status_id', $error)) {
63 throw new API_Exception($error['contribution_status_id']);
66 if (!empty($params['id']) && !empty($params['financial_type_id'])) {
68 CRM_Contribute_BAO_Contribution
::checkFinancialTypeChange($params['financial_type_id'], $params['id'], $error);
69 if (array_key_exists('financial_type_id', $error)) {
70 throw new API_Exception($error['financial_type_id']);
73 if (!isset($params['tax_amount']) && empty($params['line_item'])
74 && empty($params['skipLineItem'])
75 && empty($params['id'])
77 $taxRates = CRM_Core_PseudoConstant
::getTaxRates();
78 $taxRate = $taxRates[$params['financial_type_id']] ??
0;
80 // Be afraid - historically if a contribution was tax then the passed in amount is EXCLUSIVE
81 $params['tax_amount'] = $params['total_amount'] * ($taxRate / 100);
82 $params['total_amount'] +
= $params['tax_amount'];
85 _civicrm_api3_contribution_create_legacy_support_45($params);
87 return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__
), $params, 'Contribution');
91 * Adjust Metadata for Create action.
93 * The metadata is used for setting defaults, documentation & validation.
95 * @param array $params
96 * Array of parameters determined by getfields.
98 function _civicrm_api3_contribution_create_spec(&$params) {
99 $params['contact_id']['api.required'] = 1;
100 $params['total_amount']['api.required'] = 1;
101 $params['payment_instrument_id']['api.aliases'] = ['payment_instrument'];
102 $params['receive_date']['api.default'] = 'now';
103 $params['receive_date']['api.required'] = TRUE;
104 $params['payment_processor'] = [
105 'name' => 'payment_processor',
106 'title' => 'Payment Processor ID',
107 'description' => 'ID of payment processor used for this contribution',
108 // field is called payment processor - not payment processor id but can only be one id so
109 // it seems likely someone will fix it up one day to be more consistent - lets alias it from the start
110 'api.aliases' => ['payment_processor_id'],
111 'type' => CRM_Utils_Type
::T_INT
,
113 $params['financial_type_id']['api.aliases'] = ['contribution_type_id', 'contribution_type'];
114 $params['financial_type_id']['api.required'] = 1;
117 'uniqueName' => 'contribution_note',
120 'description' => 'Associated Note in the notes table',
122 $params['soft_credit_to'] = [
123 'name' => 'soft_credit_to',
124 'title' => 'Soft Credit contact ID (legacy)',
125 'type' => CRM_Utils_Type
::T_INT
,
126 'description' => 'ID of Contact to be Soft credited to (deprecated - use contribution_soft api)',
127 'FKClassName' => 'CRM_Contact_DAO_Contact',
129 $params['honor_contact_id'] = [
130 'name' => 'honor_contact_id',
131 'title' => 'Honoree contact ID (legacy)',
132 'type' => CRM_Utils_Type
::T_INT
,
133 'description' => 'ID of honoree contact (deprecated - use contribution_soft api)',
134 'FKClassName' => 'CRM_Contact_DAO_Contact',
136 $params['honor_type_id'] = [
137 'name' => 'honor_type_id',
138 'title' => 'Honoree Type (legacy)',
139 'type' => CRM_Utils_Type
::T_INT
,
140 'description' => 'Type of honoree contact (deprecated - use contribution_soft api)',
141 'pseudoconstant' => TRUE,
143 // note this is a recommended option but not adding as a default to avoid
144 // creating unnecessary changes for the dev
145 $params['skipRecentView'] = [
146 'name' => 'skipRecentView',
147 'title' => 'Skip adding to recent view',
148 'type' => CRM_Utils_Type
::T_BOOLEAN
,
149 'description' => 'Do not add to recent view (setting this improves performance)',
151 $params['skipLineItem'] = [
152 'name' => 'skipLineItem',
153 'title' => 'Skip adding line items',
154 'type' => CRM_Utils_Type
::T_BOOLEAN
,
156 'description' => 'Do not add line items by default (if you wish to add your own)',
158 $params['batch_id'] = [
160 'type' => CRM_Utils_Type
::T_INT
,
161 'description' => 'Batch which relevant transactions should be added to',
163 $params['refund_trxn_id'] = [
164 'title' => 'Refund Transaction ID',
165 'type' => CRM_Utils_Type
::T_STRING
,
166 'description' => 'Transaction ID specific to the refund taking place',
168 $params['card_type_id'] = [
169 'title' => 'Card Type ID',
170 'description' => 'Providing Credit Card Type ID',
171 'type' => CRM_Utils_Type
::T_INT
,
172 'pseudoconstant' => [
173 'optionGroupName' => 'accept_creditcard',
179 * Support for schema changes made in 4.5.
181 * The main purpose of the API is to provide integrators a level of stability not provided by
182 * the core code or schema - this means we have to provide support for api calls (where possible)
183 * across schema changes.
185 * @param array $params
187 function _civicrm_api3_contribution_create_legacy_support_45(&$params) {
188 //legacy soft credit handling - recommended approach is chaining
189 if (!empty($params['soft_credit_to'])) {
190 $params['soft_credit'][] = [
191 'contact_id' => $params['soft_credit_to'],
192 'amount' => $params['total_amount'],
193 'soft_credit_type_id' => CRM_Core_OptionGroup
::getDefaultValue("soft_credit_type"),
196 if (!empty($params['honor_contact_id'])) {
197 $params['soft_credit'][] = [
198 'contact_id' => $params['honor_contact_id'],
199 'amount' => $params['total_amount'],
200 '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')),
206 * Delete a Contribution.
208 * @param array $params
212 * @throws \API_Exception
214 function civicrm_api3_contribution_delete($params) {
216 $contributionID = !empty($params['contribution_id']) ?
$params['contribution_id'] : $params['id'];
217 if (!empty($params['check_permissions']) && !\Civi\Api4\Utils\CoreUtil
::checkAccessDelegated('Contribution', 'delete', ['id' => $contributionID], CRM_Core_Session
::getLoggedInContactID() ?
: 0)) {
218 throw new API_Exception('You do not have permission to delete this contribution');
220 if (CRM_Contribute_BAO_Contribution
::deleteContribution($contributionID)) {
221 return civicrm_api3_create_success([$contributionID => 1]);
223 throw new API_Exception('Could not delete contribution');
227 * Modify metadata for delete action.
229 * Legacy support for contribution_id.
231 * @param array $params
233 function _civicrm_api3_contribution_delete_spec(&$params) {
234 $params['id']['api.aliases'] = ['contribution_id'];
238 * Retrieve a set of contributions.
240 * @param array $params
244 * Array of contributions, if error an array with an error id and error message
246 function civicrm_api3_contribution_get($params) {
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);
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]);
263 return civicrm_api3_create_success($contributions, $params, 'Contribution', 'get');
267 * Fix the return values to reflect cases where the schema has been changed.
269 * At the query object level using uniquenames dismbiguates between tables.
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.
274 * @param array $params
277 * @throws \API_Exception
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;
287 return $additionalOptions;
291 * Support for supported output variables.
293 * @param array $contribution
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.
301 'contribution_check_number' => 'check_number',
302 'contribution_address_id' => 'address_id',
303 'payment_instrument_id' => 'instrument_id',
304 'contribution_cancel_date' => 'cancel_date',
306 foreach ($outputAliases as $returnName => $copyTo) {
307 if (array_key_exists($returnName, $contribution)) {
308 $contribution[$copyTo] = $contribution[$returnName];
315 * Get number of contacts matching the supplied criteria.
317 * @param array $params
321 function civicrm_api3_contribution_getcount($params) {
322 $count = _civicrm_api3_get_using_query_object('Contribution', $params, [], TRUE, CRM_Contact_BAO_Query
::MODE_CONTRIBUTE
);
327 * This function is used to format the soft credit for backward compatibility.
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
332 * @param array $contribution
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'];
342 * Adjust Metadata for Get action.
344 * The metadata is used for setting defaults, documentation & validation.
346 * @param array $params
347 * Array of parameters determined by getfields.
349 function _civicrm_api3_contribution_get_spec(&$params) {
350 $params['contribution_test'] = [
352 'type' => CRM_Utils_Type
::T_BOOLEAN
,
353 'title' => 'Get Test Contributions?',
354 'api.aliases' => ['is_test'],
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'] = $params['contribution_contact_id'] ??
NULL;
360 $params['contact_id']['api.aliases'] = ['contribution_contact_id'];
361 $params['is_template']['api.default'] = 0;
362 unset($params['contribution_contact_id']);
366 * Legacy handling for contribution parameters.
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.
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.
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);
385 * Send a contribution confirmation (receipt or invoice).
387 * The appropriate online template will be used (the existence of related objects
388 * (e.g. memberships ) will affect this selection
390 * @param array $params
395 function civicrm_api3_contribution_sendconfirmation($params) {
398 'receipt_from_email',
405 'payment_processor_id',
407 $input = array_intersect_key($params, array_flip($allowedParams));
408 CRM_Contribute_BAO_Contribution
::sendMail($input, $ids, $params['id']);
413 * Adjust Metadata for sendconfirmation action.
415 * The metadata is used for setting defaults, documentation & validation.
417 * @param array $params
418 * Array of parameters determined by getfields.
420 function _civicrm_api3_contribution_sendconfirmation_spec(&$params) {
423 'title' => ts('Contribution ID'),
424 'type' => CRM_Utils_Type
::T_INT
,
426 $params['receipt_from_email'] = [
427 'title' => ts('From Email address (string)'),
428 'type' => CRM_Utils_Type
::T_STRING
,
430 $params['receipt_from_name'] = [
431 'title' => ts('From Name (string)'),
432 'type' => CRM_Utils_Type
::T_STRING
,
434 $params['cc_receipt'] = [
435 'title' => ts('CC Email address (string)'),
436 'type' => CRM_Utils_Type
::T_STRING
,
438 $params['bcc_receipt'] = [
439 'title' => ts('BCC Email address (string)'),
440 'type' => CRM_Utils_Type
::T_STRING
,
442 $params['receipt_text'] = [
443 'title' => ts('Message (string)'),
444 'type' => CRM_Utils_Type
::T_STRING
,
446 $params['pay_later_receipt'] = [
447 'title' => ts('Pay Later Message (string)'),
448 'type' => CRM_Utils_Type
::T_STRING
,
450 $params['receipt_update'] = [
451 'title' => ts('Update the Receipt Date'),
452 'type' => CRM_Utils_Type
::T_BOOLEAN
,
453 'api.default' => TRUE,
455 $params['payment_processor_id'] = [
456 'title' => ts('Payment processor Id (avoids mis-guesses)'),
457 'type' => CRM_Utils_Type
::T_INT
,
462 * Complete an existing (pending) transaction.
464 * This will update related entities (participant, membership, pledge etc)
465 * and take any complete actions from the contribution page (e.g. send receipt).
467 * @todo - most of this should live in the BAO layer but as we want it to be an addition
468 * to 4.3 which is already stable we should add it to the api layer & re-factor into the BAO layer later
470 * @param array $params
475 * @throws \API_Exception
476 * @throws \CRM_Core_Exception
479 function civicrm_api3_contribution_completetransaction($params) {
480 $contribution = new CRM_Contribute_BAO_Contribution();
481 $contribution->id
= $params['id'];
482 if (!$contribution->find(TRUE)) {
483 throw new API_Exception('A valid contribution ID is required', 'invalid_data');
485 if ($contribution->contribution_status_id
== CRM_Core_PseudoConstant
::getKey('CRM_Contribute_BAO_Contribution', 'contribution_status_id', 'Completed')) {
486 throw new API_Exception(ts('Contribution already completed'), 'contribution_completed');
489 $params['trxn_id'] = $params['trxn_id'] ??
$contribution->trxn_id
;
491 $passThroughParams = [
493 'payment_processor_id',
496 $input = array_intersect_key($params, array_fill_keys($passThroughParams, NULL));
499 if (!$contribution->loadRelatedObjects(['payment_processor_id' => $input['payment_processor_id'] ??
NULL], $ids, TRUE)) {
500 throw new API_Exception('failed to load related objects');
503 // @todo Copied from _ipn_process_transaction - needs cleanup/refactor
504 $objects = $contribution->_relatedObjects
;
505 $objects['contribution'] = &$contribution;
506 $input['component'] = $contribution->_component
;
507 $input['is_test'] = $contribution->is_test
;
508 $input['amount'] = empty($input['total_amount']) ?
$contribution->total_amount
: $input['total_amount'];
510 if (isset($params['is_email_receipt'])) {
511 $input['is_email_receipt'] = $params['is_email_receipt'];
513 if (!empty($params['trxn_date'])) {
514 $input['trxn_date'] = $params['trxn_date'];
516 if (!empty($params['receive_date'])) {
517 $input['receive_date'] = $params['receive_date'];
519 if (empty($contribution->contribution_page_id
)) {
520 static $domainFromName;
521 static $domainFromEmail;
522 if (empty($domainFromEmail) && (empty($params['receipt_from_name']) ||
empty($params['receipt_from_email']))) {
523 [$domainFromName, $domainFromEmail] = CRM_Core_BAO_Domain
::getNameAndEmail(TRUE);
525 $input['receipt_from_name'] = CRM_Utils_Array
::value('receipt_from_name', $params, $domainFromName);
526 $input['receipt_from_email'] = CRM_Utils_Array
::value('receipt_from_email', $params, $domainFromEmail);
528 $input['card_type_id'] = $params['card_type_id'] ??
NULL;
529 $input['pan_truncation'] = $params['pan_truncation'] ??
NULL;
530 if (!empty($params['payment_instrument_id'])) {
531 $input['payment_instrument_id'] = $params['payment_instrument_id'];
533 return CRM_Contribute_BAO_Contribution
::completeOrder($input,
534 !empty($objects['contributionRecur']) ?
$objects['contributionRecur']->id
: NULL,
535 $objects['contribution']->id ??
NULL,
536 $params['is_post_payment_create'] ??
NULL);
540 * Provide function metadata.
542 * @param array $params
544 function _civicrm_api3_contribution_completetransaction_spec(&$params) {
546 'title' => 'Contribution ID',
547 'type' => CRM_Utils_Type
::T_INT
,
548 'api.required' => TRUE,
550 $params['trxn_id'] = [
551 'title' => 'Transaction ID',
552 'type' => CRM_Utils_Type
::T_STRING
,
554 $params['is_email_receipt'] = [
555 'title' => 'Send email Receipt?',
556 'type' => CRM_Utils_Type
::T_BOOLEAN
,
558 $params['receipt_from_email'] = [
559 'title' => 'Email to send receipt from.',
560 'description' => 'If not provided this will default to being based on domain mail or contribution page',
561 'type' => CRM_Utils_Type
::T_EMAIL
,
563 $params['receipt_from_name'] = [
564 'title' => 'Name to send receipt from',
565 'description' => '. If not provided this will default to domain mail or contribution page',
566 'type' => CRM_Utils_Type
::T_STRING
,
568 $params['payment_processor_id'] = [
569 'title' => 'Payment processor ID',
570 'description' => 'Providing this is strongly recommended, as not possible to calculate it accurately always',
571 'type' => CRM_Utils_Type
::T_INT
,
573 $params['fee_amount'] = [
574 'title' => 'Fee charged on transaction',
575 'description' => 'If a fee has been charged then the amount',
576 'type' => CRM_Utils_Type
::T_FLOAT
,
578 $params['trxn_date'] = [
579 'title' => 'Transaction Date',
580 'description' => 'Date this transaction occurred',
581 'type' => CRM_Utils_Type
::T_DATE + CRM_Utils_Type
::T_TIME
,
583 $params['card_type_id'] = [
584 'title' => 'Card Type ID',
585 'description' => 'Providing Credit Card Type ID',
586 'type' => CRM_Utils_Type
::T_INT
,
587 'pseudoconstant' => [
588 'optionGroupName' => 'accept_creditcard',
591 // At some point we will deprecate this api in favour of calling payment create which will in turn call this
592 // api if appropriate to transition related entities and send receipts - ie. financial responsibility should
593 // not exist in completetransaction. For now we just need to allow payment.create to force a bypass on the
594 // things it does itself.
595 $params['is_post_payment_create'] = [
596 'title' => 'Is this being called from payment create?',
597 'type' => CRM_Utils_Type
::T_BOOLEAN
,
598 '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',
603 * Complete an existing (pending) transaction.
605 * This will update related entities (participant, membership, pledge etc)
606 * and take any complete actions from the contribution page (e.g. send receipt).
608 * @todo - most of this should live in the BAO layer but as we want it to be an addition
609 * to 4.3 which is already stable we should add it to the api layer & re-factor into the BAO layer later
611 * @param array $params
616 * @throws API_Exception
618 function civicrm_api3_contribution_repeattransaction($params) {
619 civicrm_api3_verify_one_mandatory($params, NULL, ['contribution_recur_id', 'original_contribution_id']);
620 if (empty($params['original_contribution_id'])) {
621 $templateContribution = CRM_Contribute_BAO_ContributionRecur
::getTemplateContribution($params['contribution_recur_id']);
622 if (empty($templateContribution)) {
623 throw new CiviCRM_API3_Exception('Contribution.repeattransaction failed to get original_contribution_id for recur with ID: ' . $params['contribution_recur_id']);
625 $params['original_contribution_id'] = $templateContribution['id'];
627 $contribution = new CRM_Contribute_BAO_Contribution();
628 $contribution->id
= $params['original_contribution_id'];
629 if (!$contribution->find(TRUE)) {
630 throw new API_Exception(
631 'A valid original contribution ID is required', 'invalid_data');
633 // We don't support repeattransaction without a related recurring contribution.
634 if (empty($contribution->contribution_recur_id
)) {
635 throw new API_Exception(
636 'Repeattransaction API can only be used in the context of contributions that have a contribution_recur_id.',
641 $params['payment_processor_id'] = civicrm_api3('contributionRecur', 'getvalue', [
642 'return' => 'payment_processor_id',
643 'id' => $contribution->contribution_recur_id
,
646 $passThroughParams = [
652 'contribution_status_id',
653 'payment_processor_id',
655 $input = array_intersect_key($params, array_fill_keys($passThroughParams, NULL));
658 if (!$contribution->loadRelatedObjects(['payment_processor_id' => $input['payment_processor_id']], $ids, TRUE)) {
659 throw new API_Exception('failed to load related objects');
661 unset($contribution->id
, $contribution->receive_date
, $contribution->invoice_id
);
662 $contribution->receive_date
= $params['receive_date'];
664 // @todo Copied from _ipn_process_transaction - needs cleanup/refactor
665 $objects = $contribution->_relatedObjects
;
666 $objects['contribution'] = &$contribution;
667 $input['component'] = $contribution->_component
;
668 $input['is_test'] = $contribution->is_test
;
669 $input['amount'] = empty($input['total_amount']) ?
$contribution->total_amount
: $input['total_amount'];
671 if (isset($params['is_email_receipt'])) {
672 $input['is_email_receipt'] = $params['is_email_receipt'];
674 if (!empty($params['trxn_date'])) {
675 $input['trxn_date'] = $params['trxn_date'];
677 if (!empty($params['receive_date'])) {
678 $input['receive_date'] = $params['receive_date'];
680 if (empty($contribution->contribution_page_id
)) {
681 static $domainFromName;
682 static $domainFromEmail;
683 if (empty($domainFromEmail) && (empty($params['receipt_from_name']) ||
empty($params['receipt_from_email']))) {
684 [$domainFromName, $domainFromEmail] = CRM_Core_BAO_Domain
::getNameAndEmail(TRUE);
686 $input['receipt_from_name'] = CRM_Utils_Array
::value('receipt_from_name', $params, $domainFromName);
687 $input['receipt_from_email'] = CRM_Utils_Array
::value('receipt_from_email', $params, $domainFromEmail);
689 $input['card_type_id'] = $params['card_type_id'] ??
NULL;
690 $input['pan_truncation'] = $params['pan_truncation'] ??
NULL;
691 if (!empty($params['payment_instrument_id'])) {
692 $input['payment_instrument_id'] = $params['payment_instrument_id'];
694 return CRM_Contribute_BAO_Contribution
::completeOrder($input,
695 !empty($objects['contributionRecur']) ?
$objects['contributionRecur']->id
: NULL,
696 $objects['contribution']->id ??
NULL,
697 $params['is_post_payment_create'] ??
NULL);
701 * Calls IPN complete transaction for completing or repeating a transaction.
703 * The IPN function is overloaded with two purposes - this is simply a wrapper for that
704 * when separating them in the api layer.
708 * @param array $params
709 * @param CRM_Contribute_BAO_Contribution $contribution
710 * @param array $input
715 * @throws \CRM_Core_Exception
716 * @throws \CiviCRM_API3_Exception
718 function _ipn_process_transaction($params, $contribution, $input, $ids) {
719 CRM_Core_Error
::deprecatedFunctionWarning('API3 contribution.completetransaction or contribution.repeattransaction');
720 $objects = $contribution->_relatedObjects
;
721 $objects['contribution'] = &$contribution;
722 $input['component'] = $contribution->_component
;
723 $input['is_test'] = $contribution->is_test
;
724 $input['amount'] = empty($input['total_amount']) ?
$contribution->total_amount
: $input['total_amount'];
726 if (isset($params['is_email_receipt'])) {
727 $input['is_email_receipt'] = $params['is_email_receipt'];
729 if (!empty($params['trxn_date'])) {
730 $input['trxn_date'] = $params['trxn_date'];
732 if (!empty($params['receive_date'])) {
733 $input['receive_date'] = $params['receive_date'];
735 if (empty($contribution->contribution_page_id
)) {
736 static $domainFromName;
737 static $domainFromEmail;
738 if (empty($domainFromEmail) && (empty($params['receipt_from_name']) ||
empty($params['receipt_from_email']))) {
739 [$domainFromName, $domainFromEmail] = CRM_Core_BAO_Domain
::getNameAndEmail(TRUE);
741 $input['receipt_from_name'] = CRM_Utils_Array
::value('receipt_from_name', $params, $domainFromName);
742 $input['receipt_from_email'] = CRM_Utils_Array
::value('receipt_from_email', $params, $domainFromEmail);
744 $input['card_type_id'] = $params['card_type_id'] ??
NULL;
745 $input['pan_truncation'] = $params['pan_truncation'] ??
NULL;
746 if (!empty($params['payment_instrument_id'])) {
747 $input['payment_instrument_id'] = $params['payment_instrument_id'];
749 return CRM_Contribute_BAO_Contribution
::completeOrder($input,
750 !empty($objects['contributionRecur']) ?
$objects['contributionRecur']->id
: NULL,
751 $objects['contribution']->id ??
NULL,
752 $params['is_post_payment_create'] ??
NULL);
756 * Provide function metadata.
758 * @param array $params
760 function _civicrm_api3_contribution_repeattransaction_spec(&$params) {
761 $params['original_contribution_id'] = [
762 'title' => 'Original Contribution ID',
763 'description' => 'Contribution ID to copy (will be calculated from recurring contribution if not provided)',
764 'type' => CRM_Utils_Type
::T_INT
,
766 $params['contribution_recur_id'] = [
767 'title' => 'Recurring contribution ID',
768 'type' => CRM_Utils_Type
::T_INT
,
770 $params['trxn_id'] = [
771 'title' => 'Transaction ID',
772 'type' => CRM_Utils_Type
::T_STRING
,
774 $params['is_email_receipt'] = [
775 'title' => 'Send email Receipt?',
776 'type' => CRM_Utils_Type
::T_BOOLEAN
,
778 $params['contribution_status_id'] = [
779 'title' => 'Contribution Status ID',
780 'name' => 'contribution_status_id',
781 'type' => CRM_Utils_Type
::T_INT
,
782 'pseudoconstant' => [
783 'optionGroupName' => 'contribution_status',
785 'api.required' => TRUE,
786 'api.default' => 'Pending',
788 $params['receive_date'] = [
789 'title' => 'Contribution Receive Date',
790 'name' => 'receive_date',
791 'type' => CRM_Utils_Type
::T_DATE + CRM_Utils_Type
::T_TIME
,
792 'api.default' => 'now',
794 $params['trxn_id'] = [
795 'title' => 'Transaction ID',
797 'type' => CRM_Utils_Type
::T_STRING
,
799 $params['campaign_id'] = [
800 'title' => 'Campaign ID',
801 'name' => 'campaign_id',
802 'type' => CRM_Utils_Type
::T_INT
,
803 'pseudoconstant' => [
804 'table' => 'civicrm_campaign',
806 'labelColumn' => 'title',
809 $params['financial_type_id'] = [
810 'title' => 'Financial ID (ignored if more than one line item)',
811 'name' => 'financial_type_id',
812 'type' => CRM_Utils_Type
::T_INT
,
813 'pseudoconstant' => [
814 'table' => 'civicrm_financial_type',
816 'labelColumn' => 'name',
819 $params['payment_processor_id'] = [
820 'description' => ts('Payment processor ID, will be loaded from contribution_recur if not provided'),
821 'title' => 'Payment processor ID',
822 'name' => 'payment_processor_id',
823 'type' => CRM_Utils_Type
::T_INT
,
828 * Declare deprecated functions.
831 * Array of deprecated actions
833 function _civicrm_api3_contribution_deprecation() {
834 return ['transact' => 'Contribute.transact is ureliable & unsupported - see https://docs.civicrm.org/dev/en/latest/financial/OrderAPI/ for how to move on'];