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 * Test APIv3 civicrm_contribute_* functions
15 * @package CiviCRM_APIv3
16 * @subpackage API_Contribution
19 class api_v3_PaymentTest
extends CiviUnitTestCase
{
21 protected $_individualId;
23 protected $_financialTypeId = 1;
28 * @throws \CRM_Core_Exception
30 public function setUp() {
33 $this->_apiversion
= 3;
34 $this->_individualId
= $this->individualCreate();
35 CRM_Core_Config
::singleton()->userPermissionClass
->permissions
= [];
39 * Clean up after each test.
43 public function tearDown() {
44 $this->quickCleanUpFinancialEntities();
45 $this->quickCleanup(['civicrm_uf_match']);
46 unset(CRM_Core_Config
::singleton()->userPermissionClass
->permissions
);
51 * Test Get Payment api.
53 * @throws \CRM_Core_Exception
55 public function testGetPayment() {
57 'contact_id' => $this->_individualId
,
58 'receive_date' => '2010-01-20',
59 'total_amount' => 100.00,
60 'financial_type_id' => $this->_financialTypeId
,
62 'contribution_status_id' => 1,
64 $contribution = $this->callAPISuccess('contribution', 'create', $p);
67 'contribution_id' => $contribution['id'],
68 'check_permissions' => TRUE,
70 CRM_Core_Config
::singleton()->userPermissionClass
->permissions
= ['access CiviCRM', 'administer CiviCRM'];
71 $payment = $this->callAPIFailure('payment', 'get', $params, 'API permission check failed for Payment/get call; insufficient permission: require access CiviCRM and access CiviContribute');
73 array_push(CRM_Core_Config
::singleton()->userPermissionClass
->permissions
, 'access CiviContribute');
74 $payment = $this->callAPISuccess('payment', 'get', $params);
76 $payment = $this->callAPIAndDocument('payment', 'get', $params, __FUNCTION__
, __FILE__
);
77 $this->assertEquals(1, $payment['count']);
80 $contribution['id'] => [
81 'total_amount' => 100,
83 'trxn_date' => '2010-01-20 00:00:00',
84 'contribution_id' => $contribution['id'],
88 $this->checkPaymentResult($payment, $expectedResult);
89 $this->callAPISuccess('Contribution', 'Delete', [
90 'id' => $contribution['id'],
92 $this->validateAllPayments();
96 * Retrieve Payment using trxn_id.
98 * @throws \CRM_Core_Exception
100 public function testGetPaymentWithTrxnID() {
101 $this->_individualId2
= $this->individualCreate();
103 'contact_id' => $this->_individualId
,
105 'total_amount' => 10,
107 $contributionID1 = $this->contributionCreate($params1);
110 'contact_id' => $this->_individualId2
,
112 'total_amount' => 20,
114 $contributionID2 = $this->contributionCreate($params2);
116 $paymentParams = ['trxn_id' => 111111];
117 $payment = $this->callAPISuccess('payment', 'get', $paymentParams);
120 'total_amount' => 10,
124 'contribution_id' => $contributionID1,
127 $this->checkPaymentResult($payment, $expectedResult);
129 $paymentParams = ['trxn_id' => 222222];
130 $payment = $this->callAPISuccess('payment', 'get', $paymentParams);
133 'total_amount' => 20,
137 'contribution_id' => $contributionID2,
140 $this->checkPaymentResult($payment, $expectedResult);
141 $this->validateAllPayments();
145 * Test email receipt for partial payment.
147 * @throws \CRM_Core_Exception
149 public function testPaymentEmailReceipt() {
150 $mut = new CiviMailUtils($this);
151 $contribution = $this->createPartiallyPaidParticipantOrder();
152 $event = $this->callAPISuccess('Event', 'get', []);
153 $this->addLocationToEvent($event['id']);
155 'contribution_id' => $contribution['id'],
156 'total_amount' => 50,
157 'check_number' => '345',
158 'trxn_date' => '2018-08-13 17:57:56',
160 $payment = $this->callAPISuccess('payment', 'create', $params);
161 $this->checkPaymentResult($payment, [
163 'from_financial_account_id' => 7,
164 'to_financial_account_id' => 6,
165 'total_amount' => 50,
171 $this->callAPISuccess('Payment', 'sendconfirmation', ['id' => $payment['id']]);
172 $mut->assertSubjects(['Payment Receipt - Annual CiviCRM meet - Mr. Anthony Anderson II']);
174 'From: "FIXME" <info@EXAMPLE.ORG>',
176 'Total Fee: $ 300.00',
177 'This Payment Amount: $ 50.00',
178 //150 was paid in the 1st payment.
179 'Balance Owed: $ 100.00',
180 'Event Information and Location',
183 'Transaction Date: August 13th, 2018 5:57 PM',
188 $mut->clearMessages();
189 $this->validateAllPayments();
193 * Test email receipt for partial payment.
195 * @throws \CRM_Core_Exception
197 public function testPaymentEmailReceiptFullyPaid() {
198 $mut = new CiviMailUtils($this);
199 CRM_Core_Config
::singleton()->userPermissionClass
->permissions
= ['access CiviContribute', 'edit contributions', 'access CiviCRM'];
200 $contribution = $this->createPartiallyPaidParticipantOrder();
203 'contribution_id' => $contribution['id'],
204 'total_amount' => 150,
206 $payment = $this->callAPISuccess('payment', 'create', $params);
208 // Here we set the email to an invalid email & use check_permissions, domain email should be used.
209 $email = $this->callAPISuccess('Email', 'create', ['contact_id' => 1, 'email' => 'bob@example.com']);
210 $this->callAPISuccess('Payment', 'sendconfirmation', ['id' => $payment['id'], 'from' => $email['id'], 'check_permissions' => 1]);
211 $mut->assertSubjects(['Payment Receipt - Annual CiviCRM meet - Mr. Anthony Anderson II', 'Registration Confirmation - Annual CiviCRM meet - Mr. Anthony Anderson II']);
213 'From: "FIXME" <info@EXAMPLE.ORG>',
215 'Below you will find a receipt for this payment.',
216 'Total Fee: $ 300.00',
217 'This Payment Amount: $ 150.00',
218 'Balance Owed: $ 0.00',
219 'Thank you for completing this payment.',
222 $mut->clearMessages();
223 $this->validateAllPayments();
227 * Test email receipt for partial payment.
229 * @dataProvider getThousandSeparators
231 * @param string $thousandSeparator
233 * @throws \CRM_Core_Exception
235 public function testRefundEmailReceipt($thousandSeparator) {
236 $this->setCurrencySeparators($thousandSeparator);
237 $decimalSeparator = ($thousandSeparator === ',' ?
'.' : ',');
238 $mut = new CiviMailUtils($this);
239 $contribution = $this->createPartiallyPaidParticipantOrder();
240 $this->callAPISuccess('payment', 'create', [
241 'contribution_id' => $contribution['id'],
242 'total_amount' => 50,
243 'check_number' => '345',
244 'trxn_date' => '2018-08-13 17:57:56',
247 $payment = $this->callAPISuccess('payment', 'create', [
248 'contribution_id' => $contribution['id'],
249 'total_amount' => -30,
250 'trxn_date' => '2018-11-13 12:01:56',
251 'sequential' => TRUE,
255 'from_financial_account_id' => 7,
256 'to_financial_account_id' => 6,
257 'total_amount' => -30,
258 'status_id' => CRM_Core_PseudoConstant
::getKey('CRM_Core_BAO_FinancialTrxn', 'status_id', 'Refunded'),
261 foreach ($expected as $key => $value) {
262 $this->assertEquals($expected[$key], $payment[$key], 'mismatch on key ' . $key);
265 $this->callAPISuccess('Payment', 'sendconfirmation', ['id' => $payment['id']]);
266 $mut->assertSubjects(['Refund Notification - Annual CiviCRM meet - Mr. Anthony Anderson II']);
269 'A refund has been issued based on changes in your registration selections.',
270 'Total Fee: $ 300' . $decimalSeparator . '00',
271 'Refund Amount: $ -30' . $decimalSeparator . '00',
272 'Event Information and Location',
274 'Transaction Date: November 13th, 2018 12:01 PM',
275 'Total Paid: $ 170' . $decimalSeparator . '00',
278 $mut->clearMessages();
279 $this->validateAllPayments();
283 * Test adding a payment to a pending multi-line order.
285 * @throws \CRM_Core_Exception
287 public function testCreatePaymentPendingOrderNoLineItems() {
288 $order = $this->createPendingParticipantOrder();
289 $this->callAPISuccess('Payment', 'create', [
290 'order_id' => $order['id'],
291 'total_amount' => 50,
293 $this->validateAllPayments();
297 * Test that Payment.create does not fail if the line items are missing.
299 * In the original spec it was anticipated that financial items would not be created
300 * for pending contributions in some circumstances. We've backed away from this and
301 * I mostly could not find a way to do it through the UI. But I did seem to once &
302 * I want to be sure that if they ARE missing no fatal occurs so this tests
303 * that in an artificial way.
305 * @throws \CRM_Core_Exception
307 public function testAddPaymentMissingFinancialItems() {
308 $contribution = $this->callAPISuccess('Contribution', 'create', [
309 'total_amount' => 50,
310 'financial_type_id' => 'Donation',
311 'contact_id' => $this->individualCreate(),
312 'contribution_status_id' => 'Pending',
314 CRM_Core_DAO
::executeQuery('DELETE FROM civicrm_financial_item');
315 $this->callAPISuccess('Payment', 'create', ['contribution_id' => $contribution['id'], 'payment_instrument_id' => 'Check', 'total_amount' => 5]);
316 $this->validateAllPayments();
320 * Add participant with contribution
324 * @throws \CRM_Core_Exception
326 protected function createPendingParticipantOrder() {
327 return $this->callAPISuccess('Order', 'create', $this->getParticipantOrderParams());
331 * Test create payment api with no line item in params
333 * @throws \CRM_Core_Exception
335 public function testCreatePaymentNoLineItems() {
336 $contribution = $this->createPartiallyPaidParticipantOrder();
338 //Create partial payment
340 'contribution_id' => $contribution['id'],
341 'total_amount' => 50,
343 $payment = $this->callAPIAndDocument('payment', 'create', $params, __FUNCTION__
, __FILE__
);
344 $this->checkPaymentIsValid($payment['id'], $contribution['id']);
347 'entity_table' => 'civicrm_financial_item',
348 'financial_trxn_id' => $payment['id'],
350 $eft = $this->callAPISuccess('EntityFinancialTrxn', 'get', $params);
351 $amounts = [33.33, 16.67];
352 foreach ($eft['values'] as $value) {
353 $this->assertEquals($value['amount'], array_pop($amounts));
356 // Now create payment to complete total amount of contribution
358 'contribution_id' => $contribution['id'],
359 'total_amount' => 100,
361 $payment = $this->callAPISuccess('payment', 'create', $params);
364 'from_financial_account_id' => 7,
365 'to_financial_account_id' => 6,
366 'total_amount' => 100,
371 $this->checkPaymentResult($payment, $expectedResult);
373 'entity_table' => 'civicrm_financial_item',
374 'financial_trxn_id' => $payment['id'],
376 $eft = $this->callAPISuccess('EntityFinancialTrxn', 'get', $params);
377 $amounts = [66.67, 33.33];
378 foreach ($eft['values'] as $value) {
379 $this->assertEquals($value['amount'], array_pop($amounts));
381 // Check contribution for completed status
382 $contribution = $this->callAPISuccess('contribution', 'get', ['id' => $contribution['id']]);
384 $this->assertEquals($contribution['values'][$contribution['id']]['contribution_status'], 'Completed');
385 $this->assertEquals($contribution['values'][$contribution['id']]['total_amount'], 300.00);
386 $paymentParticipant = [
387 'contribution_id' => $contribution['id'],
389 $participantPayment = $this->callAPISuccess('ParticipantPayment', 'getsingle', $paymentParticipant);
390 $participant = $this->callAPISuccess('participant', 'get', ['id' => $participantPayment['participant_id']]);
391 $this->assertEquals($participant['values'][$participant['id']]['participant_status'], 'Registered');
392 $this->callAPISuccess('Contribution', 'Delete', [
393 'id' => $contribution['id'],
395 $this->validateAllPayments();
399 * Function to assert db values
401 * @throws \CRM_Core_Exception
403 public function checkPaymentResult($payment, $expectedResult) {
404 $refreshedPayment = $this->callAPISuccessGetSingle('Payment', ['financial_trxn_id' => $payment['id']]);
405 foreach ($expectedResult[$payment['id']] as $key => $value) {
406 $this->assertEquals($refreshedPayment[$key], $value, 'mismatch on ' . $key); $this->assertEquals($refreshedPayment[$key], $value, 'mismatch on ' . $key);
411 * Test create payment api with line item in params
413 * @throws \CRM_Core_Exception
415 public function testCreatePaymentLineItems() {
416 $contribution = $this->createPartiallyPaidParticipantOrder();
417 $lineItems = $this->callAPISuccess('LineItem', 'get', ['contribution_id' => $contribution['id']])['values'];
419 // Create partial payment by passing line item array is params.
421 'contribution_id' => $contribution['id'],
422 'total_amount' => 50,
425 foreach ($lineItems as $id => $ignore) {
426 $params['line_item'][] = [$id => array_pop($amounts)];
428 $payment = $this->callAPIAndDocument('Payment', 'create', $params, __FUNCTION__
, __FILE__
, 'Payment with line item', 'CreatePaymentWithLineItems');
429 $this->checkPaymentIsValid($payment['id'], $contribution['id']);
432 'entity_table' => 'civicrm_financial_item',
433 'financial_trxn_id' => $payment['id'],
434 'return' => ['entity_id.entity_id', 'amount'],
436 $eft = $this->callAPISuccess('EntityFinancialTrxn', 'get', $params)['values'];
437 $this->assertCount(2, $eft);
439 foreach ($eft as $value) {
440 $this->assertEquals($value['amount'], array_pop($amounts));
443 // Now create payment to complete total amount of contribution
445 'contribution_id' => $contribution['id'],
446 'total_amount' => 100,
449 foreach ($lineItems as $id => $ignore) {
450 $params['line_item'][] = [$id => array_pop($amounts)];
452 $payment = $this->callAPISuccess('Payment', 'create', $params);
455 'from_financial_account_id' => 7,
456 'to_financial_account_id' => 6,
457 'total_amount' => 100,
462 $this->checkPaymentResult($payment, $expectedResult);
464 'entity_table' => 'civicrm_financial_item',
465 'financial_trxn_id' => $payment['id'],
467 $eft = $this->callAPISuccess('EntityFinancialTrxn', 'get', $params)['values'];
468 $this->assertCount(2, $eft);
470 foreach ($eft as $value) {
471 $this->assertEquals($value['amount'], array_pop($amounts));
473 // Check contribution for completed status
474 $contribution = $this->callAPISuccess('Contribution', 'get', ['id' => $contribution['id']]);
476 $this->assertEquals($contribution['values'][$contribution['id']]['contribution_status'], 'Completed');
477 $this->assertEquals($contribution['values'][$contribution['id']]['total_amount'], 300.00);
478 $paymentParticipant = [
479 'contribution_id' => $contribution['id'],
481 $participantPayment = $this->callAPISuccess('ParticipantPayment', 'getsingle', $paymentParticipant);
482 $participant = $this->callAPISuccess('participant', 'get', ['id' => $participantPayment['participant_id']]);
483 $this->assertEquals($participant['values'][$participant['id']]['participant_status'], 'Registered');
484 $this->validateAllPayments();
488 * Test cancel payment api
490 * @throws \CRM_Core_Exception
492 public function testCancelPayment() {
493 CRM_Core_Config
::singleton()->userPermissionClass
->permissions
= ['administer CiviCRM', 'access CiviContribute'];
494 $contribution = $this->createPartiallyPaidParticipantOrder();
497 'contribution_id' => $contribution['id'],
500 $payment = $this->callAPISuccess('payment', 'get', $params);
501 $this->assertEquals(1, $payment['count']);
504 'id' => $payment['id'],
505 'check_permissions' => TRUE,
507 $payment = $this->callAPIFailure('payment', 'cancel', $cancelParams, 'API permission check failed for Payment/cancel call; insufficient permission: require access CiviCRM and access CiviContribute and edit contributions');
509 array_push(CRM_Core_Config
::singleton()->userPermissionClass
->permissions
, 'access CiviCRM', 'edit contributions');
511 $this->callAPIAndDocument('payment', 'cancel', $cancelParams, __FUNCTION__
, __FILE__
);
513 $payment = $this->callAPISuccess('payment', 'get', $params);
514 $this->assertEquals(2, $payment['count']);
515 $amounts = [-150.00, 150.00];
516 foreach ($payment['values'] as $value) {
517 $this->assertEquals($value['total_amount'], array_pop($amounts), 'Mismatch total amount');
520 $this->callAPISuccess('Contribution', 'Delete', [
521 'id' => $contribution['id'],
523 $this->validateAllPayments();
527 * Test delete payment api
529 * @throws \CRM_Core_Exception
531 public function testDeletePayment() {
532 CRM_Core_Config
::singleton()->userPermissionClass
->permissions
= ['administer CiviCRM', 'access CiviContribute'];
533 $contribution = $this->createPartiallyPaidParticipantOrder();
536 'contribution_id' => $contribution['id'],
539 $payment = $this->callAPISuccess('payment', 'get', $params);
540 $this->assertEquals(1, $payment['count']);
543 'id' => $payment['id'],
544 'check_permissions' => TRUE,
546 $payment = $this->callAPIFailure('payment', 'delete', $deleteParams, 'API permission check failed for Payment/delete call; insufficient permission: require access CiviCRM and access CiviContribute and delete in CiviContribute');
548 array_push(CRM_Core_Config
::singleton()->userPermissionClass
->permissions
, 'access CiviCRM', 'delete in CiviContribute');
549 $this->callAPIAndDocument('payment', 'delete', $deleteParams, __FUNCTION__
, __FILE__
);
551 $payment = $this->callAPISuccess('payment', 'get', $params);
552 $this->assertEquals(0, $payment['count']);
554 $this->callAPISuccess('Contribution', 'Delete', [
555 'id' => $contribution['id'],
560 * Test update payment api.
562 * 1) create a contribution for $300 with a partial payment of $150
563 * - this results in 2 financial transactions. The accounts receivable transaction is linked
564 * via entity_financial_trxns to the 2 line items. The $150 payment is not linked to the line items
565 * so the line items are fully allocated even though they are only half paid.
567 * 2) add a payment of $50 -
568 * This payment transaction IS linked to the line items so $350 of the $300 in line items is allocated
571 * 3) update that payment to be $100
572 * This results in a negative and a positive payment ($50 & $100) - the negative payment results in
573 * financial_items but the positive payment does not.
575 * The final result is we have
576 * - 1 partly paid contribution of $300
577 * - payment financial_trxns totalling $250
578 * - 1 Accounts receivable financial_trxn totalling $300
579 * - 2 financial items totalling $300 linked to the Accounts receivable financial_trxn
580 * - 6 entries in the civicrm_entity_financial_trxn linked to line items - totalling $450.
581 * - 5 entries in the civicrm_entity_financial_trxn linked to contributions - totalling $550.
583 * @throws \CRM_Core_Exception
585 public function testUpdatePayment() {
586 CRM_Core_Config
::singleton()->userPermissionClass
->permissions
= ['administer CiviCRM', 'access CiviContribute', 'edit contributions'];
587 $contribution = $this->createPartiallyPaidParticipantOrder();
589 //Create partial payment by passing line item array is params
591 'contribution_id' => $contribution['id'],
592 'total_amount' => 50,
595 $payment = $this->callAPISuccess('payment', 'create', $params);
598 'from_financial_account_id' => 7,
599 'to_financial_account_id' => 6,
600 'total_amount' => 50,
605 $this->checkPaymentResult($payment, $expectedResult);
608 'entity_table' => 'civicrm_financial_item',
609 'financial_trxn_id' => $payment['id'],
611 $eft = $this->callAPISuccess('EntityFinancialTrxn', 'get', $params);
612 $amounts = [33.33, 16.67];
613 foreach ($eft['values'] as $value) {
614 $this->assertEquals($value['amount'], array_pop($amounts));
617 // update the amount for payment
619 'contribution_id' => $contribution['id'],
620 'total_amount' => 100,
621 'id' => $payment['id'],
622 'check_permissions' => TRUE,
624 // @todo - move this permissions test to it's own test - it just confuses here.
625 CRM_Core_Config
::singleton()->userPermissionClass
->permissions
= ['administer CiviCRM', 'access CiviContribute'];
626 $this->callAPIFailure('payment', 'create', $params, 'API permission check failed for Payment/create call; insufficient permission: require access CiviCRM and access CiviContribute and edit contributions');
628 CRM_Core_Config
::singleton()->userPermissionClass
->permissions
= ['administer CiviCRM', 'access CiviContribute', 'access CiviCRM', 'edit contributions'];
629 $payment = $this->callAPIAndDocument('payment', 'create', $params, __FUNCTION__
, __FILE__
, 'Update Payment', 'UpdatePayment');
631 $this->validateAllPayments();
632 // Check for proportional cancelled payment against lineitems.
634 'entity_table' => 'civicrm_financial_item',
635 'financial_trxn_id' => $payment['id'] - 1,
638 $eft = $this->callAPISuccess('EntityFinancialTrxn', 'get', $minParams)['values'];
639 $this->assertCount(2, $eft);
640 $amounts = [-33.33, -16.67];
642 foreach ($eft as $value) {
643 $this->assertEquals($value['amount'], array_pop($amounts));
646 // Check for proportional updated payment against lineitems.
648 'entity_table' => 'civicrm_financial_item',
649 'financial_trxn_id' => $payment['id'],
651 $eft = $this->callAPISuccess('EntityFinancialTrxn', 'get', $params)['values'];
652 $amounts = [66.67, 33.33];
653 foreach ($eft as $value) {
654 $this->assertEquals($value['amount'], array_pop($amounts));
656 $items = $this->callAPISuccess('FinancialItem', 'get', [])['values'];
657 $this->assertCount(2, $items);
659 foreach ($items as $item) {
660 $this->assertEquals('civicrm_line_item', $item['entity_table']);
661 $itemSum +
= $item['amount'];
663 $this->assertEquals(300, $itemSum);
666 'contribution_id' => $contribution['id'],
668 $payment = $this->callAPISuccess('payment', 'get', $params);
669 $amounts = [100.00, -50.00, 50.00, 150.00];
670 foreach ($payment['values'] as $value) {
671 $amount = array_pop($amounts);
672 $this->assertEquals($value['total_amount'], $amount, 'Mismatch total amount');
674 // Check entity financial trxn created properly
676 'entity_id' => $contribution['id'],
677 'entity_table' => 'civicrm_contribution',
678 'financial_trxn_id' => $value['id'],
680 $eft = $this->callAPISuccess('EntityFinancialTrxn', 'get', $params);
681 $this->assertEquals($eft['values'][$eft['id']]['amount'], $amount);
684 $this->callAPISuccess('Contribution', 'Delete', [
685 'id' => $contribution['id'],
687 $this->validateAllPayments();
691 * Test create payment api for paylater contribution
693 * @throws \CRM_Core_Exception
695 public function testCreatePaymentPayLater() {
696 $this->createLoggedInUser();
697 $processorID = $this->paymentProcessorCreate();
698 $contributionParams = [
699 'total_amount' => 100,
701 'contact_id' => $this->_individualId
,
702 'financial_type_id' => 1,
703 'contribution_status_id' => 2,
706 $contribution = $this->callAPISuccess('Contribution', 'create', $contributionParams);
707 //add payment for pay later transaction
709 'contribution_id' => $contribution['id'],
710 'total_amount' => 100,
711 'card_type_id' => 'Visa',
712 'pan_truncation' => '1234',
713 'trxn_result_code' => 'Startling success',
714 'payment_instrument_id' => $processorID,
717 $payment = $this->callAPISuccess('Payment', 'create', $params);
720 'from_financial_account_id' => 7,
721 'to_financial_account_id' => 6,
722 'total_amount' => 100,
726 'pan_truncation' => '1234',
727 'trxn_result_code' => 'Startling success',
729 'payment_instrument_id' => 1,
732 $this->checkPaymentResult($payment, $expectedResult);
733 // Check entity financial trxn created properly
735 'entity_id' => $contribution['id'],
736 'entity_table' => 'civicrm_contribution',
737 'financial_trxn_id' => $payment['id'],
739 $eft = $this->callAPISuccess('EntityFinancialTrxn', 'get', $params);
740 $this->assertEquals($eft['values'][$eft['id']]['amount'], 100);
742 'entity_table' => 'civicrm_financial_item',
743 'financial_trxn_id' => $payment['id'],
745 $eft = $this->callAPISuccess('EntityFinancialTrxn', 'get', $params);
746 $this->assertEquals($eft['values'][$eft['id']]['amount'], 100);
747 // Check contribution for completed status
748 $contribution = $this->callAPISuccess('contribution', 'get', ['id' => $contribution['id']]);
749 $this->assertEquals($contribution['values'][$contribution['id']]['contribution_status'], 'Completed');
750 $this->assertEquals($contribution['values'][$contribution['id']]['total_amount'], 100.00);
751 $this->callAPISuccess('Contribution', 'Delete', [
752 'id' => $contribution['id'],
754 $this->validateAllPayments();
758 * Test net amount is set when fee amount is passed in.
760 * @throws \CRM_Core_Exception
762 public function testNetAmount() {
763 $order = $this->createPendingParticipantOrder();
764 $payment = $this->callAPISuccess('Payment', 'create', ['order_id' => $order['id'], 'total_amount' => 10, 'fee_amount' => .25]);
765 $this->assertEquals('9.75', $this->callAPISuccessGetValue('Payment', ['id' => $payment['id'], 'return' => 'net_amount']));
769 * Test create payment api for pay later contribution with partial payment.
771 * https://lab.civicrm.org/dev/financial/issues/69
772 * @throws \CRM_Core_Exception
774 public function testCreatePaymentIncompletePaymentPartialPayment() {
775 $contributionParams = [
776 'total_amount' => 100,
778 'contact_id' => $this->_individualId
,
779 'financial_type_id' => 1,
780 'contribution_status_id' => 2,
782 $contribution = $this->callAPISuccess('Contribution', 'create', $contributionParams);
783 $this->callAPISuccess('Payment', 'create', [
784 'contribution_id' => $contribution['id'],
785 'total_amount' => 50,
786 'payment_instrument_id' => 'Cash',
788 $payments = $this->callAPISuccess('Payment', 'get', ['contribution_id' => $contribution['id']])['values'];
789 $this->assertCount(1, $payments);
790 $this->validateAllPayments();
794 * Test create payment api for pay later contribution with partial payment.
796 * @throws \CRM_Core_Exception
798 public function testCreatePaymentPayLaterPartialPayment() {
799 $this->createLoggedInUser();
800 $contributionParams = [
801 'total_amount' => 100,
803 'contact_id' => $this->_individualId
,
804 'financial_type_id' => 1,
805 'contribution_status_id' => 2,
808 $contribution = $this->callAPISuccess('Order', 'create', $contributionParams);
809 //Create partial payment
811 'contribution_id' => $contribution['id'],
812 'total_amount' => 60,
814 $payment = $this->callAPISuccess('Payment', 'create', $params);
817 'total_amount' => 60,
822 $this->checkPaymentResult($payment, $expectedResult);
823 // Check entity financial trxn created properly
825 'entity_id' => $contribution['id'],
826 'entity_table' => 'civicrm_contribution',
827 'financial_trxn_id' => $payment['id'],
829 $eft = $this->callAPISuccess('EntityFinancialTrxn', 'get', $params);
830 $this->assertEquals($eft['values'][$eft['id']]['amount'], 60);
832 'entity_table' => 'civicrm_financial_item',
833 'financial_trxn_id' => $payment['id'],
835 $eft = $this->callAPISuccess('EntityFinancialTrxn', 'get', $params);
836 $this->assertEquals($eft['values'][$eft['id']]['amount'], 60);
837 $contribution = $this->callAPISuccess('contribution', 'get', ['id' => $contribution['id']]);
838 $this->assertEquals($contribution['values'][$contribution['id']]['contribution_status'], 'Partially paid');
839 $this->assertEquals($contribution['values'][$contribution['id']]['total_amount'], 100.00);
840 //Create full payment
842 'contribution_id' => $contribution['id'],
843 'total_amount' => 40,
845 // Rename the 'completed' status label first to check that we are not using the labels!
846 $this->callAPISuccess('OptionValue', 'get', ['name' => 'Completed', 'option_group_id' => 'contribution_status', 'api.OptionValue.create' => ['label' => 'Unicorn']]);
847 $payment = $this->callAPISuccess('Payment', 'create', $params);
850 'from_financial_account_id' => 7,
851 'to_financial_account_id' => 6,
852 'total_amount' => 40,
857 $this->checkPaymentResult($payment, $expectedResult);
858 // Check entity financial trxn created properly
860 'entity_id' => $contribution['id'],
861 'entity_table' => 'civicrm_contribution',
862 'financial_trxn_id' => $payment['id'],
864 $eft = $this->callAPISuccess('EntityFinancialTrxn', 'get', $params);
865 $this->assertEquals($eft['values'][$eft['id']]['amount'], 40);
867 'entity_table' => 'civicrm_financial_item',
868 'financial_trxn_id' => $payment['id'],
870 $eft = $this->callAPISuccess('EntityFinancialTrxn', 'get', $params);
871 $this->assertEquals($eft['values'][$eft['id']]['amount'], 40);
872 // Check contribution for completed status
873 $contribution = $this->callAPISuccess('contribution', 'get', ['id' => $contribution['id']]);
874 $this->assertEquals($contribution['values'][$contribution['id']]['contribution_status'], 'Unicorn');
875 $this->assertEquals($contribution['values'][$contribution['id']]['total_amount'], 100.00);
876 $this->callAPISuccess('Contribution', 'Delete', [
877 'id' => $contribution['id'],
879 $this->callAPISuccess('OptionValue', 'get', ['name' => 'Completed', 'option_group_id' => 'contribution_status', 'api.OptionValue.create' => ['label' => 'Completed']]);
880 $this->callAPISuccessGetCount('Activity', ['target_contact_id' => $this->_individualId
, 'activity_type_id' => 'Payment'], 2);
881 $this->validateAllPayments();
885 * Test that Payment.create uses the to_account of the payment processor.
887 * @throws \CiviCRM_API3_Exception
888 * @throws \CRM_Core_Exception
890 public function testPaymentWithProcessorWithOddFinancialAccount() {
891 $processor = $this->dummyProcessorCreate(['financial_account_id' => 'Deposit Bank Account', 'payment_instrument_id' => 'Cash']);
892 $processor2 = $this->dummyProcessorCreate(['financial_account_id' => 'Payment Processor Account', 'name' => 'p2', 'payment_instrument_id' => 'EFT']);
893 $contributionParams = [
894 'total_amount' => 100,
896 'contact_id' => $this->_individualId
,
897 'financial_type_id' => 1,
898 'contribution_status_id' => 'Pending',
900 $order = $this->callAPISuccess('Order', 'create', $contributionParams);
901 $this->callAPISuccess('Payment', 'create', ['payment_processor_id' => $processor->getID(), 'total_amount' => 6, 'contribution_id' => $order['id']]);
902 $this->callAPISuccess('Payment', 'create', ['payment_processor_id' => $processor2->getID(), 'total_amount' => 15, 'contribution_id' => $order['id']]);
903 $payments = $this->callAPISuccess('Payment', 'get', ['sequential' => 1, 'contribution_id' => $order['id']])['values'];
904 $this->assertEquals('Deposit Bank Account', CRM_Core_PseudoConstant
::getName('CRM_Core_BAO_FinancialTrxn', 'to_financial_account_id', $payments[0]['to_financial_account_id']));
905 $this->assertEquals('Payment Processor Account', CRM_Core_PseudoConstant
::getName('CRM_Core_BAO_FinancialTrxn', 'to_financial_account_id', $payments[1]['to_financial_account_id']));
906 $this->assertEquals('Accounts Receivable', CRM_Core_PseudoConstant
::getName('CRM_Core_BAO_FinancialTrxn', 'from_financial_account_id', $payments[0]['from_financial_account_id']));
907 $this->assertEquals('Accounts Receivable', CRM_Core_PseudoConstant
::getName('CRM_Core_BAO_FinancialTrxn', 'from_financial_account_id', $payments[1]['from_financial_account_id']));
908 $this->assertEquals('Cash', CRM_Core_PseudoConstant
::getName('CRM_Core_BAO_FinancialTrxn', 'payment_instrument_id', $payments[0]['payment_instrument_id']));
909 $this->assertEquals('EFT', CRM_Core_PseudoConstant
::getName('CRM_Core_BAO_FinancialTrxn', 'payment_instrument_id', $payments[1]['payment_instrument_id']));
910 // $order = $this->callAPISuccessGetSingle('Order', ['id' => $processor->getID()]);
911 // $this->assertEquals('Cash', CRM_Core_PseudoConstant::getName('CRM_Core_BAO_FinancialTrxn', 'payment_instrument_id', $order['payment_instrument_id']));
915 * Add a location to our event.
917 * @param int $eventID
919 * @throws \CRM_Core_Exception
921 protected function addLocationToEvent($eventID) {
923 'name' => 'event place',
924 'street_address' => 'streety street',
925 'location_type_id' => 1,
928 // api requires contact_id - perhaps incorrectly but use add to get past that.
929 $address = CRM_Core_BAO_Address
::add($addressParams);
931 $location = $this->callAPISuccess('LocBlock', 'create', ['address_id' => $address->id
]);
932 $this->callAPISuccess('Event', 'create', [
934 'loc_block_id' => $location['id'],
935 'is_show_location' => TRUE,
937 $this->validateAllPayments();
941 * Check the created payment is valid.
943 * This is probably over-testing really since we are repetitively checking a basic function...
945 * @param int $paymentID
946 * @param int $contributionID
949 * @throws \CRM_Core_Exception
951 protected function checkPaymentIsValid($paymentID, $contributionID, $amount = 50) {
952 $payment = $this->callAPISuccess('Payment', 'getsingle', ['financial_trxn_id' => $paymentID]);
953 $this->assertEquals(7, $payment['from_financial_account_id']);
954 $this->assertEquals(6, $payment['to_financial_account_id']);
955 $this->assertEquals(1, $payment['status_id']);
956 $this->assertEquals(1, $payment['is_payment']);
957 $this->assertEquals($amount, $payment['total_amount']);
959 $eft = $this->callAPISuccess('EntityFinancialTrxn', 'get', [
960 'entity_id' => $contributionID,
961 'entity_table' => 'civicrm_contribution',
962 'financial_trxn_id' => $payment['id'],
965 $this->assertEquals($eft['values'][$eft['id']]['amount'], $amount);
966 $this->validateAllPayments();