Refund transactions can only be performed using Capture ID retrieved from successful Capture transaction.
Use the following code snippet to perform a Refund transaction:
@RequiredArgsConstructor
public class Refund {
private final PayPalCheckoutTransactionService payPalCheckoutTransactionService;
public void performRefund() {
CurrencyUnit currency = Monetary.getCurrency(currencyCode);
MonetaryAmount transactionTotal = Monetary.getDefaultAmountFactory().setCurrency(currency).setNumber(amount).create();
PaymentRequest paymentRequest = new PaymentRequest()
.transactionReferenceId(transactionReferenceId)// This is a unique Transaction Reference ID
.transactionTotal(transactionTotal)
.additionalField(MessageConstants.CAPTURE_ID, "paypal_capture_id") // This is the Capture ID retrieved from Capture transaction
.tenantId("TENANT"); // Declare the tenant id to help identify where transaction results should be recorded
PaymentResponse paymentResponse = payPalCheckoutTransactionService.refund(paymentRequest);
paymentResponse.isSuccessful();
paymentResponse.getGatewayResponseCode(); //PayPal Response Code
paymentResponse.getFailureType(); // Failure type in case the transaction was not successful.
paymentResponse.getRawResponse(); // PayPal raw response stored as a JSON object.
}
}
To set additional fields in the PaymentRequest, use method
PaymentRequest.additionalField(key, value)
To get values from responseMap, use
PaymentResponse.getResponseMap().get(key, value)
To get the transaction reference ID from response:
PaymentResponse.getTransactionReferenceId()
To get the Broadleaf Payment ID from the response:
PaymentResponse.getPaymentId()
For more details on the Refund transaction request & response parameters, refer to the PayPal API Reference.
