Disable Reserve, Charge, Cancel or Return buttons
In the Litium Studio backoffice, in the Payments grid, four command buttons are available to execute Reserve, Charge, Cancel or Return operations on the selected payment. However, certain payment methods might not allow some of these operations. For example, a bank direct payment might not support "Reserve" operation, and an invoice method might not support "Return" operation.
This article shows how to enable or disable these buttons from the payment provider implementation logic.
Following properties in the IPaymentProvider interface defines whether a certain comman button in the menubar (in Payments grid in backoffice) is enabled or not.
- Reserve button: IPaymentProvider.CanReserveMoneyFromCustomerAccount
- Charge button: IPaymentProvider.CanChargeCustomerAccountDirectly and IPaymentProvider.CanCompleteCurrentTransaction
- Cancel button: IPaymentProvider.CanCancelCurrentTransaction
- Return button: IPaymentProvider.CanReturnPayment
By default, these properties are implemented in the PaymentProviderBase class. The default implementation guarantees that payment status is correct for a given operation. For example, a payment cannot be "Returned" if it is not yet "Paid", therefore, the return button is enabled only if payment status is "Paid".
Following is a description of default implementation.
- Reserve button: Enabled only if payment status is Init or ChargeFailed or ReserveFailed.
- Charge button: Enabled only if payment status is Init or ChargeFailed or ReserveFailed. or in a reserve mode payment "CanCompleteCurrentTransaction" is true. CanCompleteCurrentTransaction is by default set to true, if the payment status is Reserved or CaptureFailed.
- Cancel button: Enabled only if payment status is Reserved or CaptureFailed
- Return button: Enabled only if payment status is Paid or ReturnFailed
Changing default behaviour
Suppose for example, returning money is not supported when paid by a certain payment method. In this case, the defualt behaviour should be overriden to disbale the "Return" button.
/// <summary>
/// Gets a value indicating whether payment can be refunded.
/// </summary>
public override bool CanReturnPayment
{
get
{
//call the base implementation first to determine whether payment is in correct state
//additionally check whether current payment method is supporting refunding or not.
//For this example, we assume there is a payment method called "NoRefund",
//and when paid from it return button is disabled.
return base.CanReturnPayment && PaymentInfo.PaymentMethod != PaymentMethod.NoRefund.ToString();
}
}