Refunding money
Once a payment is completed, it is possible to refund the money back to the customer, usually if the order is returned. Refunding a payment may be possible only in certain payment methods depending on the payment provider.
This article shows how to implement it in the payment provider plugin.
To implement refunding, implement the IPaymentProvider.ReturnPayment() method. This method is called when "Return payment" button is clicked in the Payments grid. The button is enabled when payment status is "Paid".
In the implementation it is necessary to check IPaymentProvider.CanReturnPayment flag so that all conditions to make a refund is satisfied before the call to the payment provider is made.
/// <summary>
/// Returns the payment.
/// </summary>
public bool ReturnPayment(ReturnPaymentArgs args, Foundation.Security.SecurityToken token)
{
bool success = false;
if (CanReturnPayment)
{
//TODO: call the payment provider api to return the payment.
// success = CallPaymentProviderToReturnPayment(PaymentInfo.TransactionNumber);
if (success)
{
PaymentInfo.SetPaymentStatus((short)PaymentStatus.Returned, token);
PaymentInfo.AppendExternalMessage(DateTime.Now.ToString() + " payment returned", token);
}
}
if (!success)
PaymentInfo.AppendExternalMessage(DateTime.Now.ToString() + " payment return failed", token);
return success;
}