Payment Refund
It is possible to refund particular payments within the Sale. This is equivalent to the Sale Return, but without involving items or partial amounts.
Info
Refunds can be used for cases where the customer changes their mind immediatelly after the payment and Sale Reversal is no longer possible (Payment already sent for settlement to respective network) or if the customer wishes to replace completed payment method with alternative one.
Warning
The execution of payment Refund is bound to a Sale being in the Unconfirmed or Failed Intervene states. If your Sale is in a different state, such as Completed, what you are looking for is a Partial Return - in which case you can decide what payment method the Partial Return applies to. For further details, see the samples in the Return section.
The Sample Code
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| let sale: WDSaleResponse = WDSaleResponse();//not a real example - you would need to obtain the sale from querySale or perform a payment | |
| let sdk: WDePOS = WDePOS.sharedInstance() | |
| // End of Return process | |
| let completion: SaleUpdateCompletion = { (sale: WDSaleResponse?, error: Error?) in | |
| // sale - refunded sale detail | |
| // error - if encountered during the Refund process | |
| } | |
| let saleReturn: WDSaleRequest! = sale.saleReturn()// Here we created the full Sale Return | |
| // Perform the Refund | |
| sdk.saleManager.refundSale(saleReturn,// The full Sale Return Request | |
| message: "Merchant Refunded", // Set the note for this Return | |
| completion: completion) // End of Return process | |
| // It is possible to refund the specific payment. Applicable for Sale in Unconfirmed or Failed Intervene state | |
| let originalPayment = sale.processedCardPayments().first | |
| var paymentRefund: WDPaymentRefundCard! = originalPayment?.refund() | |
| // Alternatively you are able to Refund the specific payment with lower amount than original payment was. | |
| guard let amount = originalPayment?.amount.multiplying(by: NSDecimalNumber(value: 0.9)), let originalPaymentId = originalPayment?.internalId else { | |
| return | |
| } | |
| paymentRefund = WDPaymentRefundCard(amount: amount, originalPaymentId: originalPaymentId) | |
| sdk.saleManager.refundSale(sale.saleId, // Sale ID | |
| message:"Merchant Refunded", // Set the note for this Return | |
| externalId: nil, // The Refund ID as known by the external system | |
| payment: paymentRefund, // Payment to Refund | |
| completion: completion) // End of Return process |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| import java.math.BigDecimal; | |
| import de.wirecard.epos.EposSDK; | |
| import de.wirecard.epos.model.sale.builder.RefundRequest; | |
| import de.wirecard.epos.model.sale.builder.payment.CashRefundPayment; | |
| import de.wirecard.epos.model.with.With; | |
| import de.wirecard.epos.model.with.WithBase; | |
| import io.reactivex.android.schedulers.AndroidSchedulers; | |
| import io.reactivex.schedulers.Schedulers; | |
| //initialize your params | |
| String originalSaleId; | |
| CashRefundPayment refundPayment = new CashRefundPayment(new BigDecimal("15")); | |
| RefundRequest refundRequest = new RefundRequest(originalSaleId, refundPayment); | |
| eposSDK.sales().operation() | |
| .refund(refundRequest) | |
| .observeOn(AndroidSchedulers.mainThread()) // in case you want result in main thread | |
| .subscribe(saleNonErrorResponse -> { | |
| // check for response from backend | |
| }, throwable -> { | |
| //handle error | |
| }); | |
| //******************** USING WITH PARAMETER ********************// | |
| WithBase withBase = With.base().scheduler(Schedulers.newThread()); // in case you want request to run on specific thread | |
| eposSDK.sales().operation() | |
| .refund(refundRequest, withBase) | |
| .observeOn(AndroidSchedulers.mainThread()) // in case you want result in main thread | |
| .subscribe(saleNonErrorResponse -> { | |
| // check for response from backend | |
| }, throwable -> { | |
| //handle error | |
| }); |
Universal Windows Platform SDK coming soon