Set contribution status to refunded when it has been refunded

[mattwire]

Overview

When a contribution is refunded via Payment.create, has been previously marked completed and the sum of all payments for that contribution add up to 0 it should show "Refunded".

Before

Contribution shows "Completed" when it has been fully refunded.

After

Contribution shows "Refunded" when it has been fully refunded.

Technical Details

The function CRM_Financial_BAO_Payment::create already handles changing the contribution status to various states but does nothing with "Refunded". For end users this is really confusing!

Comments

See (sort of) https://lab.civicrm.org/dev/financial/issues/87

[civibot]

(Standard links)

• If this is your first pull-request for CiviCRM, please browse CONTRIBUTING.md for information about the development and testing processes.
• If you are reviewing this pull-request, you may wish to consult the test sites and the Review Standards (long template, short template).

[eileenmcnaughton]

@mattwire this makes sense but we'd need a test

[tapashdatta]

I have tested the new commit by @mattwire and seems to be working as expected.

[jitendrapurohit]

I might be missing something, but I'm not able to find a case where $contributionStatus is Completed while recording a payment via this function. It should be either Pending or Pending Refund based on amount being sent as positive or negative? @mattwire can you mention the steps on UI so I can replicate and test this change from my side?

I tried using event registration -> change selection but I don't see any improved behavior in the contribution status.

[mattwire]

@jitendrapurohit This only happens when using the API function Payment.create in refund mode - see eg. here: https://lab.civicrm.org/extensions/stripe/blob/master/CRM/Core/Payment/StripeIPN.php#L270

Basically pass the full amount of a completed contribution in as a negative amount.

Eg. if contribution = Completed AND amount = 12 THEN
DO Payment.Create (Amount = -12)

Before this PR contribution status remains "Completed" but is fully refunded. After this PR contribution status is "Refunded" because it has been fully refunded.

@jitendrapurohit Does that help?

[jitendrapurohit]

Ah ok - I've tested this and also added a UT for the same at #16255

Noting that when we refund a partial amount, the contribution status is still kept as Completed. This is also covered in the unit test PR.

[eileenmcnaughton]

@mattwire go ahead & merge this once @jitendrapurohit's test run completes with a (correct) fail

[magnolia61]

Using the master branch I cannot replicate the desired behavior

1. When I add a payment for a pending contribution the status becomes completed.

2. When I change the event price set so the total amount becomes 0
   The following happens:

• Event participant status stays: Registered (expected of hoped: Pending Refund)
• BTW: the contribution correctly has the status 'pending refund'

3. Then I add a refund for the total amount.
   The following happens:

• The contribution status becomes 'Completed'

Am I missing something? Would I have needed to test differently?